ultracart-rest-sdk 4.1.14__py3-none-any.whl → 4.1.16__py3-none-any.whl

ultracart/api/order_api.py

@@ -128,6 +128,63 @@ class OrderApi(object):
             },
             api_client=api_client
         )
+        self.block_refund_on_order_endpoint = _Endpoint(
+            settings={
+                'response_type': None,
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/order/orders/{order_id}/refund_block',
+                'operation_id': 'block_refund_on_order',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'order_id',
+                    'block_reason',
+                ],
+                'required': [
+                    'order_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'order_id':
+                        (str,),
+                    'block_reason':
+                        (str,),
+                },
+                'attribute_map': {
+                    'order_id': 'order_id',
+                    'block_reason': 'block_reason',
+                },
+                'location_map': {
+                    'order_id': 'path',
+                    'block_reason': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.cancel_order_endpoint = _Endpoint(
             settings={
                 'response_type': (BaseResponse,),
@@ -1438,33 +1495,26 @@ class OrderApi(object):
             },
             api_client=api_client
         )
-        self.refund_order_completely_endpoint = _Endpoint(
+        self.replacement_endpoint = _Endpoint(
             settings={
-                'response_type': (OrderResponse,),
+                'response_type': (OrderReplacementResponse,),
                 'auth': [
                     'ultraCartOauth',
                     'ultraCartSimpleApiKey'
                 ],
-                'endpoint_path': '/order/orders/{order_id}/refund_completely',
-                'operation_id': 'refund_order_completely',
-                'http_method': 'PUT',
+                'endpoint_path': '/order/orders/{order_id}/replacement',
+                'operation_id': 'replacement',
+                'http_method': 'POST',
                 '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',
+                    'replacement',
                 ],
                 'required': [
                     'order_id',
+                    'replacement',
                 ],
                 'nullable': [
                 ],
@@ -1481,48 +1531,15 @@ class OrderApi(object):
                 '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,),
+                    'replacement':
+                        (OrderReplacement,),
                 },
                 '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',
+                    'replacement': 'body',
                 },
                 'collection_format_map': {
                 }
@@ -1531,30 +1548,30 @@ class OrderApi(object):
                 'accept': [
                     'application/json'
                 ],
-                'content_type': [],
+                'content_type': [
+                    'application/json'
+                ]
             },
             api_client=api_client
         )
-        self.replacement_endpoint = _Endpoint(
+        self.resend_receipt_endpoint = _Endpoint(
             settings={
-                'response_type': (OrderReplacementResponse,),
+                'response_type': (BaseResponse,),
                 'auth': [
                     'ultraCartOauth',
                     'ultraCartSimpleApiKey'
                 ],
-                'endpoint_path': '/order/orders/{order_id}/replacement',
-                'operation_id': 'replacement',
+                'endpoint_path': '/order/orders/{order_id}/resend_receipt',
+                'operation_id': 'resend_receipt',
                 'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
                     'order_id',
-                    'replacement',
                 ],
                 'required': [
                     'order_id',
-                    'replacement',
                 ],
                 'nullable': [
                 ],
@@ -1571,15 +1588,12 @@ class OrderApi(object):
                 'openapi_types': {
                     'order_id':
                         (str,),
-                    'replacement':
-                        (OrderReplacement,),
                 },
                 'attribute_map': {
                     'order_id': 'order_id',
                 },
                 'location_map': {
                     'order_id': 'path',
-                    'replacement': 'body',
                 },
                 'collection_format_map': {
                 }
@@ -1588,21 +1602,19 @@ class OrderApi(object):
                 'accept': [
                     'application/json'
                 ],
-                'content_type': [
-                    'application/json'
-                ]
+                'content_type': [],
             },
             api_client=api_client
         )
-        self.resend_receipt_endpoint = _Endpoint(
+        self.resend_shipment_confirmation_endpoint = _Endpoint(
             settings={
                 'response_type': (BaseResponse,),
                 'auth': [
                     'ultraCartOauth',
                     'ultraCartSimpleApiKey'
                 ],
-                'endpoint_path': '/order/orders/{order_id}/resend_receipt',
-                'operation_id': 'resend_receipt',
+                'endpoint_path': '/order/orders/{order_id}/resend_shipment_confirmation',
+                'operation_id': 'resend_shipment_confirmation',
                 'http_method': 'POST',
                 'servers': None,
             },
@@ -1646,16 +1658,16 @@ class OrderApi(object):
             },
             api_client=api_client
         )
