cloudbeds_pms.MarketSegmentationApi

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

Method	HTTP request	Description
group_controller_create	POST /market-segmentation/v1/groups	Create a new Market Segmentation Group.
group_controller_delete	DELETE /market-segmentation/v1/groups/{id}	Delete a Market Segmentation Group.
group_controller_disable	POST /market-segmentation/v1/groups/{id}/disable	Disable a Market Segmentation Group.
group_controller_enable	POST /market-segmentation/v1/groups/{id}/enable	Enable a Market Segmentation Group.
group_controller_index	GET /market-segmentation/v1/groups	Get a list of Market Segmentation Groups.
group_controller_single	GET /market-segmentation/v1/groups/{id}	Get Market Segmentation Group data.
group_controller_update	PATCH /market-segmentation/v1/groups/{id}	Update a Market Segmentation Group.
segment_controller_create	POST /market-segmentation/v1/segments	Create a new Market Segmentation Segment.
segment_controller_default	POST /market-segmentation/v1/segments/{id}/default	Set Market Segmentation Segment as Default.
segment_controller_delete	DELETE /market-segmentation/v1/segments/{id}	Delete a Market Segmentation Segment.
segment_controller_disable	POST /market-segmentation/v1/segments/{id}/disable	Disable a Market Segmentation Segment.
segment_controller_enable	POST /market-segmentation/v1/segments/{id}/enable	Enable a Market Segmentation Segment.
segment_controller_index	GET /market-segmentation/v1/segments/{enabled}	Get a list of Market Segmentation Segments.
segment_controller_reservations	GET /market-segmentation/v1/segments/{id}/reservations/{active}	Get a list of reservations linked to a Market Segmentation Segment.
segment_controller_single	GET /market-segmentation/v1/segments/{id}	Get Market Segmentation Segment data.
segment_controller_update	PATCH /market-segmentation/v1/segments/{id}	Update a Market Segmentation Segment.

group_controller_create

GroupResponseSchema group_controller_create(x_property_id, group_create_request_schema)

