Metadata-Version: 2.4
Name: cloudbeds_pms
Version: 2.13.0
Summary: OpenAPI client for Cloudbeds PMS API.
Author: Cloudbeds
License: The MIT License
        
        Copyright (c) 2025 Cloudbeds (http://cloudbeds.com)
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: Documentation, https://github.com/cloudbeds/cloudbeds-api-python#README
Project-URL: Repository, https://github.com/cloudbeds/cloudbeds-api-python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.6.3
Requires-Dist: python-dateutil<3.0.0,>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: coverage; extra == "testing"
Dynamic: license-file

# Cloudbeds PMS
<p>Welcome to the documentation for <strong>Cloudbeds API Version v2</strong>! 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.</p><p>In this document you will find all the API methods we provide along with explanations for parameters and response examples.</p><p>If you have questions about different implementation steps (e.g. how to implement OAuth 2.0), please refer to our <a href='https://integrations.cloudbeds.com/hc/en-us'>Integrations Portal</a>.</p><p>Be sure to <a href='https://go.pardot.com/l/308041/2018-07-24/qb2lg'>subscribe</a> to the monthly Cloudbeds API announcement mailing list to receive information on new additions and improvements to the Cloudbeds API and related developer tools.</p><p><strong>Endpoint:</strong> https://api.cloudbeds.com/{method}</p><p><strong>HTTPS:</strong> Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.</p><p><strong>Request Format:</strong> HTTP GET, POST and PUT (Content-Type: application/x-www-form-urlencoded)</p><p><strong>Response Format:</strong> JSON</p><p><strong>Response Header:</strong> X-Request-ID is added to response headers in all calls to help accelerate support and troubleshooting.</p><p><strong><a href='https://integrations.cloudbeds.com/hc/en-us/articles/14104678058267-API-Documentation#postman-collection'><img src='https://run.pstmn.io/button.svg' alt='Run in Postman'></a></strong> use this link to access our Public collection in Postman.</p>

The `cloudbeds_pms` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v2
- Package version: 2.13.0
- Generator version: 7.20.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## 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 >= 2.1.0, < 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:

```python

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.AddonsApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    limit = 100 # int | The maximum number of items to return in the response. Default is 100. (optional) (default to 100)
    offset = 0 # int | The number of items to skip before starting to collect the result set. Used for pagination. (optional) (default to 0)
    filters = cloudbeds_pms.QueryParameterDynamicFilterSchema() # QueryParameterDynamicFilterSchema | This parameter should be formatted as a list of strings separated by ; (optional)
    accept_language = 'accept_language_example' # str | The preferred language(s) for localized strings (e.g., en-US) (optional)

    try:
        # Retrieve property add-ons
        api_response = api_instance.addon_controller_get_addons(x_property_id, limit=limit, offset=offset, filters=filters, accept_language=accept_language)
        print("The response of AddonsApi->addon_controller_get_addons:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddonsApi->addon_controller_get_addons: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AddonsApi* | [**addon_controller_get_addons**](cloudbeds_pms/docs/AddonsApi.md#addon_controller_get_addons) | **GET** /addons/v1/addons | Retrieve property add-ons
*AmenitiesApi* | [**amenity_catalog_controller_get_amenity_catalog**](cloudbeds_pms/docs/AmenitiesApi.md#amenity_catalog_controller_get_amenity_catalog) | **GET** /amenities/v1/catalogs/amenities | Get amenity catalog
*AmenitiesApi* | [**amenity_catalog_controller_get_amenity_category_catalog**](cloudbeds_pms/docs/AmenitiesApi.md#amenity_catalog_controller_get_amenity_category_catalog) | **GET** /amenities/v1/catalogs/categories | Get amenity category catalog
*AmenitiesApi* | [**property_amenity_controller_get_property_amenities**](cloudbeds_pms/docs/AmenitiesApi.md#property_amenity_controller_get_property_amenities) | **GET** /amenities/v1/properties/{propertyId}/amenities | Get property amenities
*AmenitiesApi* | [**property_amenity_controller_update_property_amenities**](cloudbeds_pms/docs/AmenitiesApi.md#property_amenity_controller_update_property_amenities) | **PUT** /amenities/v1/properties/{propertyId}/amenities | Update property amenities
*AmenitiesApi* | [**room_amenity_controller_get_property_rooms_amenities**](cloudbeds_pms/docs/AmenitiesApi.md#room_amenity_controller_get_property_rooms_amenities) | **GET** /amenities/v1/properties/{propertyId}/room-amenities | Get amenities for all rooms in a property
*AmenitiesApi* | [**room_amenity_controller_get_room_amenities**](cloudbeds_pms/docs/AmenitiesApi.md#room_amenity_controller_get_room_amenities) | **GET** /amenities/v1/properties/{propertyId}/rooms/{roomId}/amenities | Get room amenities
*AmenitiesApi* | [**room_amenity_controller_update_property_rooms_amenities**](cloudbeds_pms/docs/AmenitiesApi.md#room_amenity_controller_update_property_rooms_amenities) | **PUT** /amenities/v1/properties/{propertyId}/room-amenities | Update amenities for multiple rooms
*AmenitiesApi* | [**room_amenity_controller_update_room_amenities**](cloudbeds_pms/docs/AmenitiesApi.md#room_amenity_controller_update_room_amenities) | **PUT** /amenities/v1/properties/{propertyId}/rooms/{roomId}/amenities | Update room amenities
*ApplicationsApi* | [**api_client_controller_connected_api_clients**](cloudbeds_pms/docs/ApplicationsApi.md#api_client_controller_connected_api_clients) | **GET** /integration/v1/connected-applications | Get all connected API clients for a property
*DoorLocksApi* | [**door_lock_key_controller_batch_delete**](cloudbeds_pms/docs/DoorLocksApi.md#door_lock_key_controller_batch_delete) | **DELETE** /doorlock/v1/keys | Delete a list of doorlock keys.
*DoorLocksApi* | [**door_lock_key_controller_create**](cloudbeds_pms/docs/DoorLocksApi.md#door_lock_key_controller_create) | **POST** /doorlock/v1/keys | Create a new doorlock key.
*DoorLocksApi* | [**door_lock_key_controller_delete**](cloudbeds_pms/docs/DoorLocksApi.md#door_lock_key_controller_delete) | **DELETE** /doorlock/v1/keys/{id} | Delete a doorlock key.
*DoorLocksApi* | [**door_lock_key_controller_index**](cloudbeds_pms/docs/DoorLocksApi.md#door_lock_key_controller_index) | **GET** /doorlock/v1/keys/{propertyId} | Get a list of doorlock keys for a specific app client and property.
*DoorLocksApi* | [**door_lock_key_controller_update**](cloudbeds_pms/docs/DoorLocksApi.md#door_lock_key_controller_update) | **PATCH** /doorlock/v1/keys/{id} | Update a doorlock key.
*DoorLocksApi* | [**door_lock_settings_controller_delete**](cloudbeds_pms/docs/DoorLocksApi.md#door_lock_settings_controller_delete) | **DELETE** /doorlock/v1/settings/{propertyId} | Delete doorlock settings for property for specific application client.
*DoorLocksApi* | [**door_lock_settings_controller_single**](cloudbeds_pms/docs/DoorLocksApi.md#door_lock_settings_controller_single) | **GET** /doorlock/v1/settings/{propertyId} | Get doorlock settings for property for specific application client.
*DoorLocksApi* | [**door_lock_settings_controller_upsert**](cloudbeds_pms/docs/DoorLocksApi.md#door_lock_settings_controller_upsert) | **PUT** /doorlock/v1/settings/{propertyId} | Upsert doorlock settings for property for specific application client.
*EventsApi* | [**event_controller_create**](cloudbeds_pms/docs/EventsApi.md#event_controller_create) | **POST** /events/v2/events | Create a new event
*EventsApi* | [**event_controller_destroy**](cloudbeds_pms/docs/EventsApi.md#event_controller_destroy) | **DELETE** /events/v2/events/{eventId} | Delete an event
*EventsApi* | [**event_controller_list**](cloudbeds_pms/docs/EventsApi.md#event_controller_list) | **GET** /events/v2/events | List events for a property
*EventsApi* | [**event_controller_show**](cloudbeds_pms/docs/EventsApi.md#event_controller_show) | **GET** /events/v2/events/{eventId} | Get a single event
*EventsApi* | [**event_controller_update**](cloudbeds_pms/docs/EventsApi.md#event_controller_update) | **PATCH** /events/v2/events/{eventId} | Update an existing event
*EventsApi* | [**event_note_controller_create**](cloudbeds_pms/docs/EventsApi.md#event_note_controller_create) | **POST** /events/v2/events/{eventId}/notes | Create a note for an event
*EventsApi* | [**event_note_controller_list**](cloudbeds_pms/docs/EventsApi.md#event_note_controller_list) | **GET** /events/v2/events/{eventId}/notes | List notes for an event
*EventsApi* | [**event_note_controller_update**](cloudbeds_pms/docs/EventsApi.md#event_note_controller_update) | **PATCH** /events/v2/events/{eventId}/notes/{noteId} | Update an event note
*HousekeepingApi* | [**call_27abd48cb30106ec3251cf3baf34174c**](cloudbeds_pms/docs/HousekeepingApi.md#call_27abd48cb30106ec3251cf3baf34174c) | **GET** /housekeeping/v1/inspections/{propertyId} | Housekeeping inspection list
*IntegrationEventsApi* | [**integration_event_controller_create**](cloudbeds_pms/docs/IntegrationEventsApi.md#integration_event_controller_create) | **POST** /integration/v1/events | Create a new integration event.
*IntegrationEventsApi* | [**integration_event_controller_index**](cloudbeds_pms/docs/IntegrationEventsApi.md#integration_event_controller_index) | **GET** /integration/v1/events | Get a list of integration events for a specific property.
*IntegrationEventsApi* | [**integration_event_controller_retry**](cloudbeds_pms/docs/IntegrationEventsApi.md#integration_event_controller_retry) | **POST** /integration/v1/events/{id}/retry | Retry an integration event.
*IntegrationEventsApi* | [**integration_event_controller_update**](cloudbeds_pms/docs/IntegrationEventsApi.md#integration_event_controller_update) | **PATCH** /integration/v1/events/{id} | Update an integration event.
*ItemsApi* | [**custom_item_controller_index**](cloudbeds_pms/docs/ItemsApi.md#custom_item_controller_index) | **GET** /item/v1/custom-items | Get a list of custom items for a specific property.
*ItemsApi* | [**item_controller_create_items**](cloudbeds_pms/docs/ItemsApi.md#item_controller_create_items) | **POST** /item/v1/items | Post one or more items to a reservation, house account, or group profile
*MarketSegmentationApi* | [**group_controller_create**](cloudbeds_pms/docs/MarketSegmentationApi.md#group_controller_create) | **POST** /market-segmentation/v1/groups | Create a new Market Segmentation Group.
*MarketSegmentationApi* | [**group_controller_delete**](cloudbeds_pms/docs/MarketSegmentationApi.md#group_controller_delete) | **DELETE** /market-segmentation/v1/groups/{id} | Delete a Market Segmentation Group.
*MarketSegmentationApi* | [**group_controller_disable**](cloudbeds_pms/docs/MarketSegmentationApi.md#group_controller_disable) | **POST** /market-segmentation/v1/groups/{id}/disable | Disable a Market Segmentation Group.
*MarketSegmentationApi* | [**group_controller_enable**](cloudbeds_pms/docs/MarketSegmentationApi.md#group_controller_enable) | **POST** /market-segmentation/v1/groups/{id}/enable | Enable a Market Segmentation Group.
*MarketSegmentationApi* | [**group_controller_index**](cloudbeds_pms/docs/MarketSegmentationApi.md#group_controller_index) | **GET** /market-segmentation/v1/groups | Get a list of Market Segmentation Groups.
*MarketSegmentationApi* | [**group_controller_single**](cloudbeds_pms/docs/MarketSegmentationApi.md#group_controller_single) | **GET** /market-segmentation/v1/groups/{id} | Get Market Segmentation Group data.
*MarketSegmentationApi* | [**group_controller_update**](cloudbeds_pms/docs/MarketSegmentationApi.md#group_controller_update) | **PATCH** /market-segmentation/v1/groups/{id} | Update a Market Segmentation Group.
*MarketSegmentationApi* | [**segment_controller_create**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_create) | **POST** /market-segmentation/v1/segments | Create a new Market Segmentation Segment.
*MarketSegmentationApi* | [**segment_controller_default**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_default) | **POST** /market-segmentation/v1/segments/{id}/default | Set Market Segmentation Segment as Default.
*MarketSegmentationApi* | [**segment_controller_delete**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_delete) | **DELETE** /market-segmentation/v1/segments/{id} | Delete a Market Segmentation Segment.
*MarketSegmentationApi* | [**segment_controller_disable**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_disable) | **POST** /market-segmentation/v1/segments/{id}/disable | Disable a Market Segmentation Segment.
*MarketSegmentationApi* | [**segment_controller_enable**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_enable) | **POST** /market-segmentation/v1/segments/{id}/enable | Enable a Market Segmentation Segment.
*MarketSegmentationApi* | [**segment_controller_index**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_index) | **GET** /market-segmentation/v1/segments/{enabled} | Get a list of Market Segmentation Segments.
*MarketSegmentationApi* | [**segment_controller_reservations**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_reservations) | **GET** /market-segmentation/v1/segments/{id}/reservations/{active} | Get a list of reservations linked to a Market Segmentation Segment.
*MarketSegmentationApi* | [**segment_controller_single**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_single) | **GET** /market-segmentation/v1/segments/{id} | Get Market Segmentation Segment data.
*MarketSegmentationApi* | [**segment_controller_update**](cloudbeds_pms/docs/MarketSegmentationApi.md#segment_controller_update) | **PATCH** /market-segmentation/v1/segments/{id} | Update a Market Segmentation Segment.
*PropertyApi* | [**system_controller_get_system**](cloudbeds_pms/docs/PropertyApi.md#system_controller_get_system) | **GET** /property/v1/system | Retrieves the property&#39;s system component versions
*RoomsApi* | [**out_of_service_controller_make**](cloudbeds_pms/docs/RoomsApi.md#out_of_service_controller_make) | **POST** /rooms/v1/out-of-service | Room out of service
*SmartPolicyExceptionsApi* | [**policy_exception_controller_create**](cloudbeds_pms/docs/SmartPolicyExceptionsApi.md#policy_exception_controller_create) | **POST** /smart-policies/v1/exceptions | Create a new policy exception.
*SmartPolicyExceptionsApi* | [**policy_exception_controller_destroy**](cloudbeds_pms/docs/SmartPolicyExceptionsApi.md#policy_exception_controller_destroy) | **DELETE** /smart-policies/v1/exceptions/{exceptionId} | Delete a policy exception.
*SmartPolicyExceptionsApi* | [**policy_exception_controller_eligible_rates**](cloudbeds_pms/docs/SmartPolicyExceptionsApi.md#policy_exception_controller_eligible_rates) | **GET** /smart-policies/v1/exceptions/eligible-rates | Get eligible rate plans and base rates for exception creation.
*SmartPolicyExceptionsApi* | [**policy_exception_controller_index**](cloudbeds_pms/docs/SmartPolicyExceptionsApi.md#policy_exception_controller_index) | **GET** /smart-policies/v1/exceptions | List all policy exceptions for a property.
*SmartPolicyExceptionsApi* | [**policy_exception_controller_partial_update**](cloudbeds_pms/docs/SmartPolicyExceptionsApi.md#policy_exception_controller_partial_update) | **PATCH** /smart-policies/v1/exceptions/{exceptionId} | Partially update a policy exception.
*SmartPolicyExceptionsApi* | [**policy_exception_controller_show**](cloudbeds_pms/docs/SmartPolicyExceptionsApi.md#policy_exception_controller_show) | **GET** /smart-policies/v1/exceptions/{exceptionId} | Get a single policy exception by ID.
*SmartPolicyExceptionsApi* | [**policy_exception_controller_update**](cloudbeds_pms/docs/SmartPolicyExceptionsApi.md#policy_exception_controller_update) | **PUT** /smart-policies/v1/exceptions/{exceptionId} | Update an existing policy exception.


## Documentation For Models

 - [AddonResponseSchema](cloudbeds_pms/docs/AddonResponseSchema.md)
 - [AddonsResponseSchema](cloudbeds_pms/docs/AddonsResponseSchema.md)
 - [AgeGroupResponseSchema](cloudbeds_pms/docs/AgeGroupResponseSchema.md)
 - [AgePolicyCreateRequestSchema](cloudbeds_pms/docs/AgePolicyCreateRequestSchema.md)
 - [AgePolicyCreateRequestSchemaGroupsInner](cloudbeds_pms/docs/AgePolicyCreateRequestSchemaGroupsInner.md)
 - [AgePolicyPatchRequestSchema](cloudbeds_pms/docs/AgePolicyPatchRequestSchema.md)
 - [AgePolicyResponseSchema](cloudbeds_pms/docs/AgePolicyResponseSchema.md)
 - [AgePolicyUpdateRequestSchema](cloudbeds_pms/docs/AgePolicyUpdateRequestSchema.md)
 - [AgePolicyUpdateRequestSchemaGroupsInner](cloudbeds_pms/docs/AgePolicyUpdateRequestSchemaGroupsInner.md)
 - [AllotmentBlockAutoReleaseScheduleBulkCreateItemSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleBulkCreateItemSchema.md)
 - [AllotmentBlockAutoReleaseScheduleBulkCreateRequestSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleBulkCreateRequestSchema.md)
 - [AllotmentBlockAutoReleaseScheduleBulkResponseSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleBulkResponseSchema.md)
 - [AllotmentBlockAutoReleaseScheduleBulkUpdateItemSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleBulkUpdateItemSchema.md)
 - [AllotmentBlockAutoReleaseScheduleBulkUpdateRequestSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleBulkUpdateRequestSchema.md)
 - [AllotmentBlockAutoReleaseScheduleCreateRequestSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleCreateRequestSchema.md)
 - [AllotmentBlockAutoReleaseScheduleDeleteRequestSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleDeleteRequestSchema.md)
 - [AllotmentBlockAutoReleaseScheduleListRequestSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleListRequestSchema.md)
 - [AllotmentBlockAutoReleaseScheduleListResponseSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleListResponseSchema.md)
 - [AllotmentBlockAutoReleaseScheduleResponseSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleResponseSchema.md)
 - [AllotmentBlockAutoReleaseScheduleUpdateRequestSchema](cloudbeds_pms/docs/AllotmentBlockAutoReleaseScheduleUpdateRequestSchema.md)
 - [AllotmentBlockReleaseBulkCreateItemSchema](cloudbeds_pms/docs/AllotmentBlockReleaseBulkCreateItemSchema.md)
 - [AllotmentBlockReleaseBulkCreateRequestSchema](cloudbeds_pms/docs/AllotmentBlockReleaseBulkCreateRequestSchema.md)
 - [AllotmentBlockReleaseBulkResponseSchema](cloudbeds_pms/docs/AllotmentBlockReleaseBulkResponseSchema.md)
 - [AllotmentBlockReleaseBulkUpdateItemSchema](cloudbeds_pms/docs/AllotmentBlockReleaseBulkUpdateItemSchema.md)
 - [AllotmentBlockReleaseBulkUpdateRequestSchema](cloudbeds_pms/docs/AllotmentBlockReleaseBulkUpdateRequestSchema.md)
 - [AllotmentBlockReleaseCreateRequestSchema](cloudbeds_pms/docs/AllotmentBlockReleaseCreateRequestSchema.md)
 - [AllotmentBlockReleaseDeleteRequestSchema](cloudbeds_pms/docs/AllotmentBlockReleaseDeleteRequestSchema.md)
 - [AllotmentBlockReleaseListRequestSchema](cloudbeds_pms/docs/AllotmentBlockReleaseListRequestSchema.md)
 - [AllotmentBlockReleaseListResponseSchema](cloudbeds_pms/docs/AllotmentBlockReleaseListResponseSchema.md)
 - [AllotmentBlockReleaseResponseSchema](cloudbeds_pms/docs/AllotmentBlockReleaseResponseSchema.md)
 - [AllotmentBlockReleaseUpdateRequestSchema](cloudbeds_pms/docs/AllotmentBlockReleaseUpdateRequestSchema.md)
 - [AmenityItemSchema](cloudbeds_pms/docs/AmenityItemSchema.md)
 - [ApplicationListResponseSchema](cloudbeds_pms/docs/ApplicationListResponseSchema.md)
 - [ApplicationResponseSchema](cloudbeds_pms/docs/ApplicationResponseSchema.md)
 - [AreaItemResponseSchema](cloudbeds_pms/docs/AreaItemResponseSchema.md)
 - [AreaItemSchema](cloudbeds_pms/docs/AreaItemSchema.md)
 - [ArrangementItemResponseSchema](cloudbeds_pms/docs/ArrangementItemResponseSchema.md)
 - [ArrangementItemSchema](cloudbeds_pms/docs/ArrangementItemSchema.md)
 - [BadRequestErrorItemSchema](cloudbeds_pms/docs/BadRequestErrorItemSchema.md)
 - [BadRequestResponseSchema](cloudbeds_pms/docs/BadRequestResponseSchema.md)
 - [BedItemResponseSchema](cloudbeds_pms/docs/BedItemResponseSchema.md)
 - [BedItemSchema](cloudbeds_pms/docs/BedItemSchema.md)
 - [BodyDynamicFilterSchema](cloudbeds_pms/docs/BodyDynamicFilterSchema.md)
 - [ConflictErrorItemSchema](cloudbeds_pms/docs/ConflictErrorItemSchema.md)
 - [ConflictResponseSchema](cloudbeds_pms/docs/ConflictResponseSchema.md)
 - [CreatePolicyExceptionRequestSchema](cloudbeds_pms/docs/CreatePolicyExceptionRequestSchema.md)
 - [CursorPaginationSchema](cloudbeds_pms/docs/CursorPaginationSchema.md)
 - [CustomItemListRequestSchema](cloudbeds_pms/docs/CustomItemListRequestSchema.md)
 - [CustomItemListResponseSchema](cloudbeds_pms/docs/CustomItemListResponseSchema.md)
 - [CustomItemResponseSchema](cloudbeds_pms/docs/CustomItemResponseSchema.md)
 - [DeletePolicyExceptionRequestSchema](cloudbeds_pms/docs/DeletePolicyExceptionRequestSchema.md)
 - [DeleteRoomCustomAmenitiesRequestSchema](cloudbeds_pms/docs/DeleteRoomCustomAmenitiesRequestSchema.md)
 - [DirectionEnumSchema](cloudbeds_pms/docs/DirectionEnumSchema.md)
 - [DoorLockKeyCreateRequestSchema](cloudbeds_pms/docs/DoorLockKeyCreateRequestSchema.md)
 - [DoorLockKeyFailedToGenerateResponseSchema](cloudbeds_pms/docs/DoorLockKeyFailedToGenerateResponseSchema.md)
 - [DoorLockKeyListRequestSchema](cloudbeds_pms/docs/DoorLockKeyListRequestSchema.md)
 - [DoorLockKeyListResponseSchema](cloudbeds_pms/docs/DoorLockKeyListResponseSchema.md)
 - [DoorLockKeyResponseSchema](cloudbeds_pms/docs/DoorLockKeyResponseSchema.md)
 - [DoorLockKeyUpdateRequestSchema](cloudbeds_pms/docs/DoorLockKeyUpdateRequestSchema.md)
 - [DoorLockSettingsCommonRoomRequestSchema](cloudbeds_pms/docs/DoorLockSettingsCommonRoomRequestSchema.md)
 - [DoorLockSettingsCommonRoomResponseSchema](cloudbeds_pms/docs/DoorLockSettingsCommonRoomResponseSchema.md)
 - [DoorLockSettingsCreateRequestSchema](cloudbeds_pms/docs/DoorLockSettingsCreateRequestSchema.md)
 - [DoorLockSettingsEncoderRequestSchema](cloudbeds_pms/docs/DoorLockSettingsEncoderRequestSchema.md)
 - [DoorLockSettingsEncoderResponseSchema](cloudbeds_pms/docs/DoorLockSettingsEncoderResponseSchema.md)
 - [DoorLockSettingsKeyTypeRequestSchema](cloudbeds_pms/docs/DoorLockSettingsKeyTypeRequestSchema.md)
 - [DoorLockSettingsKeyTypeResponseSchema](cloudbeds_pms/docs/DoorLockSettingsKeyTypeResponseSchema.md)
 - [DoorLockSettingsResponseSchema](cloudbeds_pms/docs/DoorLockSettingsResponseSchema.md)
 - [DynamicFilterFieldSchema](cloudbeds_pms/docs/DynamicFilterFieldSchema.md)
 - [DynamicFilterFieldSchemaValue](cloudbeds_pms/docs/DynamicFilterFieldSchemaValue.md)
 - [DynamicFilterSchema](cloudbeds_pms/docs/DynamicFilterSchema.md)
 - [DynamicFilterSchemaAndInner](cloudbeds_pms/docs/DynamicFilterSchemaAndInner.md)
 - [EligibleRateItemSchema](cloudbeds_pms/docs/EligibleRateItemSchema.md)
 - [EligibleRatesRequestSchema](cloudbeds_pms/docs/EligibleRatesRequestSchema.md)
 - [EligibleRatesResponseSchema](cloudbeds_pms/docs/EligibleRatesResponseSchema.md)
 - [EventCreateRequestSchema](cloudbeds_pms/docs/EventCreateRequestSchema.md)
 - [EventGetRequestSchema](cloudbeds_pms/docs/EventGetRequestSchema.md)
 - [EventListRequestSchema](cloudbeds_pms/docs/EventListRequestSchema.md)
 - [EventListResponseSchema](cloudbeds_pms/docs/EventListResponseSchema.md)
 - [EventNoteCreateRequestSchema](cloudbeds_pms/docs/EventNoteCreateRequestSchema.md)
 - [EventNoteListRequestSchema](cloudbeds_pms/docs/EventNoteListRequestSchema.md)
 - [EventNoteListResponseSchema](cloudbeds_pms/docs/EventNoteListResponseSchema.md)
 - [EventNoteResponseSchema](cloudbeds_pms/docs/EventNoteResponseSchema.md)
 - [EventNoteSingleResponseSchema](cloudbeds_pms/docs/EventNoteSingleResponseSchema.md)
 - [EventNoteUpdateRequestSchema](cloudbeds_pms/docs/EventNoteUpdateRequestSchema.md)
 - [EventResponseSchema](cloudbeds_pms/docs/EventResponseSchema.md)
 - [EventSingleResponseSchema](cloudbeds_pms/docs/EventSingleResponseSchema.md)
 - [EventUpdateRequestSchema](cloudbeds_pms/docs/EventUpdateRequestSchema.md)
 - [FeatureEnum](cloudbeds_pms/docs/FeatureEnum.md)
 - [FilterOperatorEnumSchema](cloudbeds_pms/docs/FilterOperatorEnumSchema.md)
 - [ForbiddenResponseSchema](cloudbeds_pms/docs/ForbiddenResponseSchema.md)
 - [GetAddonsRequestSchema](cloudbeds_pms/docs/GetAddonsRequestSchema.md)
 - [GetAmenityCatalogResponseSchema](cloudbeds_pms/docs/GetAmenityCatalogResponseSchema.md)
 - [GetAmenityCategoryCatalogResponseSchema](cloudbeds_pms/docs/GetAmenityCategoryCatalogResponseSchema.md)
 - [GetAmenityCategoryCatalogResponseSchemaCategoriesInner](cloudbeds_pms/docs/GetAmenityCategoryCatalogResponseSchemaCategoriesInner.md)
 - [GetDistributionSettingsResponseSchema](cloudbeds_pms/docs/GetDistributionSettingsResponseSchema.md)
 - [GetDistributionSettingsResponseSchemaSettingsInner](cloudbeds_pms/docs/GetDistributionSettingsResponseSchemaSettingsInner.md)
 - [GetPolicyExceptionRequestSchema](cloudbeds_pms/docs/GetPolicyExceptionRequestSchema.md)
 - [GetPropertyAmenitiesResponseSchema](cloudbeds_pms/docs/GetPropertyAmenitiesResponseSchema.md)
 - [GetPropertyRoomsAmenitiesResponseSchema](cloudbeds_pms/docs/GetPropertyRoomsAmenitiesResponseSchema.md)
 - [GetRoomAmenitiesResponseSchema](cloudbeds_pms/docs/GetRoomAmenitiesResponseSchema.md)
 - [GetRoomLabelsResponseSchema](cloudbeds_pms/docs/GetRoomLabelsResponseSchema.md)
 - [GetRoomTypeAreasRequestSchema](cloudbeds_pms/docs/GetRoomTypeAreasRequestSchema.md)
 - [GetRoomTypeAreasResponseSchema](cloudbeds_pms/docs/GetRoomTypeAreasResponseSchema.md)
 - [GroupCreateRequestSchema](cloudbeds_pms/docs/GroupCreateRequestSchema.md)
 - [GroupDeleteRequestSchema](cloudbeds_pms/docs/GroupDeleteRequestSchema.md)
 - [GroupDisableRequestSchema](cloudbeds_pms/docs/GroupDisableRequestSchema.md)
 - [GroupEnableRequestSchema](cloudbeds_pms/docs/GroupEnableRequestSchema.md)
 - [GroupListResponseSchema](cloudbeds_pms/docs/GroupListResponseSchema.md)
 - [GroupResponseSchema](cloudbeds_pms/docs/GroupResponseSchema.md)
 - [GroupSingleRequestSchema](cloudbeds_pms/docs/GroupSingleRequestSchema.md)
 - [GroupUpdateRequestSchema](cloudbeds_pms/docs/GroupUpdateRequestSchema.md)
 - [ImportChangeStatusTaskResponse](cloudbeds_pms/docs/ImportChangeStatusTaskResponse.md)
 - [ImportFailedChangeStatusTaskResponse](cloudbeds_pms/docs/ImportFailedChangeStatusTaskResponse.md)
 - [ImportFailedToCreateImportTaskSchema](cloudbeds_pms/docs/ImportFailedToCreateImportTaskSchema.md)
 - [ImportFailedToPreProcessResponseSchema](cloudbeds_pms/docs/ImportFailedToPreProcessResponseSchema.md)
 - [ImportFailedToProcessCsvResponseSchema](cloudbeds_pms/docs/ImportFailedToProcessCsvResponseSchema.md)
 - [ImportTaskCreateRequestSchema](cloudbeds_pms/docs/ImportTaskCreateRequestSchema.md)
 - [ImportTaskGetRecordListRequestSchema](cloudbeds_pms/docs/ImportTaskGetRecordListRequestSchema.md)
 - [ImportTaskGetResponseSchema](cloudbeds_pms/docs/ImportTaskGetResponseSchema.md)
 - [ImportTaskListFailedResponseSchema](cloudbeds_pms/docs/ImportTaskListFailedResponseSchema.md)
 - [ImportTaskListRequestSchema](cloudbeds_pms/docs/ImportTaskListRequestSchema.md)
 - [ImportTaskListResponseSchema](cloudbeds_pms/docs/ImportTaskListResponseSchema.md)
 - [ImportTaskRecordGetResponseSchema](cloudbeds_pms/docs/ImportTaskRecordGetResponseSchema.md)
 - [ImportTaskRecordListResponseSchema](cloudbeds_pms/docs/ImportTaskRecordListResponseSchema.md)
 - [ImportTaskReimportRequestSchema](cloudbeds_pms/docs/ImportTaskReimportRequestSchema.md)
 - [ImportTaskResponseSchema](cloudbeds_pms/docs/ImportTaskResponseSchema.md)
 - [ImportTaskToggleProcessingRequestSchema](cloudbeds_pms/docs/ImportTaskToggleProcessingRequestSchema.md)
 - [InspectionItemSchema](cloudbeds_pms/docs/InspectionItemSchema.md)
 - [InspectionListRequestSchema](cloudbeds_pms/docs/InspectionListRequestSchema.md)
 - [InspectionListResponseSchema](cloudbeds_pms/docs/InspectionListResponseSchema.md)
 - [IntegrationEventCreateRequestSchema](cloudbeds_pms/docs/IntegrationEventCreateRequestSchema.md)
 - [IntegrationEventListRequestSchema](cloudbeds_pms/docs/IntegrationEventListRequestSchema.md)
 - [IntegrationEventListResponseSchema](cloudbeds_pms/docs/IntegrationEventListResponseSchema.md)
 - [IntegrationEventResponseSchema](cloudbeds_pms/docs/IntegrationEventResponseSchema.md)
 - [IntegrationEventUpdateRequestSchema](cloudbeds_pms/docs/IntegrationEventUpdateRequestSchema.md)
 - [InternalServerErrorResponseSchema](cloudbeds_pms/docs/InternalServerErrorResponseSchema.md)
 - [ItemRequestSchema](cloudbeds_pms/docs/ItemRequestSchema.md)
 - [LimitOffsetPaginationSchema](cloudbeds_pms/docs/LimitOffsetPaginationSchema.md)
 - [ListPolicyExceptionsRequestSchema](cloudbeds_pms/docs/ListPolicyExceptionsRequestSchema.md)
 - [MoneySchema](cloudbeds_pms/docs/MoneySchema.md)
 - [MyallocatorProxyRequestSchema](cloudbeds_pms/docs/MyallocatorProxyRequestSchema.md)
 - [MyallocatorProxyResponseSchema](cloudbeds_pms/docs/MyallocatorProxyResponseSchema.md)
 - [NotFoundResponseSchema](cloudbeds_pms/docs/NotFoundResponseSchema.md)
 - [OutOfServiceRequestSchema](cloudbeds_pms/docs/OutOfServiceRequestSchema.md)
 - [OutOfServiceResponseItemSchema](cloudbeds_pms/docs/OutOfServiceResponseItemSchema.md)
 - [OutOfServiceResponseSchema](cloudbeds_pms/docs/OutOfServiceResponseSchema.md)
 - [PatchDistributionSettingsErrorResponseSchema](cloudbeds_pms/docs/PatchDistributionSettingsErrorResponseSchema.md)
 - [PatchDistributionSettingsErrorResponseSchemaErrorsInner](cloudbeds_pms/docs/PatchDistributionSettingsErrorResponseSchemaErrorsInner.md)
 - [PatchDistributionSettingsRequestSchema](cloudbeds_pms/docs/PatchDistributionSettingsRequestSchema.md)
 - [PatchDistributionSettingsRequestSchemaSettingsInner](cloudbeds_pms/docs/PatchDistributionSettingsRequestSchemaSettingsInner.md)
 - [PatchPolicyExceptionRequestSchema](cloudbeds_pms/docs/PatchPolicyExceptionRequestSchema.md)
 - [PaymentRequestSchema](cloudbeds_pms/docs/PaymentRequestSchema.md)
 - [PlaceRoomsOutOfServiceRequest](cloudbeds_pms/docs/PlaceRoomsOutOfServiceRequest.md)
 - [PolicyExceptionIntervalResponseSchema](cloudbeds_pms/docs/PolicyExceptionIntervalResponseSchema.md)
 - [PolicyExceptionIntervalSchema](cloudbeds_pms/docs/PolicyExceptionIntervalSchema.md)
 - [PolicyExceptionListResponseSchema](cloudbeds_pms/docs/PolicyExceptionListResponseSchema.md)
 - [PolicyExceptionRateResponseSchema](cloudbeds_pms/docs/PolicyExceptionRateResponseSchema.md)
 - [PolicyExceptionRateSchema](cloudbeds_pms/docs/PolicyExceptionRateSchema.md)
 - [PolicyExceptionResponseSchema](cloudbeds_pms/docs/PolicyExceptionResponseSchema.md)
 - [PostItemsRequestSchema](cloudbeds_pms/docs/PostItemsRequestSchema.md)
 - [PostItemsResponseSchema](cloudbeds_pms/docs/PostItemsResponseSchema.md)
 - [PostedItemResponseSchema](cloudbeds_pms/docs/PostedItemResponseSchema.md)
 - [PutRoomTypeAreasRequestSchema](cloudbeds_pms/docs/PutRoomTypeAreasRequestSchema.md)
 - [PutRoomTypeAreasResponseSchema](cloudbeds_pms/docs/PutRoomTypeAreasResponseSchema.md)
 - [QueryParameterDynamicFilterSchema](cloudbeds_pms/docs/QueryParameterDynamicFilterSchema.md)
 - [QueryParameterSortSchema](cloudbeds_pms/docs/QueryParameterSortSchema.md)
 - [RatePlanAddonRequestSchema](cloudbeds_pms/docs/RatePlanAddonRequestSchema.md)
 - [RatePlanAddonResponseSchema](cloudbeds_pms/docs/RatePlanAddonResponseSchema.md)
 - [RatePlanCreateRequestSchema](cloudbeds_pms/docs/RatePlanCreateRequestSchema.md)
 - [RatePlanDeleteRequestSchema](cloudbeds_pms/docs/RatePlanDeleteRequestSchema.md)
 - [RatePlanIntervalRequestSchema](cloudbeds_pms/docs/RatePlanIntervalRequestSchema.md)
 - [RatePlanIntervalResponseSchema](cloudbeds_pms/docs/RatePlanIntervalResponseSchema.md)
 - [RatePlanListResponseSchema](cloudbeds_pms/docs/RatePlanListResponseSchema.md)
 - [RatePlanResponseSchema](cloudbeds_pms/docs/RatePlanResponseSchema.md)
 - [RatePlanSingleRequestSchema](cloudbeds_pms/docs/RatePlanSingleRequestSchema.md)
 - [RatePlanUpdateRequestSchema](cloudbeds_pms/docs/RatePlanUpdateRequestSchema.md)
 - [ReservationCommissionRequestSchema](cloudbeds_pms/docs/ReservationCommissionRequestSchema.md)
 - [ReservationCommissionResponseSchema](cloudbeds_pms/docs/ReservationCommissionResponseSchema.md)
 - [RoomAmenitiesSchema](cloudbeds_pms/docs/RoomAmenitiesSchema.md)
 - [RoomAmenitiesUpdateRequestSchema](cloudbeds_pms/docs/RoomAmenitiesUpdateRequestSchema.md)
 - [RoomAmenitiesUpdateSchema](cloudbeds_pms/docs/RoomAmenitiesUpdateSchema.md)
 - [RoomCustomAmenitiesResponseSchema](cloudbeds_pms/docs/RoomCustomAmenitiesResponseSchema.md)
 - [RoomLabelItemSchema](cloudbeds_pms/docs/RoomLabelItemSchema.md)
 - [SegmentCreateRequestSchema](cloudbeds_pms/docs/SegmentCreateRequestSchema.md)
 - [SegmentDefaultRequestSchema](cloudbeds_pms/docs/SegmentDefaultRequestSchema.md)
 - [SegmentDeleteRequestSchema](cloudbeds_pms/docs/SegmentDeleteRequestSchema.md)
 - [SegmentDisableRequestSchema](cloudbeds_pms/docs/SegmentDisableRequestSchema.md)
 - [SegmentEnableRequestSchema](cloudbeds_pms/docs/SegmentEnableRequestSchema.md)
 - [SegmentListRequestSchema](cloudbeds_pms/docs/SegmentListRequestSchema.md)
 - [SegmentListReservationsRequestSchema](cloudbeds_pms/docs/SegmentListReservationsRequestSchema.md)
 - [SegmentListReservationsResponseSchema](cloudbeds_pms/docs/SegmentListReservationsResponseSchema.md)
 - [SegmentListResponseSchema](cloudbeds_pms/docs/SegmentListResponseSchema.md)
 - [SegmentResponseSchema](cloudbeds_pms/docs/SegmentResponseSchema.md)
 - [SegmentSingleRequestSchema](cloudbeds_pms/docs/SegmentSingleRequestSchema.md)
 - [SegmentUpdateRequestSchema](cloudbeds_pms/docs/SegmentUpdateRequestSchema.md)
 - [SortFieldSchema](cloudbeds_pms/docs/SortFieldSchema.md)
 - [SortSchema](cloudbeds_pms/docs/SortSchema.md)
 - [SystemFeatureResponseSchema](cloudbeds_pms/docs/SystemFeatureResponseSchema.md)
 - [SystemResponseSchema](cloudbeds_pms/docs/SystemResponseSchema.md)
 - [UpdatePolicyExceptionRequestSchema](cloudbeds_pms/docs/UpdatePolicyExceptionRequestSchema.md)
 - [UpdatePropertyAmenitiesRequestSchema](cloudbeds_pms/docs/UpdatePropertyAmenitiesRequestSchema.md)
 - [UpdatePropertyAmenitiesResponseSchema](cloudbeds_pms/docs/UpdatePropertyAmenitiesResponseSchema.md)
 - [UpdatePropertyRoomsAmenitiesRequestSchema](cloudbeds_pms/docs/UpdatePropertyRoomsAmenitiesRequestSchema.md)
 - [UpdatePropertyRoomsAmenitiesResponseSchema](cloudbeds_pms/docs/UpdatePropertyRoomsAmenitiesResponseSchema.md)
 - [UpdateReservationRoomRequestSchema](cloudbeds_pms/docs/UpdateReservationRoomRequestSchema.md)
 - [UpdateReservationRoomResponseSchema](cloudbeds_pms/docs/UpdateReservationRoomResponseSchema.md)
 - [UpdateRoomAmenitiesRequestSchema](cloudbeds_pms/docs/UpdateRoomAmenitiesRequestSchema.md)
 - [UpdateRoomAmenitiesResponseSchema](cloudbeds_pms/docs/UpdateRoomAmenitiesResponseSchema.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="api_key"></a>
### api_key

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

<a id="default"></a>
### default

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://api.cloudbeds.com/auth/oauth/authorize
- **Scopes**: 
 - **read:addon**: Read Addon information
 - **read:doorLockKey**: Read DoorLock keys and settings
 - **write:doorLockKey**: Write DoorLock keys and settings
 - **delete:doorLockKey**: Delete DoorLock keys and settings
 - **read:housekeeping**: Read Housekeeping inspections
 - **read:marketsegment**: Read Market Segmentation groups and segments
 - **write:marketsegment**: Write Market Segmentation groups and segments
 - **delete:marketsegment**: Delete Market Segmentation groups and segments
 - **write:importTask**: Create new data imports
 - **read:importTask**: Read data imports
 - **hotel:read**: Read Hotel information
 - **hotel:write**: Write Hotel information
 - **hotel:delete**: Delete Hotel information
 - **write:appError**: Write AppError information
 - **read:agePolicy**: Read Age Policy information
 - **write:agePolicy**: Write Age Policy information
 - **delete:agePolicy**: Delete Age Policy information
 - **write:allotmentBlocks**: Write AllotmentBlock information
 - **read:allotmentBlocks**: Read AllotmentBlock information
 - **delete:allotmentBlocks**: Delete AllotmentBlock information


## Author




