ultracart-rest-sdk 4.0.222__py3-none-any.whl → 4.0.224__py3-none-any.whl

ultracart/__init__.py

@@ -11,7 +11,7 @@
 """
 
 
-__version__ = "4.0.222"
+__version__ = "4.0.224"
 
 # import ApiClient
 from ultracart.api_client import ApiClient

ultracart/api/storefront_api.py

@@ -93,6 +93,7 @@ from ultracart.model.email_performance_response import EmailPerformanceResponse
 from ultracart.model.email_plan import EmailPlan
 from ultracart.model.email_plan_response import EmailPlanResponse
 from ultracart.model.email_postcard_tracking_response import EmailPostcardTrackingResponse
+from ultracart.model.email_rate_limiters_response import EmailRateLimitersResponse
 from ultracart.model.email_segment import EmailSegment
 from ultracart.model.email_segment_archive_response import EmailSegmentArchiveResponse
 from ultracart.model.email_segment_customers_response import EmailSegmentCustomersResponse
@@ -2692,6 +2693,65 @@ class StorefrontApi(object):
             },
             api_client=api_client
         )
+        self.get_email_commseq_rate_limiters_endpoint = _Endpoint(
+            settings={
+                'response_type': (EmailRateLimitersResponse,),
+                'auth': [
+                    'ultraCartBrowserApiKey',
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters',
+                'operation_id': 'get_email_commseq_rate_limiters',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'storefront_oid',
+                    'commseq_uuid',
+                ],
+                'required': [
+                    'storefront_oid',
+                    'commseq_uuid',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'storefront_oid':
+                        (int,),
+                    'commseq_uuid':
+                        (str,),
+                },
+                'attribute_map': {
+                    'storefront_oid': 'storefront_oid',
+                    'commseq_uuid': 'commseq_uuid',
+                },
+                'location_map': {
+                    'storefront_oid': 'path',
+                    'commseq_uuid': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.get_email_commseq_sms_stats_endpoint = _Endpoint(
             settings={
                 'response_type': (EmailStatSmsSummaryResponse,),
@@ -7933,6 +7993,65 @@ class StorefrontApi(object):
             },
             api_client=api_client
         )
+        self.reset_email_commseq_rate_limiters_endpoint = _Endpoint(
+            settings={
+                'response_type': None,
+                'auth': [
+                    'ultraCartBrowserApiKey',
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters',
+                'operation_id': 'reset_email_commseq_rate_limiters',
+                'http_method': 'DELETE',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'storefront_oid',
+                    'commseq_uuid',
+                ],
+                'required': [
+                    'storefront_oid',
+                    'commseq_uuid',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'storefront_oid':
+                        (int,),
+                    'commseq_uuid':
+                        (str,),
+                },
+                'attribute_map': {
+                    'storefront_oid': 'storefront_oid',
+                    'commseq_uuid': 'commseq_uuid',
+                },
+                'location_map': {
+                    'storefront_oid': 'path',
+                    'commseq_uuid': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.review_endpoint = _Endpoint(
             settings={
                 'response_type': (EmailCommseqEmailSendTestResponse,),
@@ -14280,6 +14399,92 @@ class StorefrontApi(object):
             commseq_postcard_uuid
         return self.get_email_commseq_postcard_tracking_endpoint.call_with_http_info(**kwargs)
 
+    def get_email_commseq_rate_limiters(
+        self,
+        storefront_oid,
+        commseq_uuid,
+        **kwargs
+    ):
+        """Get email commseq rate limiters  # 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_email_commseq_rate_limiters(storefront_oid, commseq_uuid, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            storefront_oid (int):
+            commseq_uuid (str):
+
+        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:
+            EmailRateLimitersResponse
+                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['storefront_oid'] = \
+            storefront_oid
+        kwargs['commseq_uuid'] = \
+            commseq_uuid
+        return self.get_email_commseq_rate_limiters_endpoint.call_with_http_info(**kwargs)
+
     def get_email_commseq_sms_stats(
         self,
         storefront_oid,
@@ -21855,6 +22060,92 @@ class StorefrontApi(object):
             commseq_step_uuid
         return self.release_email_commseq_step_waiting_endpoint.call_with_http_info(**kwargs)
 
+    def reset_email_commseq_rate_limiters(
+        self,
+        storefront_oid,
+        commseq_uuid,
+        **kwargs
+    ):
+        """Reset email commseq rate limiters (only callable by UltraCart Support)  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            storefront_oid (int):
+            commseq_uuid (str):
+
+        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['storefront_oid'] = \
+            storefront_oid
+        kwargs['commseq_uuid'] = \
+            commseq_uuid
+        return self.reset_email_commseq_rate_limiters_endpoint.call_with_http_info(**kwargs)
+
     def review(
         self,
         storefront_oid,

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.0.222/python'
+        self.user_agent = 'OpenAPI-Generator/4.0.224/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.0.222".\
+               "SDK Package Version: 4.0.224".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

ultracart/model/email_rate_limiter.py

@@ -0,0 +1,272 @@
+"""
+    UltraCart Rest API V2
+
+    UltraCart REST API Version 2  # noqa: E501
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@ultracart.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from ultracart.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from ultracart.exceptions import ApiAttributeError
+
+
+
+class EmailRateLimiter(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+    }
+
+    validations = {
+    }
+
+    @cached_property
+    def additional_properties_type():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+        """
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        return {
+            'available': (int,),  # noqa: E501
+            'limit': (int,),  # noqa: E501
+            'name': (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'available': 'available',  # noqa: E501
+        'limit': 'limit',  # noqa: E501
+        'name': 'name',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """EmailRateLimiter - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _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)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            available (int): [optional]  # noqa: E501
+            limit (int): [optional]  # noqa: E501
+            name (str): [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """EmailRateLimiter - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _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)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            available (int): [optional]  # noqa: E501
+            limit (int): [optional]  # noqa: E501
+            name (str): [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")

ultracart/model/email_rate_limiters_response.py

@@ -0,0 +1,292 @@
+"""
+    UltraCart Rest API V2
+
+    UltraCart REST API Version 2  # noqa: E501
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@ultracart.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from ultracart.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from ultracart.exceptions import ApiAttributeError
+
+
+def lazy_import():
+    from ultracart.model.email_rate_limiter import EmailRateLimiter
+    from ultracart.model.error import Error
+    from ultracart.model.response_metadata import ResponseMetadata
+    from ultracart.model.warning import Warning
+    globals()['EmailRateLimiter'] = EmailRateLimiter
+    globals()['Error'] = Error
+    globals()['ResponseMetadata'] = ResponseMetadata
+    globals()['Warning'] = Warning
+
+
+class EmailRateLimitersResponse(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+    }
+
+    validations = {
+    }
+
+    @cached_property
+    def additional_properties_type():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+        """
+        lazy_import()
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        lazy_import()
+        return {
+            'error': (Error,),  # noqa: E501
+            'metadata': (ResponseMetadata,),  # noqa: E501
+            'rate_limiters': ([EmailRateLimiter],),  # noqa: E501
+            'success': (bool,),  # noqa: E501
+            'warning': (Warning,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'error': 'error',  # noqa: E501
+        'metadata': 'metadata',  # noqa: E501
+        'rate_limiters': 'rate_limiters',  # noqa: E501
+        'success': 'success',  # noqa: E501
+        'warning': 'warning',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """EmailRateLimitersResponse - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _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)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            error (Error): [optional]  # noqa: E501
+            metadata (ResponseMetadata): [optional]  # noqa: E501
+            rate_limiters ([EmailRateLimiter]): [optional]  # noqa: E501
+            success (bool): Indicates if API call was successful. [optional]  # noqa: E501
+            warning (Warning): [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """EmailRateLimitersResponse - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _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)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            error (Error): [optional]  # noqa: E501
+            metadata (ResponseMetadata): [optional]  # noqa: E501
+            rate_limiters ([EmailRateLimiter]): [optional]  # noqa: E501
+            success (bool): Indicates if API call was successful. [optional]  # noqa: E501
+            warning (Warning): [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")

ultracart/model/order_query.py

@@ -88,6 +88,10 @@ class OrderQuery(ModelNormal):
             'APPLE_PAY': "Apple Pay",
             '_GOOGLE_PAY': " Google Pay",
         },
+        ('query_target',): {
+            'ORIGIN': "origin",
+            'CACHE': "cache",
+        },
     }
 
     validations = {
@@ -181,6 +185,7 @@ class OrderQuery(ModelNormal):
             'phone': (str,),  # noqa: E501
             'postal_code': (str,),  # noqa: E501
             'purchase_order_number': (str,),  # noqa: E501
+            'query_target': (str,),  # noqa: E501
             'refund_date_begin': (str,),  # noqa: E501
             'refund_date_end': (str,),  # noqa: E501
             'rma': (str,),  # noqa: E501
@@ -231,6 +236,7 @@ class OrderQuery(ModelNormal):
         'phone': 'phone',  # noqa: E501
         'postal_code': 'postal_code',  # noqa: E501
         'purchase_order_number': 'purchase_order_number',  # noqa: E501
+        'query_target': 'query_target',  # noqa: E501
         'refund_date_begin': 'refund_date_begin',  # noqa: E501
         'refund_date_end': 'refund_date_end',  # noqa: E501
         'rma': 'rma',  # noqa: E501
@@ -316,6 +322,7 @@ class OrderQuery(ModelNormal):
             phone (str): Phone. [optional]  # noqa: E501
             postal_code (str): Postal code. [optional]  # noqa: E501
             purchase_order_number (str): Purchase order number. [optional]  # noqa: E501
+            query_target (str): Query Target. [optional]  # noqa: E501
             refund_date_begin (str): Date/time that the order was refunded. [optional]  # noqa: E501
             refund_date_end (str): Date/time that the order was refunded. [optional]  # noqa: E501
             rma (str): RMA number. [optional]  # noqa: E501
@@ -443,6 +450,7 @@ class OrderQuery(ModelNormal):
             phone (str): Phone. [optional]  # noqa: E501
             postal_code (str): Postal code. [optional]  # noqa: E501
             purchase_order_number (str): Purchase order number. [optional]  # noqa: E501
+            query_target (str): Query Target. [optional]  # noqa: E501
             refund_date_begin (str): Date/time that the order was refunded. [optional]  # noqa: E501
             refund_date_end (str): Date/time that the order was refunded. [optional]  # noqa: E501
             rma (str): RMA number. [optional]  # noqa: E501

ultracart/models/__init__.py

@@ -427,6 +427,8 @@ from ultracart.model.email_plan_response import EmailPlanResponse
 from ultracart.model.email_postcard_stat import EmailPostcardStat
 from ultracart.model.email_postcard_tracking import EmailPostcardTracking
 from ultracart.model.email_postcard_tracking_response import EmailPostcardTrackingResponse
+from ultracart.model.email_rate_limiter import EmailRateLimiter
+from ultracart.model.email_rate_limiters_response import EmailRateLimitersResponse
 from ultracart.model.email_segment import EmailSegment
 from ultracart.model.email_segment_archive_response import EmailSegmentArchiveResponse
 from ultracart.model.email_segment_customer import EmailSegmentCustomer

{ultracart_rest_sdk-4.0.222.dist-info → ultracart_rest_sdk-4.0.224.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ultracart-rest-sdk
-Version: 4.0.222
+Version: 4.0.224
 Summary: UltraCart Rest API V2
 Home-page: UNKNOWN
 Author: UltraCart Support

{ultracart_rest_sdk-4.0.222.dist-info → ultracart_rest_sdk-4.0.224.dist-info}/RECORD

@@ -1,6 +1,6 @@
-ultracart/__init__.py,sha256=E022fTln2L8FevjtqDlxgPsEABOxLXodzNA776zng3o,699
-ultracart/api_client.py,sha256=g4oB3Rpr3fnfMRI88jvW6qflmyZTNaZiSsL69fMyghU,39072
-ultracart/configuration.py,sha256=Gsx3xWKqWxk2QPHZ5b9e3s3iPjH3BOJDHxriWY71Vgk,17842
+ultracart/__init__.py,sha256=Mb4M6oaq4gNlrOQgUSvROiJUdHyJqmaIqdXGFXrNtFU,699
+ultracart/api_client.py,sha256=N0U--Kn-kx0NWJS98A0ShvxagKw421YC1H0psc47cZQ,39072
+ultracart/configuration.py,sha256=nzsKECfCpnZW9nWktPfGcEB6CzREIRKvuRGSTKEuOwM,17842
 ultracart/exceptions.py,sha256=dwRtrWJsW4H_jKk3B1w2chykcQ7E2FSlhftUByD9e9E,5069
 ultracart/model_utils.py,sha256=X_RAfA-TlvDKBICnIve7PPVDM34Nl58aV1bqCrVmoTo,82574
 ultracart/rest.py,sha256=2lM6zwrjGp_SjkddamoKdpk3jFuc8Ow7fKIXRdKNp24,14268
@@ -21,7 +21,7 @@ ultracart/api/item_api.py,sha256=RSJzispf9uhcHsYQDI4SM20Yx9Kpze7292XxkXcNpq8,129
 ultracart/api/oauth_api.py,sha256=oYx-F4WFF3LgMlHP-4x_gcSwS95-9Lowiwcgr5Rziyw,13636
 ultracart/api/order_api.py,sha256=Mc1Mru5z7-BrN0fhnQs3xEjxwICrFkk4dIIuGraKy44,161058
 ultracart/api/sso_api.py,sha256=Ct9oau71nCUKecojo_1kkXRcIqPxhlVZiST2bdjLJJ8,21632
-ultracart/api/storefront_api.py,sha256=WymB8Zoi_YYgIj5F4PJrKuoOb7s6sV2QXDZ55m3Ep68,994705
+ultracart/api/storefront_api.py,sha256=ypeoPTvnliyAoXIASWlf2B1ohS3UFTpycEV8rEUdvLg,1005995
 ultracart/api/tax_api.py,sha256=aQZaRsIXlFNDPwXYAykApv3KaAGfV-ZHB6QPBbEK-P0,148671
 ultracart/api/user_api.py,sha256=LrzuXSpBa5V_rS8iRDRRhFYnUZN9fR2Y54FRnJ_fpiI,56627
 ultracart/api/webhook_api.py,sha256=cAk7ABZxsKE7dD1YRxdwLkj7M-GlQf1LiiKz7MBcqiU,46761
@@ -446,6 +446,8 @@ ultracart/model/email_plan_response.py,sha256=LOJLscDvGEA_n1kf67iveG8V3LTo3kq8nM
 ultracart/model/email_postcard_stat.py,sha256=-M5OCjFw74XJsPz_0vfwGzeAHZUvFmEFVVZ95Ir5xx4,20459
 ultracart/model/email_postcard_tracking.py,sha256=tJRESM9oGuZa89gdaZuZ62puYmRiR5IYOpk8d6XCY48,16866
 ultracart/model/email_postcard_tracking_response.py,sha256=Qc3LGXUNDm-FCSX-5jdRNv6npUi_EoFpp3LEpRD3Flg,12896
+ultracart/model/email_rate_limiter.py,sha256=bIF9SoG5fR7WpipCl676zzuUmLKgjMHImDtSUHsTFU0,11783
+ultracart/model/email_rate_limiters_response.py,sha256=ZgwzURVelWN3-uXxk6HQWnS_KQJNdspaXFrpAYZFnH0,12880
 ultracart/model/email_segment.py,sha256=mqsnJTKdXD2iR1FONgObFh24yWHMzX8B4Er1f6ceP4Y,19182
 ultracart/model/email_segment_archive_response.py,sha256=fFjAgmVHrsXJlLAU5_oK5Qu5LJNVVp9-ndjhYgvKjfg,12728
 ultracart/model/email_segment_customer.py,sha256=TCGTl4E_QWFK9Szs9J5yrsvg8Wa9smJ-PHAqy6C_Jw8,12287
@@ -679,7 +681,7 @@ ultracart/model/order_point_of_sale.py,sha256=5PcsqLiP1BR7nePLXEqSF1jIFid0eco2dc
 ultracart/model/order_process_payment_request.py,sha256=J9_DP7vtyLyvyAMxoUc2s5e49DrYsAP7hSYBasUc4pU,12147
 ultracart/model/order_process_payment_response.py,sha256=mp3Jdx6-Rp5DXPhUpja2jKArwsgYCsTpYuKuds7MLKs,12959
 ultracart/model/order_property.py,sha256=TTwNAPFD0xn200o_d9xJnLVIOw2F_Kgs8veYbx7JD1Q,12365
-ultracart/model/order_query.py,sha256=B20ISgIg4N6fLPj4QkeNK3qNbETQj7f0sIg9kIVzf8k,25064
+ultracart/model/order_query.py,sha256=ZswAfhXL946t5XlWRK8vNzhxN1qGRsKKeAPFI1Yz2sU,25412
 ultracart/model/order_query_batch.py,sha256=a4wi9dX8Oi85SGTkPwSWUv6s1x6tKC2w0i16WYyFvGs,11447
 ultracart/model/order_quote.py,sha256=rearxF0qL6u7uhstszLj2iajryy7om5nGc_LiFgtZuI,12012
 ultracart/model/order_reason.py,sha256=OOSWtof1CiNxPxVo5jliywXnMTkrPdZ8PCK9pH2ty5Q,12225
@@ -876,9 +878,9 @@ ultracart/model/workflow_tasks_response.py,sha256=KmHe72xKnZiS9CemBr5hluY5EsU9_x
 ultracart/model/workflow_user.py,sha256=gkQIeMSIhawpz5wtpTJ8Lof_Td0IrwG0KZF6catE41k,11903
 ultracart/model/workflow_user_response.py,sha256=TKfMu5vF1fXlV8mvxRFhvk6WNdGce2T8a4vFycQvuhQ,12785
 ultracart/model/workflow_users_response.py,sha256=3Y7L1oHc2-HOvl1pDdcnl9xHKYLGblKpKdbkPBh2u68,13059
-ultracart/models/__init__.py,sha256=0VZcMHj-u6Zc6EOw-mQH_PPHT2FtR1T1Lzjalm0RbLI,65370
-ultracart_rest_sdk-4.0.222.dist-info/LICENSE,sha256=4DukHX-rIHAHaf5BGLq1DYAMt0-ZA1OgXS9f_xwig2M,11558
-ultracart_rest_sdk-4.0.222.dist-info/METADATA,sha256=-nke1Tho-iBhU_BEhHaHH7_6eKJliHRe3OEaGc_04Ts,403
-ultracart_rest_sdk-4.0.222.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
-ultracart_rest_sdk-4.0.222.dist-info/top_level.txt,sha256=90IoRqV6KX58jTyx9MwEBqh4j38_10hWrrvqsmXWZYo,10
-ultracart_rest_sdk-4.0.222.dist-info/RECORD,,
+ultracart/models/__init__.py,sha256=I2Mi2O700v6AG_0ofAKCYHoioXCFOuY2mrEEz-_28Ck,65517
+ultracart_rest_sdk-4.0.224.dist-info/LICENSE,sha256=4DukHX-rIHAHaf5BGLq1DYAMt0-ZA1OgXS9f_xwig2M,11558
+ultracart_rest_sdk-4.0.224.dist-info/METADATA,sha256=GIfcMY0h9FdWjRnh284N0ihdJex6YvEuXSsDLxaUuTw,403
+ultracart_rest_sdk-4.0.224.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
+ultracart_rest_sdk-4.0.224.dist-info/top_level.txt,sha256=90IoRqV6KX58jTyx9MwEBqh4j38_10hWrrvqsmXWZYo,10
+ultracart_rest_sdk-4.0.224.dist-info/RECORD,,