Back to projects

calcom-python-v2

calcom v2 api python package generated by openapi

1 Updated Oct 11, 2024

openapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ImGajeed76/calcom-python-v2.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ImGajeed76/calcom-python-v2.git)

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://api.cal.com/v2"
)



# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.BookingsApi(api_client)
    cal_api_version = 'cal_api_version_example' # str | Must be set to `2024-08-13`
    booking_uid = 'booking_uid_example' # str | 
    cancel_booking_input20240813 = openapi_client.CancelBookingInput20240813() # CancelBookingInput20240813 | 

    try:
        # Cancel a booking
        api_response = api_instance.bookings_controller20240813_cancel_booking(cal_api_version, booking_uid, cancel_booking_input20240813)
        print("The response of BookingsApi->bookings_controller20240813_cancel_booking:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BookingsApi->bookings_controller20240813_cancel_booking: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
BookingsApi bookings_controller20240813_cancel_booking POST /v2/bookings/{bookingUid}/cancel Cancel a booking
BookingsApi bookings_controller20240813_create_booking POST /v2/bookings Create a booking
BookingsApi bookings_controller20240813_get_booking GET /v2/bookings/{bookingUid} Get a booking
BookingsApi bookings_controller20240813_get_bookings GET /v2/bookings Get all bookings
BookingsApi bookings_controller20240813_mark_no_show POST /v2/bookings/{bookingUid}/mark-absent Mark a booking absence
BookingsApi bookings_controller20240813_reschedule_booking POST /v2/bookings/{bookingUid}/reschedule Reschedule a booking
CalendarsApi calendars_controller_check GET /v2/calendars/{calendar}/check Check a calendar connection
CalendarsApi calendars_controller_check_ics_feed GET /v2/calendars/ics-feed/check Check an ICS feed
CalendarsApi calendars_controller_create_ics_feed POST /v2/calendars/ics-feed/save Save an ICS feed
CalendarsApi calendars_controller_delete_calendar_credentials POST /v2/calendars/{calendar}/disconnect Disconnect a calendar
CalendarsApi calendars_controller_get_busy_times GET /v2/calendars/busy-times Get busy times
CalendarsApi calendars_controller_get_calendars GET /v2/calendars Get all calendars
CalendarsApi calendars_controller_redirect GET /v2/calendars/{calendar}/connect Get connect URL
CalendarsApi calendars_controller_save GET /v2/calendars/{calendar}/save Save a calendar
CalendarsApi calendars_controller_sync_credentials POST /v2/calendars/{calendar}/credentials Sync credentials
DestinationCalendarsApi destination_calendars_controller_update_destination_calendars PUT /v2/destination-calendars Update destination calendars
EventTypesApi event_types_controller20240614_create_event_type POST /v2/event-types Create an event type
EventTypesApi event_types_controller20240614_delete_event_type DELETE /v2/event-types/{eventTypeId} Delete an event type
EventTypesApi event_types_controller20240614_get_event_type_by_id GET /v2/event-types/{eventTypeId} Get an event type
EventTypesApi event_types_controller20240614_get_event_types GET /v2/event-types Get all event types
EventTypesApi event_types_controller20240614_update_event_type PATCH /v2/event-types/{eventTypeId} Update an event type
EventTypesWebhooksApi event_type_webhooks_controller_create_event_type_webhook POST /v2/event-types/{eventTypeId}/webhooks Create a webhook
EventTypesWebhooksApi event_type_webhooks_controller_delete_all_event_type_webhooks DELETE /v2/event-types/{eventTypeId}/webhooks Delete all webhooks
EventTypesWebhooksApi event_type_webhooks_controller_delete_event_type_webhook DELETE /v2/event-types/{eventTypeId}/webhooks/{webhookId} Delete a webhook
EventTypesWebhooksApi event_type_webhooks_controller_get_event_type_webhook GET /v2/event-types/{eventTypeId}/webhooks/{webhookId} Get a webhook
EventTypesWebhooksApi event_type_webhooks_controller_get_event_type_webhooks GET /v2/event-types/{eventTypeId}/webhooks Get all webhooks
EventTypesWebhooksApi event_type_webhooks_controller_update_event_type_webhook PATCH /v2/event-types/{eventTypeId}/webhooks/{webhookId} Update a webhook
ManagedUsersApi o_auth_flow_controller_refresh_access_token_0 POST /v2/oauth/{clientId}/refresh
MeApi me_controller_get_me GET /v2/me Get my profile
MeApi me_controller_update_me PATCH /v2/me Update my profile
OAuthApi o_auth_flow_controller_authorize POST /v2/oauth/{clientId}/authorize Authorize an OAuth client
OAuthApi o_auth_flow_controller_exchange POST /v2/oauth/{clientId}/exchange Exchange authorization code for access tokens
OAuthApi o_auth_flow_controller_refresh_access_token POST /v2/oauth/{clientId}/refresh
OrgsAttributesApi organizations_attributes_controller_create_organization_attribute POST /v2/organizations/{orgId}/attributes Create an attribute
OrgsAttributesApi organizations_attributes_controller_delete_organization_attribute DELETE /v2/organizations/{orgId}/attributes/{attributeId} Delete an attribute
OrgsAttributesApi organizations_attributes_controller_get_organization_attribute GET /v2/organizations/{orgId}/attributes/{attributeId} Get an attribute
OrgsAttributesApi organizations_attributes_controller_get_organization_attributes GET /v2/organizations/{orgId}/attributes Get all attributes
OrgsAttributesApi organizations_attributes_controller_update_organization_attribute PATCH /v2/organizations/{orgId}/attributes/{attributeId} Update an attribute
OrgsAttributesOptionsApi organizations_options_attributes_controller_assign_organization_attribute_option_to_user POST /v2/organizations/{orgId}/attributes/options/{userId} Assign an attribute to a user
OrgsAttributesOptionsApi organizations_options_attributes_controller_create_organization_attribute_option POST /v2/organizations/{orgId}/attributes/{attributeId}/options Create an attribute option
OrgsAttributesOptionsApi organizations_options_attributes_controller_delete_organization_attribute_option DELETE /v2/organizations/{orgId}/attributes/{attributeId}/options/{optionId} Delete an attribute option
OrgsAttributesOptionsApi organizations_options_attributes_controller_get_organization_attribute_options GET /v2/organizations/{orgId}/attributes/{attributeId}/options Get all attribute options
OrgsAttributesOptionsApi organizations_options_attributes_controller_get_organization_attribute_options_for_user GET /v2/organizations/{orgId}/attributes/options/{userId} Get all attribute options for a user
OrgsAttributesOptionsApi organizations_options_attributes_controller_unassign_organization_attribute_option_from_user DELETE /v2/organizations/{orgId}/attributes/options/{userId}/{attributeOptionId} Unassign an attribute from a user
OrgsAttributesOptionsApi organizations_options_attributes_controller_update_organization_attribute_option PATCH /v2/organizations/{orgId}/attributes/{attributeId}/options/{optionId} Update an attribute option
OrgsEventTypesApi organizations_event_types_controller_create_phone_call POST /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/create-phone-call Create a phone call
OrgsEventTypesApi organizations_event_types_controller_create_team_event_type POST /v2/organizations/{orgId}/teams/{teamId}/event-types Create an event type
OrgsEventTypesApi organizations_event_types_controller_delete_team_event_type DELETE /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId} Delete a team event type
OrgsEventTypesApi organizations_event_types_controller_get_team_event_type GET /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId} Get an event type
OrgsEventTypesApi organizations_event_types_controller_get_team_event_types GET /v2/organizations/{orgId}/teams/{teamId}/event-types Get a team event type
OrgsEventTypesApi organizations_event_types_controller_get_teams_event_types GET /v2/organizations/{orgId}/teams/event-types Get all team event types
OrgsEventTypesApi organizations_event_types_controller_update_team_event_type PATCH /v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId} Update a team event type
OrgsMembershipsApi organizations_memberships_controller_create_membership POST /v2/organizations/{orgId}/memberships Create a membership
OrgsMembershipsApi organizations_memberships_controller_delete_membership DELETE /v2/organizations/{orgId}/memberships/{membershipId} Delete a membership
OrgsMembershipsApi organizations_memberships_controller_get_all_memberships GET /v2/organizations/{orgId}/memberships Get all memberships
OrgsMembershipsApi organizations_memberships_controller_get_org_membership GET /v2/organizations/{orgId}/memberships/{membershipId} Get a membership
OrgsMembershipsApi organizations_memberships_controller_update_membership PATCH /v2/organizations/{orgId}/memberships/{membershipId} Update a membership
OrgsSchedulesApi organizations_schedules_controller_create_user_schedule POST /v2/organizations/{orgId}/users/{userId}/schedules Create a schedule
OrgsSchedulesApi organizations_schedules_controller_delete_user_schedule DELETE /v2/organizations/{orgId}/users/{userId}/schedules/{scheduleId} Delete a schedule
OrgsSchedulesApi organizations_schedules_controller_get_organization_schedules GET /v2/organizations/{orgId}/schedules Get all schedules
OrgsSchedulesApi organizations_schedules_controller_get_user_schedule GET /v2/organizations/{orgId}/users/{userId}/schedules/{scheduleId} Get a schedule
OrgsSchedulesApi organizations_schedules_controller_get_user_schedules GET /v2/organizations/{orgId}/users/{userId}/schedules Get all schedules
OrgsSchedulesApi organizations_schedules_controller_update_user_schedule PATCH /v2/organizations/{orgId}/users/{userId}/schedules/{scheduleId} Update a schedule
OrgsTeamsApi organizations_teams_controller_create_team POST /v2/organizations/{orgId}/teams Create a team
OrgsTeamsApi organizations_teams_controller_delete_team DELETE /v2/organizations/{orgId}/teams/{teamId} Delete a team
OrgsTeamsApi organizations_teams_controller_get_all_teams GET /v2/organizations/{orgId}/teams Get all teams
OrgsTeamsApi organizations_teams_controller_get_my_teams GET /v2/organizations/{orgId}/teams/me Get team membership for user
OrgsTeamsApi organizations_teams_controller_get_team GET /v2/organizations/{orgId}/teams/{teamId} Get a team
OrgsTeamsApi organizations_teams_controller_update_team PATCH /v2/organizations/{orgId}/teams/{teamId} Update a team
OrgsTeamsMembershipsApi organizations_teams_memberships_controller_create_org_team_membership POST /v2/organizations/{orgId}/teams/{teamId}/memberships Create a membership
OrgsTeamsMembershipsApi organizations_teams_memberships_controller_delete_org_team_membership DELETE /v2/organizations/{orgId}/teams/{teamId}/memberships/{membershipId} Delete a membership
OrgsTeamsMembershipsApi organizations_teams_memberships_controller_get_all_org_team_memberships GET /v2/organizations/{orgId}/teams/{teamId}/memberships Get all memberships
OrgsTeamsMembershipsApi organizations_teams_memberships_controller_get_org_team_membership GET /v2/organizations/{orgId}/teams/{teamId}/memberships/{membershipId} Get a membership
OrgsTeamsMembershipsApi organizations_teams_memberships_controller_update_org_team_membership PATCH /v2/organizations/{orgId}/teams/{teamId}/memberships/{membershipId} Update a membership
OrgsUsersApi organizations_users_controller_create_organization_user POST /v2/organizations/{orgId}/users Create a user
OrgsUsersApi organizations_users_controller_delete_organization_user DELETE /v2/organizations/{orgId}/users/{userId} Delete a user
OrgsUsersApi organizations_users_controller_get_organizations_users GET /v2/organizations/{orgId}/users Get all users
OrgsUsersApi organizations_users_controller_update_organization_user PATCH /v2/organizations/{orgId}/users/{userId} Update a user
OrgsUsersSchedulesApi organizations_schedules_controller_create_user_schedule_0 POST /v2/organizations/{orgId}/users/{userId}/schedules Create a schedule
OrgsUsersSchedulesApi organizations_schedules_controller_delete_user_schedule_0 DELETE /v2/organizations/{orgId}/users/{userId}/schedules/{scheduleId} Delete a schedule
OrgsUsersSchedulesApi organizations_schedules_controller_get_user_schedule_0 GET /v2/organizations/{orgId}/users/{userId}/schedules/{scheduleId} Get a schedule
OrgsUsersSchedulesApi organizations_schedules_controller_get_user_schedules_0 GET /v2/organizations/{orgId}/users/{userId}/schedules Get all schedules
OrgsUsersSchedulesApi organizations_schedules_controller_update_user_schedule_0 PATCH /v2/organizations/{orgId}/users/{userId}/schedules/{scheduleId} Update a schedule
OrgsWebhooksApi organizations_webhooks_controller_create_organization_webhook POST /v2/organizations/{orgId}/webhooks Create a webhook
OrgsWebhooksApi organizations_webhooks_controller_delete_webhook DELETE /v2/organizations/{orgId}/webhooks/{webhookId} Delete a webhook
OrgsWebhooksApi organizations_webhooks_controller_get_all_organization_webhooks GET /v2/organizations/{orgId}/webhooks Get all webhooks
OrgsWebhooksApi organizations_webhooks_controller_get_organization_webhook GET /v2/organizations/{orgId}/webhooks/{webhookId} Get a webhook
OrgsWebhooksApi organizations_webhooks_controller_update_org_webhook PATCH /v2/organizations/{orgId}/webhooks/{webhookId} Update a webhook
PlatformCalProviderApi cal_provider_controller_verify_access_token GET /v2/provider/{clientId}/access-token Verify an access token
PlatformCalProviderApi cal_provider_controller_verify_client_id GET /v2/provider/{clientId} Get a provider
PlatformConferencingApi conferencing_controller_connect POST /v2/conferencing/{app}/connect connect your conferencing application
PlatformConferencingApi conferencing_controller_default POST /v2/conferencing/{app}/default set your default conferencing application
PlatformConferencingApi conferencing_controller_disconnect DELETE /v2/conferencing/{app}/disconnect disconnect your conferencing application
PlatformConferencingApi conferencing_controller_list_conferencing_apps GET /v2/conferencing list your conferencing applications
PlatformGoogleCalendarApi gcal_controller_check GET /v2/gcal/check Check a calendar connection status
PlatformGoogleCalendarApi gcal_controller_redirect GET /v2/gcal/oauth/auth-url Get auth URL
PlatformGoogleCalendarApi gcal_controller_save GET /v2/gcal/oauth/save Connect a calendar
PlatformManagedUsersApi o_auth_client_users_controller_create_user POST /v2/oauth-clients/{clientId}/users Create a managed user
PlatformManagedUsersApi o_auth_client_users_controller_delete_user DELETE /v2/oauth-clients/{clientId}/users/{userId} Delete a managed user
PlatformManagedUsersApi o_auth_client_users_controller_force_refresh POST /v2/oauth-clients/{clientId}/users/{userId}/force-refresh Force refresh tokens
PlatformManagedUsersApi o_auth_client_users_controller_get_managed_users GET /v2/oauth-clients/{clientId}/users Get all managed users
PlatformManagedUsersApi o_auth_client_users_controller_get_user_by_id GET /v2/oauth-clients/{clientId}/users/{userId} Get a managed user
PlatformManagedUsersApi o_auth_client_users_controller_update_user PATCH /v2/oauth-clients/{clientId}/users/{userId} Update a managed user
PlatformWebhooksApi o_auth_client_webhooks_controller_create_o_auth_client_webhook POST /v2/oauth-clients/{clientId}/webhooks Create a webhook
PlatformWebhooksApi o_auth_client_webhooks_controller_delete_all_o_auth_client_webhooks DELETE /v2/oauth-clients/{clientId}/webhooks Delete all webhooks
PlatformWebhooksApi o_auth_client_webhooks_controller_delete_o_auth_client_webhook DELETE /v2/oauth-clients/{clientId}/webhooks/{webhookId} Delete a webhook
PlatformWebhooksApi o_auth_client_webhooks_controller_get_o_auth_client_webhook GET /v2/oauth-clients/{clientId}/webhooks/{webhookId} Get a webhook
PlatformWebhooksApi o_auth_client_webhooks_controller_get_o_auth_client_webhooks GET /v2/oauth-clients/{clientId}/webhooks Get all webhooks
PlatformWebhooksApi o_auth_client_webhooks_controller_update_o_auth_client_webhook PATCH /v2/oauth-clients/{clientId}/webhooks/{webhookId} Update a webhook
SchedulesApi schedules_controller20240611_create_schedule POST /v2/schedules Create a schedule
SchedulesApi schedules_controller20240611_delete_schedule DELETE /v2/schedules/{scheduleId} Delete a schedule
SchedulesApi schedules_controller20240611_get_default_schedule GET /v2/schedules/default Get default schedule
SchedulesApi schedules_controller20240611_get_schedule GET /v2/schedules/{scheduleId} Get a schedule
SchedulesApi schedules_controller20240611_get_schedules GET /v2/schedules Get all schedules
SchedulesApi schedules_controller20240611_update_schedule PATCH /v2/schedules/{scheduleId} Update a schedule
SelectedCalendarsApi selected_calendars_controller_add_selected_calendar POST /v2/selected-calendars Add a selected calendar
SelectedCalendarsApi selected_calendars_controller_remove_selected_calendar DELETE /v2/selected-calendars Delete a selected calendar
SlotsApi slots_controller_delete_selected_slot DELETE /v2/slots/selected-slot Delete a selected slot
SlotsApi slots_controller_get_available_slots GET /v2/slots/available Get available slots
SlotsApi slots_controller_reserve_slot POST /v2/slots/reserve Reserve a slot
StripeApi stripe_controller_check GET /v2/stripe/check Check stripe connection
StripeApi stripe_controller_redirect GET /v2/stripe/connect Get stripe connect URL
StripeApi stripe_controller_save GET /v2/stripe/save Save stripe credentials
TeamsApi organizations_teams_controller_get_all_teams_0 GET /v2/organizations/{orgId}/teams Get all teams
TimezonesApi timezones_controller_get_time_zones GET /v2/timezones Get all timezones
WebhooksApi webhooks_controller_create_webhook POST /v2/webhooks Create a webhook
WebhooksApi webhooks_controller_delete_webhook DELETE /v2/webhooks/{webhookId} Delete a webhook
WebhooksApi webhooks_controller_get_webhook GET /v2/webhooks/{webhookId} Get a webhook
WebhooksApi webhooks_controller_get_webhooks GET /v2/webhooks Get all webooks (paginated)
WebhooksApi webhooks_controller_update_webhook PATCH /v2/webhooks/{webhookId} Update a webhook

Documentation For Models

<a id="documentation-for-authorization"></a>

Documentation For Authorization

Endpoints do not require authorization.

Author