OpenAPI client for Cloudbeds PMS API.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for artifacts from gravatar.com artifacts

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (The MIT License)
  • Author: Cloudbeds
  • Requires: Python >=3.9
  • Provides-Extra: testing
Classifiers
Report project as malware

Project description

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.

Run in Postman 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.11.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.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 GET /addons/v1/addons Retrieve property add-ons
AmenitiesApi amenity_catalog_controller_get_amenity_catalog GET /amenities/v1/catalogs/amenities Get amenity catalog
AmenitiesApi amenity_catalog_controller_get_amenity_category_catalog GET /amenities/v1/catalogs/categories Get amenity category catalog
AmenitiesApi property_amenity_controller_get_property_amenities GET /amenities/v1/properties/{propertyId}/amenities Get property amenities
AmenitiesApi property_amenity_controller_update_property_amenities PUT /amenities/v1/properties/{propertyId}/amenities Update property amenities
AmenitiesApi 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 GET /amenities/v1/properties/{propertyId}/rooms/{roomId}/amenities Get room amenities
AmenitiesApi 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 PUT /amenities/v1/properties/{propertyId}/rooms/{roomId}/amenities Update room amenities
ApplicationsApi 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 DELETE /doorlock/v1/keys Delete a list of doorlock keys.
DoorLocksApi door_lock_key_controller_create POST /doorlock/v1/keys Create a new doorlock key.
DoorLocksApi door_lock_key_controller_delete DELETE /doorlock/v1/keys/{id} Delete a doorlock key.
DoorLocksApi 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 PATCH /doorlock/v1/keys/{id} Update a doorlock key.
DoorLocksApi 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 GET /doorlock/v1/settings/{propertyId} Get doorlock settings for property for specific application client.
DoorLocksApi door_lock_settings_controller_upsert PUT /doorlock/v1/settings/{propertyId} Upsert doorlock settings for property for specific application client.
EventsApi event_controller_create POST /events/v2/events Create a new event
EventsApi event_controller_destroy DELETE /events/v2/events/{eventId} Delete an event
EventsApi event_controller_list GET /events/v2/events List events for a property
EventsApi event_controller_show GET /events/v2/events/{eventId} Get a single event
EventsApi event_controller_update PATCH /events/v2/events/{eventId} Update an existing event
EventsApi event_note_controller_create POST /events/v2/events/{eventId}/notes Create a note for an event
EventsApi event_note_controller_list GET /events/v2/events/{eventId}/notes List notes for an event
EventsApi event_note_controller_update PATCH /events/v2/events/{eventId}/notes/{noteId} Update an event note
HousekeepingApi call_27abd48cb30106ec3251cf3baf34174c GET /housekeeping/v1/inspections/{propertyId} Housekeeping inspection list
IntegrationEventsApi integration_event_controller_create POST /integration/v1/events Create a new integration event.
IntegrationEventsApi integration_event_controller_index GET /integration/v1/events Get a list of integration events for a specific property.
IntegrationEventsApi integration_event_controller_retry POST /integration/v1/events/{id}/retry Retry an integration event.
IntegrationEventsApi integration_event_controller_update PATCH /integration/v1/events/{id} Update an integration event.
ItemsApi custom_item_controller_index GET /item/v1/custom-items Get a list of custom items for a specific property.
ItemsApi 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 POST /market-segmentation/v1/groups Create a new Market Segmentation Group.
MarketSegmentationApi group_controller_delete DELETE /market-segmentation/v1/groups/{id} Delete a Market Segmentation Group.
MarketSegmentationApi group_controller_disable POST /market-segmentation/v1/groups/{id}/disable Disable a Market Segmentation Group.
MarketSegmentationApi group_controller_enable POST /market-segmentation/v1/groups/{id}/enable Enable a Market Segmentation Group.
MarketSegmentationApi group_controller_index GET /market-segmentation/v1/groups Get a list of Market Segmentation Groups.
MarketSegmentationApi group_controller_single GET /market-segmentation/v1/groups/{id} Get Market Segmentation Group data.
MarketSegmentationApi group_controller_update PATCH /market-segmentation/v1/groups/{id} Update a Market Segmentation Group.
MarketSegmentationApi segment_controller_create POST /market-segmentation/v1/segments Create a new Market Segmentation Segment.
MarketSegmentationApi segment_controller_default POST /market-segmentation/v1/segments/{id}/default Set Market Segmentation Segment as Default.
MarketSegmentationApi segment_controller_delete DELETE /market-segmentation/v1/segments/{id} Delete a Market Segmentation Segment.
MarketSegmentationApi segment_controller_disable POST /market-segmentation/v1/segments/{id}/disable Disable a Market Segmentation Segment.
MarketSegmentationApi segment_controller_enable POST /market-segmentation/v1/segments/{id}/enable Enable a Market Segmentation Segment.
MarketSegmentationApi segment_controller_index GET /market-segmentation/v1/segments/{enabled} Get a list of Market Segmentation Segments.
MarketSegmentationApi 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 GET /market-segmentation/v1/segments/{id} Get Market Segmentation Segment data.
MarketSegmentationApi segment_controller_update PATCH /market-segmentation/v1/segments/{id} Update a Market Segmentation Segment.
PropertyApi system_controller_get_system GET /property/v1/system Retrieves the property's system component versions
ReservationsApi reservation_room_controller_update_room PATCH /reservation/v1/reservations/{reservationId}/rooms/{reservationRoomId} Update room assignment for a reservation
RoomsApi out_of_service_controller_make POST /rooms/v1/out-of-service Room out of service

