diff --git a/hubspot/automation/actions/api/callbacks_api.py b/hubspot/automation/actions/api/callbacks_api.py index ed48c890..ba95b36e 100644 --- a/hubspot/automation/actions/api/callbacks_api.py +++ b/hubspot/automation/actions/api/callbacks_api.py @@ -34,15 +34,16 @@ def __init__(self, api_client=None): self.api_client = api_client def complete(self, callback_id, callback_completion_request, **kwargs): # noqa: E501 - """Completes a single callback # noqa: E501 + """Completes a callback # noqa: E501 + Complete a specific blocked action execution by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.complete(callback_id, callback_completion_request, async_req=True) >>> result = thread.get() - :param callback_id: (required) + :param callback_id: The ID of the action execution. (required) :type callback_id: str :param callback_completion_request: (required) :type callback_completion_request: CallbackCompletionRequest @@ -65,15 +66,16 @@ def complete(self, callback_id, callback_completion_request, **kwargs): # noqa: return self.complete_with_http_info(callback_id, callback_completion_request, **kwargs) # noqa: E501 def complete_with_http_info(self, callback_id, callback_completion_request, **kwargs): # noqa: E501 - """Completes a single callback # noqa: E501 + """Completes a callback # noqa: E501 + Complete a specific blocked action execution by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.complete_with_http_info(callback_id, callback_completion_request, async_req=True) >>> result = thread.get() - :param callback_id: (required) + :param callback_id: The ID of the action execution. (required) :type callback_id: str :param callback_completion_request: (required) :type callback_completion_request: CallbackCompletionRequest @@ -167,8 +169,9 @@ def complete_with_http_info(self, callback_id, callback_completion_request, **kw ) def complete_batch(self, batch_input_callback_completion_batch_request, **kwargs): # noqa: E501 - """Completes a batch of callbacks # noqa: E501 + """Complete a batch of callbacks # noqa: E501 + Complete a batch of blocked action executions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -196,8 +199,9 @@ def complete_batch(self, batch_input_callback_completion_batch_request, **kwargs return self.complete_batch_with_http_info(batch_input_callback_completion_batch_request, **kwargs) # noqa: E501 def complete_batch_with_http_info(self, batch_input_callback_completion_batch_request, **kwargs): # noqa: E501 - """Completes a batch of callbacks # noqa: E501 + """Complete a batch of callbacks # noqa: E501 + Complete a batch of blocked action executions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/hubspot/automation/actions/api/definitions_api.py b/hubspot/automation/actions/api/definitions_api.py index 8b33c650..785d5c55 100644 --- a/hubspot/automation/actions/api/definitions_api.py +++ b/hubspot/automation/actions/api/definitions_api.py @@ -34,17 +34,18 @@ def __init__(self, api_client=None): self.api_client = api_client def archive(self, definition_id, app_id, **kwargs): # noqa: E501 - """Archive an extension definition # noqa: E501 + """Delete an action definition # noqa: E501 + Delete an action definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.archive(definition_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the custom action definition. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -65,17 +66,18 @@ def archive(self, definition_id, app_id, **kwargs): # noqa: E501 return self.archive_with_http_info(definition_id, app_id, **kwargs) # noqa: E501 def archive_with_http_info(self, definition_id, app_id, **kwargs): # noqa: E501 - """Archive an extension definition # noqa: E501 + """Delete an action definition # noqa: E501 + Delete an action definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.archive_with_http_info(definition_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the custom action definition. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -162,15 +164,16 @@ def archive_with_http_info(self, definition_id, app_id, **kwargs): # noqa: E501 ) def create(self, app_id, public_action_definition_egg, **kwargs): # noqa: E501 - """Create a new extension definition # noqa: E501 + """Create a new custom action definition # noqa: E501 + Create a new custom workflow action. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create(app_id, public_action_definition_egg, async_req=True) >>> result = thread.get() - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param public_action_definition_egg: (required) :type public_action_definition_egg: PublicActionDefinitionEgg @@ -193,15 +196,16 @@ def create(self, app_id, public_action_definition_egg, **kwargs): # noqa: E501 return self.create_with_http_info(app_id, public_action_definition_egg, **kwargs) # noqa: E501 def create_with_http_info(self, app_id, public_action_definition_egg, **kwargs): # noqa: E501 - """Create a new extension definition # noqa: E501 + """Create a new custom action definition # noqa: E501 + Create a new custom workflow action. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_with_http_info(app_id, public_action_definition_egg, async_req=True) >>> result = thread.get() - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param public_action_definition_egg: (required) :type public_action_definition_egg: PublicActionDefinitionEgg @@ -297,17 +301,18 @@ def create_with_http_info(self, app_id, public_action_definition_egg, **kwargs): ) def get_by_id(self, definition_id, app_id, **kwargs): # noqa: E501 - """Get extension definition by Id # noqa: E501 + """Retrieve a custom action definition # noqa: E501 + Retrieve a custom workflow action definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_id(definition_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the custom action. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param archived: Whether to return only results that have been archived. :type archived: bool @@ -330,17 +335,18 @@ def get_by_id(self, definition_id, app_id, **kwargs): # noqa: E501 return self.get_by_id_with_http_info(definition_id, app_id, **kwargs) # noqa: E501 def get_by_id_with_http_info(self, definition_id, app_id, **kwargs): # noqa: E501 - """Get extension definition by Id # noqa: E501 + """Retrieve a custom action definition # noqa: E501 + Retrieve a custom workflow action definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_id_with_http_info(definition_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the custom action. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param archived: Whether to return only results that have been archived. :type archived: bool @@ -433,15 +439,16 @@ def get_by_id_with_http_info(self, definition_id, app_id, **kwargs): # noqa: E5 ) def get_page(self, app_id, **kwargs): # noqa: E501 - """Get paged extension definitions # noqa: E501 + """Retrieve custom action definitions # noqa: E501 + Retrieve custom workflow action definitions by app ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_page(app_id, async_req=True) >>> result = thread.get() - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param limit: The maximum number of results to display per page. :type limit: int @@ -468,15 +475,16 @@ def get_page(self, app_id, **kwargs): # noqa: E501 return self.get_page_with_http_info(app_id, **kwargs) # noqa: E501 def get_page_with_http_info(self, app_id, **kwargs): # noqa: E501 - """Get paged extension definitions # noqa: E501 + """Retrieve custom action definitions # noqa: E501 + Retrieve custom workflow action definitions by app ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_page_with_http_info(app_id, async_req=True) >>> result = thread.get() - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param limit: The maximum number of results to display per page. :type limit: int @@ -572,17 +580,18 @@ def get_page_with_http_info(self, app_id, **kwargs): # noqa: E501 ) def update(self, definition_id, app_id, public_action_definition_patch, **kwargs): # noqa: E501 - """Patch an existing extension definition # noqa: E501 + """Update an existing action definition # noqa: E501 + Update an existing action definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update(definition_id, app_id, public_action_definition_patch, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the custom action definition. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param public_action_definition_patch: (required) :type public_action_definition_patch: PublicActionDefinitionPatch @@ -605,17 +614,18 @@ def update(self, definition_id, app_id, public_action_definition_patch, **kwargs return self.update_with_http_info(definition_id, app_id, public_action_definition_patch, **kwargs) # noqa: E501 def update_with_http_info(self, definition_id, app_id, public_action_definition_patch, **kwargs): # noqa: E501 - """Patch an existing extension definition # noqa: E501 + """Update an existing action definition # noqa: E501 + Update an existing action definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_with_http_info(definition_id, app_id, public_action_definition_patch, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the custom action definition. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param public_action_definition_patch: (required) :type public_action_definition_patch: PublicActionDefinitionPatch diff --git a/hubspot/automation/actions/api/functions_api.py b/hubspot/automation/actions/api/functions_api.py index 3cb62e64..d1133861 100644 --- a/hubspot/automation/actions/api/functions_api.py +++ b/hubspot/automation/actions/api/functions_api.py @@ -36,6 +36,7 @@ def __init__(self, api_client=None): def archive(self, definition_id, function_type, function_id, app_id, **kwargs): # noqa: E501 """Archive a function for a definition # noqa: E501 + Archive a function for a specific definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -71,6 +72,7 @@ def archive(self, definition_id, function_type, function_id, app_id, **kwargs): def archive_with_http_info(self, definition_id, function_type, function_id, app_id, **kwargs): # noqa: E501 """Archive a function for a definition # noqa: E501 + Archive a function for a specific definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -182,17 +184,18 @@ def archive_with_http_info(self, definition_id, function_type, function_id, app_ def archive_by_function_type(self, definition_id, function_type, app_id, **kwargs): # noqa: E501 """Delete a function for a definition # noqa: E501 + Delete a function within a given definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.archive_by_function_type(definition_id, function_type, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -215,17 +218,18 @@ def archive_by_function_type(self, definition_id, function_type, app_id, **kwarg def archive_by_function_type_with_http_info(self, definition_id, function_type, app_id, **kwargs): # noqa: E501 """Delete a function for a definition # noqa: E501 + Delete a function within a given definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.archive_by_function_type_with_http_info(definition_id, function_type, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -317,21 +321,22 @@ def archive_by_function_type_with_http_info(self, definition_id, function_type, ) def create_or_replace(self, definition_id, function_type, function_id, app_id, body, **kwargs): # noqa: E501 - """Insert a function for a definition # noqa: E501 + """Update a function for a definition # noqa: E501 + Update a function for a given definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_or_replace(definition_id, function_type, function_id, app_id, body, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param function_id: (required) + :param function_id: The ID of the function. (required) :type function_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param body: (required) :type body: str @@ -354,21 +359,22 @@ def create_or_replace(self, definition_id, function_type, function_id, app_id, b return self.create_or_replace_with_http_info(definition_id, function_type, function_id, app_id, body, **kwargs) # noqa: E501 def create_or_replace_with_http_info(self, definition_id, function_type, function_id, app_id, body, **kwargs): # noqa: E501 - """Insert a function for a definition # noqa: E501 + """Update a function for a definition # noqa: E501 + Update a function for a given definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_or_replace_with_http_info(definition_id, function_type, function_id, app_id, body, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param function_id: (required) + :param function_id: The ID of the function. (required) :type function_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param body: (required) :type body: str @@ -481,17 +487,18 @@ def create_or_replace_with_http_info(self, definition_id, function_type, functio def create_or_replace_by_function_type(self, definition_id, function_type, app_id, body, **kwargs): # noqa: E501 """Insert a function for a definition # noqa: E501 + Add a function for a given definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_or_replace_by_function_type(definition_id, function_type, app_id, body, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param body: (required) :type body: str @@ -516,17 +523,18 @@ def create_or_replace_by_function_type(self, definition_id, function_type, app_i def create_or_replace_by_function_type_with_http_info(self, definition_id, function_type, app_id, body, **kwargs): # noqa: E501 """Insert a function for a definition # noqa: E501 + Add a function for a given definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_or_replace_by_function_type_with_http_info(definition_id, function_type, app_id, body, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param body: (required) :type body: str @@ -632,19 +640,20 @@ def create_or_replace_by_function_type_with_http_info(self, definition_id, funct ) def get_by_function_type(self, definition_id, function_type, app_id, **kwargs): # noqa: E501 - """Get all functions by a type for a given definition # noqa: E501 + """Retrieve functions by a type for a given definition # noqa: E501 + Retrieve functions of a specific type for a given definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_function_type(definition_id, function_type, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -665,19 +674,20 @@ def get_by_function_type(self, definition_id, function_type, app_id, **kwargs): return self.get_by_function_type_with_http_info(definition_id, function_type, app_id, **kwargs) # noqa: E501 def get_by_function_type_with_http_info(self, definition_id, function_type, app_id, **kwargs): # noqa: E501 - """Get all functions by a type for a given definition # noqa: E501 + """Retrieve functions by a type for a given definition # noqa: E501 + Retrieve functions of a specific type for a given definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_function_type_with_http_info(definition_id, function_type, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -771,21 +781,22 @@ def get_by_function_type_with_http_info(self, definition_id, function_type, app_ ) def get_by_id(self, definition_id, function_type, function_id, app_id, **kwargs): # noqa: E501 - """Get a function for a given definition # noqa: E501 + """Retrieve a function from a given definition # noqa: E501 + Retrieve a specific function from a given definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_id(definition_id, function_type, function_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param function_id: (required) + :param function_id: The ID of the function. (required) :type function_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -806,21 +817,22 @@ def get_by_id(self, definition_id, function_type, function_id, app_id, **kwargs) return self.get_by_id_with_http_info(definition_id, function_type, function_id, app_id, **kwargs) # noqa: E501 def get_by_id_with_http_info(self, definition_id, function_type, function_id, app_id, **kwargs): # noqa: E501 - """Get a function for a given definition # noqa: E501 + """Retrieve a function from a given definition # noqa: E501 + Retrieve a specific function from a given definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_id_with_http_info(definition_id, function_type, function_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param function_type: (required) + :param function_type: The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`. (required) :type function_type: str - :param function_id: (required) + :param function_id: The ID of the function. (required) :type function_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -919,17 +931,18 @@ def get_by_id_with_http_info(self, definition_id, function_type, function_id, ap ) def get_page(self, definition_id, app_id, **kwargs): # noqa: E501 - """Get all functions for a given definition # noqa: E501 + """Retrieve functions for a given definition # noqa: E501 + Retrieve all functions included in a definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_page(definition_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -950,17 +963,18 @@ def get_page(self, definition_id, app_id, **kwargs): # noqa: E501 return self.get_page_with_http_info(definition_id, app_id, **kwargs) # noqa: E501 def get_page_with_http_info(self, definition_id, app_id, **kwargs): # noqa: E501 - """Get all functions for a given definition # noqa: E501 + """Retrieve functions for a given definition # noqa: E501 + Retrieve all functions included in a definition. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_page_with_http_info(definition_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional diff --git a/hubspot/automation/actions/api/revisions_api.py b/hubspot/automation/actions/api/revisions_api.py index 62fd30bf..2f5cc2c1 100644 --- a/hubspot/automation/actions/api/revisions_api.py +++ b/hubspot/automation/actions/api/revisions_api.py @@ -34,19 +34,20 @@ def __init__(self, api_client=None): self.api_client = api_client def get_by_id(self, definition_id, revision_id, app_id, **kwargs): # noqa: E501 - """Gets a revision for a given definition by revision id # noqa: E501 + """Retrieve a specific revision of a definition # noqa: E501 + Retrieve a specific revision of a definition by revision ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_id(definition_id, revision_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param revision_id: (required) + :param revision_id: The ID of the revision. (required) :type revision_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -67,19 +68,20 @@ def get_by_id(self, definition_id, revision_id, app_id, **kwargs): # noqa: E501 return self.get_by_id_with_http_info(definition_id, revision_id, app_id, **kwargs) # noqa: E501 def get_by_id_with_http_info(self, definition_id, revision_id, app_id, **kwargs): # noqa: E501 - """Gets a revision for a given definition by revision id # noqa: E501 + """Retrieve a specific revision of a definition # noqa: E501 + Retrieve a specific revision of a definition by revision ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_id_with_http_info(definition_id, revision_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param revision_id: (required) + :param revision_id: The ID of the revision. (required) :type revision_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -173,17 +175,18 @@ def get_by_id_with_http_info(self, definition_id, revision_id, app_id, **kwargs) ) def get_page(self, definition_id, app_id, **kwargs): # noqa: E501 - """Get all revisions for a given definition # noqa: E501 + """Retrieve revisions for a given definition # noqa: E501 + Retrieve the versions of a definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_page(definition_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param limit: The maximum number of results to display per page. :type limit: int @@ -208,17 +211,18 @@ def get_page(self, definition_id, app_id, **kwargs): # noqa: E501 return self.get_page_with_http_info(definition_id, app_id, **kwargs) # noqa: E501 def get_page_with_http_info(self, definition_id, app_id, **kwargs): # noqa: E501 - """Get all revisions for a given definition # noqa: E501 + """Retrieve revisions for a given definition # noqa: E501 + Retrieve the versions of a definition by ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_page_with_http_info(definition_id, app_id, async_req=True) >>> result = thread.get() - :param definition_id: (required) + :param definition_id: The ID of the definition. (required) :type definition_id: str - :param app_id: (required) + :param app_id: The ID of the app. (required) :type app_id: int :param limit: The maximum number of results to display per page. :type limit: int diff --git a/hubspot/automation/actions/models/next_page.py b/hubspot/automation/actions/models/next_page.py index 4c401d21..bc3e24a5 100644 --- a/hubspot/automation/actions/models/next_page.py +++ b/hubspot/automation/actions/models/next_page.py @@ -57,6 +57,7 @@ def __init__(self, link=None, after=None, local_vars_configuration=None): # noq def link(self): """Gets the link of this NextPage. # noqa: E501 + A URL that can be used to retrieve the next page results. # noqa: E501 :return: The link of this NextPage. # noqa: E501 :rtype: str @@ -67,6 +68,7 @@ def link(self): def link(self, link): """Sets the link of this NextPage. + A URL that can be used to retrieve the next page results. # noqa: E501 :param link: The link of this NextPage. # noqa: E501 :type link: str @@ -78,6 +80,7 @@ def link(self, link): def after(self): """Gets the after of this NextPage. # noqa: E501 + A paging cursor token for retrieving subsequent pages. # noqa: E501 :return: The after of this NextPage. # noqa: E501 :rtype: str @@ -88,6 +91,7 @@ def after(self): def after(self, after): """Sets the after of this NextPage. + A paging cursor token for retrieving subsequent pages. # noqa: E501 :param after: The after of this NextPage. # noqa: E501 :type after: str diff --git a/hubspot/automation/actions/models/option.py b/hubspot/automation/actions/models/option.py index 514e0c00..a317a55a 100644 --- a/hubspot/automation/actions/models/option.py +++ b/hubspot/automation/actions/models/option.py @@ -66,6 +66,7 @@ def __init__(self, hidden=None, display_order=None, double_data=None, descriptio def hidden(self): """Gets the hidden of this Option. # noqa: E501 + Whether the option is displayed in HubSpot's UI. # noqa: E501 :return: The hidden of this Option. # noqa: E501 :rtype: bool @@ -76,6 +77,7 @@ def hidden(self): def hidden(self, hidden): """Sets the hidden of this Option. + Whether the option is displayed in HubSpot's UI. # noqa: E501 :param hidden: The hidden of this Option. # noqa: E501 :type hidden: bool @@ -89,6 +91,7 @@ def hidden(self, hidden): def display_order(self): """Gets the display_order of this Option. # noqa: E501 + The position of the item relative to others in the list. # noqa: E501 :return: The display_order of this Option. # noqa: E501 :rtype: int @@ -99,6 +102,7 @@ def display_order(self): def display_order(self, display_order): """Sets the display_order of this Option. + The position of the item relative to others in the list. # noqa: E501 :param display_order: The display_order of this Option. # noqa: E501 :type display_order: int @@ -135,6 +139,7 @@ def double_data(self, double_data): def description(self): """Gets the description of this Option. # noqa: E501 + A description of the option. # noqa: E501 :return: The description of this Option. # noqa: E501 :rtype: str @@ -145,6 +150,7 @@ def description(self): def description(self, description): """Sets the description of this Option. + A description of the option. # noqa: E501 :param description: The description of this Option. # noqa: E501 :type description: str @@ -158,6 +164,7 @@ def description(self, description): def read_only(self): """Gets the read_only of this Option. # noqa: E501 + Whether the option is read-only. # noqa: E501 :return: The read_only of this Option. # noqa: E501 :rtype: bool @@ -168,6 +175,7 @@ def read_only(self): def read_only(self, read_only): """Sets the read_only of this Option. + Whether the option is read-only. # noqa: E501 :param read_only: The read_only of this Option. # noqa: E501 :type read_only: bool @@ -181,6 +189,7 @@ def read_only(self, read_only): def label(self): """Gets the label of this Option. # noqa: E501 + A user-friendly label that identifies the option. # noqa: E501 :return: The label of this Option. # noqa: E501 :rtype: str @@ -191,6 +200,7 @@ def label(self): def label(self, label): """Sets the label of this Option. + A user-friendly label that identifies the option. # noqa: E501 :param label: The label of this Option. # noqa: E501 :type label: str @@ -204,6 +214,7 @@ def label(self, label): def value(self): """Gets the value of this Option. # noqa: E501 + The actual value of the option. # noqa: E501 :return: The value of this Option. # noqa: E501 :rtype: str @@ -214,6 +225,7 @@ def value(self): def value(self, value): """Sets the value of this Option. + The actual value of the option. # noqa: E501 :param value: The value of this Option. # noqa: E501 :type value: str diff --git a/hubspot/automation/actions/models/public_action_definition_input_field_dependencies_inner.py b/hubspot/automation/actions/models/public_action_definition_input_field_dependencies_inner.py index a9528efa..02256259 100644 --- a/hubspot/automation/actions/models/public_action_definition_input_field_dependencies_inner.py +++ b/hubspot/automation/actions/models/public_action_definition_input_field_dependencies_inner.py @@ -44,6 +44,8 @@ class PublicActionDefinitionInputFieldDependenciesInner(object): "controlling_field_value": "controllingFieldValue", } + discriminator_value_class_map = {} + def __init__(self, dependency_type="CONDITIONAL_SINGLE_FIELD", controlling_field_name=None, dependent_field_names=None, controlling_field_value=None, local_vars_configuration=None): # noqa: E501 """PublicActionDefinitionInputFieldDependenciesInner - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: @@ -54,7 +56,7 @@ def __init__(self, dependency_type="CONDITIONAL_SINGLE_FIELD", controlling_field self._controlling_field_name = None self._dependent_field_names = None self._controlling_field_value = None - self.discriminator = None + self.discriminator = "dependency_type" self.dependency_type = dependency_type self.controlling_field_name = controlling_field_name @@ -156,6 +158,12 @@ def controlling_field_value(self, controlling_field_value): self._controlling_field_value = controlling_field_value + def get_real_child_model(self, data): + """Returns the real base class specified by the discriminator""" + discriminator_key = self.attribute_map[self.discriminator] + discriminator_value = data[discriminator_key] + return self.discriminator_value_class_map.get(discriminator_value) + def to_dict(self, serialize=False): """Returns the model properties as a dict""" result = {}