Create a new Market Segmentation Group.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.group_create_request_schema import GroupCreateRequestSchema
from cloudbeds_pms.models.group_response_schema import GroupResponseSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    group_create_request_schema = cloudbeds_pms.GroupCreateRequestSchema() # GroupCreateRequestSchema | Group data.

    try:
        # Create a new Market Segmentation Group.
        api_response = api_instance.group_controller_create(x_property_id, group_create_request_schema)
        print("The response of MarketSegmentationApi->group_controller_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->group_controller_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
group_create_request_schema	GroupCreateRequestSchema	Group data.

Return type

GroupResponseSchema

Authorization

default

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created Market Segmentation Group.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

group_controller_delete

object group_controller_delete(x_property_id, id)

Delete a Market Segmentation Group.

Example

OAuth Authentication (default):

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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Group ID.

    try:
        # Delete a Market Segmentation Group.
        api_response = api_instance.group_controller_delete(x_property_id, id)
        print("The response of MarketSegmentationApi->group_controller_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->group_controller_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Group ID.

Return type

object

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Market Segmentation Group was deleted.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

group_controller_disable

object group_controller_disable(x_property_id, id)

Disable a Market Segmentation Group.

Example

OAuth Authentication (default):

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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Group ID.

    try:
        # Disable a Market Segmentation Group.
        api_response = api_instance.group_controller_disable(x_property_id, id)
        print("The response of MarketSegmentationApi->group_controller_disable:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->group_controller_disable: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Group ID.

Return type

object

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Market Segmentation Group was disabled.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

group_controller_enable

object group_controller_enable(x_property_id, id)

Enable a Market Segmentation Group.

Example

OAuth Authentication (default):

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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Group ID.

    try:
        # Enable a Market Segmentation Group.
        api_response = api_instance.group_controller_enable(x_property_id, id)
        print("The response of MarketSegmentationApi->group_controller_enable:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->group_controller_enable: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Group ID.

Return type

object

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Market Segmentation Group was enabled.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

group_controller_index

GroupListResponseSchema group_controller_index(x_property_id, offset=offset, limit=limit)

Get a list of Market Segmentation Groups.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.group_list_response_schema import GroupListResponseSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    offset = 0 # int | The number of items to skip before starting to collect the result set. Used for pagination. (optional) (default to 0)
    limit = 100 # int | The maximum number of items to return in the response. Default is 100. (optional) (default to 100)

    try:
        # Get a list of Market Segmentation Groups.
        api_response = api_instance.group_controller_index(x_property_id, offset=offset, limit=limit)
        print("The response of MarketSegmentationApi->group_controller_index:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->group_controller_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
offset	int	The number of items to skip before starting to collect the result set. Used for pagination.	[optional] [default to 0]
limit	int	The maximum number of items to return in the response. Default is 100.	[optional] [default to 100]

Return type

GroupListResponseSchema

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of Market Segmentation Groups.	-
400	Bad request response.	-
403	Forbidden response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

group_controller_single

GroupResponseSchema group_controller_single(x_property_id, id)

Get Market Segmentation Group data.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.group_response_schema import GroupResponseSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Group ID.

    try:
        # Get Market Segmentation Group data.
        api_response = api_instance.group_controller_single(x_property_id, id)
        print("The response of MarketSegmentationApi->group_controller_single:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->group_controller_single: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Group ID.

Return type

GroupResponseSchema

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Market Segmentation Group data.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not Found response.	-
500	Internal Server Error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

group_controller_update

GroupResponseSchema group_controller_update(x_property_id, id, group_update_request_schema)

Update a Market Segmentation Group.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.group_response_schema import GroupResponseSchema
from cloudbeds_pms.models.group_update_request_schema import GroupUpdateRequestSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Group ID.
    group_update_request_schema = cloudbeds_pms.GroupUpdateRequestSchema() # GroupUpdateRequestSchema | Group data.

    try:
        # Update a Market Segmentation Group.
        api_response = api_instance.group_controller_update(x_property_id, id, group_update_request_schema)
        print("The response of MarketSegmentationApi->group_controller_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->group_controller_update: %s\n" % e)

Parameters

Name	Type	Description
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Group ID.
group_update_request_schema	GroupUpdateRequestSchema	Group data.

Return type

GroupResponseSchema

Authorization

default

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Updated Market Segmentation Group.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_create

SegmentResponseSchema segment_controller_create(x_property_id, segment_create_request_schema)

Create a new Market Segmentation Segment.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.segment_create_request_schema import SegmentCreateRequestSchema
from cloudbeds_pms.models.segment_response_schema import SegmentResponseSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    segment_create_request_schema = cloudbeds_pms.SegmentCreateRequestSchema() # SegmentCreateRequestSchema | Segment data.

    try:
        # Create a new Market Segmentation Segment.
        api_response = api_instance.segment_controller_create(x_property_id, segment_create_request_schema)
        print("The response of MarketSegmentationApi->segment_controller_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
segment_create_request_schema	SegmentCreateRequestSchema	Segment data.

Return type

SegmentResponseSchema

Authorization

default

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created Market Segmentation Segment.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_default

object segment_controller_default(x_property_id, id)

Set Market Segmentation Segment as Default.

Example

OAuth Authentication (default):

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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Segment ID.

    try:
        # Set Market Segmentation Segment as Default.
        api_response = api_instance.segment_controller_default(x_property_id, id)
        print("The response of MarketSegmentationApi->segment_controller_default:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_default: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Segment ID.

Return type

object

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Market Segmentation Segment was set as default.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_delete

object segment_controller_delete(x_property_id, id)

Delete a Market Segmentation Segment.

Example

OAuth Authentication (default):

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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Segment ID.

    try:
        # Delete a Market Segmentation Segment.
        api_response = api_instance.segment_controller_delete(x_property_id, id)
        print("The response of MarketSegmentationApi->segment_controller_delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Segment ID.

Return type

object

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Market Segmentation Segment was deleted.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_disable

object segment_controller_disable(x_property_id, id)

Disable a Market Segmentation Segment.

Example

OAuth Authentication (default):

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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Segment ID.

    try:
        # Disable a Market Segmentation Segment.
        api_response = api_instance.segment_controller_disable(x_property_id, id)
        print("The response of MarketSegmentationApi->segment_controller_disable:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_disable: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Segment ID.

Return type

object

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Market Segmentation Segment was disabled.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_enable

object segment_controller_enable(x_property_id, id)

Enable a Market Segmentation Segment.

Example

OAuth Authentication (default):

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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Segment ID.

    try:
        # Enable a Market Segmentation Segment.
        api_response = api_instance.segment_controller_enable(x_property_id, id)
        print("The response of MarketSegmentationApi->segment_controller_enable:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_enable: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Segment ID.

Return type

object

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Market Segmentation Segment was enabled.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_index

SegmentListResponseSchema segment_controller_index(x_property_id, enabled, offset=offset, limit=limit, filters=filters)

Get a list of Market Segmentation Segments.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.query_parameter_dynamic_filter_schema import QueryParameterDynamicFilterSchema
from cloudbeds_pms.models.segment_list_response_schema import SegmentListResponseSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    enabled = false # bool | List only enabled segments.
    offset = 0 # int | The number of items to skip before starting to collect the result set. Used for pagination. (optional) (default to 0)
    limit = 100 # int | The maximum number of items to return in the response. Default is 100. (optional) (default to 100)
    filters = cloudbeds_pms.QueryParameterDynamicFilterSchema() # QueryParameterDynamicFilterSchema | This parameter should be formatted as a list of strings separated by ; (optional)

    try:
        # Get a list of Market Segmentation Segments.
        api_response = api_instance.segment_controller_index(x_property_id, enabled, offset=offset, limit=limit, filters=filters)
        print("The response of MarketSegmentationApi->segment_controller_index:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
enabled	bool	List only enabled segments.
offset	int	The number of items to skip before starting to collect the result set. Used for pagination.	[optional] [default to 0]
limit	int	The maximum number of items to return in the response. Default is 100.	[optional] [default to 100]
filters	QueryParameterDynamicFilterSchema	This parameter should be formatted as a list of strings separated by ;	[optional]

Return type

SegmentListResponseSchema

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of Market Segmentation Segments.	-
400	Bad request response.	-
403	Forbidden response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_reservations

SegmentListReservationsResponseSchema segment_controller_reservations(x_property_id, id, active, offset=offset, limit=limit)

Get a list of reservations linked to a Market Segmentation Segment.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.segment_list_reservations_response_schema import SegmentListReservationsResponseSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = '1-b' # str | Segment ID.
    active = false # bool | List only active reservations.
    offset = 0 # int | The number of items to skip before starting to collect the result set. Used for pagination. (optional) (default to 0)
    limit = 100 # int | The maximum number of items to return in the response. Default is 100. (optional) (default to 100)

    try:
        # Get a list of reservations linked to a Market Segmentation Segment.
        api_response = api_instance.segment_controller_reservations(x_property_id, id, active, offset=offset, limit=limit)
        print("The response of MarketSegmentationApi->segment_controller_reservations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_reservations: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	str	Segment ID.
active	bool	List only active reservations.
offset	int	The number of items to skip before starting to collect the result set. Used for pagination.	[optional] [default to 0]
limit	int	The maximum number of items to return in the response. Default is 100.	[optional] [default to 100]

Return type

SegmentListReservationsResponseSchema

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of reservations linked to a Market Segmentation Segment.	-
400	Bad request response.	-
403	Forbidden response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_single

SegmentResponseSchema segment_controller_single(x_property_id, id)

Get Market Segmentation Segment data.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.segment_response_schema import SegmentResponseSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Segment ID.

    try:
        # Get Market Segmentation Segment data.
        api_response = api_instance.segment_controller_single(x_property_id, id)
        print("The response of MarketSegmentationApi->segment_controller_single:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_single: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Segment ID.

Return type

SegmentResponseSchema

Authorization

default

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Market Segmentation Segment data.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not Found response.	-
500	Internal Server Error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

segment_controller_update

SegmentResponseSchema segment_controller_update(x_property_id, id, segment_update_request_schema)

Update a Market Segmentation Segment.

Example

OAuth Authentication (default):

import cloudbeds_pms
from cloudbeds_pms.models.segment_response_schema import SegmentResponseSchema
from cloudbeds_pms.models.segment_update_request_schema import SegmentUpdateRequestSchema
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.MarketSegmentationApi(api_client)
    x_property_id = '1,2,3' # str | A numeric, comma-separated string representing the property IDs, sent in the header.
    id = cloudbeds_pms.Id() # Id | Segment ID.
    segment_update_request_schema = cloudbeds_pms.SegmentUpdateRequestSchema() # SegmentUpdateRequestSchema | Segment data.

    try:
        # Update a Market Segmentation Segment.
        api_response = api_instance.segment_controller_update(x_property_id, id, segment_update_request_schema)
        print("The response of MarketSegmentationApi->segment_controller_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MarketSegmentationApi->segment_controller_update: %s\n" % e)

Parameters

Name	Type	Description
x_property_id	str	A numeric, comma-separated string representing the property IDs, sent in the header.
id	Id	Segment ID.
segment_update_request_schema	SegmentUpdateRequestSchema	Segment data.

Return type

SegmentResponseSchema

Authorization

default

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Updated Market Segmentation Segment.	-
400	Bad request response.	-
403	Forbidden response.	-
404	Not found response.	-
500	Internal server error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

MarketSegmentationApi.md

Latest commit

History

MarketSegmentationApi.md

File metadata and controls

cloudbeds_pms.MarketSegmentationApi

group_controller_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_controller_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_controller_disable

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_controller_enable

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_controller_index

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_controller_single

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_controller_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

segment_controller_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

segment_controller_default

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

segment_controller_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

segment_controller_disable

Example

Parameters