ultracart-rest-sdk 4.0.168__tar.gz → 4.0.170__tar.gz

{ultracart_rest_sdk-4.0.168 → ultracart_rest_sdk-4.0.170}/PKG-INFO

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

{ultracart_rest_sdk-4.0.168 → ultracart_rest_sdk-4.0.170}/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.168
+- Package version: 4.0.170
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -307,6 +307,7 @@ Class | Method | HTTP request | Description
 *OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
 *OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
 *OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
+*OrderApi* | [**validate_order**](docs/OrderApi.md#validate_order) | **POST** /order/validate | Validate
 *SsoApi* | [**get_sso_session_user**](docs/SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
 *SsoApi* | [**sso_authorize**](docs/SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
 *SsoApi* | [**sso_session_revoke**](docs/SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
@@ -1153,6 +1154,8 @@ Class | Method | HTTP request | Description
  - [OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
  - [OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
  - [OrderUtm](docs/OrderUtm.md)
+ - [OrderValidationRequest](docs/OrderValidationRequest.md)
+ - [OrderValidationResponse](docs/OrderValidationResponse.md)
  - [OrdersResponse](docs/OrdersResponse.md)
  - [Permission](docs/Permission.md)
  - [PointOfSaleLocation](docs/PointOfSaleLocation.md)
@@ -1407,6 +1410,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.170 | 08/14/2023 | esp - expose rate limiter values in settings object |
+| 4.0.169 | 07/27/2023 | dw bi - add settings to the report and page objects |
 | 4.0.168 | 07/19/2023 | dw bi - add data_source_uuid to filter connection obj |
 | 4.0.167 | 07/19/2023 | dw bi - add data_source_uuid to page visualization obj |
 | 4.0.166 | 07/19/2023 | dw bi - add data_source_uuid to report data source |

{ultracart_rest_sdk-4.0.168 → ultracart_rest_sdk-4.0.170}/setup.py

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

{ultracart_rest_sdk-4.0.168 → ultracart_rest_sdk-4.0.170}/ultracart/__init__.py

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

{ultracart_rest_sdk-4.0.168 → ultracart_rest_sdk-4.0.170}/ultracart/api/order_api.py

@@ -43,6 +43,8 @@ from ultracart.model.order_replacement import OrderReplacement
 from ultracart.model.order_replacement_response import OrderReplacementResponse
 from ultracart.model.order_response import OrderResponse
 from ultracart.model.order_token_response import OrderTokenResponse
+from ultracart.model.order_validation_request import OrderValidationRequest
+from ultracart.model.order_validation_response import OrderValidationResponse
 from ultracart.model.orders_response import OrdersResponse
 
 
@@ -1711,6 +1713,59 @@ class OrderApi(object):
             },
             api_client=api_client
         )
+        self.validate_order_endpoint = _Endpoint(
+            settings={
+                'response_type': (OrderValidationResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/order/validate',
+                'operation_id': 'validate_order',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'validation_request',
+                ],
+                'required': [
+                    'validation_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'validation_request':
+                        (OrderValidationRequest,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'validation_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
 
     def adjust_order_total(
         self,
@@ -3935,3 +3990,86 @@ class OrderApi(object):
             order
         return self.update_order_endpoint.call_with_http_info(**kwargs)
 
+    def validate_order(
+        self,
+        validation_request,
+        **kwargs
+    ):
+        """Validate  # noqa: E501
+
+        Validate the order for errors.  Specific checks can be passed to fine tune what is validated. Read and write permissions are required because the validate method may fix obvious address issues automatically which require update permission.This rest call makes use of the built-in translation of rest objects to UltraCart internal objects which also contains a multitude of validation checks that cannot be trapped.  Therefore any time this call is made, you should also trap api exceptions and examine their content because it may contain validation issues.  So check the response object and trap any exceptions.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.validate_order(validation_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            validation_request (OrderValidationRequest): Validation request
+
+        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:
+            OrderValidationResponse
+                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['validation_request'] = \
+            validation_request
+        return self.validate_order_endpoint.call_with_http_info(**kwargs)
+

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

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

{ultracart_rest_sdk-4.0.168 → ultracart_rest_sdk-4.0.170}/ultracart/model/email_settings.py

@@ -82,6 +82,9 @@ class EmailSettings(ModelNormal):
                 and the value is attribute type.
         """
         return {
+            'emails_per_day': (int,),  # noqa: E501
+            'emails_per_hour': (int,),  # noqa: E501
+            'emails_per_month': (int,),  # noqa: E501
             'marketing_esp_domain_user': (str,),  # noqa: E501
             'marketing_esp_domain_uuid': (str,),  # noqa: E501
             'marketing_esp_friendly_name': (str,),  # noqa: E501
@@ -105,6 +108,9 @@ class EmailSettings(ModelNormal):
 
 
     attribute_map = {
+        'emails_per_day': 'emails_per_day',  # noqa: E501
+        'emails_per_hour': 'emails_per_hour',  # noqa: E501
+        'emails_per_month': 'emails_per_month',  # noqa: E501
         'marketing_esp_domain_user': 'marketing_esp_domain_user',  # noqa: E501
         'marketing_esp_domain_uuid': 'marketing_esp_domain_uuid',  # noqa: E501
         'marketing_esp_friendly_name': 'marketing_esp_friendly_name',  # noqa: E501
@@ -163,6 +169,9 @@ class EmailSettings(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            emails_per_day (int): Emails per day allowed. [optional]  # noqa: E501
+            emails_per_hour (int): Emails per hour allowed. [optional]  # noqa: E501
+            emails_per_month (int): Emails per month allowed. [optional]  # noqa: E501
             marketing_esp_domain_user (str): [optional]  # noqa: E501
             marketing_esp_domain_uuid (str): [optional]  # noqa: E501
             marketing_esp_friendly_name (str): [optional]  # noqa: E501
@@ -263,6 +272,9 @@ class EmailSettings(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            emails_per_day (int): Emails per day allowed. [optional]  # noqa: E501
+            emails_per_hour (int): Emails per hour allowed. [optional]  # noqa: E501
+            emails_per_month (int): Emails per month allowed. [optional]  # noqa: E501
             marketing_esp_domain_user (str): [optional]  # noqa: E501
             marketing_esp_domain_uuid (str): [optional]  # noqa: E501
             marketing_esp_friendly_name (str): [optional]  # noqa: E501

{ultracart_rest_sdk-4.0.168 → ultracart_rest_sdk-4.0.170}/ultracart/model/order_payment.py

@@ -95,6 +95,8 @@ class OrderPayment(ModelNormal):
             'SHOP.COM': "Shop.com",
             'SEZZLE': "Sezzle",
             'VENMO': "Venmo",
+            'APPLE_PAY': "Apple Pay",
+            'GOOGLE_PAY': "Google Pay",
         },
         ('payment_status',): {
             'UNPROCESSED': "Unprocessed",

{ultracart_rest_sdk-4.0.168 → ultracart_rest_sdk-4.0.170}/ultracart/model/order_query.py

@@ -84,6 +84,9 @@ class OrderQuery(ModelNormal):
             'QUOTE_REQUEST': "Quote Request",
             'UNKNOWN': "Unknown",
             'WIRE_TRANSFER': "Wire Transfer",
+            'VENMO': "Venmo",
+            'APPLE_PAY': "Apple Pay",
+            '_GOOGLE_PAY': " Google Pay",
         },
     }
 

ultracart_rest_sdk-4.0.170/ultracart/model/order_validation_request.py

@@ -0,0 +1,274 @@
+"""
+    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.order import Order
+    globals()['Order'] = Order
+
+
+class OrderValidationRequest(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 {
+            'checks': ([str],),  # noqa: E501
+            'order': (Order,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'checks': 'checks',  # noqa: E501
+        'order': 'order',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """OrderValidationRequest - 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,)
+            checks ([str]): Checks to perform. [optional]  # noqa: E501
+            order (Order): [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
+        """OrderValidationRequest - 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,)
+            checks ([str]): Checks to perform. [optional]  # noqa: E501
+            order (Order): [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.")