ultracart-rest-sdk 4.1.20__tar.gz → 4.1.22__tar.gz

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/PKG-INFO

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

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.20
+- Package version: 4.1.22
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -97,6 +97,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.22 | 10/06/2025 | added Customer.fax back into object model |
+| 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
 | 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
 | 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
 | 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/setup.py

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

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/ultracart/__init__.py

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

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/ultracart/api/datawarehouse_api.py

@@ -31,6 +31,9 @@ from ultracart.model.custom_dashboards_response import CustomDashboardsResponse
 from ultracart.model.custom_report import CustomReport
 from ultracart.model.custom_report_account_config import CustomReportAccountConfig
 from ultracart.model.custom_report_account_config_response import CustomReportAccountConfigResponse
+from ultracart.model.custom_report_analysis_request import CustomReportAnalysisRequest
+from ultracart.model.custom_report_analysis_response import CustomReportAnalysisResponse
+from ultracart.model.custom_report_chart_png_upload_response import CustomReportChartPngUploadResponse
 from ultracart.model.custom_report_execution_request import CustomReportExecutionRequest
 from ultracart.model.custom_report_execution_response import CustomReportExecutionResponse
 from ultracart.model.custom_report_response import CustomReportResponse
@@ -71,6 +74,65 @@ class DatawarehouseApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
+        self.analyze_custom_report_endpoint = _Endpoint(
+            settings={
+                'response_type': (CustomReportAnalysisResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/datawarehouse/custom_reports/{custom_report_oid}/analysis',
+                'operation_id': 'analyze_custom_report',
+                'http_method': 'PUT',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'custom_report_oid',
+                    'analyze_request',
+                ],
+                'required': [
+                    'custom_report_oid',
+                    'analyze_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'custom_report_oid':
+                        (int,),
+                    'analyze_request':
+                        (CustomReportAnalysisRequest,),
+                },
+                'attribute_map': {
+                    'custom_report_oid': 'custom_report_oid',
+                },
+                'location_map': {
+                    'custom_report_oid': 'path',
+                    'analyze_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json; charset=UTF-8'
+                ]
+            },
+            api_client=api_client
+        )
         self.delete_custom_dashboard_endpoint = _Endpoint(
             settings={
                 'response_type': None,
@@ -749,6 +811,58 @@ class DatawarehouseApi(object):
             },
             api_client=api_client
         )
