ultracart-rest-sdk 4.1.13__py3-none-any.whl → 4.1.15__py3-none-any.whl

ultracart/api/order_api.py

@@ -128,6 +128,63 @@ class OrderApi(object):
             },
             api_client=api_client
         )
+        self.block_refund_on_order_endpoint = _Endpoint(
+            settings={
+                'response_type': None,
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/order/orders/{order_id}/refund_block',
+                'operation_id': 'block_refund_on_order',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'order_id',
+                    'block_reason',
+                ],
+                'required': [
+                    'order_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'order_id':
+                        (str,),
+                    'block_reason':
+                        (str,),
+                },
+                'attribute_map': {
+                    'order_id': 'order_id',
+                    'block_reason': 'block_reason',
+                },
+                'location_map': {
+                    'order_id': 'path',
+                    'block_reason': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.cancel_order_endpoint = _Endpoint(
             settings={
                 'response_type': (BaseResponse,),
@@ -1698,6 +1755,58 @@ class OrderApi(object):
             },
             api_client=api_client
         )
+        self.unblock_refund_on_order_endpoint = _Endpoint(
+            settings={
+                'response_type': None,
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/order/orders/{order_id}/refund_unblock',
+                'operation_id': 'unblock_refund_on_order',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'order_id',
+                ],
+                'required': [
+                    'order_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'order_id':
+                        (str,),
+                },
+                'attribute_map': {
+                    'order_id': 'order_id',
+                },
+                'location_map': {
+                    'order_id': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.update_accounts_receivable_retry_config_endpoint = _Endpoint(
             settings={
                 'response_type': (BaseResponse,),
@@ -1956,6 +2065,90 @@ class OrderApi(object):
             desired_total
         return self.adjust_order_total_endpoint.call_with_http_info(**kwargs)
 
+    def block_refund_on_order(
+        self,
+        order_id,
+        **kwargs
+    ):
+        """Set a refund block on an order  # noqa: E501
+
+        Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.block_refund_on_order(order_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            order_id (str): The order id to block a refund on.
+
+        Keyword Args:
+            block_reason (str): Block reason code (optional). [optional]
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            None
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['order_id'] = \
+            order_id
+        return self.block_refund_on_order_endpoint.call_with_http_info(**kwargs)
+
     def cancel_order(
         self,
         order_id,
@@ -4014,6 +4207,89 @@ class OrderApi(object):
             order_id
         return self.resend_shipment_confirmation_endpoint.call_with_http_info(**kwargs)
 
+    def unblock_refund_on_order(
+        self,
+        order_id,
+        **kwargs
+    ):
+        """Remove a refund block on an order  # noqa: E501
+
+        Removes a refund block on an order to prevent a user from performing a refund.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.unblock_refund_on_order(order_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            order_id (str): The order id to unblock a refund on.
+
+        Keyword Args:
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            None
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['order_id'] = \
+            order_id
+        return self.unblock_refund_on_order_endpoint.call_with_http_info(**kwargs)
+
     def update_accounts_receivable_retry_config(
         self,
         retry_config,

ultracart/api_client.py

@@ -77,7 +77,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/4.1.13/python'
+        self.user_agent = 'OpenAPI-Generator/4.1.15/python'
 
     def __enter__(self):
         return self

ultracart/configuration.py

@@ -422,7 +422,7 @@ conf = ultracart.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0.0\n"\
-               "SDK Package Version: 4.1.13".\
+               "SDK Package Version: 4.1.15".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

ultracart/model/cart_upsell_after.py

@@ -88,6 +88,8 @@ class CartUpsellAfter(ModelNormal):
             'finalize_after_dts': (str,),  # noqa: E501
             'finalize_after_minutes': (int,),  # noqa: E501
             'upsell_path_code': (str,),  # noqa: E501
+            'upsell_path_name': (str,),  # noqa: E501
+            'upsell_path_variation': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -99,6 +101,8 @@ class CartUpsellAfter(ModelNormal):
         'finalize_after_dts': 'finalize_after_dts',  # noqa: E501
         'finalize_after_minutes': 'finalize_after_minutes',  # noqa: E501
         'upsell_path_code': 'upsell_path_code',  # noqa: E501
+        'upsell_path_name': 'upsell_path_name',  # noqa: E501
+        'upsell_path_variation': 'upsell_path_variation',  # noqa: E501
     }
 
     read_only_vars = {
@@ -144,7 +148,9 @@ class CartUpsellAfter(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             finalize_after_dts (str): The date/time after which the cart will finalize into an order.. [optional]  # noqa: E501
             finalize_after_minutes (int): The amount of inactivity in minutes after which the cart should be finalized into an order.  This will calculate the finalize_after_dts field.. [optional]  # noqa: E501
-            upsell_path_code (str): Upsell path code. [optional]  # noqa: E501
+            upsell_path_code (str): Upsell path code (this is for legacy upsells only). [optional]  # noqa: E501
+            upsell_path_name (str): Upsell path name to start on (StoreFront Upsells).  Will only be respected on a handoff API call.. [optional]  # noqa: E501
+            upsell_path_variation (str): Upsell path variation to start on (StoreFront Upsells).   Will only be respected on a handoff API call.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -232,7 +238,9 @@ class CartUpsellAfter(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             finalize_after_dts (str): The date/time after which the cart will finalize into an order.. [optional]  # noqa: E501
             finalize_after_minutes (int): The amount of inactivity in minutes after which the cart should be finalized into an order.  This will calculate the finalize_after_dts field.. [optional]  # noqa: E501
-            upsell_path_code (str): Upsell path code. [optional]  # noqa: E501
+            upsell_path_code (str): Upsell path code (this is for legacy upsells only). [optional]  # noqa: E501
+            upsell_path_name (str): Upsell path name to start on (StoreFront Upsells).  Will only be respected on a handoff API call.. [optional]  # noqa: E501
+            upsell_path_variation (str): Upsell path variation to start on (StoreFront Upsells).   Will only be respected on a handoff API call.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

ultracart/model/conversation_virtual_agent_capabilities.py

@@ -56,6 +56,12 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
     """
 
     allowed_values = {
+        ('open_support_ticket_channel',): {
+            'NONE': "none",
+            'EMAIL': "email",
+            'ULTRACART_TASK': "UltraCart Task",
+            'ZOHO_DESK_TICKET': "Zoho Desk Ticket",
+        },
     }
 
     validations = {
@@ -87,6 +93,8 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
             'lookup_order_information': (bool,),  # noqa: E501
             'lookup_subscription_information': (bool,),  # noqa: E501
             'open_support_ticket': (bool,),  # noqa: E501
+            'open_support_ticket_channel': (str,),  # noqa: E501
+            'open_support_ticket_channel_email': (str,),  # noqa: E501
             'pause_subscription': (bool,),  # noqa: E501
             'resume_subscription': (bool,),  # noqa: E501
             'transfer_chat_to_live_agent': (bool,),  # noqa: E501
@@ -104,6 +112,8 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
         'lookup_order_information': 'lookup_order_information',  # noqa: E501
         'lookup_subscription_information': 'lookup_subscription_information',  # noqa: E501
         'open_support_ticket': 'open_support_ticket',  # noqa: E501
+        'open_support_ticket_channel': 'open_support_ticket_channel',  # noqa: E501
+        'open_support_ticket_channel_email': 'open_support_ticket_channel_email',  # noqa: E501
         'pause_subscription': 'pause_subscription',  # noqa: E501
         'resume_subscription': 'resume_subscription',  # noqa: E501
         'transfer_chat_to_live_agent': 'transfer_chat_to_live_agent',  # noqa: E501
@@ -156,6 +166,8 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
             lookup_order_information (bool): [optional]  # noqa: E501
             lookup_subscription_information (bool): [optional]  # noqa: E501
             open_support_ticket (bool): [optional]  # noqa: E501
+            open_support_ticket_channel (str): Channel to use to open the support ticket. [optional]  # noqa: E501
+            open_support_ticket_channel_email (str): Email to send support ticket to. [optional]  # noqa: E501
             pause_subscription (bool): [optional]  # noqa: E501
             resume_subscription (bool): [optional]  # noqa: E501
             transfer_chat_to_live_agent (bool): [optional]  # noqa: E501
@@ -250,6 +262,8 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
             lookup_order_information (bool): [optional]  # noqa: E501
             lookup_subscription_information (bool): [optional]  # noqa: E501
             open_support_ticket (bool): [optional]  # noqa: E501
+            open_support_ticket_channel (str): Channel to use to open the support ticket. [optional]  # noqa: E501
+            open_support_ticket_channel_email (str): Email to send support ticket to. [optional]  # noqa: E501
             pause_subscription (bool): [optional]  # noqa: E501
             resume_subscription (bool): [optional]  # noqa: E501
             transfer_chat_to_live_agent (bool): [optional]  # noqa: E501