Documentation For Models

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: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

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for artifacts from gravatar.com artifacts

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (The MIT License)
  • Author: Cloudbeds
  • Requires: Python >=3.9
  • Provides-Extra: testing
Classifiers

Release history Release notifications | RSS feed

2.13.0

2.12.0

This version

2.11.0

2.10.0

2.9.0

2.8.0

2.7.0

2.6.0

2.5.0

2.4.0

2.3.0

2.2.0

2.1.0

2.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudbeds_pms-2.11.0.tar.gz (153.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cloudbeds_pms-2.11.0-py3-none-any.whl (811.3 kB view details)

Uploaded Python 3

File details

Details for the file cloudbeds_pms-2.11.0.tar.gz.

File metadata

  • Download URL: cloudbeds_pms-2.11.0.tar.gz
  • Upload date:
  • Size: 153.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cloudbeds_pms-2.11.0.tar.gz
Algorithm Hash digest
SHA256 70c6896c75cfc40d4bf0ae3fbbcd8d1383642446f7f18b9014eb7a867f49f224
MD5 fcb33a9b1479e66df435bbae1c29f167
BLAKE2b-256 657039aa2838b9420b34a6a24ed7045b243ab0b7c4529db516acc50b1444c93c

See more details on using hashes here.

Provenance

The following attestation bundles were made for cloudbeds_pms-2.11.0.tar.gz:

Publisher: publish.yaml on cloudbeds/cloudbeds-api-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cloudbeds_pms-2.11.0-py3-none-any.whl.

File metadata

  • Download URL: cloudbeds_pms-2.11.0-py3-none-any.whl
  • Upload date:
  • Size: 811.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cloudbeds_pms-2.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d16af4950876ff262647485ed9bc16443599359975c2d958f05fdbbe04fa0b23
MD5 8f9c40bab998eb4c0a8317aa45006fac
BLAKE2b-256 302b6de30892b24ddab1d0f4b51099a2b8622729001ad16c6de1b40071fe0905

See more details on using hashes here.

Provenance

The following attestation bundles were made for cloudbeds_pms-2.11.0-py3-none-any.whl:

Publisher: publish.yaml on cloudbeds/cloudbeds-api-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page