click_and_drop_api 3.1.1__tar.gz → 3.3.0__tar.gz

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

@@ -1,9 +1,7 @@
 Metadata-Version: 2.4
 Name: click_and_drop_api
-Version: 3.1.1
+Version: 3.3.0
 Summary: ChannelShipper & Royal Mail Public API
-Home-page: 
-Author: OpenAPI Generator community
 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/
 Project-URL: Repository, https://github.com/niccokunzmann/python-royal-mail-click-and-drop-api
@@ -25,11 +23,10 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: urllib3<3.0.0,>=2.7.0
 Requires-Dist: python-dateutil>=2.8.2
-Requires-Dist: pydantic>=2
+Requires-Dist: pydantic>=2.11
 Requires-Dist: typing-extensions>=4.7.1
-Dynamic: author
 Dynamic: license-file
 
 # click-and-drop-api
@@ -49,6 +46,7 @@ Read about Royal Mail's Click & Drop API:
 
 - [Royal Mail Help Centre](https://help.parcel.royalmail.com/hc/en-gb/sections/360003305257-Click-Drop-API)
 - [Click & Drop API Specification](https://api.parcel.royalmail.com/)
+- [Click & Drop User Voice](https://clickanddrop.uservoice.com/)
 
 Links for this package:
 

{click_and_drop_api-3.1.1 → click_and_drop_api-3.3.0}/README.md

@@ -15,6 +15,7 @@ Read about Royal Mail's Click & Drop API:
 
 - [Royal Mail Help Centre](https://help.parcel.royalmail.com/hc/en-gb/sections/360003305257-Click-Drop-API)
 - [Click & Drop API Specification](https://api.parcel.royalmail.com/)
+- [Click & Drop User Voice](https://clickanddrop.uservoice.com/)
 
 Links for this package:
 

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

@@ -18,9 +18,13 @@ __version__ = "1.0.0"
 
 # Define package exports
 __all__ = [
+    "CarriersApi",
     "LabelsApi",
     "ManifestsApi",
+    "OlpServicesApi",
     "OrdersApi",
+    "ReturnsApi",
+    "ServicesApi",
     "VersionApi",
     "ApiResponse",
     "ApiClient",
@@ -31,6 +35,7 @@ __all__ = [
     "ApiKeyError",
     "ApiAttributeError",
     "ApiException",
+    "Address",
     "AddressRequest",
     "BillingDetailsRequest",
     "CreateOrderErrorResponse",
@@ -40,17 +45,25 @@ __all__ = [
     "CreateOrdersRequest",
     "CreateOrdersResponse",
     "CreatePackagesResponse",
+    "CreateReturnRequest",
+    "CreateReturnResponse",
+    "CreateReturnResponseShipment",
+    "CustomerReference",
     "DeleteOrdersResource",
     "DeletedOrderInfo",
     "DimensionsRequest",
     "ErrorResponse",
     "FailedOrderResponse",
+    "GetCarrierResource",
+    "GetCarrierServicesResource",
     "GetOrderDetailsResource",
     "GetOrderInfoResource",
     "GetOrderLineResult",
     "GetOrdersDetailsResponse",
     "GetOrdersResponse",
     "GetPostalDetailsResult",
+    "GetServiceResource",
+    "GetServicesResponse",
     "GetShippingDetailsResult",
     "GetTagDetailsResult",
     "GetVersionResource",
@@ -61,6 +74,8 @@ __all__ = [
     "ManifestErrorsErrorDetailsResponse",
     "ManifestErrorsResponse",
     "ManifestOrdersResponse",
+    "OlpServiceOption",
+    "OlpServicesResult",
     "OrderErrorInfo",
     "OrderErrorResponse",
     "OrderFieldResponse",
@@ -69,6 +84,9 @@ __all__ = [
     "ProductItemRequest",
     "RecipientDetailsRequest",
     "SenderDetailsRequest",
+    "ServiceCode",
+    "ServiceItem",
+    "Shipment",
     "ShipmentPackageRequest",
     "TagRequest",
     "UpdateOrderStatusRequest",
@@ -78,9 +96,13 @@ __all__ = [
 ]
 
 # import apis into sdk package
+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
@@ -95,6 +117,7 @@ from click_and_drop_api.exceptions import ApiAttributeError as ApiAttributeError
 from click_and_drop_api.exceptions import ApiException as ApiException
 
 # import models into sdk package
+from click_and_drop_api.models.address import Address as Address
 from click_and_drop_api.models.address_request import AddressRequest as AddressRequest
 from click_and_drop_api.models.billing_details_request import BillingDetailsRequest as BillingDetailsRequest
 from click_and_drop_api.models.create_order_error_response import CreateOrderErrorResponse as CreateOrderErrorResponse
@@ -104,17 +127,25 @@ from click_and_drop_api.models.create_order_response import CreateOrderResponse
 from click_and_drop_api.models.create_orders_request import CreateOrdersRequest as CreateOrdersRequest
 from click_and_drop_api.models.create_orders_response import CreateOrdersResponse as CreateOrdersResponse
 from click_and_drop_api.models.create_packages_response import CreatePackagesResponse as CreatePackagesResponse
+from click_and_drop_api.models.create_return_request import CreateReturnRequest as CreateReturnRequest
+from click_and_drop_api.models.create_return_response import CreateReturnResponse as CreateReturnResponse
+from click_and_drop_api.models.create_return_response_shipment import CreateReturnResponseShipment as CreateReturnResponseShipment
+from click_and_drop_api.models.customer_reference import CustomerReference as CustomerReference
 from click_and_drop_api.models.delete_orders_resource import DeleteOrdersResource as DeleteOrdersResource
 from click_and_drop_api.models.deleted_order_info import DeletedOrderInfo as DeletedOrderInfo
 from click_and_drop_api.models.dimensions_request import DimensionsRequest as DimensionsRequest
 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
 from click_and_drop_api.models.get_version_resource import GetVersionResource as GetVersionResource
@@ -125,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
@@ -133,6 +166,9 @@ from click_and_drop_api.models.postage_details_request import PostageDetailsRequ
 from click_and_drop_api.models.product_item_request import ProductItemRequest as ProductItemRequest
 from click_and_drop_api.models.recipient_details_request import RecipientDetailsRequest as RecipientDetailsRequest
 from click_and_drop_api.models.sender_details_request import SenderDetailsRequest as SenderDetailsRequest
+from click_and_drop_api.models.service_code import ServiceCode as ServiceCode
+from click_and_drop_api.models.service_item import ServiceItem as ServiceItem
+from click_and_drop_api.models.shipment import Shipment as Shipment
 from click_and_drop_api.models.shipment_package_request import ShipmentPackageRequest as ShipmentPackageRequest
 from click_and_drop_api.models.tag_request import TagRequest as TagRequest
 from click_and_drop_api.models.update_order_status_request import UpdateOrderStatusRequest as UpdateOrderStatusRequest

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

@@ -1,8 +1,12 @@
 # flake8: noqa
 
 # import apis into api package
+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.3.0/click_and_drop_api/api/carriers_api.py

@@ -0,0 +1,285 @@
+"""
+    ChannelShipper & Royal Mail Public API
+
+    Import your orders, retrieve your orders and generate labels.
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from typing import List
+from click_and_drop_api.models.get_carrier_resource import GetCarrierResource
+
+from click_and_drop_api.api_client import ApiClient, RequestSerialized
+from click_and_drop_api.api_response import ApiResponse
+from click_and_drop_api.rest import RESTResponseType
+
+
+class CarriersApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_carriers_async(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> List[GetCarrierResource]:
+        """Retrieve list of carriers for the account
+
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_carriers_async_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[GetCarrierResource]",
+            '401': None,
+            '500': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_carriers_async_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[List[GetCarrierResource]]:
+        """Retrieve list of carriers for the account
+
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_carriers_async_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[GetCarrierResource]",
+            '401': None,
+            '500': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_carriers_async_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Retrieve list of carriers for the account
+
+
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_carriers_async_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "List[GetCarrierResource]",
+            '401': None,
+            '500': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_carriers_async_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _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]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if not any(key.lower() == 'accept' for key in _header_params):
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Bearer'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/carriers',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+