ultracart-rest-sdk 4.1.15__tar.gz → 4.1.16__tar.gz

{ultracart_rest_sdk-4.1.15 → ultracart_rest_sdk-4.1.16}/PKG-INFO

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

{ultracart_rest_sdk-4.1.15 → ultracart_rest_sdk-4.1.16}/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.15
+- Package version: 4.1.16
 - 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,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.16 | 07/28/2025 | updated doc samples |
 | 4.1.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
 | 4.1.14 | 07/10/2025 | automation test |
 | 4.1.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |

{ultracart_rest_sdk-4.1.15 → ultracart_rest_sdk-4.1.16}/setup.py

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

{ultracart_rest_sdk-4.1.15 → ultracart_rest_sdk-4.1.16}/ultracart/__init__.py

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

{ultracart_rest_sdk-4.1.15 → ultracart_rest_sdk-4.1.16}/ultracart/api/datawarehouse_api.py

@@ -27,6 +27,7 @@ from ultracart.model.custom_report_account_config import CustomReportAccountConf
 from ultracart.model.custom_report_account_config_response import CustomReportAccountConfigResponse
 from ultracart.model.custom_report_execution_request import CustomReportExecutionRequest
 from ultracart.model.custom_report_response import CustomReportResponse
+from ultracart.model.custom_reports_response import CustomReportsResponse
 from ultracart.model.error_response import ErrorResponse
 from ultracart.model.report import Report
 from ultracart.model.report_auth_response import ReportAuthResponse
@@ -427,6 +428,51 @@ class DatawarehouseApi(object):
             },
             api_client=api_client
         )
