cloudbeds-pms 2.2.0

OpenAPI client for Cloudbeds PMS API.

Cloudbeds PMS

Welcome to the documentation for Cloudbeds API Version v2! If you are looking to learn how to use the Cloudbeds API to access guest information, reservations, or similar data for your Cloudbeds customers, then you've come to the right place.

In this document you will find all the API methods we provide along with explanations for parameters and response examples.

If you have questions about different implementation steps (e.g. how to implement OAuth 2.0), please refer to our Integrations Portal.

Be sure to subscribe to the monthly Cloudbeds API announcement mailing list to receive information on new additions and improvements to the Cloudbeds API and related developer tools.

Endpoint: https://api.cloudbeds.com/{method}

HTTPS: Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.

Request Format: HTTP GET, POST and PUT (Content-Type: application/x-www-form-urlencoded)

Response Format: JSON

Response Header: X-Request-ID is added to response headers in all calls to help accelerate support and troubleshooting.

use this link to access our Public collection in Postman.

The cloudbeds_pms package is automatically generated by the OpenAPI Generator project:

• API version: v2
• Package version: 2.2.0
• Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

• urllib3 >= 1.25.3, < 3.0.0
• python-dateutil >= 2.8.2
• pydantic >= 2
• typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with Cloudbeds PMS, you can run the following:

import cloudbeds_pms
from cloudbeds_pms.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with cloudbeds_pms.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cloudbeds_pms.DoorlockKeysApi(api_client)
    door_lock_key_create_request_schema = cloudbeds_pms.DoorLockKeyCreateRequestSchema() # DoorLockKeyCreateRequestSchema | Key data

    try:
        # Create a new doorlock key.
        api_response = api_instance.door_lock_key_controller_create(door_lock_key_create_request_schema)
        print("The response of DoorlockKeysApi->door_lock_key_controller_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DoorlockKeysApi->door_lock_key_controller_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.cloudbeds.com

Class	Method	HTTP request	Description
DoorlockKeysApi	door_lock_key_controller_create	POST /doorlock/v1/keys	Create a new doorlock key.
DoorlockKeysApi	door_lock_key_controller_delete	DELETE /doorlock/v1/keys/{id}	Delete a doorlock key.
DoorlockKeysApi	door_lock_key_controller_index	GET /doorlock/v1/keys/{propertyId}	Get a list of doorlock keys for a specific app client and property.
DoorlockKeysApi	door_lock_key_controller_update	PATCH /doorlock/v1/keys/{id}	Update a doorlock key.
DoorlockSettingsApi	door_lock_settings_controller_delete	DELETE /doorlock/v1/settings/{propertyId}	Delete doorlock settings for property for specific application client.
DoorlockSettingsApi	door_lock_settings_controller_single	GET /doorlock/v1/settings/{propertyId}	Get doorlock settings for property for specific application client.
DoorlockSettingsApi	door_lock_settings_controller_upsert	PUT /doorlock/v1/settings/{propertyId}	Upsert doorlock settings for property for specific application client.
HousekeepingApi	call_27abd48cb30106ec3251cf3baf34174c	GET /housekeeping/v1/inspections/{propertyId}	Housekeeping inspection list
ImportTasksApi	import_task_controller_create	POST /import/v1/tasks	Create a new import task and generate a temporary upload URL.
ImportTasksApi	import_task_controller_find_by_id	GET /import/v1/tasks/{taskId}	Fetch import task by ID.
ImportTasksApi	import_task_controller_find_task_records	GET /import/v1/tasks/{taskId}/records	Fetch import task records by ID.
ImportTasksApi	import_task_controller_get_all	GET /import/v1/tasks	Fetch a list of previously uploaded imports.

Documentation For Models

• BadRequestErrorItemSchema
• BadRequestResponseSchema
• BadRequestResponseSchemaErrors
• BodyDynamicFilterSchema
• BodyDynamicFilterSchemaFilters
• CursorPaginationSchema
• DirectionEnumSchema
• DoorLockKeyCreateRequestSchema
• DoorLockKeyFailedToGenerateResponseSchema
• DoorLockKeyListRequestSchema
• DoorLockKeyListResponseSchema
• DoorLockKeyResponseSchema
• DoorLockKeyUpdateRequestSchema
• DoorLockSettingsCommonRoomRequestSchema
• DoorLockSettingsCommonRoomResponseSchema
• DoorLockSettingsCreateRequestSchema
• DoorLockSettingsEncoderRequestSchema
• DoorLockSettingsEncoderResponseSchema
• DoorLockSettingsKeyTypeRequestSchema
• DoorLockSettingsKeyTypeResponseSchema
• DoorLockSettingsResponseSchema
• DynamicFilterFieldSchema
• DynamicFilterFieldSchemaValue
• DynamicFilterSchema
• DynamicFilterSchemaAndInner
• FeatureEnum
• FilterOperatorEnumSchema
• ForbiddenResponseSchema
• GroupCreateRequestSchema
• GroupDeleteRequestSchema
• GroupDisableRequestSchema
• GroupEnableRequestSchema
• GroupListResponseSchema
• GroupResponseSchema
• GroupSingleRequestSchema
• GroupUpdateRequestSchema
• ImportFailedToCreateImportTaskSchema
• ImportFailedToPreProcessResponseSchema
• ImportFailedToProcessCsvResponseSchema
• ImportTaskCreateRequestSchema
• ImportTaskGetRecordListRequestSchema
• ImportTaskGetResponseSchema
• ImportTaskListFailedResponseSchema
• ImportTaskListRequestSchema
• ImportTaskListResponseSchema
• ImportTaskRecordGetResponseSchema
• ImportTaskRecordListResponseSchema
• ImportTaskResponseSchema
• InspectionItemSchema
• InspectionListRequestSchema
• InspectionListResponseSchema
• InternalServerErrorResponseSchema
• LimitOffsetPaginationSchema
• NotFoundResponseSchema
• QueryParameterDynamicFilterSchema
• QueryParameterDynamicFilterSchemaFilters
• QueryParameterSortSchema
• SegmentCreateRequestSchema
• SegmentDeleteRequestSchema
• SegmentDisableRequestSchema
• SegmentEnableRequestSchema
• SegmentListRequestSchema
• SegmentListReservationsRequestSchema
• SegmentListReservationsResponseSchema
• SegmentListResponseSchema
• SegmentResponseSchema
• SegmentSingleRequestSchema
• SegmentUpdateRequestSchema
• SortFieldSchema
• SortSchema

Documentation For Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

default

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://api.cloudbeds.com/auth/oauth/authorize
• Scopes:
• read:doorLockKey: Read DoorLock keys and settings
• write:doorLockKey: Write DoorLock keys and settings
• read:housekeeping: Read Housekeeping inspections
• read:marketSegmentation: Read Market Segmentation groups and segments
• write:marketSegmentation: Write Market Segmentation groups and segments
• delete:marketSegmentation: Delete Market Segmentation groups and segments
• write:importTask: Create new data imports
• read:importTask: Read data imports

Author