ultracart-rest-sdk 4.0.223__tar.gz → 4.0.225__tar.gz

{ultracart_rest_sdk-4.0.223 → ultracart_rest_sdk-4.0.225}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: ultracart_rest_sdk
-Version: 4.0.223
+Version: 4.0.225
 Summary: UltraCart Rest API V2
 Home-page: UNKNOWN
 Author: UltraCart Support

{ultracart_rest_sdk-4.0.223 → ultracart_rest_sdk-4.0.225}/README.md

@@ -4,7 +4,7 @@ UltraCart REST API Version 2
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.223
+- Package version: 4.0.225
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -410,6 +410,7 @@ Class | Method | HTTP request | Description
 *StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
 *StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
 *StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
+*StorefrontApi* | [**get_email_commseq_rate_limiters**](docs/StorefrontApi.md#get_email_commseq_rate_limiters) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters | Get email commseq rate limiters
 *StorefrontApi* | [**get_email_commseq_sms_stats**](docs/StorefrontApi.md#get_email_commseq_sms_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats | Get email communication sequence sms stats
 *StorefrontApi* | [**get_email_commseq_stat_overall**](docs/StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
 *StorefrontApi* | [**get_email_commseq_step_stats**](docs/StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
@@ -499,6 +500,7 @@ Class | Method | HTTP request | Description
 *StorefrontApi* | [**publish_library_item**](docs/StorefrontApi.md#publish_library_item) | **POST** /storefront/code_library/{library_item_oid}/publish | Publish library item.
 *StorefrontApi* | [**purchase_library_item**](docs/StorefrontApi.md#purchase_library_item) | **POST** /storefront/code_library/{library_item_oid}/purchase | Purchase public library item, which creates a copy of the item in your personal code library
 *StorefrontApi* | [**release_email_commseq_step_waiting**](docs/StorefrontApi.md#release_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid} | Release email communication sequence customers waiting at the specified step
+*StorefrontApi* | [**reset_email_commseq_rate_limiters**](docs/StorefrontApi.md#reset_email_commseq_rate_limiters) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters | Reset email commseq rate limiters (only callable by UltraCart Support)
 *StorefrontApi* | [**review**](docs/StorefrontApi.md#review) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review | Request a review of an email
 *StorefrontApi* | [**search**](docs/StorefrontApi.md#search) | **GET** /storefront/search | Searches for all matching values
 *StorefrontApi* | [**search2**](docs/StorefrontApi.md#search2) | **POST** /storefront/search | Searches for all matching values (using POST)
@@ -1022,6 +1024,8 @@ Class | Method | HTTP request | Description
  - [EmailPostcardStat](docs/EmailPostcardStat.md)
  - [EmailPostcardTracking](docs/EmailPostcardTracking.md)
  - [EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
+ - [EmailRateLimiter](docs/EmailRateLimiter.md)
+ - [EmailRateLimitersResponse](docs/EmailRateLimitersResponse.md)
  - [EmailSegment](docs/EmailSegment.md)
  - [EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
  - [EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
@@ -1551,6 +1555,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.225 | 05/30/2024 | add adult sig req. to the merchant item destination markup for items |
+| 4.0.224 | 05/29/2024 | added methods getEmailCommseqRateLimiters, resetEmailCommseqRateLimiters |
 | 4.0.223 | 05/28/2024 | added property to OrderQuery object to allow querying from cache |
 | 4.0.222 | 05/17/2024 | conv.pbx time based config - changed name from default to default_mapping |
 | 4.0.221 | 05/16/2024 | OrderPayment - constants for payment method Amazon Pay and Link |

{ultracart_rest_sdk-4.0.223 → ultracart_rest_sdk-4.0.225}/setup.py

@@ -12,7 +12,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "ultracart_rest_sdk"
-VERSION = "4.0.223"
+VERSION = "4.0.225"
 # To install the library, run the following
 #
 # python setup.py install

{ultracart_rest_sdk-4.0.223 → ultracart_rest_sdk-4.0.225}/ultracart/__init__.py

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

{ultracart_rest_sdk-4.0.223 → ultracart_rest_sdk-4.0.225}/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_rest_sdk-4.0.223 → ultracart_rest_sdk-4.0.225}/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.223/python'
+        self.user_agent = 'OpenAPI-Generator/4.0.225/python'
 
     def __enter__(self):
         return self

{ultracart_rest_sdk-4.0.223 → ultracart_rest_sdk-4.0.225}/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.223".\
+               "SDK Package Version: 4.0.225".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):