+        self.get_custom_reports_endpoint = _Endpoint(
+            settings={
+                'response_type': (CustomReportsResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/datawarehouse/custom_reports',
+                'operation_id': 'get_custom_reports',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.get_report_endpoint = _Endpoint(
             settings={
                 'response_type': (ReportResponse,),
@@ -1537,6 +1583,84 @@ 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_reports(
+        self,
+        **kwargs
+    ):
+        """Get custom reports  # noqa: E501
+
+        Retrieve a custom reports   # 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_reports(async_req=True)
+        >>> result = thread.get()
+
+
+        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:
+            CustomReportsResponse
+                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)
+        return self.get_custom_reports_endpoint.call_with_http_info(**kwargs)
+
     def get_report(
         self,
         report_oid,

{ultracart_rest_sdk-4.1.15 → ultracart_rest_sdk-4.1.16}/ultracart/api/order_api.py

@@ -137,7 +137,7 @@ class OrderApi(object):
                 ],
                 'endpoint_path': '/order/orders/{order_id}/refund_block',
                 'operation_id': 'block_refund_on_order',
-                'http_method': 'POST',
+                'http_method': 'GET',
                 'servers': None,
             },
             params_map={
@@ -1495,103 +1495,6 @@ class OrderApi(object):
             },
             api_client=api_client
         )
-        self.refund_order_completely_endpoint = _Endpoint(
-            settings={
-                'response_type': (OrderResponse,),
-                'auth': [
-                    'ultraCartOauth',
-                    'ultraCartSimpleApiKey'
-                ],
-                'endpoint_path': '/order/orders/{order_id}/refund_completely',
-                'operation_id': 'refund_order_completely',
-                'http_method': 'PUT',
-                'servers': None,
-            },
-            params_map={
-                'all': [
-                    'order_id',
-                    'reject_after_refund',
-                    'skip_customer_notification',
-                    'auto_order_cancel',
-                    'manual_refund',
-                    'reverse_affiliate_transactions',
-                    'issue_store_credit',
-                    'auto_order_cancel_reason',
-                    'refund_reason',
-                    'reject_reason',
-                ],
-                'required': [
-                    'order_id',
-                ],
-                'nullable': [
-                ],
-                'enum': [
-                ],
-                'validation': [
-                ]
-            },
-            root_map={
-                'validations': {
-                },
-                'allowed_values': {
-                },
-                'openapi_types': {
-                    'order_id':
-                        (str,),
-                    'reject_after_refund':
-                        (bool,),
-                    'skip_customer_notification':
-                        (bool,),
-                    'auto_order_cancel':
-                        (bool,),
-                    'manual_refund':
-                        (bool,),
-                    'reverse_affiliate_transactions':
-                        (bool,),
-                    'issue_store_credit':
-                        (bool,),
-                    'auto_order_cancel_reason':
-                        (str,),
-                    'refund_reason':
-                        (str,),
-                    'reject_reason':
-                        (str,),
-                },
-                'attribute_map': {
-                    'order_id': 'order_id',
-                    'reject_after_refund': 'reject_after_refund',
-                    'skip_customer_notification': 'skip_customer_notification',
-                    'auto_order_cancel': 'auto_order_cancel',
-                    'manual_refund': 'manual_refund',
-                    'reverse_affiliate_transactions': 'reverse_affiliate_transactions',
-                    'issue_store_credit': 'issue_store_credit',
-                    'auto_order_cancel_reason': 'auto_order_cancel_reason',
-                    'refund_reason': 'refund_reason',
-                    'reject_reason': 'reject_reason',
-                },
-                'location_map': {
-                    'order_id': 'path',
-                    'reject_after_refund': 'query',
-                    'skip_customer_notification': 'query',
-                    'auto_order_cancel': 'query',
-                    'manual_refund': 'query',
-                    'reverse_affiliate_transactions': 'query',
-                    'issue_store_credit': 'query',
-                    'auto_order_cancel_reason': 'query',
-                    'refund_reason': 'query',
-                    'reject_reason': 'query',
-                },
-                'collection_format_map': {
-                }
-            },
-            headers_map={
-                'accept': [
-                    'application/json'
-                ],
-                'content_type': [],
-            },
-            api_client=api_client
-        )
         self.replacement_endpoint = _Endpoint(
             settings={
                 'response_type': (OrderReplacementResponse,),
@@ -1764,7 +1667,7 @@ class OrderApi(object):
                 ],
                 'endpoint_path': '/order/orders/{order_id}/refund_unblock',
                 'operation_id': 'unblock_refund_on_order',
-                'http_method': 'POST',
+                'http_method': 'GET',
                 'servers': None,
             },
             params_map={
@@ -3862,98 +3765,6 @@ class OrderApi(object):
             order
         return self.refund_order_endpoint.call_with_http_info(**kwargs)
 
-    def refund_order_completely(
-        self,
-        order_id,
-        **kwargs
-    ):
-        """Refund an order completely  # noqa: E501
-
-        Perform a refund operation on an order and then update the order if successful.   # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.refund_order_completely(order_id, async_req=True)
-        >>> result = thread.get()
-
-        Args:
-            order_id (str): The order id to refund.
-
-        Keyword Args:
-            reject_after_refund (bool): Reject order after refund. [optional] if omitted the server will use the default value of False
-            skip_customer_notification (bool): Skip customer email notification. [optional] if omitted the server will use the default value of False
-            auto_order_cancel (bool): Cancel associated auto orders. [optional] if omitted the server will use the default value of False
-            manual_refund (bool): Consider a manual refund done externally. [optional] if omitted the server will use the default value of False
-            reverse_affiliate_transactions (bool): Reverse affiliate transactions. [optional] if omitted the server will use the default value of True
-            issue_store_credit (bool): Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account. [optional] if omitted the server will use the default value of False
-            auto_order_cancel_reason (str): Reason for auto orders cancellation. [optional]
-            refund_reason (str): Reason for refund. [optional]
-            reject_reason (str): Reason for reject. [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
-        return self.refund_order_completely_endpoint.call_with_http_info(**kwargs)
-
     def replacement(
         self,
         order_id,

{ultracart_rest_sdk-4.1.15 → ultracart_rest_sdk-4.1.16}/ultracart/api/webhook_api.py

@@ -231,14 +231,6 @@ class WebhookApi(object):
             params_map={
                 'all': [
                     'webhook_oid',
-                    'request_id',
-                    'begin_date',
-                    'end_date',
-                    'status',
-                    'event',
-                    'order_id',
-                    'request',
-                    'duration',
                     'limit',
                     'offset',
                     'since',
@@ -261,22 +253,6 @@ class WebhookApi(object):
                 'openapi_types': {
                     'webhook_oid':
                         (int,),
-                    'request_id':
-                        (str,),
-                    'begin_date':
-                        (str,),
-                    'end_date':
-                        (str,),
-                    'status':
-                        (str,),
-                    'event':
-                        (str,),
-                    'order_id':
-                        (str,),
-                    'request':
-                        (str,),
-                    'duration':
-                        (int,),
                     'limit':
                         (int,),
                     'offset':
@@ -286,28 +262,12 @@ class WebhookApi(object):
                 },
                 'attribute_map': {
                     'webhook_oid': 'webhookOid',
-                    'request_id': 'requestId',
-                    'begin_date': 'beginDate',
-                    'end_date': 'endDate',
-                    'status': 'status',
-                    'event': 'event',
-                    'order_id': 'orderId',
-                    'request': 'request',
-                    'duration': 'duration',
                     'limit': '_limit',
                     'offset': '_offset',
                     'since': '_since',
                 },
                 'location_map': {
                     'webhook_oid': 'path',
-                    'request_id': 'query',
-                    'begin_date': 'query',
-                    'end_date': 'query',
-                    'status': 'query',
-                    'event': 'query',
-                    'order_id': 'query',
-                    'request': 'query',
-                    'duration': 'query',
                     'limit': 'query',
                     'offset': 'query',
                     'since': 'query',
@@ -840,14 +800,6 @@ class WebhookApi(object):
             webhook_oid (int): The webhook oid to retrieve log summaries for.
 
         Keyword Args:
-            request_id (str): [optional]
-            begin_date (str): [optional]
-            end_date (str): [optional]
-            status (str): [optional]
-            event (str): [optional]
-            order_id (str): [optional]
-            request (str): [optional]
-            duration (int): [optional]
             limit (int): The maximum number of records to return on this one API call.. [optional] if omitted the server will use the default value of 100
             offset (int): Pagination of the record set.  Offset is a zero based index.. [optional] if omitted the server will use the default value of 0
             since (str): Fetch log summaries that have been delivered since this date/time.. [optional]

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

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