-        self.resend_shipment_confirmation_endpoint = _Endpoint(
+        self.unblock_refund_on_order_endpoint = _Endpoint(
             settings={
-                'response_type': (BaseResponse,),
+                'response_type': None,
                 'auth': [
                     'ultraCartOauth',
                     'ultraCartSimpleApiKey'
                 ],
-                'endpoint_path': '/order/orders/{order_id}/resend_shipment_confirmation',
-                'operation_id': 'resend_shipment_confirmation',
-                'http_method': 'POST',
+                'endpoint_path': '/order/orders/{order_id}/refund_unblock',
+                'operation_id': 'unblock_refund_on_order',
+                'http_method': 'GET',
                 'servers': None,
             },
             params_map={
@@ -1956,6 +1968,90 @@ class OrderApi(object):
             desired_total
         return self.adjust_order_total_endpoint.call_with_http_info(**kwargs)
 
+    def block_refund_on_order(
+        self,
+        order_id,
+        **kwargs
+    ):
+        """Set a refund block on an order  # noqa: E501
+
+        Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.block_refund_on_order(order_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            order_id (str): The order id to block a refund on.
+
+        Keyword Args:
+            block_reason (str): Block reason code (optional). [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:
+            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['order_id'] = \
+            order_id
+        return self.block_refund_on_order_endpoint.call_with_http_info(**kwargs)
+
     def cancel_order(
         self,
         order_id,
@@ -3669,33 +3765,26 @@ class OrderApi(object):
             order
         return self.refund_order_endpoint.call_with_http_info(**kwargs)
 
-    def refund_order_completely(
+    def replacement(
         self,
         order_id,
+        replacement,
         **kwargs
     ):
-        """Refund an order completely  # noqa: E501
+        """Replacement order  # noqa: E501
 
-        Perform a refund operation on an order and then update the order if successful.   # noqa: E501
+        Create a replacement order based upon a previous order   # 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)
+        >>> thread = api.replacement(order_id, replacement, async_req=True)
         >>> result = thread.get()
 
         Args:
-            order_id (str): The order id to refund.
+            order_id (str): The order id to generate a replacement for.
+            replacement (OrderReplacement): Replacement order details
 
         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
@@ -3728,7 +3817,7 @@ class OrderApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            OrderResponse
+            OrderReplacementResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -3759,26 +3848,26 @@ class OrderApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['order_id'] = \
             order_id
-        return self.refund_order_completely_endpoint.call_with_http_info(**kwargs)
+        kwargs['replacement'] = \
+            replacement
+        return self.replacement_endpoint.call_with_http_info(**kwargs)
 
-    def replacement(
+    def resend_receipt(
         self,
         order_id,
-        replacement,
         **kwargs
     ):
-        """Replacement order  # noqa: E501
+        """Resend receipt  # noqa: E501
 
-        Create a replacement order based upon a previous order   # noqa: E501
+        Resend the receipt for an order 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.replacement(order_id, replacement, async_req=True)
+        >>> thread = api.resend_receipt(order_id, async_req=True)
         >>> result = thread.get()
 
         Args:
-            order_id (str): The order id to generate a replacement for.
-            replacement (OrderReplacement): Replacement order details
+            order_id (str): The order id to resend the receipt for.
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -3813,7 +3902,7 @@ class OrderApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            OrderReplacementResponse
+            BaseResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -3844,26 +3933,24 @@ class OrderApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['order_id'] = \
             order_id
-        kwargs['replacement'] = \
-            replacement
-        return self.replacement_endpoint.call_with_http_info(**kwargs)
+        return self.resend_receipt_endpoint.call_with_http_info(**kwargs)
 
-    def resend_receipt(
+    def resend_shipment_confirmation(
         self,
         order_id,
         **kwargs
     ):
-        """Resend receipt  # noqa: E501
+        """Resend shipment confirmation  # noqa: E501
 
-        Resend the receipt for an order on the UltraCart account.   # noqa: E501
+        Resend shipment confirmation for an order 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.resend_receipt(order_id, async_req=True)
+        >>> thread = api.resend_shipment_confirmation(order_id, async_req=True)
         >>> result = thread.get()
 
         Args:
-            order_id (str): The order id to resend the receipt for.
+            order_id (str): The order id to resend the shipment notification for.
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -3929,24 +4016,24 @@ class OrderApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['order_id'] = \
             order_id
-        return self.resend_receipt_endpoint.call_with_http_info(**kwargs)
+        return self.resend_shipment_confirmation_endpoint.call_with_http_info(**kwargs)
 
-    def resend_shipment_confirmation(
+    def unblock_refund_on_order(
         self,
         order_id,
         **kwargs
     ):
-        """Resend shipment confirmation  # noqa: E501
+        """Remove a refund block on an order  # noqa: E501
 
-        Resend shipment confirmation for an order on the UltraCart account.   # noqa: E501
+        Removes a refund block on an order to prevent a user from performing a refund.   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.resend_shipment_confirmation(order_id, async_req=True)
+        >>> thread = api.unblock_refund_on_order(order_id, async_req=True)
         >>> result = thread.get()
 
         Args:
-            order_id (str): The order id to resend the shipment notification for.
+            order_id (str): The order id to unblock a refund on.
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -3981,7 +4068,7 @@ class OrderApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            BaseResponse
+            None
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -4012,7 +4099,7 @@ class OrderApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['order_id'] = \
             order_id
-        return self.resend_shipment_confirmation_endpoint.call_with_http_info(**kwargs)
+        return self.unblock_refund_on_order_endpoint.call_with_http_info(**kwargs)
 
     def update_accounts_receivable_retry_config(
         self,

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/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.14/python'
+        self.user_agent = 'OpenAPI-Generator/4.1.16/python'
 
     def __enter__(self):
         return self

ultracart/configuration.py

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

ultracart/model/cart_upsell_after.py

@@ -88,6 +88,8 @@ class CartUpsellAfter(ModelNormal):
             'finalize_after_dts': (str,),  # noqa: E501
             'finalize_after_minutes': (int,),  # noqa: E501
             'upsell_path_code': (str,),  # noqa: E501
+            'upsell_path_name': (str,),  # noqa: E501
+            'upsell_path_variation': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -99,6 +101,8 @@ class CartUpsellAfter(ModelNormal):
         'finalize_after_dts': 'finalize_after_dts',  # noqa: E501
         'finalize_after_minutes': 'finalize_after_minutes',  # noqa: E501
         'upsell_path_code': 'upsell_path_code',  # noqa: E501
+        'upsell_path_name': 'upsell_path_name',  # noqa: E501
+        'upsell_path_variation': 'upsell_path_variation',  # noqa: E501
     }
 
     read_only_vars = {
@@ -144,7 +148,9 @@ class CartUpsellAfter(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             finalize_after_dts (str): The date/time after which the cart will finalize into an order.. [optional]  # noqa: E501
             finalize_after_minutes (int): The amount of inactivity in minutes after which the cart should be finalized into an order.  This will calculate the finalize_after_dts field.. [optional]  # noqa: E501
-            upsell_path_code (str): Upsell path code. [optional]  # noqa: E501
+            upsell_path_code (str): Upsell path code (this is for legacy upsells only). [optional]  # noqa: E501
+            upsell_path_name (str): Upsell path name to start on (StoreFront Upsells).  Will only be respected on a handoff API call.. [optional]  # noqa: E501
+            upsell_path_variation (str): Upsell path variation to start on (StoreFront Upsells).   Will only be respected on a handoff API call.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -232,7 +238,9 @@ class CartUpsellAfter(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             finalize_after_dts (str): The date/time after which the cart will finalize into an order.. [optional]  # noqa: E501
             finalize_after_minutes (int): The amount of inactivity in minutes after which the cart should be finalized into an order.  This will calculate the finalize_after_dts field.. [optional]  # noqa: E501
-            upsell_path_code (str): Upsell path code. [optional]  # noqa: E501
+            upsell_path_code (str): Upsell path code (this is for legacy upsells only). [optional]  # noqa: E501
+            upsell_path_name (str): Upsell path name to start on (StoreFront Upsells).  Will only be respected on a handoff API call.. [optional]  # noqa: E501
+            upsell_path_variation (str): Upsell path variation to start on (StoreFront Upsells).   Will only be respected on a handoff API call.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)