+        self.get_custom_report_chart_png_upload_url_endpoint = _Endpoint(
+            settings={
+                'response_type': (CustomReportChartPngUploadResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/datawarehouse/custom_reports/{custom_report_oid}/chart_png',
+                'operation_id': 'get_custom_report_chart_png_upload_url',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'custom_report_oid',
+                ],
+                'required': [
+                    'custom_report_oid',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'custom_report_oid':
+                        (int,),
+                },
+                'attribute_map': {
+                    'custom_report_oid': 'custom_report_oid',
+                },
+                'location_map': {
+                    'custom_report_oid': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.get_custom_reports_endpoint = _Endpoint(
             settings={
                 'response_type': (CustomReportsResponse,),
@@ -1560,6 +1674,93 @@ class DatawarehouseApi(object):
             api_client=api_client
         )
 
+    def analyze_custom_report(
+        self,
+        custom_report_oid,
+        analyze_request,
+        **kwargs
+    ):
+        """Analyze a custom report  # noqa: E501
+
+        Analyze a custom report on the UltraCart account.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.analyze_custom_report(custom_report_oid, analyze_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            custom_report_oid (int): The report oid to analyze.
+            analyze_request (CustomReportAnalysisRequest): Request to analyze custom report
+
+        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:
+            CustomReportAnalysisResponse
+                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['custom_report_oid'] = \
+            custom_report_oid
+        kwargs['analyze_request'] = \
+            analyze_request
+        return self.analyze_custom_report_endpoint.call_with_http_info(**kwargs)
+
     def delete_custom_dashboard(
         self,
         custom_dashboard_oid,
@@ -2637,6 +2838,89 @@ class DatawarehouseApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         return self.get_custom_report_account_config_endpoint.call_with_http_info(**kwargs)
 
+    def get_custom_report_chart_png_upload_url(
+        self,
+        custom_report_oid,
+        **kwargs
+    ):
+        """Upload a PNG of a custom report chart  # noqa: E501
+
+        Upload a PNG of a custom report chart   # 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_custom_report_chart_png_upload_url(custom_report_oid, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            custom_report_oid (int): The report oid to upload a chart PNG for.
+
+        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:
+            CustomReportChartPngUploadResponse
+                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['custom_report_oid'] = \
+            custom_report_oid
+        return self.get_custom_report_chart_png_upload_url_endpoint.call_with_http_info(**kwargs)
+
     def get_custom_reports(
         self,
         **kwargs

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/ultracart/api/order_api.py

@@ -46,6 +46,7 @@ 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
+from ultracart.model.replace_order_item_id_request import ReplaceOrderItemIdRequest
 
 
 class OrderApi(object):
@@ -1495,6 +1496,70 @@ class OrderApi(object):
             },
             api_client=api_client
         )
+        self.replace_order_item_merchant_item_id_endpoint = _Endpoint(
+            settings={
+                'response_type': (OrderResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/order/orders/{order_id}/replace_item_id',
+                'operation_id': 'replace_order_item_merchant_item_id',
+                'http_method': 'PUT',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'order_id',
+                    'replace_order_item_id_request',
+                    'expand',
+                ],
+                'required': [
+                    'order_id',
+                    'replace_order_item_id_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'order_id':
+                        (str,),
+                    'replace_order_item_id_request':
+                        (ReplaceOrderItemIdRequest,),
+                    'expand':
+                        (str,),
+                },
+                'attribute_map': {
+                    'order_id': 'order_id',
+                    'expand': '_expand',
+                },
+                'location_map': {
+                    'order_id': 'path',
+                    'replace_order_item_id_request': 'body',
+                    'expand': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json; charset=UTF-8'
+                ]
+            },
+            api_client=api_client
+        )
         self.replacement_endpoint = _Endpoint(
             settings={
                 'response_type': (OrderReplacementResponse,),
@@ -3765,6 +3830,94 @@ class OrderApi(object):
             order
         return self.refund_order_endpoint.call_with_http_info(**kwargs)
 
+    def replace_order_item_merchant_item_id(
+        self,
+        order_id,
+        replace_order_item_id_request,
+        **kwargs
+    ):
+        """Replaces an order item id  # noqa: E501
+
+        Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged.  A custom method requested by a merchant to allow for item id updates due to shipping errors.  It is doubtful you will ever need this method.  The expansion variable affects the returned order object.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.replace_order_item_merchant_item_id(order_id, replace_order_item_id_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            order_id (str): The order id to update.
+            replace_order_item_id_request (ReplaceOrderItemIdRequest): Replacement Request
+
+        Keyword Args:
+            expand (str): The object expansion to perform on the result.  See documentation for examples. [optional]
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            OrderResponse
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['order_id'] = \
+            order_id
+        kwargs['replace_order_item_id_request'] = \
+            replace_order_item_id_request
+        return self.replace_order_item_merchant_item_id_endpoint.call_with_http_info(**kwargs)
+
     def replacement(
         self,
         order_id,

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/ultracart/api_client.py

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

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/ultracart/configuration.py

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

{ultracart_rest_sdk-4.1.20 → ultracart_rest_sdk-4.1.22}/ultracart/model/custom_report_account_config.py

@@ -89,6 +89,7 @@ class CustomReportAccountConfig(ModelNormal):
             'opt_in': (bool,),  # noqa: E501
             'opt_in_by_user': (str,),  # noqa: E501
             'opt_in_date': (str,),  # noqa: E501
+            'read_only': (bool,),  # noqa: E501
             'sql_budget': (float,),  # noqa: E501
             'sql_usage': (float,),  # noqa: E501
         }
@@ -106,6 +107,7 @@ class CustomReportAccountConfig(ModelNormal):
         'opt_in': 'opt_in',  # noqa: E501
         'opt_in_by_user': 'opt_in_by_user',  # noqa: E501
         'opt_in_date': 'opt_in_date',  # noqa: E501
+        'read_only': 'read_only',  # noqa: E501
         'sql_budget': 'sql_budget',  # noqa: E501
         'sql_usage': 'sql_usage',  # noqa: E501
     }
@@ -158,6 +160,7 @@ class CustomReportAccountConfig(ModelNormal):
             opt_in (bool): True if they have opted into custom reports. [optional]  # noqa: E501
             opt_in_by_user (str): User that opted into custom reporting. [optional]  # noqa: E501
             opt_in_date (str): Date/time that custom reporting was opted in to. [optional]  # noqa: E501
+            read_only (bool): [optional]  # noqa: E501
             sql_budget (float): [optional]  # noqa: E501
             sql_usage (float): [optional]  # noqa: E501
         """
@@ -252,6 +255,7 @@ class CustomReportAccountConfig(ModelNormal):
             opt_in (bool): True if they have opted into custom reports. [optional]  # noqa: E501
             opt_in_by_user (str): User that opted into custom reporting. [optional]  # noqa: E501
             opt_in_date (str): Date/time that custom reporting was opted in to. [optional]  # noqa: E501
+            read_only (bool): [optional]  # noqa: E501
             sql_budget (float): [optional]  # noqa: E501
             sql_usage (float): [optional]  # noqa: E501
         """