click_and_drop_api 3.2.0__tar.gz → 3.3.0__tar.gz

{click_and_drop_api-3.2.0/click_and_drop_api.egg-info → click_and_drop_api-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: click_and_drop_api
-Version: 3.2.0
+Version: 3.3.0
 Summary: ChannelShipper & Royal Mail Public API
 Author-email: Nicco Kunzmann <niccokunzmann@rambler.ru>, OpenAPI Generator Community <team@openapitools.org>
 Project-URL: Documentation, https://niccokunzmann.github.io/python-royal-mail-click-and-drop-api/

{click_and_drop_api-3.2.0 → click_and_drop_api-3.3.0}/click_and_drop_api/__init__.py

@@ -21,8 +21,10 @@ __all__ = [
     "CarriersApi",
     "LabelsApi",
     "ManifestsApi",
+    "OlpServicesApi",
     "OrdersApi",
     "ReturnsApi",
+    "ServicesApi",
     "VersionApi",
     "ApiResponse",
     "ApiClient",
@@ -53,12 +55,14 @@ __all__ = [
     "ErrorResponse",
     "FailedOrderResponse",
     "GetCarrierResource",
+    "GetCarrierServicesResource",
     "GetOrderDetailsResource",
     "GetOrderInfoResource",
     "GetOrderLineResult",
     "GetOrdersDetailsResponse",
     "GetOrdersResponse",
     "GetPostalDetailsResult",
+    "GetServiceResource",
     "GetServicesResponse",
     "GetShippingDetailsResult",
     "GetTagDetailsResult",
@@ -70,6 +74,8 @@ __all__ = [
     "ManifestErrorsErrorDetailsResponse",
     "ManifestErrorsResponse",
     "ManifestOrdersResponse",
+    "OlpServiceOption",
+    "OlpServicesResult",
     "OrderErrorInfo",
     "OrderErrorResponse",
     "OrderFieldResponse",
@@ -93,8 +99,10 @@ __all__ = [
 from click_and_drop_api.api.carriers_api import CarriersApi as CarriersApi
 from click_and_drop_api.api.labels_api import LabelsApi as LabelsApi
 from click_and_drop_api.api.manifests_api import ManifestsApi as ManifestsApi
+from click_and_drop_api.api.olp_services_api import OlpServicesApi as OlpServicesApi
 from click_and_drop_api.api.orders_api import OrdersApi as OrdersApi
 from click_and_drop_api.api.returns_api import ReturnsApi as ReturnsApi
+from click_and_drop_api.api.services_api import ServicesApi as ServicesApi
 from click_and_drop_api.api.version_api import VersionApi as VersionApi
 
 # import ApiClient
@@ -129,12 +137,14 @@ from click_and_drop_api.models.dimensions_request import DimensionsRequest as Di
 from click_and_drop_api.models.error_response import ErrorResponse as ErrorResponse
 from click_and_drop_api.models.failed_order_response import FailedOrderResponse as FailedOrderResponse
 from click_and_drop_api.models.get_carrier_resource import GetCarrierResource as GetCarrierResource
+from click_and_drop_api.models.get_carrier_services_resource import GetCarrierServicesResource as GetCarrierServicesResource
 from click_and_drop_api.models.get_order_details_resource import GetOrderDetailsResource as GetOrderDetailsResource
 from click_and_drop_api.models.get_order_info_resource import GetOrderInfoResource as GetOrderInfoResource
 from click_and_drop_api.models.get_order_line_result import GetOrderLineResult as GetOrderLineResult
 from click_and_drop_api.models.get_orders_details_response import GetOrdersDetailsResponse as GetOrdersDetailsResponse
 from click_and_drop_api.models.get_orders_response import GetOrdersResponse as GetOrdersResponse
 from click_and_drop_api.models.get_postal_details_result import GetPostalDetailsResult as GetPostalDetailsResult
+from click_and_drop_api.models.get_service_resource import GetServiceResource as GetServiceResource
 from click_and_drop_api.models.get_services_response import GetServicesResponse as GetServicesResponse
 from click_and_drop_api.models.get_shipping_details_result import GetShippingDetailsResult as GetShippingDetailsResult
 from click_and_drop_api.models.get_tag_details_result import GetTagDetailsResult as GetTagDetailsResult
@@ -146,6 +156,8 @@ from click_and_drop_api.models.manifest_eligible_orders_request import ManifestE
 from click_and_drop_api.models.manifest_errors_error_details_response import ManifestErrorsErrorDetailsResponse as ManifestErrorsErrorDetailsResponse
 from click_and_drop_api.models.manifest_errors_response import ManifestErrorsResponse as ManifestErrorsResponse
 from click_and_drop_api.models.manifest_orders_response import ManifestOrdersResponse as ManifestOrdersResponse
+from click_and_drop_api.models.olp_service_option import OlpServiceOption as OlpServiceOption
+from click_and_drop_api.models.olp_services_result import OlpServicesResult as OlpServicesResult
 from click_and_drop_api.models.order_error_info import OrderErrorInfo as OrderErrorInfo
 from click_and_drop_api.models.order_error_response import OrderErrorResponse as OrderErrorResponse
 from click_and_drop_api.models.order_field_response import OrderFieldResponse as OrderFieldResponse

{click_and_drop_api-3.2.0 → click_and_drop_api-3.3.0}/click_and_drop_api/api/__init__.py

@@ -4,7 +4,9 @@
 from click_and_drop_api.api.carriers_api import CarriersApi
 from click_and_drop_api.api.labels_api import LabelsApi
 from click_and_drop_api.api.manifests_api import ManifestsApi
+from click_and_drop_api.api.olp_services_api import OlpServicesApi
 from click_and_drop_api.api.orders_api import OrdersApi
 from click_and_drop_api.api.returns_api import ReturnsApi
+from click_and_drop_api.api.services_api import ServicesApi
 from click_and_drop_api.api.version_api import VersionApi
 

{click_and_drop_api-3.2.0 → click_and_drop_api-3.3.0}/click_and_drop_api/api/carriers_api.py

@@ -239,7 +239,7 @@ class CarriersApi:
 
         _path_params: Dict[str, str] = {}
         _query_params: List[Tuple[str, str]] = []
-        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers)
         _form_params: List[Tuple[str, str]] = []
         _files: Dict[
             str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
@@ -254,7 +254,7 @@ class CarriersApi:
 
 
         # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
+        if not any(key.lower() == 'accept' for key in _header_params):
             _header_params['Accept'] = self.api_client.select_header_accept(
                 [
                     'application/json'

{click_and_drop_api-3.2.0 → click_and_drop_api-3.3.0}/click_and_drop_api/api/labels_api.py

@@ -41,9 +41,10 @@ class LabelsApi:
     def get_orders_label_async(
         self,
         order_identifiers: Annotated[StrictStr, Field(description="One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100.")],
-        document_type: Annotated[StrictStr, Field(description="Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\"")],
+        document_type: Annotated[StrictStr, Field(description="Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\". When documentType is set to \"commercialInvoice\" the includeCommercialInvoice parameter applies. ")],
         include_returns_label: Annotated[Optional[StrictBool], Field(description="Include returns label. Required when documentType is set to 'postageLabel'")] = None,
         include_cn: Annotated[Optional[StrictBool], Field(description="Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the \"Label format\" setting \"Generate customs declarations with orders\"")] = None,
+        include_commercial_invoice: Annotated[Optional[StrictBool], Field(description="Includes the commercial invoice with the label. Only applies when documentType is \"commercialInvoice\". ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -63,12 +64,14 @@ class LabelsApi:
 
         :param order_identifiers: One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100. (required)
         :type order_identifiers: str
-        :param document_type: Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\" (required)
+        :param document_type: Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\". When documentType is set to \"commercialInvoice\" the includeCommercialInvoice parameter applies.  (required)
         :type document_type: str
         :param include_returns_label: Include returns label. Required when documentType is set to 'postageLabel'
         :type include_returns_label: bool
         :param include_cn: Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the \"Label format\" setting \"Generate customs declarations with orders\"
         :type include_cn: bool
+        :param include_commercial_invoice: Includes the commercial invoice with the label. Only applies when documentType is \"commercialInvoice\". 
+        :type include_commercial_invoice: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -96,6 +99,7 @@ class LabelsApi:
             document_type=document_type,
             include_returns_label=include_returns_label,
             include_cn=include_cn,
+            include_commercial_invoice=include_commercial_invoice,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -125,9 +129,10 @@ class LabelsApi:
     def get_orders_label_async_with_http_info(
         self,
         order_identifiers: Annotated[StrictStr, Field(description="One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100.")],
-        document_type: Annotated[StrictStr, Field(description="Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\"")],
+        document_type: Annotated[StrictStr, Field(description="Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\". When documentType is set to \"commercialInvoice\" the includeCommercialInvoice parameter applies. ")],
         include_returns_label: Annotated[Optional[StrictBool], Field(description="Include returns label. Required when documentType is set to 'postageLabel'")] = None,
         include_cn: Annotated[Optional[StrictBool], Field(description="Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the \"Label format\" setting \"Generate customs declarations with orders\"")] = None,
+        include_commercial_invoice: Annotated[Optional[StrictBool], Field(description="Includes the commercial invoice with the label. Only applies when documentType is \"commercialInvoice\". ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -147,12 +152,14 @@ class LabelsApi:
 
         :param order_identifiers: One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100. (required)
         :type order_identifiers: str
-        :param document_type: Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\" (required)
+        :param document_type: Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\". When documentType is set to \"commercialInvoice\" the includeCommercialInvoice parameter applies.  (required)
         :type document_type: str
         :param include_returns_label: Include returns label. Required when documentType is set to 'postageLabel'
         :type include_returns_label: bool
         :param include_cn: Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the \"Label format\" setting \"Generate customs declarations with orders\"
         :type include_cn: bool
+        :param include_commercial_invoice: Includes the commercial invoice with the label. Only applies when documentType is \"commercialInvoice\". 
+        :type include_commercial_invoice: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -180,6 +187,7 @@ class LabelsApi:
             document_type=document_type,
             include_returns_label=include_returns_label,
             include_cn=include_cn,
+            include_commercial_invoice=include_commercial_invoice,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -209,9 +217,10 @@ class LabelsApi:
     def get_orders_label_async_without_preload_content(
         self,
         order_identifiers: Annotated[StrictStr, Field(description="One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100.")],
-        document_type: Annotated[StrictStr, Field(description="Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\"")],
+        document_type: Annotated[StrictStr, Field(description="Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\". When documentType is set to \"commercialInvoice\" the includeCommercialInvoice parameter applies. ")],
         include_returns_label: Annotated[Optional[StrictBool], Field(description="Include returns label. Required when documentType is set to 'postageLabel'")] = None,
         include_cn: Annotated[Optional[StrictBool], Field(description="Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the \"Label format\" setting \"Generate customs declarations with orders\"")] = None,
+        include_commercial_invoice: Annotated[Optional[StrictBool], Field(description="Includes the commercial invoice with the label. Only applies when documentType is \"commercialInvoice\". ")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -231,12 +240,14 @@ class LabelsApi:
 
         :param order_identifiers: One or several Order Identifiers or Order References separated by semicolon. Order Identifiers are integer numbers. Order References are strings - each must be percent-encoded and surrounded by double quotation marks. The maximum number of identifiers is 100. (required)
         :type order_identifiers: str
-        :param document_type: Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\" (required)
+        :param document_type: Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\". When documentType is set to \"commercialInvoice\" the includeCommercialInvoice parameter applies.  (required)
         :type document_type: str
         :param include_returns_label: Include returns label. Required when documentType is set to 'postageLabel'
         :type include_returns_label: bool
         :param include_cn: Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the \"Label format\" setting \"Generate customs declarations with orders\"
         :type include_cn: bool
+        :param include_commercial_invoice: Includes the commercial invoice with the label. Only applies when documentType is \"commercialInvoice\". 
+        :type include_commercial_invoice: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -264,6 +275,7 @@ class LabelsApi:
             document_type=document_type,
             include_returns_label=include_returns_label,
             include_cn=include_cn,
+            include_commercial_invoice=include_commercial_invoice,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -291,6 +303,7 @@ class LabelsApi:
         document_type,
         include_returns_label,
         include_cn,
+        include_commercial_invoice,
         _request_auth,
         _content_type,
         _headers,
@@ -304,7 +317,7 @@ class LabelsApi:
 
         _path_params: Dict[str, str] = {}
         _query_params: List[Tuple[str, str]] = []
-        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers)
         _form_params: List[Tuple[str, str]] = []
         _files: Dict[
             str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
@@ -327,13 +340,17 @@ class LabelsApi:
             
             _query_params.append(('includeCN', include_cn))
             
+        if include_commercial_invoice is not None:
+            
+            _query_params.append(('includeCommercialInvoice', include_commercial_invoice))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
 
 
         # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
+        if not any(key.lower() == 'accept' for key in _header_params):
             _header_params['Accept'] = self.api_client.select_header_accept(
                 [
                     'application/pdf', 

{click_and_drop_api-3.2.0 → click_and_drop_api-3.3.0}/click_and_drop_api/api/manifests_api.py

@@ -268,7 +268,7 @@ class ManifestsApi:
 
         _path_params: Dict[str, str] = {}
         _query_params: List[Tuple[str, str]] = []
-        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers)
         _form_params: List[Tuple[str, str]] = []
         _files: Dict[
             str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
@@ -285,7 +285,7 @@ class ManifestsApi:
 
 
         # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
+        if not any(key.lower() == 'accept' for key in _header_params):
             _header_params['Accept'] = self.api_client.select_header_accept(
                 [
                     'application/json'
@@ -547,7 +547,7 @@ class ManifestsApi:
 
         _path_params: Dict[str, str] = {}
         _query_params: List[Tuple[str, str]] = []
-        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers)
         _form_params: List[Tuple[str, str]] = []
         _files: Dict[
             str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
@@ -564,7 +564,7 @@ class ManifestsApi:
 
 
         # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
+        if not any(key.lower() == 'accept' for key in _header_params):
             _header_params['Accept'] = self.api_client.select_header_accept(
                 [
                     'application/json'
@@ -573,7 +573,7 @@ class ManifestsApi:
 
         # set the HTTP header `Content-Type`
         if _content_type:
-            _header_params['Content-Type'] = _content_type
+            self.api_client._set_header(_header_params, 'Content-Type', _content_type)
         else:
             _default_content_type = (
                 self.api_client.select_header_content_type(
@@ -583,7 +583,7 @@ class ManifestsApi:
                 )
             )
             if _default_content_type is not None:
-                _header_params['Content-Type'] = _default_content_type
+                self.api_client._set_header(_header_params, 'Content-Type', _default_content_type)
 
         # authentication setting
         _auth_settings: List[str] = [
@@ -839,7 +839,7 @@ class ManifestsApi:
 
         _path_params: Dict[str, str] = {}
         _query_params: List[Tuple[str, str]] = []
-        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _header_params: Dict[str, Any] = self.api_client._merge_headers(_headers)
         _form_params: List[Tuple[str, str]] = []
         _files: Dict[
             str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
@@ -856,7 +856,7 @@ class ManifestsApi:
 
 
         # set the HTTP header `Accept`
-        if 'Accept' not in _header_params:
+        if not any(key.lower() == 'accept' for key in _header_params):
             _header_params['Accept'] = self.api_client.select_header_accept(
                 [
                     'application/json'