diff --git a/README.md b/README.md index c9e9560..bcd9d31 100755 --- a/README.md +++ b/README.md @@ -52,11 +52,14 @@ except ApiException as e: - [Address](docs/Address.md) - [AddressData](docs/AddressData.md) +- [AddressList](docs/AddressList.md) +- [CarrierList](docs/CarrierList.md) - [CarrierSettings](docs/CarrierSettings.md) - [Charge](docs/Charge.md) - [Commodity](docs/Commodity.md) - [Customs](docs/Customs.md) - [CustomsData](docs/CustomsData.md) +- [CustomsList](docs/CustomsList.md) - [ErrorResponse](docs/ErrorResponse.md) - [LabelPrintingRequest](docs/LabelPrintingRequest.md) - [Message](docs/Message.md) @@ -65,12 +68,14 @@ except ApiException as e: - [OperationResponse](docs/OperationResponse.md) - [Parcel](docs/Parcel.md) - [ParcelData](docs/ParcelData.md) +- [ParcelList](docs/ParcelList.md) - [Payment](docs/Payment.md) - [PaymentData](docs/PaymentData.md) - [Pickup](docs/Pickup.md) - [PickupCancelData](docs/PickupCancelData.md) - [PickupCancelRequest](docs/PickupCancelRequest.md) - [PickupData](docs/PickupData.md) +- [PickupList](docs/PickupList.md) - [PickupRequest](docs/PickupRequest.md) - [PickupResponse](docs/PickupResponse.md) - [PickupUpdateData](docs/PickupUpdateData.md) @@ -82,8 +87,10 @@ except ApiException as e: - [Shipment](docs/Shipment.md) - [ShipmentCancelRequest](docs/ShipmentCancelRequest.md) - [ShipmentData](docs/ShipmentData.md) +- [ShipmentList](docs/ShipmentList.md) - [ShipmentPurchaseData](docs/ShipmentPurchaseData.md) - [ShippingRequest](docs/ShippingRequest.md) +- [TrackerList](docs/TrackerList.md) - [TrackingEvent](docs/TrackingEvent.md) - [TrackingResponse](docs/TrackingResponse.md) - [TrackingStatus](docs/TrackingStatus.md) diff --git a/docs/AddressList.md b/docs/AddressList.md new file mode 100644 index 0000000..1685d7e --- /dev/null +++ b/docs/AddressList.md @@ -0,0 +1,11 @@ +# AddressList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**list[Address]**](Address.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CarrierList.md b/docs/CarrierList.md new file mode 100644 index 0000000..4458bd9 --- /dev/null +++ b/docs/CarrierList.md @@ -0,0 +1,11 @@ +# CarrierList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**list[CarrierSettings]**](CarrierSettings.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CustomsList.md b/docs/CustomsList.md new file mode 100644 index 0000000..e5ed4d9 --- /dev/null +++ b/docs/CustomsList.md @@ -0,0 +1,11 @@ +# CustomsList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**list[Customs]**](Customs.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ParcelList.md b/docs/ParcelList.md new file mode 100644 index 0000000..e2bce8c --- /dev/null +++ b/docs/ParcelList.md @@ -0,0 +1,11 @@ +# ParcelList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**list[Parcel]**](Parcel.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Payment.md b/docs/Payment.md index c6e2076..5193c24 100644 --- a/docs/Payment.md +++ b/docs/Payment.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | A unique identifier | [optional] -**paid_by** | **str** | The payment payer | +**paid_by** | **str** | The payment payer | [optional] [default to 'sender'] **amount** | **float** | The payment amount if known | [optional] **currency** | **str** | The payment amount currency | **account_number** | **str** | The selected rate carrier payer account number | [optional] diff --git a/docs/PaymentData.md b/docs/PaymentData.md index c65d316..2415573 100644 --- a/docs/PaymentData.md +++ b/docs/PaymentData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**paid_by** | **str** | The payment payer | +**paid_by** | **str** | The payment payer | [optional] [default to 'sender'] **amount** | **float** | The payment amount if known | [optional] **currency** | **str** | The payment amount currency | **account_number** | **str** | The selected rate carrier payer account number | [optional] diff --git a/docs/PickupList.md b/docs/PickupList.md new file mode 100644 index 0000000..1dfd5f1 --- /dev/null +++ b/docs/PickupList.md @@ -0,0 +1,11 @@ +# PickupList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**list[Pickup]**](Pickup.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ShipmentList.md b/docs/ShipmentList.md new file mode 100644 index 0000000..843694c --- /dev/null +++ b/docs/ShipmentList.md @@ -0,0 +1,11 @@ +# ShipmentList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**list[Shipment]**](Shipment.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ShipmentsApi.md b/docs/ShipmentsApi.md deleted file mode 100644 index 4c13dee..0000000 --- a/docs/ShipmentsApi.md +++ /dev/null @@ -1,512 +0,0 @@ -# purplship.ShipmentsApi - -All URIs are relative to *https://app.purplship.com/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_customs**](ShipmentsApi.md#add_customs) | **POST** /shipments/{id}/customs | Add shipment customs declaration -[**add_parcel**](ShipmentsApi.md#add_parcel) | **POST** /shipments/{id}/parcels | Add a parcel to a shipment -[**cancel**](ShipmentsApi.md#cancel) | **DELETE** /shipments/{id} | Cancel a shipment -[**create**](ShipmentsApi.md#create) | **POST** /shipments | Create a shipment -[**list**](ShipmentsApi.md#list) | **GET** /shipments | List all shipments -[**purchase**](ShipmentsApi.md#purchase) | **POST** /shipments/{id}/purchase | Buy a shipment label -[**rates**](ShipmentsApi.md#rates) | **GET** /shipments/{id}/rates | Fetch new shipment rates -[**retrieve**](ShipmentsApi.md#retrieve) | **GET** /shipments/{id} | Retrieve a shipment -[**set_options**](ShipmentsApi.md#set_options) | **POST** /shipments/{id}/options | Add shipment options - -# **add_customs** -> Shipment add_customs(body, id) - -Add shipment customs declaration - -Add the customs declaration for the shipment if non existent. - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -body = purplship.CustomsData() # CustomsData | -id = 'id_example' # str | - -try: - # Add shipment customs declaration - api_response = api_instance.add_customs(body, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->add_customs: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**CustomsData**](CustomsData.md)| | - **id** | **str**| | - -### Return type - -[**Shipment**](Shipment.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **add_parcel** -> Shipment add_parcel(body, id) - -Add a parcel to a shipment - -Add a parcel to an existing shipment for a multi-parcel shipment. - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -body = purplship.ParcelData() # ParcelData | -id = 'id_example' # str | - -try: - # Add a parcel to a shipment - api_response = api_instance.add_parcel(body, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->add_parcel: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**ParcelData**](ParcelData.md)| | - **id** | **str**| | - -### Return type - -[**Shipment**](Shipment.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **cancel** -> OperationResponse cancel(id) - -Cancel a shipment - -Void a shipment with the associated label. - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -id = 'id_example' # str | - -try: - # Cancel a shipment - api_response = api_instance.cancel(id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->cancel: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - -### Return type - -[**OperationResponse**](OperationResponse.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create** -> Shipment create(body) - -Create a shipment - -Create a new shipment instance. - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -body = purplship.ShipmentData() # ShipmentData | - -try: - # Create a shipment - api_response = api_instance.create(body) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->create: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**ShipmentData**](ShipmentData.md)| | - -### Return type - -[**Shipment**](Shipment.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list** -> list[Shipment] list(limit=limit, offset=offset) - -List all shipments - -Retrieve all shipments. - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -limit = 56 # int | Number of results to return per page. (optional) -offset = 56 # int | The initial index from which to return the results. (optional) - -try: - # List all shipments - api_response = api_instance.list(limit=limit, offset=offset) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->list: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **limit** | **int**| Number of results to return per page. | [optional] - **offset** | **int**| The initial index from which to return the results. | [optional] - -### Return type - -[**list[Shipment]**](Shipment.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **purchase** -> Shipment purchase(body, id) - -Buy a shipment label - -Select your preferred rates to buy a shipment label. - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -body = purplship.ShipmentPurchaseData() # ShipmentPurchaseData | -id = 'id_example' # str | - -try: - # Buy a shipment label - api_response = api_instance.purchase(body, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->purchase: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**ShipmentPurchaseData**](ShipmentPurchaseData.md)| | - **id** | **str**| | - -### Return type - -[**Shipment**](Shipment.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **rates** -> Shipment rates(id) - -Fetch new shipment rates - -Refresh the list of the shipment rates - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -id = 'id_example' # str | - -try: - # Fetch new shipment rates - api_response = api_instance.rates(id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->rates: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - -### Return type - -[**Shipment**](Shipment.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retrieve** -> Shipment retrieve(id) - -Retrieve a shipment - -Retrieve a shipment. - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -id = 'id_example' # str | - -try: - # Retrieve a shipment - api_response = api_instance.retrieve(id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->retrieve: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - -### Return type - -[**Shipment**](Shipment.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **set_options** -> Shipment set_options(body, id) - -Add shipment options - -Add one or many options to your shipment.
**eg:**
- add shipment **insurance** - specify the preferred transaction **currency** - setup a **cash collected on delivery** option ```json { \"insurance\": 120, \"currency\": \"USD\" } ``` And many more, check additional options available in the [reference](#operation/all_references). - -### Example -```python -from __future__ import print_function -import time -import swagger_client -from purplship.rest import ApiException -from pprint import pprint - -# Configure API key authorization: Token -configuration = purplship.Configuration() -configuration.api_key['Authorization'] = 'YOUR_API_KEY' -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# create an instance of the API class -api_instance = purplship.ShipmentsApi(purplship.ApiClient(configuration)) -body = NULL # object | -id = 'id_example' # str | - -try: - # Add shipment options - api_response = api_instance.set_options(body, id) - pprint(api_response) -except ApiException as e: - print("Exception when calling ShipmentsApi->set_options: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**object**](object.md)| | - **id** | **str**| | - -### Return type - -[**Shipment**](Shipment.md) - -### Authorization - -[Token](../README.md#Token) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TrackerList.md b/docs/TrackerList.md new file mode 100644 index 0000000..84c953c --- /dev/null +++ b/docs/TrackerList.md @@ -0,0 +1,11 @@ +# TrackerList + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **str** | | [optional] +**previous** | **str** | | [optional] +**results** | [**list[TrackingStatus]**](TrackingStatus.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TrackingEvent.md b/docs/TrackingEvent.md index 79c4b1c..0f27a3e 100644 --- a/docs/TrackingEvent.md +++ b/docs/TrackingEvent.md @@ -3,12 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_date** | **str** | The tracking event's date | -**description** | **str** | The tracking event's description | -**location** | **str** | The tracking event's location | +**_date** | **str** | The tracking event's date | [optional] +**description** | **str** | The tracking event's description | [optional] +**location** | **str** | The tracking event's location | [optional] **code** | **str** | The tracking event's code | [optional] **time** | **str** | The tracking event's time | [optional] -**signatory** | **str** | The tracking signature on delivery | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TrackingStatus.md b/docs/TrackingStatus.md index 1fa2ce9..a9f6fc2 100644 --- a/docs/TrackingStatus.md +++ b/docs/TrackingStatus.md @@ -8,7 +8,8 @@ Name | Type | Description | Notes **carrier_id** | **str** | The tracking carrier configured identifier | **tracking_number** | **str** | The shipment tracking number | **events** | [**list[TrackingEvent]**](TrackingEvent.md) | The tracking details events | [optional] -**test_mode** | **bool** | Specified whether it was created with a carrier in test mode | +**delivered** | **bool** | Specified whether the related shipment was delivered | [optional] +**test_mode** | **bool** | Specified whether the object was created with a carrier in test mode | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/purplship/__init__.py b/purplship/__init__.py index 60eb2d1..7658f18 100755 --- a/purplship/__init__.py +++ b/purplship/__init__.py @@ -1,4 +1,4 @@ -# coding: utf-8 +## coding: utf-8 # flake8: noqa @@ -7,7 +7,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -22,7 +22,7 @@ from purplship.api.pickups_api import PickupsApi from purplship.api.proxy_api import ProxyApi from purplship.api.shipments_api import ShipmentsApi -from purplship.api.tracking_api import TrackingApi +from purplship.api.trackers_api import TrackersApi from purplship.api.utils_api import UtilsApi # import ApiClient from purplship.api_client import ApiClient @@ -138,8 +138,8 @@ def cancel_pickup(*args, **kwargs): return ProxyApi(init_client()).cancel_pickup(*args, **kwargs) @staticmethod - def fetch(*args, **kwargs): - return ProxyApi(init_client()).fetch(*args, **kwargs) + def fetch_rates(*args, **kwargs): + return ProxyApi(init_client()).fetch_rates(*args, **kwargs) @staticmethod def schedule_pickup(*args, **kwargs): @@ -197,15 +197,15 @@ def set_options(*args, **kwargs): return ShipmentsApi(init_client()).set_options(*args, **kwargs) -class Tracking: +class Trackers: @staticmethod def retrieve(*args, **kwargs): - return TrackingApi(init_client()).retrieve(*args, **kwargs) + return TrackersApi(init_client()).retrieve(*args, **kwargs) @staticmethod - def statuses(*args, **kwargs): - return TrackingApi(init_client()).statuses(*args, **kwargs) + def list(*args, **kwargs): + return TrackersApi(init_client()).list(*args, **kwargs) class Utils: diff --git a/purplship/api/__init__.py b/purplship/api/__init__.py index 8a29761..e0e5eff 100644 --- a/purplship/api/__init__.py +++ b/purplship/api/__init__.py @@ -10,5 +10,5 @@ from purplship.api.pickups_api import PickupsApi from purplship.api.proxy_api import ProxyApi from purplship.api.shipments_api import ShipmentsApi -from purplship.api.tracking_api import TrackingApi +from purplship.api.trackers_api import TrackersApi from purplship.api.utils_api import UtilsApi diff --git a/purplship/api/addresses_api.py b/purplship/api/addresses_api.py index 5c2e135..54ed1ac 100644 --- a/purplship/api/addresses_api.py +++ b/purplship/api/addresses_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -143,7 +143,7 @@ def list(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Address] + :return: AddressList If the method is called asynchronously, returns the request thread. """ @@ -166,7 +166,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Address] + :return: AddressList If the method is called asynchronously, returns the request thread. """ @@ -218,7 +218,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='list[Address]', # noqa: E501 + response_type='AddressList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/purplship/api/carriers_api.py b/purplship/api/carriers_api.py index 3d3d997..3986010 100644 --- a/purplship/api/carriers_api.py +++ b/purplship/api/carriers_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -45,8 +45,10 @@ def list(self, **kwargs): # noqa: E501 :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. :param str carrier_name: Indicates a carrier (type) - :param bool test: The test flag filter carrier configured in test mode - :return: list[CarrierSettings] + :param bool test: This flag filter out carriers in test or prod mode + :param bool active: This flag indicates whether to return active carriers only + :param bool system_only: This flag indicates that only system carriers should be returned + :return: CarrierList If the method is called asynchronously, returns the request thread. """ @@ -70,13 +72,15 @@ def list_with_http_info(self, **kwargs): # noqa: E501 :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. :param str carrier_name: Indicates a carrier (type) - :param bool test: The test flag filter carrier configured in test mode - :return: list[CarrierSettings] + :param bool test: This flag filter out carriers in test or prod mode + :param bool active: This flag indicates whether to return active carriers only + :param bool system_only: This flag indicates that only system carriers should be returned + :return: CarrierList If the method is called asynchronously, returns the request thread. """ - all_params = ['limit', 'offset', 'carrier_name', 'test'] # noqa: E501 + all_params = ['limit', 'offset', 'carrier_name', 'test', 'active', 'system_only'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -105,6 +109,10 @@ def list_with_http_info(self, **kwargs): # noqa: E501 query_params.append(('carrier_name', params['carrier_name'])) # noqa: E501 if 'test' in params: query_params.append(('test', params['test'])) # noqa: E501 + if 'active' in params: + query_params.append(('active', params['active'])) # noqa: E501 + if 'system_only' in params: + query_params.append(('system_only', params['system_only'])) # noqa: E501 header_params = {} @@ -127,7 +135,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='list[CarrierSettings]', # noqa: E501 + response_type='CarrierList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/purplship/api/customs_api.py b/purplship/api/customs_api.py index d84ffbc..e8bd3fa 100644 --- a/purplship/api/customs_api.py +++ b/purplship/api/customs_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -238,7 +238,7 @@ def list(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Customs] + :return: CustomsList If the method is called asynchronously, returns the request thread. """ @@ -261,7 +261,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Customs] + :return: CustomsList If the method is called asynchronously, returns the request thread. """ @@ -313,7 +313,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='list[Customs]', # noqa: E501 + response_type='CustomsList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/purplship/api/parcels_api.py b/purplship/api/parcels_api.py index 704a38e..3bb04d4 100644 --- a/purplship/api/parcels_api.py +++ b/purplship/api/parcels_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -238,7 +238,7 @@ def list(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Parcel] + :return: ParcelList If the method is called asynchronously, returns the request thread. """ @@ -261,7 +261,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Parcel] + :return: ParcelList If the method is called asynchronously, returns the request thread. """ @@ -313,7 +313,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='list[Parcel]', # noqa: E501 + response_type='ParcelList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/purplship/api/pickups_api.py b/purplship/api/pickups_api.py index a873af9..8a66bbc 100644 --- a/purplship/api/pickups_api.py +++ b/purplship/api/pickups_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -151,7 +151,7 @@ def list(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Pickup] + :return: PickupList If the method is called asynchronously, returns the request thread. """ @@ -174,7 +174,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Pickup] + :return: PickupList If the method is called asynchronously, returns the request thread. """ @@ -226,7 +226,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='list[Pickup]', # noqa: E501 + response_type='PickupList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -341,7 +341,7 @@ def schedule(self, body, carrier_name, **kwargs): # noqa: E501 :param async_req bool :param PickupData body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: Pickup If the method is called asynchronously, returns the request thread. @@ -365,7 +365,7 @@ def schedule_with_http_info(self, body, carrier_name, **kwargs): # noqa: E501 :param async_req bool :param PickupData body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: Pickup If the method is called asynchronously, returns the request thread. diff --git a/purplship/api/proxy_api.py b/purplship/api/proxy_api.py index ecd4843..626ee4e 100644 --- a/purplship/api/proxy_api.py +++ b/purplship/api/proxy_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -143,7 +143,7 @@ def cancel_pickup(self, body, carrier_name, **kwargs): # noqa: E501 :param async_req bool :param PickupCancelRequest body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: OperationResponse If the method is called asynchronously, returns the request thread. @@ -167,7 +167,7 @@ def cancel_pickup_with_http_info(self, body, carrier_name, **kwargs): # noqa: E :param async_req bool :param PickupCancelRequest body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: OperationResponse If the method is called asynchronously, returns the request thread. @@ -242,13 +242,13 @@ def cancel_pickup_with_http_info(self, body, carrier_name, **kwargs): # noqa: E _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def fetch(self, body, **kwargs): # noqa: E501 + def fetch_rates(self, body, **kwargs): # noqa: E501 """Fetch shipment rates # noqa: E501 The Shipping process begins by fetching rates for your shipment. Use this service to fetch a shipping rates available. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.fetch(body, async_req=True) + >>> thread = api.fetch_rates(body, async_req=True) >>> result = thread.get() :param async_req bool @@ -259,18 +259,18 @@ def fetch(self, body, **kwargs): # noqa: E501 """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.fetch_with_http_info(body, **kwargs) # noqa: E501 + return self.fetch_rates_with_http_info(body, **kwargs) # noqa: E501 else: - (data) = self.fetch_with_http_info(body, **kwargs) # noqa: E501 + (data) = self.fetch_rates_with_http_info(body, **kwargs) # noqa: E501 return data - def fetch_with_http_info(self, body, **kwargs): # noqa: E501 + def fetch_rates_with_http_info(self, body, **kwargs): # noqa: E501 """Fetch shipment rates # noqa: E501 The Shipping process begins by fetching rates for your shipment. Use this service to fetch a shipping rates available. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.fetch_with_http_info(body, async_req=True) + >>> thread = api.fetch_rates_with_http_info(body, async_req=True) >>> result = thread.get() :param async_req bool @@ -291,14 +291,14 @@ def fetch_with_http_info(self, body, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method fetch" % key + " to method fetch_rates" % key ) params[key] = val del params['kwargs'] # verify the required parameter 'body' is set if ('body' not in params or params['body'] is None): - raise ValueError("Missing the required parameter `body` when calling `fetch`") # noqa: E501 + raise ValueError("Missing the required parameter `body` when calling `fetch_rates`") # noqa: E501 collection_formats = {} @@ -353,7 +353,7 @@ def schedule_pickup(self, body, carrier_name, **kwargs): # noqa: E501 :param async_req bool :param PickupRequest body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: PickupResponse If the method is called asynchronously, returns the request thread. @@ -377,7 +377,7 @@ def schedule_pickup_with_http_info(self, body, carrier_name, **kwargs): # noqa: :param async_req bool :param PickupRequest body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: PickupResponse If the method is called asynchronously, returns the request thread. @@ -464,7 +464,7 @@ def track_shipment(self, carrier_name, tracking_number, **kwargs): # noqa: E501 :param async_req bool :param str carrier_name: (required) :param str tracking_number: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: TrackingResponse If the method is called asynchronously, returns the request thread. @@ -488,7 +488,7 @@ def track_shipment_with_http_info(self, carrier_name, tracking_number, **kwargs) :param async_req bool :param str carrier_name: (required) :param str tracking_number: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: TrackingResponse If the method is called asynchronously, returns the request thread. @@ -571,7 +571,7 @@ def update_pickup(self, body, carrier_name, **kwargs): # noqa: E501 :param async_req bool :param PickupUpdateRequest body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: PickupResponse If the method is called asynchronously, returns the request thread. @@ -595,7 +595,7 @@ def update_pickup_with_http_info(self, body, carrier_name, **kwargs): # noqa: E :param async_req bool :param PickupUpdateRequest body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: PickupResponse If the method is called asynchronously, returns the request thread. @@ -682,7 +682,7 @@ def void_label(self, body, carrier_name, **kwargs): # noqa: E501 :param async_req bool :param ShipmentCancelRequest body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: OperationResponse If the method is called asynchronously, returns the request thread. @@ -706,7 +706,7 @@ def void_label_with_http_info(self, body, carrier_name, **kwargs): # noqa: E501 :param async_req bool :param ShipmentCancelRequest body: (required) :param str carrier_name: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. + :param bool test: The test flag indicates whether to use a carrier configured for test. :return: OperationResponse If the method is called asynchronously, returns the request thread. diff --git a/purplship/api/shipments_api.py b/purplship/api/shipments_api.py index e28d6da..cf428ac 100644 --- a/purplship/api/shipments_api.py +++ b/purplship/api/shipments_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -33,7 +33,7 @@ def __init__(self, api_client=None): self.api_client = api_client def add_customs(self, body, id, **kwargs): # noqa: E501 - """Add shipment customs declaration # noqa: E501 + """Add a customs declaration # noqa: E501 Add the customs declaration for the shipment if non existent. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -56,7 +56,7 @@ def add_customs(self, body, id, **kwargs): # noqa: E501 return data def add_customs_with_http_info(self, body, id, **kwargs): # noqa: E501 - """Add shipment customs declaration # noqa: E501 + """Add a customs declaration # noqa: E501 Add the customs declaration for the shipment if non existent. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -140,7 +140,7 @@ def add_customs_with_http_info(self, body, id, **kwargs): # noqa: E501 collection_formats=collection_formats) def add_parcel(self, body, id, **kwargs): # noqa: E501 - """Add a parcel to a shipment # noqa: E501 + """Add a shipment parcel # noqa: E501 Add a parcel to an existing shipment for a multi-parcel shipment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -163,7 +163,7 @@ def add_parcel(self, body, id, **kwargs): # noqa: E501 return data def add_parcel_with_http_info(self, body, id, **kwargs): # noqa: E501 - """Add a parcel to a shipment # noqa: E501 + """Add a shipment parcel # noqa: E501 Add a parcel to an existing shipment for a multi-parcel shipment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an @@ -452,7 +452,7 @@ def list(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Shipment] + :return: ShipmentList If the method is called asynchronously, returns the request thread. """ @@ -475,7 +475,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param int limit: Number of results to return per page. :param int offset: The initial index from which to return the results. - :return: list[Shipment] + :return: ShipmentList If the method is called asynchronously, returns the request thread. """ @@ -527,7 +527,7 @@ def list_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='list[Shipment]', # noqa: E501 + response_type='ShipmentList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/purplship/api/tracking_api.py b/purplship/api/trackers_api.py similarity index 86% rename from purplship/api/tracking_api.py rename to purplship/api/trackers_api.py index 7256208..2cdb4c0 100644 --- a/purplship/api/tracking_api.py +++ b/purplship/api/trackers_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -20,7 +20,7 @@ from purplship.api_client import ApiClient -class TrackingApi(object): +class TrackersApi(object): """NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -32,49 +32,47 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client - def retrieve(self, carrier_name, tracking_number, **kwargs): # noqa: E501 - """Retrieve a tracking status # noqa: E501 + def list(self, **kwargs): # noqa: E501 + """List all shipment trackers # noqa: E501 - This API retrieves or creates (if non existent) a tracking status object containing the details and events of a shipping in progress. # noqa: E501 + Retrieve all shipment trackers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.retrieve(carrier_name, tracking_number, async_req=True) + >>> thread = api.list(async_req=True) >>> result = thread.get() :param async_req bool - :param str carrier_name: (required) - :param str tracking_number: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. - :return: TrackingStatus + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :return: TrackerList If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.retrieve_with_http_info(carrier_name, tracking_number, **kwargs) # noqa: E501 + return self.list_with_http_info(**kwargs) # noqa: E501 else: - (data) = self.retrieve_with_http_info(carrier_name, tracking_number, **kwargs) # noqa: E501 + (data) = self.list_with_http_info(**kwargs) # noqa: E501 return data - def retrieve_with_http_info(self, carrier_name, tracking_number, **kwargs): # noqa: E501 - """Retrieve a tracking status # noqa: E501 + def list_with_http_info(self, **kwargs): # noqa: E501 + """List all shipment trackers # noqa: E501 - This API retrieves or creates (if non existent) a tracking status object containing the details and events of a shipping in progress. # noqa: E501 + Retrieve all shipment trackers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.retrieve_with_http_info(carrier_name, tracking_number, async_req=True) + >>> thread = api.list_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool - :param str carrier_name: (required) - :param str tracking_number: (required) - :param bool test: The test flag indicates whether to use a carrier configured for test. - :return: TrackingStatus + :param int limit: Number of results to return per page. + :param int offset: The initial index from which to return the results. + :return: TrackerList If the method is called asynchronously, returns the request thread. """ - all_params = ['carrier_name', 'tracking_number', 'test'] # noqa: E501 + all_params = ['limit', 'offset'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -85,30 +83,20 @@ def retrieve_with_http_info(self, carrier_name, tracking_number, **kwargs): # n if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method retrieve" % key + " to method list" % key ) params[key] = val del params['kwargs'] - # verify the required parameter 'carrier_name' is set - if ('carrier_name' not in params or - params['carrier_name'] is None): - raise ValueError("Missing the required parameter `carrier_name` when calling `retrieve`") # noqa: E501 - # verify the required parameter 'tracking_number' is set - if ('tracking_number' not in params or - params['tracking_number'] is None): - raise ValueError("Missing the required parameter `tracking_number` when calling `retrieve`") # noqa: E501 collection_formats = {} path_params = {} - if 'carrier_name' in params: - path_params['carrier_name'] = params['carrier_name'] # noqa: E501 - if 'tracking_number' in params: - path_params['tracking_number'] = params['tracking_number'] # noqa: E501 query_params = [] - if 'test' in params: - query_params.append(('test', params['test'])) # noqa: E501 + if 'limit' in params: + query_params.append(('limit', params['limit'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 header_params = {} @@ -124,14 +112,14 @@ def retrieve_with_http_info(self, carrier_name, tracking_number, **kwargs): # n auth_settings = ['Token'] # noqa: E501 return self.api_client.call_api( - '/tracking_status/{carrier_name}/{tracking_number}', 'GET', + '/trackers', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='TrackingStatus', # noqa: E501 + response_type='TrackerList', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -139,47 +127,49 @@ def retrieve_with_http_info(self, carrier_name, tracking_number, **kwargs): # n _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def statuses(self, **kwargs): # noqa: E501 - """List all tracking statuses # noqa: E501 + def retrieve(self, carrier_name, tracking_number, **kwargs): # noqa: E501 + """Retrieves or creates a shipment trackers # noqa: E501 - Retrieve all tracking statuses. # noqa: E501 + This API retrieves or creates (if non existent) a tracking status object containing the details and events of a shipping in progress. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.statuses(async_req=True) + >>> thread = api.retrieve(carrier_name, tracking_number, async_req=True) >>> result = thread.get() :param async_req bool - :param int limit: Number of results to return per page. - :param int offset: The initial index from which to return the results. - :return: list[TrackingStatus] + :param str carrier_name: (required) + :param str tracking_number: (required) + :param bool test: The test flag indicates whether to use a carrier configured for test. + :return: TrackingStatus If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True if kwargs.get('async_req'): - return self.statuses_with_http_info(**kwargs) # noqa: E501 + return self.retrieve_with_http_info(carrier_name, tracking_number, **kwargs) # noqa: E501 else: - (data) = self.statuses_with_http_info(**kwargs) # noqa: E501 + (data) = self.retrieve_with_http_info(carrier_name, tracking_number, **kwargs) # noqa: E501 return data - def statuses_with_http_info(self, **kwargs): # noqa: E501 - """List all tracking statuses # noqa: E501 + def retrieve_with_http_info(self, carrier_name, tracking_number, **kwargs): # noqa: E501 + """Retrieves or creates a shipment trackers # noqa: E501 - Retrieve all tracking statuses. # noqa: E501 + This API retrieves or creates (if non existent) a tracking status object containing the details and events of a shipping in progress. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.statuses_with_http_info(async_req=True) + >>> thread = api.retrieve_with_http_info(carrier_name, tracking_number, async_req=True) >>> result = thread.get() :param async_req bool - :param int limit: Number of results to return per page. - :param int offset: The initial index from which to return the results. - :return: list[TrackingStatus] + :param str carrier_name: (required) + :param str tracking_number: (required) + :param bool test: The test flag indicates whether to use a carrier configured for test. + :return: TrackingStatus If the method is called asynchronously, returns the request thread. """ - all_params = ['limit', 'offset'] # noqa: E501 + all_params = ['carrier_name', 'tracking_number', 'test'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -190,20 +180,30 @@ def statuses_with_http_info(self, **kwargs): # noqa: E501 if key not in all_params: raise TypeError( "Got an unexpected keyword argument '%s'" - " to method statuses" % key + " to method retrieve" % key ) params[key] = val del params['kwargs'] + # verify the required parameter 'carrier_name' is set + if ('carrier_name' not in params or + params['carrier_name'] is None): + raise ValueError("Missing the required parameter `carrier_name` when calling `retrieve`") # noqa: E501 + # verify the required parameter 'tracking_number' is set + if ('tracking_number' not in params or + params['tracking_number'] is None): + raise ValueError("Missing the required parameter `tracking_number` when calling `retrieve`") # noqa: E501 collection_formats = {} path_params = {} + if 'carrier_name' in params: + path_params['carrier_name'] = params['carrier_name'] # noqa: E501 + if 'tracking_number' in params: + path_params['tracking_number'] = params['tracking_number'] # noqa: E501 query_params = [] - if 'limit' in params: - query_params.append(('limit', params['limit'])) # noqa: E501 - if 'offset' in params: - query_params.append(('offset', params['offset'])) # noqa: E501 + if 'test' in params: + query_params.append(('test', params['test'])) # noqa: E501 header_params = {} @@ -219,14 +219,14 @@ def statuses_with_http_info(self, **kwargs): # noqa: E501 auth_settings = ['Token'] # noqa: E501 return self.api_client.call_api( - '/tracking_status', 'GET', + '/trackers/{carrier_name}/{tracking_number}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, - response_type='list[TrackingStatus]', # noqa: E501 + response_type='TrackingStatus', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/purplship/api/utils_api.py b/purplship/api/utils_api.py index 3149a71..87ca49d 100644 --- a/purplship/api/utils_api.py +++ b/purplship/api/utils_api.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -134,7 +134,6 @@ def print_label_with_http_info(self, body, **kwargs): # noqa: E501 def references(self, **kwargs): # noqa: E501 """Data References # noqa: E501 - ## Countries
Code | Name --- | --- AD | Andorra AE | United Arab Emirates AF | Afghanistan AG | Antigua AI | Anguilla AL | Albania AM | Armenia AN | Netherlands Antilles AO | Angola AR | Argentina AS | American Samoa AT | Austria AU | Australia AW | Aruba AZ | Azerbaijan BA | Bosnia And Herzegovina BB | Barbados BD | Bangladesh BE | Belgium BF | Burkina Faso BG | Bulgaria BH | Bahrain BI | Burundi BJ | Benin BM | Bermuda BN | Brunei BO | Bolivia BR | Brazil BS | Bahamas BT | Bhutan BW | Botswana BY | Belarus BZ | Belize CA | Canada CD | Congo, The Democratic Republic Of CF | Central African Republic CG | Congo CH | Switzerland CI | Cote D Ivoire CK | Cook Islands CL | Chile CM | Cameroon CN | China, Peoples Republic CO | Colombia CR | Costa Rica CU | Cuba CV | Cape Verde CY | Cyprus CZ | Czech Republic, The DE | Germany DJ | Djibouti DK | Denmark DM | Dominica DO | Dominican Republic DZ | Algeria EC | Ecuador EE | Estonia EG | Egypt ER | Eritrea ES | Spain ET | Ethiopia FI | Finland FJ | Fiji FK | Falkland Islands FM | Micronesia, Federated States Of FO | Faroe Islands FR | France GA | Gabon GB | United Kingdom GD | Grenada GE | Georgia GF | French Guyana GG | Guernsey GH | Ghana GI | Gibraltar GL | Greenland GM | Gambia GN | Guinea Republic GP | Guadeloupe GQ | Guinea-equatorial GR | Greece GT | Guatemala GU | Guam GW | Guinea-bissau GY | Guyana (british) HK | Hong Kong HN | Honduras HR | Croatia HT | Haiti HU | Hungary IC | Canary Islands, The ID | Indonesia IE | Ireland, Republic Of IL | Israel IN | India IQ | Iraq IR | Iran (islamic Republic Of) IS | Iceland IT | Italy JE | Jersey JM | Jamaica JO | Jordan JP | Japan KE | Kenya KG | Kyrgyzstan KH | Cambodia KI | Kiribati KM | Comoros KN | St. Kitts KP | Korea, The D.p.r Of (north K.) KR | Korea, Republic Of (south K.) KV | Kosovo KW | Kuwait KY | Cayman Islands KZ | Kazakhstan LA | Lao Peoples Democratic Republic LB | Lebanon LC | St. Lucia LI | Liechtenstein LK | Sri Lanka LR | Liberia LS | Lesotho LT | Lithuania LU | Luxembourg LV | Latvia LY | Libya MA | Morocco MC | Monaco MD | Moldova, Republic Of ME | Montenegro, Republic Of MG | Madagascar MH | Marshall Islands MK | Macedonia, Republic Of ML | Mali MM | Myanmar MN | Mongolia MO | Macau MP | Commonwealth No. Mariana Islands MQ | Martinique MR | Mauritania MS | Montserrat MT | Malta MU | Mauritius MV | Maldives MW | Malawi MX | Mexico MY | Malaysia MZ | Mozambique NA | Namibia NC | New Caledonia NE | Niger NG | Nigeria NI | Nicaragua NL | Netherlands, The NO | Norway NP | Nepal NR | Nauru, Republic Of NU | Niue NZ | New Zealand OM | Oman PA | Panama PE | Peru PF | Tahiti PG | Papua New Guinea PH | Philippines, The PK | Pakistan PL | Poland PR | Puerto Rico PT | Portugal PW | Palau PY | Paraguay QA | Qatar RE | Reunion, Island Of RO | Romania RS | Serbia, Republic Of RU | Russian Federation, The RW | Rwanda SA | Saudi Arabia SB | Solomon Islands SC | Seychelles SD | Sudan SE | Sweden SG | Singapore SH | Saint Helena SI | Slovenia SK | Slovakia SL | Sierra Leone SM | San Marino SN | Senegal SO | Somalia SR | Suriname SS | South Sudan ST | Sao Tome And Principe SV | El Salvador SY | Syria SZ | Swaziland TC | Turks And Caicos Islands TD | Chad TG | Togo TH | Thailand TJ | Tajikistan TL | Timor Leste TN | Tunisia TO | Tonga TR | Turkey TT | Trinidad And Tobago TV | Tuvalu TW | Taiwan TZ | Tanzania UA | Ukraine UG | Uganda US | United States UY | Uruguay UZ | Uzbekistan VA | Vatican City State VC | St. Vincent VE | Venezuela VG | British Virgin Islands VI | U.S. Virgin Islands VN | Vietnam VU | Vanuatu WS | Samoa XB | Bonaire XC | Curacao XE | St. Eustatius XM | St. Maarten XN | Nevis XS | Somaliland, Rep Of (north Somalia) XY | St. Barthelemy YE | Yemen, Republic Of YT | Mayotte ZA | South Africa ZM | Zambia ZW | Zimbabwe

## States and Provinces
### United Arab Emirates
Code | Name --- | --- AB | Abu Dhabi AJ | Ajman DU | Dubai FU | Fujairah RA | Ras al-Khaimah SH | Sharjah UM | Umm al-Qaiwain

### Canada
Code | Name --- | --- AB | Alberta BC | British Columbia MB | Manitoba NB | New Brunswick NL | Newfoundland NT | Northwest Territories NS | Nova Scotia NU | Nunavut ON | Ontario PE | Prince Edward Island QC | Quebec SK | Saskatchewan YT | Yukon

### China, Peoples Republic
Code | Name --- | --- anhui | Anhui hainan | Hainan jiangxi | Jiangxi shanghai | Shanghai beijing | Beijing hebei | Hebei jilin | Jilin shanxi | Shanxi chongqing | Chongqing heilongjiang | Heilongjiang liaoning | Liaoning sichuan | Sichuan fujian | Fujian henan | Henan nei_mongol | Nei Mongol tianjin | Tianjin gansu | Gansu hubei | Hubei qinghai | Qinghai xinjiang | Xinjiang guangdong | Guangdong hunan | Hunan shaanxi | Shaanxi yunnan | Yunnan guizhou | Guizhou jiangsu | Jiangsu shandong | Shandong zhejiang | Zhejiang

### India
Code | Name --- | --- AN | Andaman & Nicobar (U.T) AP | Andhra Pradesh AR | Arunachal Pradesh AS | Assam BR | Bihar CG | Chattisgarh CH | Chandigarh (U.T.) DD | Daman & Diu (U.T.) DL | Delhi (U.T.) DN | Dadra and Nagar Haveli (U.T.) GA | Goa GJ | Gujarat HP | Himachal Pradesh HR | Haryana JH | Jharkhand JK | Jammu & Kashmir KA | Karnataka KL | Kerala LD | Lakshadweep (U.T) MH | Maharashtra ML | Meghalaya MN | Manipur MP | Madhya Pradesh MZ | Mizoram NL | Nagaland OR | Orissa PB | Punjab PY | Puducherry (U.T.) RJ | Rajasthan SK | Sikkim TN | Tamil Nadu TR | Tripura UA | Uttaranchal UP | Uttar Pradesh WB | West Bengal

### Mexico
Code | Name --- | --- AG | Aguascalientes BC | Baja California BS | Baja California Sur CM | Campeche CS | Chiapas CH | Chihuahua CO | Coahuila CL | Colima DF | Ciudad de México DG | Durango GT | Guanajuato GR | Guerrero HG | Hidalgo JA | Jalisco EM | Estado de México MI | Michoacán MO | Morelos NA | Nayarit NL | Nuevo León OA | Oaxaca PU | Puebla QE | Querétaro QR | Quintana Roo SL | San Luis Potosí SI | Sinaloa SO | Sonora TB | Tabasco TM | Tamaulipas TL | Tlaxcala VE | Veracruz YU | Yucatán ZA | Zacatecas

### United States
Code | Name --- | --- AL | Alabama AK | Alaska AZ | Arizona AR | Arkansas CA | California CO | Colorado CT | Connecticut DE | Delaware DC | District of Columbia FL | Florida GA | Georgia HI | Hawaii ID | Idaho IL | Illinois IN | Indiana IA | Iowa KS | Kansas KY | Kentucky LA | Louisiana ME | Maine MD | Maryland MA | Massachusetts MI | Michigan MN | Minnesota MS | Mississippi MO | Missouri MT | Montana NE | Nebraska NV | Nevada NH | New Hampshire NJ | New Jersey NM | New Mexico NY | New York NC | North Carolina ND | North Dakota OH | Ohio OK | Oklahoma OR | Oregon PA | Pennsylvania RI | Rhode Island SC | South Carolina SD | South Dakota TN | Tennessee TX | Texas UT | Utah VT | Vermont VA | Virginia WA | Washington State WV | West Virginia WI | Wisconsin WY | Wyoming PR | Puerto Rico


## Currencies
Code | Name --- | --- EUR | Euro AED | UAE Dirham USD | US Dollar XCD | East Caribbean Dollar AMD | Dran ANG | Netherlands Antilles Guilder AOA | Kwanza ARS | Argentine Peso AUD | Australian Dollar AWG | Aruba Guilder AZN | Manat BAM | Convertible Marks BBD | Barbadian Dollar BDT | Taka XOF | CFA Franc West Africa BGN | Bulgarian Lev BHD | Bahraini Dinar BIF | Burundese Franc BMD | Bermudian Dollar BND | Brunei Dollar BOB | Boliviano BRL | Real BSD | Bahamian Dollar BTN | Ngultrum BWP | Pula BYN | Belarussian Ruble BZD | Belize Dollar CAD | Canadian Dollar CDF | Franc Congolais XAF | CFA Franc Central Africa CHF | Swiss Franc NZD | New Zealand Dollar CLP | New Chile Peso CNY | Yuan (Ren Min Bi) COP | Colombian Peso CRC | Costa Rican Colon CUC | Peso Convertible CVE | Cape Verde Escudo CZK | Czech Koruna DJF | Djibouti Franc DKK | Danish Krone DOP | Dominican Republic Peso DZD | Algerian Dinar EGP | Egyptian Pound ERN | Nakfa ETB | Birr FJD | Fijian Dollar GBP | Pound Sterling GEL | Georgian Lari GHS | Cedi GMD | Dalasi GNF | Guinea Franc GTQ | Quetzal GYD | Guyanan Dollar HKD | Hong Kong Dollar HNL | Lempira HRK | Croatian Kuna HTG | Gourde HUF | Forint IDR | Rupiah ILS | New Israeli Shekel INR | Indian Rupee IRR | Iranian Rial ISK | Icelandic Krona JMD | Jamaican Dollar JOD | Jordanian Dinar JPY | Yen KES | Kenyan Shilling KGS | Som KHR | Khmer Rial KMF | Comoros Franc KPW | North Korean Won KRW | Won KWD | Kuwaiti Dinar KYD | Cayman Islands Dollar KZT | Tenge LAK | Kip LKR | Sri Lankan Rupee LRD | Liberian Dollar LSL | Loti LYD | Libyan Dinar MAD | Moroccan Dirham MDL | Leu MGA | Ariary MKD | Denar MMK | Kyat MNT | Tugrik MOP | Pataca MRO | Ouguiya MUR | Mauritius Rupee MVR | Rufiyaa MWK | Kwacha MXN | Mexican Nuevo Peso MYR | Ringgit MZN | Mozambique Metical NAD | Namibian Dollar XPF | CFP Franc NGN | Naira NIO | Cordoba Oro NOK | Norwegian Krone NPR | Nepalese Rupee OMR | Omani Rial PEN | Nuevo Sol PGK | Kina PHP | Phillipines Peso PKR | Pakistani Rupee PLN | Zloty PYG | Guarani QAR | Qatar Rial RSD | Serbia, Dinars RUB | Russian Ruble RWF | Rwanda Franc SAR | Saudi Riyal SBD | Solomon Islands Dollar SCR | Seychelles Rupee SDG | Sudanese Pound SEK | Swedish Krona SGD | Singapore Dollar SHP | St. Helena Pound SLL | Leone SOS | Somali Shilling SRD | Suriname Dollar SSP | South Sudanese pound STD | Dobra SYP | Syrian Pound SZL | Lilangeni THB | Baht TJS | Somoni TND | Tunisian Dinar TOP | Pa'anga TRY | New Turkish Lira TTD | Trinidad and Tobago Dollar TWD | New Taiwan Dollar TZS | Tanzanian Shilling UAH | Hryvna UYU | Peso Uruguayo UZS | Sum VEF | Bolivar Fuerte VND | Dong VUV | Vanuatu Vatu WST | Tala YER | Yemeni Riyal ZAR | South African Rand

## Packaging Types
### Multi-carrier (purplship)
Code | Identifier --- | --- envelope | Small Envelope pak | Pak tube | Tube pallet | Pallet small_box | Small Box medium_box | Medium Box your_packaging | Your Packaging

### DHL Express
Code | Identifier --- | --- dhl_flyer_smalls | FLY dhl_parcels_conveyables | COY dhl_non_conveyables | NCY dhl_pallets | PAL dhl_double_pallets | DBL dhl_box | BOX

### FedEx Express
Code | Identifier --- | --- fedex_envelope | FEDEX_ENVELOPE fedex_pak | FEDEX_PAK fedex_box | FEDEX_BOX fedex_10_kg_box | FEDEX_10KG_BOX fedex_25_kg_box | FEDEX_25KG_BOX fedex_tube | FEDEX_TUBE your_packaging | YOUR_PACKAGING

### Purolator Courier
Code | Identifier --- | --- purolator_express_envelope | Envelope purolator_express_pack | Pack purolator_express_box | Box purolator_customer_packaging | Customer Packaging

### UPS Package
Code | Identifier --- | --- ups_unknown | 00 ups_letter | 01 ups_package | 02 ups_tube | 03 ups_pak | 04 ups_express_box | 21 ups_box_25_kg | 24 ups_box_10_kg | 25 ups_pallet | 30 ups_small_express_box | 2a ups_medium_express_box | 2b ups_large_express_box | 2c


## Package Preset
### Canada Post
Code | Dimensions | Note --- | --- | --- canadapost_mailing_box | 15.2 x 1.0 x 10.2 | height x length x width canadapost_extra_small_mailing_box | 14.0 x 14.0 x 14.0 | height x length x width canadapost_small_mailing_box | 22.9 x 6.4 x 28.6 | height x length x width canadapost_medium_mailing_box | 23.5 x 13.3 x 31.0 | height x length x width canadapost_large_mailing_box | 30.5 x 9.5 x 38.1 | height x length x width canadapost_extra_large_mailing_box | 30.5 x 21.6 x 40.0 | height x length x width canadapost_corrugated_small_box | 32.0 x 32.0 x 42.0 | height x length x width canadapost_corrugated_medium_box | 38.0 x 32.0 x 46.0 | height x length x width canadapost_corrugated_large_box | 46.0 x 40.6 x 46.0 | height x length x width canadapost_xexpresspost_certified_envelope | 15.9 x 1.5 x 0.5 x 26.0 | height x length x weight x width canadapost_xexpresspost_national_large_envelope | 29.2 x 1.5 x 1.36 x 40.0 | height x length x weight x width

### DHL Express
Code | Dimensions | Note --- | --- | --- dhl_express_envelope | 27.5 x 1.0 x 0.5 x 35.0 | height x length x weight x width dhl_express_standard_flyer | 30.0 x 1.5 x 2.0 x 40.0 | height x length x weight x width dhl_express_large_flyer | 37.5 x 1.5 x 3.0 x 47.5 | height x length x weight x width dhl_express_box_2 | 18.2 x 10.0 x 1.0 x 33.7 | height x length x weight x width dhl_express_box_3 | 32.0 x 5.2 x 2.0 x 33.6 | height x length x weight x width dhl_express_box_4 | 32.2 x 18.0 x 5.0 x 33.7 | height x length x weight x width dhl_express_box_5 | 32.2 x 34.5 x 10.0 x 33.7 | height x length x weight x width dhl_express_box_6 | 35.9 x 36.9 x 15.0 x 41.7 | height x length x weight x width dhl_express_box_7 | 40.4 x 38.9 x 20.0 x 48.1 | height x length x weight x width dhl_express_box_8 | 44.4 x 40.9 x 25.0 x 54.2 | height x length x weight x width dhl_express_tube | 15.0 x 15.0 x 5.0 x 96.0 | height x length x weight x width dhl_didgeridoo_box | 13.0 x 162.0 x 10.0 x 13.0 | height x length x weight x width dhl_jumbo_box | 42.7 x 33.0 x 30.0 x 45.0 | height x length x weight x width dhl_jumbo_box_junior | 34.0 x 24.1 x 20.0 x 39.9 | height x length x weight x width

### FedEx Express
Code | Dimensions | Note --- | --- | --- fedex_envelope_legal_size | 15.5 x 1.0 x 9.5 | height x weight x width fedex_padded_pak | 14.75 x 2.2 x 11.75 | height x weight x width fedex_polyethylene_pak | 15.5 x 2.2 x 12.0 | height x weight x width fedex_clinical_pak | 18.0 x 2.2 x 13.5 | height x weight x width fedex_small_box | 10.9 x 1.5 x 20.0 x 12.25 | height x length x weight x width fedex_medium_box | 11.5 x 2.38 x 20.0 x 13.25 | height x length x weight x width fedex_large_box | 12.38 x 3.0 x 20.0 x 17.88 | height x length x weight x width fedex_10_kg_box | 12.94 x 10.19 x 10.0 x 15.81 | height x length x weight x width fedex_25_kg_box | 16.56 x 13.19 x 25.0 x 21.56 | height x length x weight x width fedex_tube | 6.0 x 6.0 x 20.0 x 38.0 | height x length x weight x width

### Purolator Courier
Code | Dimensions | Note --- | --- | --- purolator_express_envelope | 1.5 x 1.0 x 12.5 | length x weight x width purolator_express_pack | 1.0 x 3.0 x 12.5 | length x weight x width purolator_express_box | 3.5 x 7.0 | length x weight

### UPS Package
Code | Dimensions | Note --- | --- | --- ups_small_express_box | 11.0 x 2.0 x 30.0 x 13.0 | height x length x weight x width ups_medium_express_box | 11.0 x 3.0 x 30.0 x 16.0 | height x length x weight x width ups_large_express_box | 13.0 x 3.0 x 30.0 x 18.0 | height x length x weight x width ups_express_tube | 6.0 x 6.0 x 38.0 | height x length x width ups_express_pak | 11.75 x 1.5 x 16.0 | height x length x width ups_world_document_box | 12.5 x 3.0 x 17.5 | height x length x width


## Shipment Options
### Canada Post
Code | Identifier --- | --- canadapost_signature | SO canadapost_coverage | COV canadapost_collect_on_delivery | COD canadapost_proof_of_age_required_18 | PA18 canadapost_proof_of_age_required_19 | PA19 canadapost_card_for_pickup | HFP canadapost_do_not_safe_drop | DNS canadapost_leave_at_door | LAD canadapost_deliver_to_post_office | D2PO canadapost_return_at_senders_expense | RASE canadapost_return_to_sender | RTS canadapost_abandon | ABAN

### DHL Express
Code | Identifier --- | --- dhl_logistics_services | 0A dhl_mailroom_management | 0B dhl_pallet_administration | 0C dhl_warehousing | 0D dhl_express_logistics_centre | 0E dhl_strategic_parts_centre | 0F dhl_local_distribution_centre | 0G dhl_terminal_handling | 0H dhl_cross_docking | 0I dhl_inventory_management | 0J dhl_loading_unloading | 0K dhl_product_kitting | 0L dhl_priority_account_desk | 0M dhl_document_archiving | 0N dhl_saturday_delivery | AA dhl_saturday_pickup | AB dhl_holiday_delivery | AC dhl_holiday_pickup | AD dhl_domestic_saturday_delivery | AG dhl_standard | BA dhl_globalmail_item | BB dhl_letter | BC dhl_packet | BD dhl_letter_plus | BE dhl_packet_plus | BF dhl_elevated_risk | CA dhl_restricted_destination | CB dhl_security_validation | CC dhl_secure_protection | CD dhl_proof_of_identity | CE dhl_secure_storage | CF dhl_diplomatic_material | CG dhl_smart_sensor | CH dhl_visa_program | CI dhl_onboard_courier | CJ dhl_secure_safebox | CK dhl_smart_sentry | CL dhl_split_duties_and_tax | DC dhl_duties_and_taxes_paid | DD dhl_receiver_paid | DE dhl_duties_and_taxes_unpaid | DS dhl_import_billing | DT dhl_importer_of_record | DU dhl_go_green_carbon_neutral | EA dhl_go_green_carbon_footprint | EB dhl_go_green_carbon_estimate | EC dhl_fuel_surcharge_b | FB dhl_fuel_surcharge_c | FC dhl_fuel_surcharge_f | FF dhl_smartphone_box | GA dhl_laptop_box | GB dhl_bottle_box | GC dhl_repacking | GD dhl_tablet_box | GE dhl_filler_material | GF dhl_packaging | GG dhl_diplomatic_bag | GH dhl_pallet_box | GI dhl_lock_box | GJ dhl_lithium_ion_pi965_section_ii | HB dhl_dry_ice_un1845 | HC dhl_lithium_ion_pi965_966_section_ii | HD dhl_dangerous_goods | HE dhl_perishable_cargo | HG dhl_excepted_quantity | HH dhl_spill_cleaning | HI dhl_consumer_commodities | HK dhl_limited_quantities_adr | HL dhl_lithium_metal_pi969_section_ii | HM dhl_adr_load_exemption | HN dhl_lithium_ion_pi967_section_ii | HV dhl_lithium_metal_pi970_section_ii | HW dhl_biological_un3373 | HY dhl_extended_liability | IB dhl_contract_insurance | IC dhl_shipment_insurance | II dhl_delivery_notification | JA dhl_pickup_notification | JC dhl_proactive_tracking | JD dhl_performance_reporting | JE dhl_prealert_notification | JY dhl_change_of_billing | KA dhl_cash_on_delivery | KB dhl_printed_invoice | KD dhl_waybill_copy | KE dhl_import_paperwork | KF dhl_payment_on_pickup | KY dhl_shipment_intercept | LA dhl_shipment_redirect | LC dhl_storage_at_facility | LE dhl_cold_storage | LG dhl_specific_routing | LH dhl_service_recovery | LV dhl_alternative_address | LW dhl_hold_for_collection | LX dhl_address_correction_a | MA dhl_address_correction_b | MB dhl_neutral_delivery | NN dhl_remote_area_pickup | OB dhl_remote_area_delivery_c | OC dhl_out_of_service_area | OE dhl_remote_area_delivery_o | OO dhl_shipment_preparation | PA dhl_shipment_labeling | PB dhl_shipment_consolidation | PC dhl_relabeling_data_entry | PD dhl_preprinted_waybill | PE dhl_piece_labelling | PS dhl_data_staging_03 | PT dhl_data_staging_06 | PU dhl_data_staging_12 | PV dhl_data_staging_24 | PW dhl_standard_pickup | PX dhl_scheduled_pickup | PY dhl_dedicated_pickup | QA dhl_early_pickup | QB dhl_late_pickup | QD dhl_residential_pickup | QE dhl_loading_waiting | QF dhl_bypass_injection | QH dhl_direct_injection | QI dhl_drop_off_at_facility | QY dhl_delivery_signature | SA dhl_content_signature | SB dhl_named_signature | SC dhl_adult_signature | SD dhl_contract_signature | SE dhl_alternative_signature | SW dhl_no_signature_required | SX dhl_dedicated_delivery | TA dhl_early_delivery | TB dhl_time_window_delivery | TC dhl_evening_delivery | TD dhl_delivery_on_appointment | TE dhl_return_undeliverable | TG dhl_swap_delivery | TH dhl_unloading_waiting | TJ dhl_residential_delivery | TK dhl_repeat_delivery | TN dhl_alternative_date | TT dhl_no_partial_delivery | TU dhl_service_point_24_7 | TV dhl_pre_9_00 | TW dhl_pre_10_30 | TX dhl_pre_12_00 | TY dhl_thermo_packaging | UA dhl_ambient_vialsafe | UB dhl_ambient_non_insulated | UC dhl_ambient_insulated | UD dhl_ambient_extreme | UE dhl_chilled_box_s | UF dhl_chilled_box_m | UG dhl_chilled_box_l | UH dhl_frozen_no_ice_s | UI dhl_frozen_no_ice_m | UJ dhl_frozen_no_ice_l | UK dhl_frozen_ice_sticks_s | UL dhl_frozen_ice_sticks_m | UM dhl_frozen_ice_sticks_l | UN dhl_frozen_ice_plates_s | UO dhl_frozen_ice_plates_m | UP dhl_frozen_ice_plates_l | UQ dhl_combination_no_ice | UR dhl_combination_dry_ice | US dhl_frozen_ice_sticks_e | UT dhl_frozen_ice_plates_e | UV dhl_customer_tcp_1 | UW dhl_thermo_accessories | VA dhl_absorbent_sleeve | VB dhl_cooland_wrap | VC dhl_dry_ice_supplies | VD dhl_pressure_bag_s | VE dhl_pressure_bag_m | VF dhl_pressure_bag_l | VG dhl_informal_clearance | WA dhl_formal_clearance | WB dhl_payment_deferment | WC dhl_clearance_authorization | WD dhl_multiline_entry | WE dhl_post_clearance_modification | WF dhl_handover_to_broker | WG dhl_physical_intervention | WH dhl_bio_phyto_veterinary_controls | WI dhl_obtaining_permits_and_licences | WJ dhl_bonded_storage | WK dhl_bonded_transit_documents | WL dhl_temporary_import_export | WM dhl_under_bond_guarantee | WN dhl_export_declaration | WO dhl_exporter_validation | WP dhl_certificate_of_origin | WQ dhl_document_translation | WR dhl_personal_effects | WS dhl_paperless_trade | WY dhl_import_export_taxes | XB dhl_unrecoverable_origin_tax | XC dhl_quarantine_inspection | XD dhl_merchandise_process | XE dhl_domestic_postal_tax | XF dhl_tier_two_tax | XG dhl_tier_three_tax | XH dhl_import_penalty | XI dhl_cargo_zone_process | XJ dhl_import_export_duties | XX dhl_premium_09_00 | Y1 dhl_premium_10_30 | Y2 dhl_premium_12_00 | Y3 dhl_over_sized_piece_b | YB dhl_over_handled_piece_c | YC dhl_multipiece_shipment | YE dhl_over_weight_piece_f | YF dhl_over_sized_piece_g | YG dhl_over_handled_piece_h | YH dhl_premium_9_00_i | YI dhl_premium_10_30_j | YJ dhl_premium_12_00_k | YK dhl_paket_shipment | YV dhl_breakbulk_mother | YW dhl_breakbulk_baby | YX dhl_over_weight_piece_y | YY dhl_customer_claim | ZA dhl_damage_compensation | ZB dhl_loss_compensation | ZC dhl_customer_rebate | ZD dhl_e_com_discount | ZE

### FedEx Express
Code | Identifier --- | --- fedex_blind_shipment | BLIND_SHIPMENT fedex_broker_select_option | BROKER_SELECT_OPTION fedex_call_before_delivery | CALL_BEFORE_DELIVERY fedex_cod | COD fedex_cod_remittance | COD_REMITTANCE fedex_custom_delivery_window | CUSTOM_DELIVERY_WINDOW fedex_cut_flowers | CUT_FLOWERS fedex_dangerous_goods | DANGEROUS_GOODS fedex_delivery_on_invoice_acceptance | DELIVERY_ON_INVOICE_ACCEPTANCE fedex_detention | DETENTION fedex_do_not_break_down_pallets | DO_NOT_BREAK_DOWN_PALLETS fedex_do_not_stack_pallets | DO_NOT_STACK_PALLETS fedex_dry_ice | DRY_ICE fedex_east_coast_special | EAST_COAST_SPECIAL fedex_electronic_trade_documents | ELECTRONIC_TRADE_DOCUMENTS fedex_event_notification | EVENT_NOTIFICATION fedex_exclude_from_consolidation | EXCLUDE_FROM_CONSOLIDATION fedex_exclusive_use | EXCLUSIVE_USE fedex_exhibition_delivery | EXHIBITION_DELIVERY fedex_exhibition_pickup | EXHIBITION_PICKUP fedex_expedited_alternate_delivery_route | EXPEDITED_ALTERNATE_DELIVERY_ROUTE fedex_expedited_one_day_earlier | EXPEDITED_ONE_DAY_EARLIER fedex_expedited_service_monitoring_and_delivery | EXPEDITED_SERVICE_MONITORING_AND_DELIVERY fedex_expedited_standard_day_early_delivery | EXPEDITED_STANDARD_DAY_EARLY_DELIVERY fedex_extra_labor | EXTRA_LABOR fedex_extreme_length | EXTREME_LENGTH fedex_one_rate | FEDEX_ONE_RATE fedex_flatbed_trailer | FLATBED_TRAILER fedex_food | FOOD fedex_freight_guarantee | FREIGHT_GUARANTEE fedex_freight_to_collect | FREIGHT_TO_COLLECT fedex_future_day_shipment | FUTURE_DAY_SHIPMENT fedex_hold_at_location | HOLD_AT_LOCATION fedex_holiday_delivery | HOLIDAY_DELIVERY fedex_holiday_guarantee | HOLIDAY_GUARANTEE fedex_home_delivery_premium | HOME_DELIVERY_PREMIUM fedex_inside_delivery | INSIDE_DELIVERY fedex_inside_pickup | INSIDE_PICKUP fedex_international_controlled_export_service | INTERNATIONAL_CONTROLLED_EXPORT_SERVICE fedex_international_mail_service | INTERNATIONAL_MAIL_SERVICE fedex_international_traffic_in_arms_regulations | INTERNATIONAL_TRAFFIC_IN_ARMS_REGULATIONS fedex_liftgate_delivery | LIFTGATE_DELIVERY fedex_liftgate_pickup | LIFTGATE_PICKUP fedex_limited_access_delivery | LIMITED_ACCESS_DELIVERY fedex_limited_access_pickup | LIMITED_ACCESS_PICKUP fedex_marking_or_tagging | MARKING_OR_TAGGING fedex_non_business_time | NON_BUSINESS_TIME fedex_pallet_shrinkwrap | PALLET_SHRINKWRAP fedex_pallet_weight_allowance | PALLET_WEIGHT_ALLOWANCE fedex_pallets_provided | PALLETS_PROVIDED fedex_pending_complete | PENDING_COMPLETE fedex_pending_shipment | PENDING_SHIPMENT fedex_permit | PERMIT fedex_pharmacy_delivery | PHARMACY_DELIVERY fedex_poison | POISON fedex_port_delivery | PORT_DELIVERY fedex_port_pickup | PORT_PICKUP fedex_pre_delivery_notification | PRE_DELIVERY_NOTIFICATION fedex_pre_eig_processing | PRE_EIG_PROCESSING fedex_pre_multiplier_processing | PRE_MULTIPLIER_PROCESSING fedex_protection_from_freezing | PROTECTION_FROM_FREEZING fedex_regional_mall_delivery | REGIONAL_MALL_DELIVERY fedex_regional_mall_pickup | REGIONAL_MALL_PICKUP fedex_return_shipment | RETURN_SHIPMENT fedex_returns_clearance | RETURNS_CLEARANCE fedex_returns_clearance_special_routing_required | RETURNS_CLEARANCE_SPECIAL_ROUTING_REQUIRED fedex_saturday_delivery | SATURDAY_DELIVERY fedex_saturday_pickup | SATURDAY_PICKUP fedex_shipment_assembly | SHIPMENT_ASSEMBLY fedex_sort_and_segregate | SORT_AND_SEGREGATE fedex_special_delivery | SPECIAL_DELIVERY fedex_special_equipment | SPECIAL_EQUIPMENT fedex_storage | STORAGE fedex_sunday_delivery | SUNDAY_DELIVERY fedex_third_party_consignee | THIRD_PARTY_CONSIGNEE fedex_top_load | TOP_LOAD fedex_usps_delivery | USPS_DELIVERY fedex_usps_pickup | USPS_PICKUP fedex_weighing | WEIGHING

### Purolator Courier
Code | Identifier --- | --- purolator_dangerous_goods | Dangerous Goods purolator_chain_of_signature | Chain of Signature purolator_express_cheque | ExpressCheque purolator_hold_for_pickup | Hold For Pickup purolator_return_services | Return Services purolator_saturday_service | Saturday Service purolator_origin_signature_not_required | Origin Signature Not Required (OSNR) purolator_adult_signature_required | Adult Signature Required (ASR) purolator_special_handling | Special Handling

### UPS Package
Code | Identifier --- | --- ups_saturday_delivery_indicator | SaturdayDeliveryIndicator ups_access_point_cod | AccessPointCOD ups_deliver_to_addressee_only_indicator | DeliverToAddresseeOnlyIndicator ups_direct_delivery_only_indicator | DirectDeliveryOnlyIndicator ups_cod | COD ups_delivery_confirmation | DeliveryConfirmation ups_return_of_document_indicator | ReturnOfDocumentIndicator ups_up_scarbonneutral_indicator | UPScarbonneutralIndicator ups_certificate_of_origin_indicator | CertificateOfOriginIndicator ups_pickup_options | PickupOptions ups_delivery_options | DeliveryOptions ups_restricted_articles | RestrictedArticles ups_shipper_export_declaration_indicator | ShipperExportDeclarationIndicator ups_commercial_invoice_removal_indicator | CommercialInvoiceRemovalIndicator ups_import_control | ImportControl ups_return_service | ReturnService ups_sdl_shipment_indicator | SDLShipmentIndicator ups_epra_indicator | EPRAIndicator

### Freightcom
Code | Identifier --- | --- freightcom_saturday_pickup_required | saturdayPickupRequired freightcom_homeland_security | homelandSecurity freightcom_exhibition_convention_site | exhibitionConventionSite freightcom_military_base_delivery | militaryBaseDelivery freightcom_customs_in_bond_freight | customsIn_bondFreight freightcom_limited_access | limitedAccess freightcom_excess_length | excessLength freightcom_tailgate_pickup | tailgatePickup freightcom_residential_pickup | residentialPickup freightcom_cross_border_fee | crossBorderFee freightcom_notify_recipient | notifyRecipient freightcom_single_shipment | singleShipment freightcom_tailgate_delivery | tailgateDelivery freightcom_residential_delivery | residentialDelivery freightcom_insurance_type | insuranceType freightcom_inside_delivery | insideDelivery freightcom_is_saturday_service | isSaturdayService freightcom_dangerous_goods_type | dangerousGoodsType freightcom_stackable | stackable

### eShipper
Code | Identifier --- | --- eshipper_saturday_pickup_required | saturdayPickupRequired eshipper_homeland_security | homelandSecurity eshipper_exhibition_convention_site | exhibitionConventionSite eshipper_military_base_delivery | militaryBaseDelivery eshipper_customs_in_bond_freight | customsIn_bondFreight eshipper_limited_access | limitedAccess eshipper_excess_length | excessLength eshipper_tailgate_pickup | tailgatePickup eshipper_residential_pickup | residentialPickup eshipper_cross_border_fee | crossBorderFee eshipper_notify_recipient | notifyRecipient eshipper_single_shipment | singleShipment eshipper_tailgate_delivery | tailgateDelivery eshipper_residential_delivery | residentialDelivery eshipper_insurance_type | insuranceType eshipper_inside_delivery | insideDelivery eshipper_is_saturday_service | isSaturdayService eshipper_dangerous_goods_type | dangerousGoodsType eshipper_stackable | stackable


## Shipment Services
### Canada Post
Code | Identifier --- | --- canadapost_regular_parcel | DOM.RP canadapost_expedited_parcel | DOM.EP canadapost_xpresspost | DOM.XP canadapost_priority | DOM.PC canadapost_library_books | DOM.LIB canadapost_expedited_parcel_usa | USA.EP canadapost_priority_worldwide_envelope_usa | USA.PW.ENV canadapost_priority_worldwide_pak_usa | USA.PW.PAK canadapost_priority_worldwide_parcel_usa | USA.PW.PARCEL canadapost_small_packet_usa_air | USA.SP.AIR canadapost_tracked_packet_usa | USA.TP canadapost_tracked_packet_usa_lvm | USA.TP.LVM canadapost_xpresspost_usa | USA.XP canadapost_xpresspost_international | INT.XP canadapost_international_parcel_air | INT.IP.AIR canadapost_international_parcel_surface | INT.IP.SURF canadapost_priority_worldwide_envelope_intl | INT.PW.ENV canadapost_priority_worldwide_pak_intl | INT.PW.PAK canadapost_priority_worldwide_parcel_intl | INT.PW.PARCEL canadapost_small_packet_international_air | INT.SP.AIR canadapost_small_packet_international_surface | INT.SP.SURF canadapost_tracked_packet_international | INT.TP

### DHL Express
Code | Identifier --- | --- dhl_logistics_services | LOGISTICS SERVICES dhl_domestic_express_12_00_doc | DOMESTIC EXPRESS 12:00 DOC dhl_b2_c_doc | B2C DOC dhl_b2_c_nondoc | B2C NONDOC dhl_jetline | JETLINE dhl_sprintline | SPRINTLINE dhl_express_easy_doc | EXPRESS EASY DOC dhl_express_easy_nondoc | EXPRESS EASY NONDOC dhl_europack_doc | EUROPACK DOC dhl_auto_reversals | AUTO REVERSALS dhl_breakbulk_express_doc | BREAKBULK EXPRESS DOC dhl_medical_express_doc | MEDICAL EXPRESS DOC dhl_express_worldwide_doc | EXPRESS WORLDWIDE DOC dhl_express_9_00_nondoc | EXPRESS 9:00 NONDOC dhl_freight_worldwide_nondoc | FREIGHT WORLDWIDE NONDOC dhl_domestic_economy_select_doc | DOMESTIC ECONOMY SELECT DOC dhl_economy_select_nondoc | ECONOMY SELECT NONDOC dhl_domestic_express_9_00_doc | DOMESTIC EXPRESS 9:00 DOC dhl_jumbo_box_nondoc | JUMBO BOX NONDOC dhl_express_9_00_doc | EXPRESS 9:00 DOC dhl_express_10_30_doc | EXPRESS 10:30 DOC dhl_express_10_30_nondoc | EXPRESS 10:30 NONDOC dhl_domestic_express_doc | DOMESTIC EXPRESS DOC dhl_domestic_express_10_30_doc | DOMESTIC EXPRESS 10:30 DOC dhl_express_worldwide_nondoc | EXPRESS WORLDWIDE NONDOC dhl_medical_express_nondoc | MEDICAL EXPRESS NONDOC dhl_globalmail_business_doc | GLOBALMAIL BUSINESS DOC dhl_same_day_doc | SAME DAY DOC dhl_express_12_00_doc | EXPRESS 12:00 DOC dhl_europack_nondoc | EUROPACK NONDOC dhl_economy_select_doc | ECONOMY SELECT DOC dhl_express_envelope_doc | EXPRESS ENVELOPE DOC dhl_express_12_00_nondoc | EXPRESS 12:00 NONDOC dhl_destination_charges | Destination Charges

### FedEx Express
Code | Identifier --- | --- fedex_europe_first_international_priority | EUROPE_FIRST_INTERNATIONAL_PRIORITY fedex_1_day_freight | FEDEX_1_DAY_FREIGHT fedex_2_day | FEDEX_2_DAY fedex_2_day_am | FEDEX_2_DAY_AM fedex_2_day_freight | FEDEX_2_DAY_FREIGHT fedex_3_day_freight | FEDEX_3_DAY_FREIGHT fedex_cargo_airport_to_airport | FEDEX_CARGO_AIRPORT_TO_AIRPORT fedex_cargo_freight_forwarding | FEDEX_CARGO_FREIGHT_FORWARDING fedex_cargo_international_express_freight | FEDEX_CARGO_INTERNATIONAL_EXPRESS_FREIGHT fedex_cargo_international_premium | FEDEX_CARGO_INTERNATIONAL_PREMIUM fedex_cargo_mail | FEDEX_CARGO_MAIL fedex_cargo_registered_mail | FEDEX_CARGO_REGISTERED_MAIL fedex_cargo_surface_mail | FEDEX_CARGO_SURFACE_MAIL fedex_custom_critical_air_expedite | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE fedex_custom_critical_air_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_air_expedite_network | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_NETWORK fedex_custom_critical_charter_air | FEDEX_CUSTOM_CRITICAL_CHARTER_AIR fedex_custom_critical_point_to_point | FEDEX_CUSTOM_CRITICAL_POINT_TO_POINT fedex_custom_critical_surface_expedite | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE fedex_custom_critical_surface_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_temp_assure_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_AIR fedex_custom_critical_temp_assure_validated_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_VALIDATED_AIR fedex_custom_critical_white_glove_services | FEDEX_CUSTOM_CRITICAL_WHITE_GLOVE_SERVICES fedex_distance_deferred | FEDEX_DISTANCE_DEFERRED fedex_express_saver | FEDEX_EXPRESS_SAVER fedex_first_freight | FEDEX_FIRST_FREIGHT fedex_freight_economy | FEDEX_FREIGHT_ECONOMY fedex_freight_priority | FEDEX_FREIGHT_PRIORITY fedex_ground | FEDEX_GROUND fedex_international_priority_plus | FEDEX_INTERNATIONAL_PRIORITY_PLUS fedex_next_day_afternoon | FEDEX_NEXT_DAY_AFTERNOON fedex_next_day_early_morning | FEDEX_NEXT_DAY_EARLY_MORNING fedex_next_day_end_of_day | FEDEX_NEXT_DAY_END_OF_DAY fedex_next_day_freight | FEDEX_NEXT_DAY_FREIGHT fedex_next_day_mid_morning | FEDEX_NEXT_DAY_MID_MORNING fedex_first_overnight | FIRST_OVERNIGHT fedex_ground_home_delivery | GROUND_HOME_DELIVERY fedex_international_distribution_freight | INTERNATIONAL_DISTRIBUTION_FREIGHT fedex_international_economy | INTERNATIONAL_ECONOMY fedex_international_economy_distribution | INTERNATIONAL_ECONOMY_DISTRIBUTION fedex_international_economy_freight | INTERNATIONAL_ECONOMY_FREIGHT fedex_international_first | INTERNATIONAL_FIRST fedex_international_ground | INTERNATIONAL_GROUND fedex_international_priority | INTERNATIONAL_PRIORITY fedex_international_priority_distribution | INTERNATIONAL_PRIORITY_DISTRIBUTION fedex_international_priority_express | INTERNATIONAL_PRIORITY_EXPRESS fedex_international_priority_freight | INTERNATIONAL_PRIORITY_FREIGHT fedex_priority_overnight | PRIORITY_OVERNIGHT fedex_same_day | SAME_DAY fedex_same_day_city | SAME_DAY_CITY fedex_same_day_metro_afternoon | SAME_DAY_METRO_AFTERNOON fedex_same_day_metro_morning | SAME_DAY_METRO_MORNING fedex_same_day_metro_rush | SAME_DAY_METRO_RUSH fedex_smart_post | SMART_POST fedex_standard_overnight | STANDARD_OVERNIGHT fedex_transborder_distribution_consolidation | TRANSBORDER_DISTRIBUTION_CONSOLIDATION

### Purolator Courier
Code | Identifier --- | --- purolator_express_9_am | PurolatorExpress9AM purolator_express_us | PurolatorExpressU.S. purolator_express_10_30_am | PurolatorExpress10:30AM purolator_express_us_9_am | PurolatorExpressU.S.9AM purolator_express_12_pm | PurolatorExpress12PM purolator_express_us_10_30_am | PurolatorExpressU.S.10:30AM purolator_express | PurolatorExpress purolator_express_us_12_00 | PurolatorExpressU.S.12:00 purolator_express_evening | PurolatorExpressEvening purolator_express_envelope_us | PurolatorExpressEnvelopeU.S. purolator_express_envelope_9_am | PurolatorExpressEnvelope9AM purolator_express_us_envelope_9_am | PurolatorExpressU.S.Envelope9AM purolator_express_envelope_10_30_am | PurolatorExpressEnvelope10:30AM purolator_express_us_envelope_10_30_am | PurolatorExpressU.S.Envelope10:30AM purolator_express_envelope_12_pm | PurolatorExpressEnvelope12PM purolator_express_us_envelope_12_00 | PurolatorExpressU.S.Envelope12:00 purolator_express_envelope | PurolatorExpressEnvelope purolator_express_pack_us | PurolatorExpressPackU.S. purolator_express_envelope_evening | PurolatorExpressEnvelopeEvening purolator_express_us_pack_9_am | PurolatorExpressU.S.Pack9AM purolator_express_pack_9_am | PurolatorExpressPack9AM purolator_express_us_pack_10_30_am | PurolatorExpressU.S.Pack10:30AM purolator_express_pack10_30_am | PurolatorExpressPack10:30AM purolator_express_us_pack_12_00 | PurolatorExpressU.S.Pack12:00 purolator_express_pack_12_pm | PurolatorExpressPack12PM purolator_express_box_us | PurolatorExpressBoxU.S. purolator_express_pack | PurolatorExpressPack purolator_express_us_box_9_am | PurolatorExpressU.S.Box9AM purolator_express_pack_evening | PurolatorExpressPackEvening purolator_express_us_box_10_30_am | PurolatorExpressU.S.Box10:30AM purolator_express_box_9_am | PurolatorExpressBox9AM purolator_express_us_box_12_00 | PurolatorExpressU.S.Box12:00 purolator_express_box_10_30_am | PurolatorExpressBox10:30AM purolator_ground_us | PurolatorGroundU.S. purolator_express_box_12_pm | PurolatorExpressBox12PM purolator_express_international | PurolatorExpressInternational purolator_express_box | PurolatorExpressBox purolator_express_international_9_am | PurolatorExpressInternational9AM purolator_express_box_evening | PurolatorExpressBoxEvening purolator_express_international_10_30_am | PurolatorExpressInternational10:30AM purolator_ground | PurolatorGround purolator_express_international_12_00 | PurolatorExpressInternational12:00 purolator_ground9_am | PurolatorGround9AM purolator_express_envelope_international | PurolatorExpressEnvelopeInternational purolator_ground10_30_am | PurolatorGround10:30AM purolator_express_international_envelope_9_am | PurolatorExpressInternationalEnvelope9AM purolator_ground_evening | PurolatorGroundEvening purolator_express_international_envelope_10_30_am | PurolatorExpressInternationalEnvelope10:30AM purolator_quick_ship | PurolatorQuickShip purolator_express_international_envelope_12_00 | PurolatorExpressInternationalEnvelope12:00 purolator_quick_ship_envelope | PurolatorQuickShipEnvelope purolator_express_pack_international | PurolatorExpressPackInternational purolator_quick_ship_pack | PurolatorQuickShipPack purolator_express_international_pack_9_am | PurolatorExpressInternationalPack9AM purolator_quick_ship_box | PurolatorQuickShipBox purolator_express_international_pack_10_30_am | PurolatorExpressInternationalPack10:30AM purolator_express_international_pack_12_00 | PurolatorExpressInternationalPack12:00 purolator_express_box_international | PurolatorExpressBoxInternational purolator_express_international_box_9_am | PurolatorExpressInternationalBox9AM purolator_express_international_box_10_30_am | PurolatorExpressInternationalBox10:30AM purolator_express_international_box_12_00 | PurolatorExpressInternationalBox12:00

### UPS Package
Code | Identifier --- | --- ups_standard | 11 ups_worldwide_expedited | 08 ups_worldwide_express | 07 ups_worldwide_express_plus | 54 ups_worldwide_saver | 65 ups_2nd_day_air | 02 ups_2nd_day_air_am | 59 ups_3_day_select | 12 ups_expedited_mail_innovations | M4 ups_first_class_mail | M2 ups_ground | 03 ups_next_day_air | 01 ups_next_day_air_early | 14 ups_next_day_air_saver | 13 ups_priority_mail | M3 ups_access_point_economy | 70 ups_today_dedicated_courier | 83 ups_today_express | 85 ups_today_express_saver | 86 ups_today_standard | 82 ups_worldwide_express_freight | 96 ups_priority_mail_innovations | M5 ups_economy_mail_innovations | M6

### Freightcom
Code | Identifier --- | --- freightcom_central_transport | 2029 freigthcom_estes | 2107 freigthcom_usf_holland | 1911 freightcom_dicom_ground | 3700 freightcom_ground | 3400 freightcom_select | 3404 freightcom_overnight | 3407 freightcom_purolator_ground | 4000 freightcom_purolator_express | 4003 freightcom_purolator_express_9_am | 4004 freightcom_purolator_express_10_30_am | 4005 freightcom_fedex_express_saver | 4100 freightcom_fedex_ground | 4101 freightcom_fedex_2_day | 4102 freightcom_fedex_priority_overnight | 4104 freightcom_fedex_standard_overnight | 4105 freightcom_fedex_first_overnight | 4106 freightcom_fedex_international_economy | 4109 freightcom_ups_standard | 4600 freightcom_ups_expedited | 4601 freightcom_ups_express_saver | 4602 freightcom_ups_express | 4603 freightcom_ups_express_early | 4604 freightcom_ups_3_day_select | 4605 freightcom_ups_worldwide_expedited | 4606 freightcom_ups_worldwide_express | 4607 freightcom_fedex_international_priority | 4108 freightcom_ups_worldwide_express_saver | 4609 freightcom_purolator_ground_us | 4016 freightcom_purolator_express_us | 4015 freightcom_purolator_express_us_10_30_am | 4014 freightcom_ups_worldwide_express_plus | 4608 freightcom_purolator_express_us_9_am | 4013 freightcom_express_easy | 5202 freightcom_express_10_30 | 5208 freightcom_express_worldwide | 5211 freightcom_express_12_00 | 5215 freightcom_economy_select | 5216 freightcom_dayr_e_comm_am_service | 5706 freightcom_dayr_e_comm_ground_service | 5707 freightcom_regular_parcel | 6301 freightcom_expedited_parcel | 6300 freightcom_xpresspost | 6303 freightcom_priority | 6302

### eShipper
Code | Identifier --- | --- eshipper_fedex_priority | 1 eshipper_fedex_first_overnight | 2 eshipper_fedex_ground | 3 eshipper_fedex_standard_overnight | 28 eshipper_fedex_2nd_day | 29 eshipper_fedex_express_saver | 30 eshipper_fedex_international_economy | 35 eshipper_purolator_air | 4 eshipper_purolator_air_9_am | 5 eshipper_purolator_air_10_30 | 6 eshipper_puro_letter | 7 eshipper_puro_letter_9_am | 8 eshipper_puro_letter_10_30 | 9 eshipper_puro_pak | 10 eshipper_puro_pak_9_am | 11 eshipper_puro_pak_10_30 | 12 eshipper_purolator_ground | 13 eshipper_purolator_ground_9_am | 19 eshipper_purolator_ground_10_30 | 20 eshipper_canada_worldwide_same_day | 14 eshipper_canada_worldwide_next_flight_out | 15 eshipper_canada_worldwide_air_freight | 16 eshipper_canada_worldwide_ltl | 17 eshipper_dhl_express_worldwide | 101 eshipper_dhl_express_12_pm | 103 eshipper_dhl_express_10_30_am | 102 eshipper_dhl_esi_export | 104 eshipper_dhl_international_express | 106 eshipper_ups_express_next_day_air | 600 eshipper_ups_expedited_second_day_air | 601 eshipper_ups_worldwide_express | 602 eshipper_ups_worldwide_expedited | 603 eshipper_ups_standard_ground | 604 eshipper_ups_express_early_am_next_day_air_early_am | 605 eshipper_ups_three_day_select | 606 eshipper_ups_saver | 607 eshipper_ups_ground | 608 eshipper_next_day_saver | 609 eshipper_worldwide_express_plus | 610 eshipper_second_day_air_am | 611 eshipper_canada_post_priority | 500 eshipper_canada_post_xpress_post | 501 eshipper_canada_post_expedited | 502 eshipper_canada_post_regular | 503 eshipper_canada_post_xpress_post_usa | 504 eshipper_canada_post_xpress_post_intl | 505 eshipper_canada_post_air_parcel_intl | 506 eshipper_canada_post_surface_parcel_intl | 507 eshipper_canada_post_expedited_parcel_usa | 508 eshipper_tst_ltl | 1100 eshipper_ltl_chicago_suburban_express | 1500 eshipper_ltl_fedex_freight_east | 1501 eshipper_ltl_fedex_freight_west | 1502 eshipper_ltl_mid_states_express | 1503 eshipper_ltl_new_england_motor_freight | 1504 eshipper_ltl_new_penn | 1505 eshipper_ltl_oak_harbor | 1506 eshipper_ltl_pitt_ohio | 1507 eshipper_ltl_r_l_carriers | 1508 eshipper_ltl_saia | 1509 eshipper_ltl_usf_reddaway | 1510 eshipper_ltl_vitran_express | 1511 eshipper_ltl_wilson_trucking | 1512 eshipper_ltl_yellow_transportation | 1513 eshipper_ltl_roadway | 1514 eshipper_ltl_fedex_national | 1515 eshipper_wilson_trucking_tfc | 1800 eshipper_aaa_cooper_transportation | 1801 eshipper_roadrunner_dawes | 1802 eshipper_new_england_motor_freight | 1803 eshipper_new_penn_motor_express | 1804 eshipper_dayton_freight | 1805 eshipper_southeastern_freightway | 1806 eshipper_saia_inc | 1807 eshipper_conway | 1808 eshipper_roadway | 1809 eshipper_usf_reddaway | 1810 eshipper_usf_holland | 1811 eshipper_dependable_highway_express | 1812 eshipper_day_and_ross | 1813 eshipper_day_and_ross_r_and_l | 1814 eshipper_ups | 1815 eshipper_aaa_cooper | 1816 eshipper_ama_transportation | 1817 eshipper_averitt_express | 1818 eshipper_central_freight | 1819 eshipper_conway_us | 1820 eshipper_dayton | 1821 eshipper_drug_transport | 1822 eshipper_estes | 1823 eshipper_land_air_express | 1824 eshipper_fedex_west | 1825 eshipper_fedex_national | 1826 eshipper_usf_holland_us | 1827 eshipper_lakeville_m_express | 1828 eshipper_milan_express | 1829 eshipper_nebraska_transport | 1830 eshipper_new_england | 1831 eshipper_new_penn | 1832 eshipper_a_duie_pyle | 1833 eshipper_roadway_us | 1834 eshipper_usf_reddaway_us | 1835 eshipper_rhody_transportation | 1836 eshipper_saia_motor_freight | 1837 eshipper_southeastern_frgt | 1838 eshipper_pitt_ohio | 1839 eshipper_ward | 1840 eshipper_wilson | 1841 eshipper_chi_cargo | 1842 eshipper_tax_air | 1843 eshipper_fedex_east | 1844 eshipper_central_transport | 1845 eshipper_roadrunner | 1846 eshipper_r_and_l_carriers | 1847 eshipper_estes_us | 1848 eshipper_yrc_roadway | 1849 eshipper_central_transport_us | 1850 eshipper_absolute_transportation_services | 1851 eshipper_blue_sky_express | 1852 eshipper_galasso_trucking | 1853 eshipper_griley_air_freight | 1854 eshipper_jet_transportation | 1855 eshipper_metro_transportation_logistics | 1856 eshipper_oak_harbor | 1857 eshipper_stream_links_express | 1858 eshipper_tiffany_trucking | 1859 eshipper_ups_freight | 1860 eshipper_roadrunner_us | 1861 eshipper_global_mail_parcel_priority | 3500 eshipper_global_mail_parcel_standard | 3501 eshipper_global_mail_packet_plus_priority | 3502 eshipper_global_mail_packet_priority | 3503 eshipper_global_mail_packet_standard | 3504 eshipper_global_mail_business_priority | 3505 eshipper_global_mail_business_standard | 3506 eshipper_global_mail_parcel_direct_priority | 3507 eshipper_global_mail_parcel_direct_standard | 3508 eshipper_ground | 4500 eshipper_select_parcel | 4504 eshipper_express_parcel | 4507


# noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.references(async_req=True) @@ -155,7 +154,6 @@ def references(self, **kwargs): # noqa: E501 def references_with_http_info(self, **kwargs): # noqa: E501 """Data References # noqa: E501 - ## Countries
Code | Name --- | --- AD | Andorra AE | United Arab Emirates AF | Afghanistan AG | Antigua AI | Anguilla AL | Albania AM | Armenia AN | Netherlands Antilles AO | Angola AR | Argentina AS | American Samoa AT | Austria AU | Australia AW | Aruba AZ | Azerbaijan BA | Bosnia And Herzegovina BB | Barbados BD | Bangladesh BE | Belgium BF | Burkina Faso BG | Bulgaria BH | Bahrain BI | Burundi BJ | Benin BM | Bermuda BN | Brunei BO | Bolivia BR | Brazil BS | Bahamas BT | Bhutan BW | Botswana BY | Belarus BZ | Belize CA | Canada CD | Congo, The Democratic Republic Of CF | Central African Republic CG | Congo CH | Switzerland CI | Cote D Ivoire CK | Cook Islands CL | Chile CM | Cameroon CN | China, Peoples Republic CO | Colombia CR | Costa Rica CU | Cuba CV | Cape Verde CY | Cyprus CZ | Czech Republic, The DE | Germany DJ | Djibouti DK | Denmark DM | Dominica DO | Dominican Republic DZ | Algeria EC | Ecuador EE | Estonia EG | Egypt ER | Eritrea ES | Spain ET | Ethiopia FI | Finland FJ | Fiji FK | Falkland Islands FM | Micronesia, Federated States Of FO | Faroe Islands FR | France GA | Gabon GB | United Kingdom GD | Grenada GE | Georgia GF | French Guyana GG | Guernsey GH | Ghana GI | Gibraltar GL | Greenland GM | Gambia GN | Guinea Republic GP | Guadeloupe GQ | Guinea-equatorial GR | Greece GT | Guatemala GU | Guam GW | Guinea-bissau GY | Guyana (british) HK | Hong Kong HN | Honduras HR | Croatia HT | Haiti HU | Hungary IC | Canary Islands, The ID | Indonesia IE | Ireland, Republic Of IL | Israel IN | India IQ | Iraq IR | Iran (islamic Republic Of) IS | Iceland IT | Italy JE | Jersey JM | Jamaica JO | Jordan JP | Japan KE | Kenya KG | Kyrgyzstan KH | Cambodia KI | Kiribati KM | Comoros KN | St. Kitts KP | Korea, The D.p.r Of (north K.) KR | Korea, Republic Of (south K.) KV | Kosovo KW | Kuwait KY | Cayman Islands KZ | Kazakhstan LA | Lao Peoples Democratic Republic LB | Lebanon LC | St. Lucia LI | Liechtenstein LK | Sri Lanka LR | Liberia LS | Lesotho LT | Lithuania LU | Luxembourg LV | Latvia LY | Libya MA | Morocco MC | Monaco MD | Moldova, Republic Of ME | Montenegro, Republic Of MG | Madagascar MH | Marshall Islands MK | Macedonia, Republic Of ML | Mali MM | Myanmar MN | Mongolia MO | Macau MP | Commonwealth No. Mariana Islands MQ | Martinique MR | Mauritania MS | Montserrat MT | Malta MU | Mauritius MV | Maldives MW | Malawi MX | Mexico MY | Malaysia MZ | Mozambique NA | Namibia NC | New Caledonia NE | Niger NG | Nigeria NI | Nicaragua NL | Netherlands, The NO | Norway NP | Nepal NR | Nauru, Republic Of NU | Niue NZ | New Zealand OM | Oman PA | Panama PE | Peru PF | Tahiti PG | Papua New Guinea PH | Philippines, The PK | Pakistan PL | Poland PR | Puerto Rico PT | Portugal PW | Palau PY | Paraguay QA | Qatar RE | Reunion, Island Of RO | Romania RS | Serbia, Republic Of RU | Russian Federation, The RW | Rwanda SA | Saudi Arabia SB | Solomon Islands SC | Seychelles SD | Sudan SE | Sweden SG | Singapore SH | Saint Helena SI | Slovenia SK | Slovakia SL | Sierra Leone SM | San Marino SN | Senegal SO | Somalia SR | Suriname SS | South Sudan ST | Sao Tome And Principe SV | El Salvador SY | Syria SZ | Swaziland TC | Turks And Caicos Islands TD | Chad TG | Togo TH | Thailand TJ | Tajikistan TL | Timor Leste TN | Tunisia TO | Tonga TR | Turkey TT | Trinidad And Tobago TV | Tuvalu TW | Taiwan TZ | Tanzania UA | Ukraine UG | Uganda US | United States UY | Uruguay UZ | Uzbekistan VA | Vatican City State VC | St. Vincent VE | Venezuela VG | British Virgin Islands VI | U.S. Virgin Islands VN | Vietnam VU | Vanuatu WS | Samoa XB | Bonaire XC | Curacao XE | St. Eustatius XM | St. Maarten XN | Nevis XS | Somaliland, Rep Of (north Somalia) XY | St. Barthelemy YE | Yemen, Republic Of YT | Mayotte ZA | South Africa ZM | Zambia ZW | Zimbabwe

## States and Provinces
### United Arab Emirates
Code | Name --- | --- AB | Abu Dhabi AJ | Ajman DU | Dubai FU | Fujairah RA | Ras al-Khaimah SH | Sharjah UM | Umm al-Qaiwain

### Canada
Code | Name --- | --- AB | Alberta BC | British Columbia MB | Manitoba NB | New Brunswick NL | Newfoundland NT | Northwest Territories NS | Nova Scotia NU | Nunavut ON | Ontario PE | Prince Edward Island QC | Quebec SK | Saskatchewan YT | Yukon

### China, Peoples Republic
Code | Name --- | --- anhui | Anhui hainan | Hainan jiangxi | Jiangxi shanghai | Shanghai beijing | Beijing hebei | Hebei jilin | Jilin shanxi | Shanxi chongqing | Chongqing heilongjiang | Heilongjiang liaoning | Liaoning sichuan | Sichuan fujian | Fujian henan | Henan nei_mongol | Nei Mongol tianjin | Tianjin gansu | Gansu hubei | Hubei qinghai | Qinghai xinjiang | Xinjiang guangdong | Guangdong hunan | Hunan shaanxi | Shaanxi yunnan | Yunnan guizhou | Guizhou jiangsu | Jiangsu shandong | Shandong zhejiang | Zhejiang

### India
Code | Name --- | --- AN | Andaman & Nicobar (U.T) AP | Andhra Pradesh AR | Arunachal Pradesh AS | Assam BR | Bihar CG | Chattisgarh CH | Chandigarh (U.T.) DD | Daman & Diu (U.T.) DL | Delhi (U.T.) DN | Dadra and Nagar Haveli (U.T.) GA | Goa GJ | Gujarat HP | Himachal Pradesh HR | Haryana JH | Jharkhand JK | Jammu & Kashmir KA | Karnataka KL | Kerala LD | Lakshadweep (U.T) MH | Maharashtra ML | Meghalaya MN | Manipur MP | Madhya Pradesh MZ | Mizoram NL | Nagaland OR | Orissa PB | Punjab PY | Puducherry (U.T.) RJ | Rajasthan SK | Sikkim TN | Tamil Nadu TR | Tripura UA | Uttaranchal UP | Uttar Pradesh WB | West Bengal

### Mexico
Code | Name --- | --- AG | Aguascalientes BC | Baja California BS | Baja California Sur CM | Campeche CS | Chiapas CH | Chihuahua CO | Coahuila CL | Colima DF | Ciudad de México DG | Durango GT | Guanajuato GR | Guerrero HG | Hidalgo JA | Jalisco EM | Estado de México MI | Michoacán MO | Morelos NA | Nayarit NL | Nuevo León OA | Oaxaca PU | Puebla QE | Querétaro QR | Quintana Roo SL | San Luis Potosí SI | Sinaloa SO | Sonora TB | Tabasco TM | Tamaulipas TL | Tlaxcala VE | Veracruz YU | Yucatán ZA | Zacatecas

### United States
Code | Name --- | --- AL | Alabama AK | Alaska AZ | Arizona AR | Arkansas CA | California CO | Colorado CT | Connecticut DE | Delaware DC | District of Columbia FL | Florida GA | Georgia HI | Hawaii ID | Idaho IL | Illinois IN | Indiana IA | Iowa KS | Kansas KY | Kentucky LA | Louisiana ME | Maine MD | Maryland MA | Massachusetts MI | Michigan MN | Minnesota MS | Mississippi MO | Missouri MT | Montana NE | Nebraska NV | Nevada NH | New Hampshire NJ | New Jersey NM | New Mexico NY | New York NC | North Carolina ND | North Dakota OH | Ohio OK | Oklahoma OR | Oregon PA | Pennsylvania RI | Rhode Island SC | South Carolina SD | South Dakota TN | Tennessee TX | Texas UT | Utah VT | Vermont VA | Virginia WA | Washington State WV | West Virginia WI | Wisconsin WY | Wyoming PR | Puerto Rico


## Currencies
Code | Name --- | --- EUR | Euro AED | UAE Dirham USD | US Dollar XCD | East Caribbean Dollar AMD | Dran ANG | Netherlands Antilles Guilder AOA | Kwanza ARS | Argentine Peso AUD | Australian Dollar AWG | Aruba Guilder AZN | Manat BAM | Convertible Marks BBD | Barbadian Dollar BDT | Taka XOF | CFA Franc West Africa BGN | Bulgarian Lev BHD | Bahraini Dinar BIF | Burundese Franc BMD | Bermudian Dollar BND | Brunei Dollar BOB | Boliviano BRL | Real BSD | Bahamian Dollar BTN | Ngultrum BWP | Pula BYN | Belarussian Ruble BZD | Belize Dollar CAD | Canadian Dollar CDF | Franc Congolais XAF | CFA Franc Central Africa CHF | Swiss Franc NZD | New Zealand Dollar CLP | New Chile Peso CNY | Yuan (Ren Min Bi) COP | Colombian Peso CRC | Costa Rican Colon CUC | Peso Convertible CVE | Cape Verde Escudo CZK | Czech Koruna DJF | Djibouti Franc DKK | Danish Krone DOP | Dominican Republic Peso DZD | Algerian Dinar EGP | Egyptian Pound ERN | Nakfa ETB | Birr FJD | Fijian Dollar GBP | Pound Sterling GEL | Georgian Lari GHS | Cedi GMD | Dalasi GNF | Guinea Franc GTQ | Quetzal GYD | Guyanan Dollar HKD | Hong Kong Dollar HNL | Lempira HRK | Croatian Kuna HTG | Gourde HUF | Forint IDR | Rupiah ILS | New Israeli Shekel INR | Indian Rupee IRR | Iranian Rial ISK | Icelandic Krona JMD | Jamaican Dollar JOD | Jordanian Dinar JPY | Yen KES | Kenyan Shilling KGS | Som KHR | Khmer Rial KMF | Comoros Franc KPW | North Korean Won KRW | Won KWD | Kuwaiti Dinar KYD | Cayman Islands Dollar KZT | Tenge LAK | Kip LKR | Sri Lankan Rupee LRD | Liberian Dollar LSL | Loti LYD | Libyan Dinar MAD | Moroccan Dirham MDL | Leu MGA | Ariary MKD | Denar MMK | Kyat MNT | Tugrik MOP | Pataca MRO | Ouguiya MUR | Mauritius Rupee MVR | Rufiyaa MWK | Kwacha MXN | Mexican Nuevo Peso MYR | Ringgit MZN | Mozambique Metical NAD | Namibian Dollar XPF | CFP Franc NGN | Naira NIO | Cordoba Oro NOK | Norwegian Krone NPR | Nepalese Rupee OMR | Omani Rial PEN | Nuevo Sol PGK | Kina PHP | Phillipines Peso PKR | Pakistani Rupee PLN | Zloty PYG | Guarani QAR | Qatar Rial RSD | Serbia, Dinars RUB | Russian Ruble RWF | Rwanda Franc SAR | Saudi Riyal SBD | Solomon Islands Dollar SCR | Seychelles Rupee SDG | Sudanese Pound SEK | Swedish Krona SGD | Singapore Dollar SHP | St. Helena Pound SLL | Leone SOS | Somali Shilling SRD | Suriname Dollar SSP | South Sudanese pound STD | Dobra SYP | Syrian Pound SZL | Lilangeni THB | Baht TJS | Somoni TND | Tunisian Dinar TOP | Pa'anga TRY | New Turkish Lira TTD | Trinidad and Tobago Dollar TWD | New Taiwan Dollar TZS | Tanzanian Shilling UAH | Hryvna UYU | Peso Uruguayo UZS | Sum VEF | Bolivar Fuerte VND | Dong VUV | Vanuatu Vatu WST | Tala YER | Yemeni Riyal ZAR | South African Rand

## Packaging Types
### Multi-carrier (purplship)
Code | Identifier --- | --- envelope | Small Envelope pak | Pak tube | Tube pallet | Pallet small_box | Small Box medium_box | Medium Box your_packaging | Your Packaging

### DHL Express
Code | Identifier --- | --- dhl_flyer_smalls | FLY dhl_parcels_conveyables | COY dhl_non_conveyables | NCY dhl_pallets | PAL dhl_double_pallets | DBL dhl_box | BOX

### FedEx Express
Code | Identifier --- | --- fedex_envelope | FEDEX_ENVELOPE fedex_pak | FEDEX_PAK fedex_box | FEDEX_BOX fedex_10_kg_box | FEDEX_10KG_BOX fedex_25_kg_box | FEDEX_25KG_BOX fedex_tube | FEDEX_TUBE your_packaging | YOUR_PACKAGING

### Purolator Courier
Code | Identifier --- | --- purolator_express_envelope | Envelope purolator_express_pack | Pack purolator_express_box | Box purolator_customer_packaging | Customer Packaging

### UPS Package
Code | Identifier --- | --- ups_unknown | 00 ups_letter | 01 ups_package | 02 ups_tube | 03 ups_pak | 04 ups_express_box | 21 ups_box_25_kg | 24 ups_box_10_kg | 25 ups_pallet | 30 ups_small_express_box | 2a ups_medium_express_box | 2b ups_large_express_box | 2c


## Package Preset
### Canada Post
Code | Dimensions | Note --- | --- | --- canadapost_mailing_box | 15.2 x 1.0 x 10.2 | height x length x width canadapost_extra_small_mailing_box | 14.0 x 14.0 x 14.0 | height x length x width canadapost_small_mailing_box | 22.9 x 6.4 x 28.6 | height x length x width canadapost_medium_mailing_box | 23.5 x 13.3 x 31.0 | height x length x width canadapost_large_mailing_box | 30.5 x 9.5 x 38.1 | height x length x width canadapost_extra_large_mailing_box | 30.5 x 21.6 x 40.0 | height x length x width canadapost_corrugated_small_box | 32.0 x 32.0 x 42.0 | height x length x width canadapost_corrugated_medium_box | 38.0 x 32.0 x 46.0 | height x length x width canadapost_corrugated_large_box | 46.0 x 40.6 x 46.0 | height x length x width canadapost_xexpresspost_certified_envelope | 15.9 x 1.5 x 0.5 x 26.0 | height x length x weight x width canadapost_xexpresspost_national_large_envelope | 29.2 x 1.5 x 1.36 x 40.0 | height x length x weight x width

### DHL Express
Code | Dimensions | Note --- | --- | --- dhl_express_envelope | 27.5 x 1.0 x 0.5 x 35.0 | height x length x weight x width dhl_express_standard_flyer | 30.0 x 1.5 x 2.0 x 40.0 | height x length x weight x width dhl_express_large_flyer | 37.5 x 1.5 x 3.0 x 47.5 | height x length x weight x width dhl_express_box_2 | 18.2 x 10.0 x 1.0 x 33.7 | height x length x weight x width dhl_express_box_3 | 32.0 x 5.2 x 2.0 x 33.6 | height x length x weight x width dhl_express_box_4 | 32.2 x 18.0 x 5.0 x 33.7 | height x length x weight x width dhl_express_box_5 | 32.2 x 34.5 x 10.0 x 33.7 | height x length x weight x width dhl_express_box_6 | 35.9 x 36.9 x 15.0 x 41.7 | height x length x weight x width dhl_express_box_7 | 40.4 x 38.9 x 20.0 x 48.1 | height x length x weight x width dhl_express_box_8 | 44.4 x 40.9 x 25.0 x 54.2 | height x length x weight x width dhl_express_tube | 15.0 x 15.0 x 5.0 x 96.0 | height x length x weight x width dhl_didgeridoo_box | 13.0 x 162.0 x 10.0 x 13.0 | height x length x weight x width dhl_jumbo_box | 42.7 x 33.0 x 30.0 x 45.0 | height x length x weight x width dhl_jumbo_box_junior | 34.0 x 24.1 x 20.0 x 39.9 | height x length x weight x width

### FedEx Express
Code | Dimensions | Note --- | --- | --- fedex_envelope_legal_size | 15.5 x 1.0 x 9.5 | height x weight x width fedex_padded_pak | 14.75 x 2.2 x 11.75 | height x weight x width fedex_polyethylene_pak | 15.5 x 2.2 x 12.0 | height x weight x width fedex_clinical_pak | 18.0 x 2.2 x 13.5 | height x weight x width fedex_small_box | 10.9 x 1.5 x 20.0 x 12.25 | height x length x weight x width fedex_medium_box | 11.5 x 2.38 x 20.0 x 13.25 | height x length x weight x width fedex_large_box | 12.38 x 3.0 x 20.0 x 17.88 | height x length x weight x width fedex_10_kg_box | 12.94 x 10.19 x 10.0 x 15.81 | height x length x weight x width fedex_25_kg_box | 16.56 x 13.19 x 25.0 x 21.56 | height x length x weight x width fedex_tube | 6.0 x 6.0 x 20.0 x 38.0 | height x length x weight x width

### Purolator Courier
Code | Dimensions | Note --- | --- | --- purolator_express_envelope | 1.5 x 1.0 x 12.5 | length x weight x width purolator_express_pack | 1.0 x 3.0 x 12.5 | length x weight x width purolator_express_box | 3.5 x 7.0 | length x weight

### UPS Package
Code | Dimensions | Note --- | --- | --- ups_small_express_box | 11.0 x 2.0 x 30.0 x 13.0 | height x length x weight x width ups_medium_express_box | 11.0 x 3.0 x 30.0 x 16.0 | height x length x weight x width ups_large_express_box | 13.0 x 3.0 x 30.0 x 18.0 | height x length x weight x width ups_express_tube | 6.0 x 6.0 x 38.0 | height x length x width ups_express_pak | 11.75 x 1.5 x 16.0 | height x length x width ups_world_document_box | 12.5 x 3.0 x 17.5 | height x length x width


## Shipment Options
### Canada Post
Code | Identifier --- | --- canadapost_signature | SO canadapost_coverage | COV canadapost_collect_on_delivery | COD canadapost_proof_of_age_required_18 | PA18 canadapost_proof_of_age_required_19 | PA19 canadapost_card_for_pickup | HFP canadapost_do_not_safe_drop | DNS canadapost_leave_at_door | LAD canadapost_deliver_to_post_office | D2PO canadapost_return_at_senders_expense | RASE canadapost_return_to_sender | RTS canadapost_abandon | ABAN

### DHL Express
Code | Identifier --- | --- dhl_logistics_services | 0A dhl_mailroom_management | 0B dhl_pallet_administration | 0C dhl_warehousing | 0D dhl_express_logistics_centre | 0E dhl_strategic_parts_centre | 0F dhl_local_distribution_centre | 0G dhl_terminal_handling | 0H dhl_cross_docking | 0I dhl_inventory_management | 0J dhl_loading_unloading | 0K dhl_product_kitting | 0L dhl_priority_account_desk | 0M dhl_document_archiving | 0N dhl_saturday_delivery | AA dhl_saturday_pickup | AB dhl_holiday_delivery | AC dhl_holiday_pickup | AD dhl_domestic_saturday_delivery | AG dhl_standard | BA dhl_globalmail_item | BB dhl_letter | BC dhl_packet | BD dhl_letter_plus | BE dhl_packet_plus | BF dhl_elevated_risk | CA dhl_restricted_destination | CB dhl_security_validation | CC dhl_secure_protection | CD dhl_proof_of_identity | CE dhl_secure_storage | CF dhl_diplomatic_material | CG dhl_smart_sensor | CH dhl_visa_program | CI dhl_onboard_courier | CJ dhl_secure_safebox | CK dhl_smart_sentry | CL dhl_split_duties_and_tax | DC dhl_duties_and_taxes_paid | DD dhl_receiver_paid | DE dhl_duties_and_taxes_unpaid | DS dhl_import_billing | DT dhl_importer_of_record | DU dhl_go_green_carbon_neutral | EA dhl_go_green_carbon_footprint | EB dhl_go_green_carbon_estimate | EC dhl_fuel_surcharge_b | FB dhl_fuel_surcharge_c | FC dhl_fuel_surcharge_f | FF dhl_smartphone_box | GA dhl_laptop_box | GB dhl_bottle_box | GC dhl_repacking | GD dhl_tablet_box | GE dhl_filler_material | GF dhl_packaging | GG dhl_diplomatic_bag | GH dhl_pallet_box | GI dhl_lock_box | GJ dhl_lithium_ion_pi965_section_ii | HB dhl_dry_ice_un1845 | HC dhl_lithium_ion_pi965_966_section_ii | HD dhl_dangerous_goods | HE dhl_perishable_cargo | HG dhl_excepted_quantity | HH dhl_spill_cleaning | HI dhl_consumer_commodities | HK dhl_limited_quantities_adr | HL dhl_lithium_metal_pi969_section_ii | HM dhl_adr_load_exemption | HN dhl_lithium_ion_pi967_section_ii | HV dhl_lithium_metal_pi970_section_ii | HW dhl_biological_un3373 | HY dhl_extended_liability | IB dhl_contract_insurance | IC dhl_shipment_insurance | II dhl_delivery_notification | JA dhl_pickup_notification | JC dhl_proactive_tracking | JD dhl_performance_reporting | JE dhl_prealert_notification | JY dhl_change_of_billing | KA dhl_cash_on_delivery | KB dhl_printed_invoice | KD dhl_waybill_copy | KE dhl_import_paperwork | KF dhl_payment_on_pickup | KY dhl_shipment_intercept | LA dhl_shipment_redirect | LC dhl_storage_at_facility | LE dhl_cold_storage | LG dhl_specific_routing | LH dhl_service_recovery | LV dhl_alternative_address | LW dhl_hold_for_collection | LX dhl_address_correction_a | MA dhl_address_correction_b | MB dhl_neutral_delivery | NN dhl_remote_area_pickup | OB dhl_remote_area_delivery_c | OC dhl_out_of_service_area | OE dhl_remote_area_delivery_o | OO dhl_shipment_preparation | PA dhl_shipment_labeling | PB dhl_shipment_consolidation | PC dhl_relabeling_data_entry | PD dhl_preprinted_waybill | PE dhl_piece_labelling | PS dhl_data_staging_03 | PT dhl_data_staging_06 | PU dhl_data_staging_12 | PV dhl_data_staging_24 | PW dhl_standard_pickup | PX dhl_scheduled_pickup | PY dhl_dedicated_pickup | QA dhl_early_pickup | QB dhl_late_pickup | QD dhl_residential_pickup | QE dhl_loading_waiting | QF dhl_bypass_injection | QH dhl_direct_injection | QI dhl_drop_off_at_facility | QY dhl_delivery_signature | SA dhl_content_signature | SB dhl_named_signature | SC dhl_adult_signature | SD dhl_contract_signature | SE dhl_alternative_signature | SW dhl_no_signature_required | SX dhl_dedicated_delivery | TA dhl_early_delivery | TB dhl_time_window_delivery | TC dhl_evening_delivery | TD dhl_delivery_on_appointment | TE dhl_return_undeliverable | TG dhl_swap_delivery | TH dhl_unloading_waiting | TJ dhl_residential_delivery | TK dhl_repeat_delivery | TN dhl_alternative_date | TT dhl_no_partial_delivery | TU dhl_service_point_24_7 | TV dhl_pre_9_00 | TW dhl_pre_10_30 | TX dhl_pre_12_00 | TY dhl_thermo_packaging | UA dhl_ambient_vialsafe | UB dhl_ambient_non_insulated | UC dhl_ambient_insulated | UD dhl_ambient_extreme | UE dhl_chilled_box_s | UF dhl_chilled_box_m | UG dhl_chilled_box_l | UH dhl_frozen_no_ice_s | UI dhl_frozen_no_ice_m | UJ dhl_frozen_no_ice_l | UK dhl_frozen_ice_sticks_s | UL dhl_frozen_ice_sticks_m | UM dhl_frozen_ice_sticks_l | UN dhl_frozen_ice_plates_s | UO dhl_frozen_ice_plates_m | UP dhl_frozen_ice_plates_l | UQ dhl_combination_no_ice | UR dhl_combination_dry_ice | US dhl_frozen_ice_sticks_e | UT dhl_frozen_ice_plates_e | UV dhl_customer_tcp_1 | UW dhl_thermo_accessories | VA dhl_absorbent_sleeve | VB dhl_cooland_wrap | VC dhl_dry_ice_supplies | VD dhl_pressure_bag_s | VE dhl_pressure_bag_m | VF dhl_pressure_bag_l | VG dhl_informal_clearance | WA dhl_formal_clearance | WB dhl_payment_deferment | WC dhl_clearance_authorization | WD dhl_multiline_entry | WE dhl_post_clearance_modification | WF dhl_handover_to_broker | WG dhl_physical_intervention | WH dhl_bio_phyto_veterinary_controls | WI dhl_obtaining_permits_and_licences | WJ dhl_bonded_storage | WK dhl_bonded_transit_documents | WL dhl_temporary_import_export | WM dhl_under_bond_guarantee | WN dhl_export_declaration | WO dhl_exporter_validation | WP dhl_certificate_of_origin | WQ dhl_document_translation | WR dhl_personal_effects | WS dhl_paperless_trade | WY dhl_import_export_taxes | XB dhl_unrecoverable_origin_tax | XC dhl_quarantine_inspection | XD dhl_merchandise_process | XE dhl_domestic_postal_tax | XF dhl_tier_two_tax | XG dhl_tier_three_tax | XH dhl_import_penalty | XI dhl_cargo_zone_process | XJ dhl_import_export_duties | XX dhl_premium_09_00 | Y1 dhl_premium_10_30 | Y2 dhl_premium_12_00 | Y3 dhl_over_sized_piece_b | YB dhl_over_handled_piece_c | YC dhl_multipiece_shipment | YE dhl_over_weight_piece_f | YF dhl_over_sized_piece_g | YG dhl_over_handled_piece_h | YH dhl_premium_9_00_i | YI dhl_premium_10_30_j | YJ dhl_premium_12_00_k | YK dhl_paket_shipment | YV dhl_breakbulk_mother | YW dhl_breakbulk_baby | YX dhl_over_weight_piece_y | YY dhl_customer_claim | ZA dhl_damage_compensation | ZB dhl_loss_compensation | ZC dhl_customer_rebate | ZD dhl_e_com_discount | ZE

### FedEx Express
Code | Identifier --- | --- fedex_blind_shipment | BLIND_SHIPMENT fedex_broker_select_option | BROKER_SELECT_OPTION fedex_call_before_delivery | CALL_BEFORE_DELIVERY fedex_cod | COD fedex_cod_remittance | COD_REMITTANCE fedex_custom_delivery_window | CUSTOM_DELIVERY_WINDOW fedex_cut_flowers | CUT_FLOWERS fedex_dangerous_goods | DANGEROUS_GOODS fedex_delivery_on_invoice_acceptance | DELIVERY_ON_INVOICE_ACCEPTANCE fedex_detention | DETENTION fedex_do_not_break_down_pallets | DO_NOT_BREAK_DOWN_PALLETS fedex_do_not_stack_pallets | DO_NOT_STACK_PALLETS fedex_dry_ice | DRY_ICE fedex_east_coast_special | EAST_COAST_SPECIAL fedex_electronic_trade_documents | ELECTRONIC_TRADE_DOCUMENTS fedex_event_notification | EVENT_NOTIFICATION fedex_exclude_from_consolidation | EXCLUDE_FROM_CONSOLIDATION fedex_exclusive_use | EXCLUSIVE_USE fedex_exhibition_delivery | EXHIBITION_DELIVERY fedex_exhibition_pickup | EXHIBITION_PICKUP fedex_expedited_alternate_delivery_route | EXPEDITED_ALTERNATE_DELIVERY_ROUTE fedex_expedited_one_day_earlier | EXPEDITED_ONE_DAY_EARLIER fedex_expedited_service_monitoring_and_delivery | EXPEDITED_SERVICE_MONITORING_AND_DELIVERY fedex_expedited_standard_day_early_delivery | EXPEDITED_STANDARD_DAY_EARLY_DELIVERY fedex_extra_labor | EXTRA_LABOR fedex_extreme_length | EXTREME_LENGTH fedex_one_rate | FEDEX_ONE_RATE fedex_flatbed_trailer | FLATBED_TRAILER fedex_food | FOOD fedex_freight_guarantee | FREIGHT_GUARANTEE fedex_freight_to_collect | FREIGHT_TO_COLLECT fedex_future_day_shipment | FUTURE_DAY_SHIPMENT fedex_hold_at_location | HOLD_AT_LOCATION fedex_holiday_delivery | HOLIDAY_DELIVERY fedex_holiday_guarantee | HOLIDAY_GUARANTEE fedex_home_delivery_premium | HOME_DELIVERY_PREMIUM fedex_inside_delivery | INSIDE_DELIVERY fedex_inside_pickup | INSIDE_PICKUP fedex_international_controlled_export_service | INTERNATIONAL_CONTROLLED_EXPORT_SERVICE fedex_international_mail_service | INTERNATIONAL_MAIL_SERVICE fedex_international_traffic_in_arms_regulations | INTERNATIONAL_TRAFFIC_IN_ARMS_REGULATIONS fedex_liftgate_delivery | LIFTGATE_DELIVERY fedex_liftgate_pickup | LIFTGATE_PICKUP fedex_limited_access_delivery | LIMITED_ACCESS_DELIVERY fedex_limited_access_pickup | LIMITED_ACCESS_PICKUP fedex_marking_or_tagging | MARKING_OR_TAGGING fedex_non_business_time | NON_BUSINESS_TIME fedex_pallet_shrinkwrap | PALLET_SHRINKWRAP fedex_pallet_weight_allowance | PALLET_WEIGHT_ALLOWANCE fedex_pallets_provided | PALLETS_PROVIDED fedex_pending_complete | PENDING_COMPLETE fedex_pending_shipment | PENDING_SHIPMENT fedex_permit | PERMIT fedex_pharmacy_delivery | PHARMACY_DELIVERY fedex_poison | POISON fedex_port_delivery | PORT_DELIVERY fedex_port_pickup | PORT_PICKUP fedex_pre_delivery_notification | PRE_DELIVERY_NOTIFICATION fedex_pre_eig_processing | PRE_EIG_PROCESSING fedex_pre_multiplier_processing | PRE_MULTIPLIER_PROCESSING fedex_protection_from_freezing | PROTECTION_FROM_FREEZING fedex_regional_mall_delivery | REGIONAL_MALL_DELIVERY fedex_regional_mall_pickup | REGIONAL_MALL_PICKUP fedex_return_shipment | RETURN_SHIPMENT fedex_returns_clearance | RETURNS_CLEARANCE fedex_returns_clearance_special_routing_required | RETURNS_CLEARANCE_SPECIAL_ROUTING_REQUIRED fedex_saturday_delivery | SATURDAY_DELIVERY fedex_saturday_pickup | SATURDAY_PICKUP fedex_shipment_assembly | SHIPMENT_ASSEMBLY fedex_sort_and_segregate | SORT_AND_SEGREGATE fedex_special_delivery | SPECIAL_DELIVERY fedex_special_equipment | SPECIAL_EQUIPMENT fedex_storage | STORAGE fedex_sunday_delivery | SUNDAY_DELIVERY fedex_third_party_consignee | THIRD_PARTY_CONSIGNEE fedex_top_load | TOP_LOAD fedex_usps_delivery | USPS_DELIVERY fedex_usps_pickup | USPS_PICKUP fedex_weighing | WEIGHING

### Purolator Courier
Code | Identifier --- | --- purolator_dangerous_goods | Dangerous Goods purolator_chain_of_signature | Chain of Signature purolator_express_cheque | ExpressCheque purolator_hold_for_pickup | Hold For Pickup purolator_return_services | Return Services purolator_saturday_service | Saturday Service purolator_origin_signature_not_required | Origin Signature Not Required (OSNR) purolator_adult_signature_required | Adult Signature Required (ASR) purolator_special_handling | Special Handling

### UPS Package
Code | Identifier --- | --- ups_saturday_delivery_indicator | SaturdayDeliveryIndicator ups_access_point_cod | AccessPointCOD ups_deliver_to_addressee_only_indicator | DeliverToAddresseeOnlyIndicator ups_direct_delivery_only_indicator | DirectDeliveryOnlyIndicator ups_cod | COD ups_delivery_confirmation | DeliveryConfirmation ups_return_of_document_indicator | ReturnOfDocumentIndicator ups_up_scarbonneutral_indicator | UPScarbonneutralIndicator ups_certificate_of_origin_indicator | CertificateOfOriginIndicator ups_pickup_options | PickupOptions ups_delivery_options | DeliveryOptions ups_restricted_articles | RestrictedArticles ups_shipper_export_declaration_indicator | ShipperExportDeclarationIndicator ups_commercial_invoice_removal_indicator | CommercialInvoiceRemovalIndicator ups_import_control | ImportControl ups_return_service | ReturnService ups_sdl_shipment_indicator | SDLShipmentIndicator ups_epra_indicator | EPRAIndicator

### Freightcom
Code | Identifier --- | --- freightcom_saturday_pickup_required | saturdayPickupRequired freightcom_homeland_security | homelandSecurity freightcom_exhibition_convention_site | exhibitionConventionSite freightcom_military_base_delivery | militaryBaseDelivery freightcom_customs_in_bond_freight | customsIn_bondFreight freightcom_limited_access | limitedAccess freightcom_excess_length | excessLength freightcom_tailgate_pickup | tailgatePickup freightcom_residential_pickup | residentialPickup freightcom_cross_border_fee | crossBorderFee freightcom_notify_recipient | notifyRecipient freightcom_single_shipment | singleShipment freightcom_tailgate_delivery | tailgateDelivery freightcom_residential_delivery | residentialDelivery freightcom_insurance_type | insuranceType freightcom_inside_delivery | insideDelivery freightcom_is_saturday_service | isSaturdayService freightcom_dangerous_goods_type | dangerousGoodsType freightcom_stackable | stackable

### eShipper
Code | Identifier --- | --- eshipper_saturday_pickup_required | saturdayPickupRequired eshipper_homeland_security | homelandSecurity eshipper_exhibition_convention_site | exhibitionConventionSite eshipper_military_base_delivery | militaryBaseDelivery eshipper_customs_in_bond_freight | customsIn_bondFreight eshipper_limited_access | limitedAccess eshipper_excess_length | excessLength eshipper_tailgate_pickup | tailgatePickup eshipper_residential_pickup | residentialPickup eshipper_cross_border_fee | crossBorderFee eshipper_notify_recipient | notifyRecipient eshipper_single_shipment | singleShipment eshipper_tailgate_delivery | tailgateDelivery eshipper_residential_delivery | residentialDelivery eshipper_insurance_type | insuranceType eshipper_inside_delivery | insideDelivery eshipper_is_saturday_service | isSaturdayService eshipper_dangerous_goods_type | dangerousGoodsType eshipper_stackable | stackable


## Shipment Services
### Canada Post
Code | Identifier --- | --- canadapost_regular_parcel | DOM.RP canadapost_expedited_parcel | DOM.EP canadapost_xpresspost | DOM.XP canadapost_priority | DOM.PC canadapost_library_books | DOM.LIB canadapost_expedited_parcel_usa | USA.EP canadapost_priority_worldwide_envelope_usa | USA.PW.ENV canadapost_priority_worldwide_pak_usa | USA.PW.PAK canadapost_priority_worldwide_parcel_usa | USA.PW.PARCEL canadapost_small_packet_usa_air | USA.SP.AIR canadapost_tracked_packet_usa | USA.TP canadapost_tracked_packet_usa_lvm | USA.TP.LVM canadapost_xpresspost_usa | USA.XP canadapost_xpresspost_international | INT.XP canadapost_international_parcel_air | INT.IP.AIR canadapost_international_parcel_surface | INT.IP.SURF canadapost_priority_worldwide_envelope_intl | INT.PW.ENV canadapost_priority_worldwide_pak_intl | INT.PW.PAK canadapost_priority_worldwide_parcel_intl | INT.PW.PARCEL canadapost_small_packet_international_air | INT.SP.AIR canadapost_small_packet_international_surface | INT.SP.SURF canadapost_tracked_packet_international | INT.TP

### DHL Express
Code | Identifier --- | --- dhl_logistics_services | LOGISTICS SERVICES dhl_domestic_express_12_00_doc | DOMESTIC EXPRESS 12:00 DOC dhl_b2_c_doc | B2C DOC dhl_b2_c_nondoc | B2C NONDOC dhl_jetline | JETLINE dhl_sprintline | SPRINTLINE dhl_express_easy_doc | EXPRESS EASY DOC dhl_express_easy_nondoc | EXPRESS EASY NONDOC dhl_europack_doc | EUROPACK DOC dhl_auto_reversals | AUTO REVERSALS dhl_breakbulk_express_doc | BREAKBULK EXPRESS DOC dhl_medical_express_doc | MEDICAL EXPRESS DOC dhl_express_worldwide_doc | EXPRESS WORLDWIDE DOC dhl_express_9_00_nondoc | EXPRESS 9:00 NONDOC dhl_freight_worldwide_nondoc | FREIGHT WORLDWIDE NONDOC dhl_domestic_economy_select_doc | DOMESTIC ECONOMY SELECT DOC dhl_economy_select_nondoc | ECONOMY SELECT NONDOC dhl_domestic_express_9_00_doc | DOMESTIC EXPRESS 9:00 DOC dhl_jumbo_box_nondoc | JUMBO BOX NONDOC dhl_express_9_00_doc | EXPRESS 9:00 DOC dhl_express_10_30_doc | EXPRESS 10:30 DOC dhl_express_10_30_nondoc | EXPRESS 10:30 NONDOC dhl_domestic_express_doc | DOMESTIC EXPRESS DOC dhl_domestic_express_10_30_doc | DOMESTIC EXPRESS 10:30 DOC dhl_express_worldwide_nondoc | EXPRESS WORLDWIDE NONDOC dhl_medical_express_nondoc | MEDICAL EXPRESS NONDOC dhl_globalmail_business_doc | GLOBALMAIL BUSINESS DOC dhl_same_day_doc | SAME DAY DOC dhl_express_12_00_doc | EXPRESS 12:00 DOC dhl_europack_nondoc | EUROPACK NONDOC dhl_economy_select_doc | ECONOMY SELECT DOC dhl_express_envelope_doc | EXPRESS ENVELOPE DOC dhl_express_12_00_nondoc | EXPRESS 12:00 NONDOC dhl_destination_charges | Destination Charges

### FedEx Express
Code | Identifier --- | --- fedex_europe_first_international_priority | EUROPE_FIRST_INTERNATIONAL_PRIORITY fedex_1_day_freight | FEDEX_1_DAY_FREIGHT fedex_2_day | FEDEX_2_DAY fedex_2_day_am | FEDEX_2_DAY_AM fedex_2_day_freight | FEDEX_2_DAY_FREIGHT fedex_3_day_freight | FEDEX_3_DAY_FREIGHT fedex_cargo_airport_to_airport | FEDEX_CARGO_AIRPORT_TO_AIRPORT fedex_cargo_freight_forwarding | FEDEX_CARGO_FREIGHT_FORWARDING fedex_cargo_international_express_freight | FEDEX_CARGO_INTERNATIONAL_EXPRESS_FREIGHT fedex_cargo_international_premium | FEDEX_CARGO_INTERNATIONAL_PREMIUM fedex_cargo_mail | FEDEX_CARGO_MAIL fedex_cargo_registered_mail | FEDEX_CARGO_REGISTERED_MAIL fedex_cargo_surface_mail | FEDEX_CARGO_SURFACE_MAIL fedex_custom_critical_air_expedite | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE fedex_custom_critical_air_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_air_expedite_network | FEDEX_CUSTOM_CRITICAL_AIR_EXPEDITE_NETWORK fedex_custom_critical_charter_air | FEDEX_CUSTOM_CRITICAL_CHARTER_AIR fedex_custom_critical_point_to_point | FEDEX_CUSTOM_CRITICAL_POINT_TO_POINT fedex_custom_critical_surface_expedite | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE fedex_custom_critical_surface_expedite_exclusive_use | FEDEX_CUSTOM_CRITICAL_SURFACE_EXPEDITE_EXCLUSIVE_USE fedex_custom_critical_temp_assure_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_AIR fedex_custom_critical_temp_assure_validated_air | FEDEX_CUSTOM_CRITICAL_TEMP_ASSURE_VALIDATED_AIR fedex_custom_critical_white_glove_services | FEDEX_CUSTOM_CRITICAL_WHITE_GLOVE_SERVICES fedex_distance_deferred | FEDEX_DISTANCE_DEFERRED fedex_express_saver | FEDEX_EXPRESS_SAVER fedex_first_freight | FEDEX_FIRST_FREIGHT fedex_freight_economy | FEDEX_FREIGHT_ECONOMY fedex_freight_priority | FEDEX_FREIGHT_PRIORITY fedex_ground | FEDEX_GROUND fedex_international_priority_plus | FEDEX_INTERNATIONAL_PRIORITY_PLUS fedex_next_day_afternoon | FEDEX_NEXT_DAY_AFTERNOON fedex_next_day_early_morning | FEDEX_NEXT_DAY_EARLY_MORNING fedex_next_day_end_of_day | FEDEX_NEXT_DAY_END_OF_DAY fedex_next_day_freight | FEDEX_NEXT_DAY_FREIGHT fedex_next_day_mid_morning | FEDEX_NEXT_DAY_MID_MORNING fedex_first_overnight | FIRST_OVERNIGHT fedex_ground_home_delivery | GROUND_HOME_DELIVERY fedex_international_distribution_freight | INTERNATIONAL_DISTRIBUTION_FREIGHT fedex_international_economy | INTERNATIONAL_ECONOMY fedex_international_economy_distribution | INTERNATIONAL_ECONOMY_DISTRIBUTION fedex_international_economy_freight | INTERNATIONAL_ECONOMY_FREIGHT fedex_international_first | INTERNATIONAL_FIRST fedex_international_ground | INTERNATIONAL_GROUND fedex_international_priority | INTERNATIONAL_PRIORITY fedex_international_priority_distribution | INTERNATIONAL_PRIORITY_DISTRIBUTION fedex_international_priority_express | INTERNATIONAL_PRIORITY_EXPRESS fedex_international_priority_freight | INTERNATIONAL_PRIORITY_FREIGHT fedex_priority_overnight | PRIORITY_OVERNIGHT fedex_same_day | SAME_DAY fedex_same_day_city | SAME_DAY_CITY fedex_same_day_metro_afternoon | SAME_DAY_METRO_AFTERNOON fedex_same_day_metro_morning | SAME_DAY_METRO_MORNING fedex_same_day_metro_rush | SAME_DAY_METRO_RUSH fedex_smart_post | SMART_POST fedex_standard_overnight | STANDARD_OVERNIGHT fedex_transborder_distribution_consolidation | TRANSBORDER_DISTRIBUTION_CONSOLIDATION

### Purolator Courier
Code | Identifier --- | --- purolator_express_9_am | PurolatorExpress9AM purolator_express_us | PurolatorExpressU.S. purolator_express_10_30_am | PurolatorExpress10:30AM purolator_express_us_9_am | PurolatorExpressU.S.9AM purolator_express_12_pm | PurolatorExpress12PM purolator_express_us_10_30_am | PurolatorExpressU.S.10:30AM purolator_express | PurolatorExpress purolator_express_us_12_00 | PurolatorExpressU.S.12:00 purolator_express_evening | PurolatorExpressEvening purolator_express_envelope_us | PurolatorExpressEnvelopeU.S. purolator_express_envelope_9_am | PurolatorExpressEnvelope9AM purolator_express_us_envelope_9_am | PurolatorExpressU.S.Envelope9AM purolator_express_envelope_10_30_am | PurolatorExpressEnvelope10:30AM purolator_express_us_envelope_10_30_am | PurolatorExpressU.S.Envelope10:30AM purolator_express_envelope_12_pm | PurolatorExpressEnvelope12PM purolator_express_us_envelope_12_00 | PurolatorExpressU.S.Envelope12:00 purolator_express_envelope | PurolatorExpressEnvelope purolator_express_pack_us | PurolatorExpressPackU.S. purolator_express_envelope_evening | PurolatorExpressEnvelopeEvening purolator_express_us_pack_9_am | PurolatorExpressU.S.Pack9AM purolator_express_pack_9_am | PurolatorExpressPack9AM purolator_express_us_pack_10_30_am | PurolatorExpressU.S.Pack10:30AM purolator_express_pack10_30_am | PurolatorExpressPack10:30AM purolator_express_us_pack_12_00 | PurolatorExpressU.S.Pack12:00 purolator_express_pack_12_pm | PurolatorExpressPack12PM purolator_express_box_us | PurolatorExpressBoxU.S. purolator_express_pack | PurolatorExpressPack purolator_express_us_box_9_am | PurolatorExpressU.S.Box9AM purolator_express_pack_evening | PurolatorExpressPackEvening purolator_express_us_box_10_30_am | PurolatorExpressU.S.Box10:30AM purolator_express_box_9_am | PurolatorExpressBox9AM purolator_express_us_box_12_00 | PurolatorExpressU.S.Box12:00 purolator_express_box_10_30_am | PurolatorExpressBox10:30AM purolator_ground_us | PurolatorGroundU.S. purolator_express_box_12_pm | PurolatorExpressBox12PM purolator_express_international | PurolatorExpressInternational purolator_express_box | PurolatorExpressBox purolator_express_international_9_am | PurolatorExpressInternational9AM purolator_express_box_evening | PurolatorExpressBoxEvening purolator_express_international_10_30_am | PurolatorExpressInternational10:30AM purolator_ground | PurolatorGround purolator_express_international_12_00 | PurolatorExpressInternational12:00 purolator_ground9_am | PurolatorGround9AM purolator_express_envelope_international | PurolatorExpressEnvelopeInternational purolator_ground10_30_am | PurolatorGround10:30AM purolator_express_international_envelope_9_am | PurolatorExpressInternationalEnvelope9AM purolator_ground_evening | PurolatorGroundEvening purolator_express_international_envelope_10_30_am | PurolatorExpressInternationalEnvelope10:30AM purolator_quick_ship | PurolatorQuickShip purolator_express_international_envelope_12_00 | PurolatorExpressInternationalEnvelope12:00 purolator_quick_ship_envelope | PurolatorQuickShipEnvelope purolator_express_pack_international | PurolatorExpressPackInternational purolator_quick_ship_pack | PurolatorQuickShipPack purolator_express_international_pack_9_am | PurolatorExpressInternationalPack9AM purolator_quick_ship_box | PurolatorQuickShipBox purolator_express_international_pack_10_30_am | PurolatorExpressInternationalPack10:30AM purolator_express_international_pack_12_00 | PurolatorExpressInternationalPack12:00 purolator_express_box_international | PurolatorExpressBoxInternational purolator_express_international_box_9_am | PurolatorExpressInternationalBox9AM purolator_express_international_box_10_30_am | PurolatorExpressInternationalBox10:30AM purolator_express_international_box_12_00 | PurolatorExpressInternationalBox12:00

### UPS Package
Code | Identifier --- | --- ups_standard | 11 ups_worldwide_expedited | 08 ups_worldwide_express | 07 ups_worldwide_express_plus | 54 ups_worldwide_saver | 65 ups_2nd_day_air | 02 ups_2nd_day_air_am | 59 ups_3_day_select | 12 ups_expedited_mail_innovations | M4 ups_first_class_mail | M2 ups_ground | 03 ups_next_day_air | 01 ups_next_day_air_early | 14 ups_next_day_air_saver | 13 ups_priority_mail | M3 ups_access_point_economy | 70 ups_today_dedicated_courier | 83 ups_today_express | 85 ups_today_express_saver | 86 ups_today_standard | 82 ups_worldwide_express_freight | 96 ups_priority_mail_innovations | M5 ups_economy_mail_innovations | M6

### Freightcom
Code | Identifier --- | --- freightcom_central_transport | 2029 freigthcom_estes | 2107 freigthcom_usf_holland | 1911 freightcom_dicom_ground | 3700 freightcom_ground | 3400 freightcom_select | 3404 freightcom_overnight | 3407 freightcom_purolator_ground | 4000 freightcom_purolator_express | 4003 freightcom_purolator_express_9_am | 4004 freightcom_purolator_express_10_30_am | 4005 freightcom_fedex_express_saver | 4100 freightcom_fedex_ground | 4101 freightcom_fedex_2_day | 4102 freightcom_fedex_priority_overnight | 4104 freightcom_fedex_standard_overnight | 4105 freightcom_fedex_first_overnight | 4106 freightcom_fedex_international_economy | 4109 freightcom_ups_standard | 4600 freightcom_ups_expedited | 4601 freightcom_ups_express_saver | 4602 freightcom_ups_express | 4603 freightcom_ups_express_early | 4604 freightcom_ups_3_day_select | 4605 freightcom_ups_worldwide_expedited | 4606 freightcom_ups_worldwide_express | 4607 freightcom_fedex_international_priority | 4108 freightcom_ups_worldwide_express_saver | 4609 freightcom_purolator_ground_us | 4016 freightcom_purolator_express_us | 4015 freightcom_purolator_express_us_10_30_am | 4014 freightcom_ups_worldwide_express_plus | 4608 freightcom_purolator_express_us_9_am | 4013 freightcom_express_easy | 5202 freightcom_express_10_30 | 5208 freightcom_express_worldwide | 5211 freightcom_express_12_00 | 5215 freightcom_economy_select | 5216 freightcom_dayr_e_comm_am_service | 5706 freightcom_dayr_e_comm_ground_service | 5707 freightcom_regular_parcel | 6301 freightcom_expedited_parcel | 6300 freightcom_xpresspost | 6303 freightcom_priority | 6302

### eShipper
Code | Identifier --- | --- eshipper_fedex_priority | 1 eshipper_fedex_first_overnight | 2 eshipper_fedex_ground | 3 eshipper_fedex_standard_overnight | 28 eshipper_fedex_2nd_day | 29 eshipper_fedex_express_saver | 30 eshipper_fedex_international_economy | 35 eshipper_purolator_air | 4 eshipper_purolator_air_9_am | 5 eshipper_purolator_air_10_30 | 6 eshipper_puro_letter | 7 eshipper_puro_letter_9_am | 8 eshipper_puro_letter_10_30 | 9 eshipper_puro_pak | 10 eshipper_puro_pak_9_am | 11 eshipper_puro_pak_10_30 | 12 eshipper_purolator_ground | 13 eshipper_purolator_ground_9_am | 19 eshipper_purolator_ground_10_30 | 20 eshipper_canada_worldwide_same_day | 14 eshipper_canada_worldwide_next_flight_out | 15 eshipper_canada_worldwide_air_freight | 16 eshipper_canada_worldwide_ltl | 17 eshipper_dhl_express_worldwide | 101 eshipper_dhl_express_12_pm | 103 eshipper_dhl_express_10_30_am | 102 eshipper_dhl_esi_export | 104 eshipper_dhl_international_express | 106 eshipper_ups_express_next_day_air | 600 eshipper_ups_expedited_second_day_air | 601 eshipper_ups_worldwide_express | 602 eshipper_ups_worldwide_expedited | 603 eshipper_ups_standard_ground | 604 eshipper_ups_express_early_am_next_day_air_early_am | 605 eshipper_ups_three_day_select | 606 eshipper_ups_saver | 607 eshipper_ups_ground | 608 eshipper_next_day_saver | 609 eshipper_worldwide_express_plus | 610 eshipper_second_day_air_am | 611 eshipper_canada_post_priority | 500 eshipper_canada_post_xpress_post | 501 eshipper_canada_post_expedited | 502 eshipper_canada_post_regular | 503 eshipper_canada_post_xpress_post_usa | 504 eshipper_canada_post_xpress_post_intl | 505 eshipper_canada_post_air_parcel_intl | 506 eshipper_canada_post_surface_parcel_intl | 507 eshipper_canada_post_expedited_parcel_usa | 508 eshipper_tst_ltl | 1100 eshipper_ltl_chicago_suburban_express | 1500 eshipper_ltl_fedex_freight_east | 1501 eshipper_ltl_fedex_freight_west | 1502 eshipper_ltl_mid_states_express | 1503 eshipper_ltl_new_england_motor_freight | 1504 eshipper_ltl_new_penn | 1505 eshipper_ltl_oak_harbor | 1506 eshipper_ltl_pitt_ohio | 1507 eshipper_ltl_r_l_carriers | 1508 eshipper_ltl_saia | 1509 eshipper_ltl_usf_reddaway | 1510 eshipper_ltl_vitran_express | 1511 eshipper_ltl_wilson_trucking | 1512 eshipper_ltl_yellow_transportation | 1513 eshipper_ltl_roadway | 1514 eshipper_ltl_fedex_national | 1515 eshipper_wilson_trucking_tfc | 1800 eshipper_aaa_cooper_transportation | 1801 eshipper_roadrunner_dawes | 1802 eshipper_new_england_motor_freight | 1803 eshipper_new_penn_motor_express | 1804 eshipper_dayton_freight | 1805 eshipper_southeastern_freightway | 1806 eshipper_saia_inc | 1807 eshipper_conway | 1808 eshipper_roadway | 1809 eshipper_usf_reddaway | 1810 eshipper_usf_holland | 1811 eshipper_dependable_highway_express | 1812 eshipper_day_and_ross | 1813 eshipper_day_and_ross_r_and_l | 1814 eshipper_ups | 1815 eshipper_aaa_cooper | 1816 eshipper_ama_transportation | 1817 eshipper_averitt_express | 1818 eshipper_central_freight | 1819 eshipper_conway_us | 1820 eshipper_dayton | 1821 eshipper_drug_transport | 1822 eshipper_estes | 1823 eshipper_land_air_express | 1824 eshipper_fedex_west | 1825 eshipper_fedex_national | 1826 eshipper_usf_holland_us | 1827 eshipper_lakeville_m_express | 1828 eshipper_milan_express | 1829 eshipper_nebraska_transport | 1830 eshipper_new_england | 1831 eshipper_new_penn | 1832 eshipper_a_duie_pyle | 1833 eshipper_roadway_us | 1834 eshipper_usf_reddaway_us | 1835 eshipper_rhody_transportation | 1836 eshipper_saia_motor_freight | 1837 eshipper_southeastern_frgt | 1838 eshipper_pitt_ohio | 1839 eshipper_ward | 1840 eshipper_wilson | 1841 eshipper_chi_cargo | 1842 eshipper_tax_air | 1843 eshipper_fedex_east | 1844 eshipper_central_transport | 1845 eshipper_roadrunner | 1846 eshipper_r_and_l_carriers | 1847 eshipper_estes_us | 1848 eshipper_yrc_roadway | 1849 eshipper_central_transport_us | 1850 eshipper_absolute_transportation_services | 1851 eshipper_blue_sky_express | 1852 eshipper_galasso_trucking | 1853 eshipper_griley_air_freight | 1854 eshipper_jet_transportation | 1855 eshipper_metro_transportation_logistics | 1856 eshipper_oak_harbor | 1857 eshipper_stream_links_express | 1858 eshipper_tiffany_trucking | 1859 eshipper_ups_freight | 1860 eshipper_roadrunner_us | 1861 eshipper_global_mail_parcel_priority | 3500 eshipper_global_mail_parcel_standard | 3501 eshipper_global_mail_packet_plus_priority | 3502 eshipper_global_mail_packet_priority | 3503 eshipper_global_mail_packet_standard | 3504 eshipper_global_mail_business_priority | 3505 eshipper_global_mail_business_standard | 3506 eshipper_global_mail_parcel_direct_priority | 3507 eshipper_global_mail_parcel_direct_standard | 3508 eshipper_ground | 4500 eshipper_select_parcel | 4504 eshipper_express_parcel | 4507


# noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.references_with_http_info(async_req=True) diff --git a/purplship/api_client.py b/purplship/api_client.py index 73b240c..887c6e7 100644 --- a/purplship/api_client.py +++ b/purplship/api_client.py @@ -4,7 +4,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/purplship/configuration.py b/purplship/configuration.py index aa36e5e..91d6b10 100644 --- a/purplship/configuration.py +++ b/purplship/configuration.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -246,6 +246,6 @@ def to_debug_report(self): return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: v1-2021.0\n"\ + "Version of the API: v1-2021.2\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/purplship/models/__init__.py b/purplship/models/__init__.py index 33995ac..5d20125 100644 --- a/purplship/models/__init__.py +++ b/purplship/models/__init__.py @@ -6,7 +6,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -16,11 +16,14 @@ # import models into model package from purplship.models.address import Address from purplship.models.address_data import AddressData +from purplship.models.address_list import AddressList +from purplship.models.carrier_list import CarrierList from purplship.models.carrier_settings import CarrierSettings from purplship.models.charge import Charge from purplship.models.commodity import Commodity from purplship.models.customs import Customs from purplship.models.customs_data import CustomsData +from purplship.models.customs_list import CustomsList from purplship.models.error_response import ErrorResponse from purplship.models.label_printing_request import LabelPrintingRequest from purplship.models.message import Message @@ -29,12 +32,14 @@ from purplship.models.operation_response import OperationResponse from purplship.models.parcel import Parcel from purplship.models.parcel_data import ParcelData +from purplship.models.parcel_list import ParcelList from purplship.models.payment import Payment from purplship.models.payment_data import PaymentData from purplship.models.pickup import Pickup from purplship.models.pickup_cancel_data import PickupCancelData from purplship.models.pickup_cancel_request import PickupCancelRequest from purplship.models.pickup_data import PickupData +from purplship.models.pickup_list import PickupList from purplship.models.pickup_request import PickupRequest from purplship.models.pickup_response import PickupResponse from purplship.models.pickup_update_data import PickupUpdateData @@ -46,8 +51,10 @@ from purplship.models.shipment import Shipment from purplship.models.shipment_cancel_request import ShipmentCancelRequest from purplship.models.shipment_data import ShipmentData +from purplship.models.shipment_list import ShipmentList from purplship.models.shipment_purchase_data import ShipmentPurchaseData from purplship.models.shipping_request import ShippingRequest +from purplship.models.tracker_list import TrackerList from purplship.models.tracking_event import TrackingEvent from purplship.models.tracking_response import TrackingResponse from purplship.models.tracking_status import TrackingStatus diff --git a/purplship/models/address.py b/purplship/models/address.py index 49907d4..2ca08ec 100644 --- a/purplship/models/address.py +++ b/purplship/models/address.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -64,7 +64,7 @@ class Address(object): } def __init__(self, id=None, postal_code=None, city=None, federal_tax_id=None, state_tax_id=None, person_name=None, company_name=None, country_code=None, email=None, phone_number=None, state_code=None, suburb=None, residential=False, address_line1=None, address_line2=None): # noqa: E501 - """Address - a model defined in Swagger""" # noqa: E501 + """Address - a model defined in Purplship""" # noqa: E501 self._id = None self._postal_code = None self._city = None diff --git a/purplship/models/address_data.py b/purplship/models/address_data.py index ce65064..0d04621 100644 --- a/purplship/models/address_data.py +++ b/purplship/models/address_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -62,7 +62,7 @@ class AddressData(object): } def __init__(self, postal_code=None, city=None, federal_tax_id=None, state_tax_id=None, person_name=None, company_name=None, country_code=None, email=None, phone_number=None, state_code=None, suburb=None, residential=False, address_line1=None, address_line2=None): # noqa: E501 - """AddressData - a model defined in Swagger""" # noqa: E501 + """AddressData - a model defined in Purplship""" # noqa: E501 self._postal_code = None self._city = None self._federal_tax_id = None diff --git a/purplship/models/address_list.py b/purplship/models/address_list.py new file mode 100644 index 0000000..4a5a705 --- /dev/null +++ b/purplship/models/address_list.py @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + Purplship Open Source Multi-carrier Shipping API + + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 + + OpenAPI spec version: v1-2021.2 + Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AddressList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next': 'str', + 'previous': 'str', + 'results': 'list[Address]' + } + + attribute_map = { + 'next': 'next', + 'previous': 'previous', + 'results': 'results' + } + + def __init__(self, next=None, previous=None, results=None): # noqa: E501 + """AddressList - a model defined in Purplship""" # noqa: E501 + self._next = None + self._previous = None + self._results = None + self.discriminator = None + if next is not None: + self.next = next + if previous is not None: + self.previous = previous + self.results = results + + @property + def next(self): + """Gets the next of this AddressList. # noqa: E501 + + + :return: The next of this AddressList. # noqa: E501 + :rtype: str + """ + return self._next + + @next.setter + def next(self, next): + """Sets the next of this AddressList. + + + :param next: The next of this AddressList. # noqa: E501 + :type: str + """ + + self._next = next + + @property + def previous(self): + """Gets the previous of this AddressList. # noqa: E501 + + + :return: The previous of this AddressList. # noqa: E501 + :rtype: str + """ + return self._previous + + @previous.setter + def previous(self, previous): + """Sets the previous of this AddressList. + + + :param previous: The previous of this AddressList. # noqa: E501 + :type: str + """ + + self._previous = previous + + @property + def results(self): + """Gets the results of this AddressList. # noqa: E501 + + + :return: The results of this AddressList. # noqa: E501 + :rtype: list[Address] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this AddressList. + + + :param results: The results of this AddressList. # noqa: E501 + :type: list[Address] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AddressList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AddressList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/purplship/models/carrier_list.py b/purplship/models/carrier_list.py new file mode 100644 index 0000000..1e47bec --- /dev/null +++ b/purplship/models/carrier_list.py @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + Purplship Open Source Multi-carrier Shipping API + + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 + + OpenAPI spec version: v1-2021.2 + Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CarrierList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next': 'str', + 'previous': 'str', + 'results': 'list[CarrierSettings]' + } + + attribute_map = { + 'next': 'next', + 'previous': 'previous', + 'results': 'results' + } + + def __init__(self, next=None, previous=None, results=None): # noqa: E501 + """CarrierList - a model defined in Purplship""" # noqa: E501 + self._next = None + self._previous = None + self._results = None + self.discriminator = None + if next is not None: + self.next = next + if previous is not None: + self.previous = previous + self.results = results + + @property + def next(self): + """Gets the next of this CarrierList. # noqa: E501 + + + :return: The next of this CarrierList. # noqa: E501 + :rtype: str + """ + return self._next + + @next.setter + def next(self, next): + """Sets the next of this CarrierList. + + + :param next: The next of this CarrierList. # noqa: E501 + :type: str + """ + + self._next = next + + @property + def previous(self): + """Gets the previous of this CarrierList. # noqa: E501 + + + :return: The previous of this CarrierList. # noqa: E501 + :rtype: str + """ + return self._previous + + @previous.setter + def previous(self, previous): + """Sets the previous of this CarrierList. + + + :param previous: The previous of this CarrierList. # noqa: E501 + :type: str + """ + + self._previous = previous + + @property + def results(self): + """Gets the results of this CarrierList. # noqa: E501 + + + :return: The results of this CarrierList. # noqa: E501 + :rtype: list[CarrierSettings] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this CarrierList. + + + :param results: The results of this CarrierList. # noqa: E501 + :type: list[CarrierSettings] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CarrierList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CarrierList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/purplship/models/carrier_settings.py b/purplship/models/carrier_settings.py index a5e9944..3a87de9 100644 --- a/purplship/models/carrier_settings.py +++ b/purplship/models/carrier_settings.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -44,7 +44,7 @@ class CarrierSettings(object): } def __init__(self, id=None, carrier_name=None, carrier_id=None, test=None, active=None): # noqa: E501 - """CarrierSettings - a model defined in Swagger""" # noqa: E501 + """CarrierSettings - a model defined in Purplship""" # noqa: E501 self._id = None self._carrier_name = None self._carrier_id = None @@ -104,7 +104,7 @@ def carrier_name(self, carrier_name): """ if carrier_name is None: raise ValueError("Invalid value for `carrier_name`, must not be `None`") # noqa: E501 - allowed_values = ["canadapost", "dhl_express", "fedex_express", "purolator_courier", "ups_package", "eshipper", "freightcom"] # noqa: E501 + allowed_values = ["aramex", "australiapost", "canadapost", "canpar", "dhl_express", "dhl_universal", "dicom", "fedex_express", "purolator_courier", "royalmail", "sendle", "sf_express", "ups_package", "usps", "yanwen", "yunexpress", "freightcom", "eshipper"] # noqa: E501 if carrier_name not in allowed_values: raise ValueError( "Invalid value for `carrier_name` ({0}), must be one of {1}" # noqa: E501 diff --git a/purplship/models/charge.py b/purplship/models/charge.py index bdea0e7..3fdf741 100644 --- a/purplship/models/charge.py +++ b/purplship/models/charge.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -40,7 +40,7 @@ class Charge(object): } def __init__(self, name=None, amount=None, currency=None): # noqa: E501 - """Charge - a model defined in Swagger""" # noqa: E501 + """Charge - a model defined in Purplship""" # noqa: E501 self._name = None self._amount = None self._currency = None diff --git a/purplship/models/commodity.py b/purplship/models/commodity.py index 5b97b23..148f3cf 100644 --- a/purplship/models/commodity.py +++ b/purplship/models/commodity.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -52,7 +52,7 @@ class Commodity(object): } def __init__(self, id=None, weight=None, weight_unit=None, description=None, quantity=None, sku=None, value_amount=None, value_currency=None, origin_country=None): # noqa: E501 - """Commodity - a model defined in Swagger""" # noqa: E501 + """Commodity - a model defined in Purplship""" # noqa: E501 self._id = None self._weight = None self._weight_unit = None diff --git a/purplship/models/customs.py b/purplship/models/customs.py index a4aeb15..d680654 100644 --- a/purplship/models/customs.py +++ b/purplship/models/customs.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -62,7 +62,7 @@ class Customs(object): } def __init__(self, id=None, aes=None, eel_pfc=None, content_type=None, content_description=None, incoterm=None, commodities=None, duty=None, invoice=None, commercial_invoice=None, certify=None, signer=None, certificate_number=None, options=None): # noqa: E501 - """Customs - a model defined in Swagger""" # noqa: E501 + """Customs - a model defined in Purplship""" # noqa: E501 self._id = None self._aes = None self._eel_pfc = None diff --git a/purplship/models/customs_data.py b/purplship/models/customs_data.py index fd509a6..4531128 100644 --- a/purplship/models/customs_data.py +++ b/purplship/models/customs_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -60,7 +60,7 @@ class CustomsData(object): } def __init__(self, aes=None, eel_pfc=None, content_type=None, content_description=None, incoterm=None, commodities=None, duty=None, invoice=None, commercial_invoice=None, certify=None, signer=None, certificate_number=None, options=None): # noqa: E501 - """CustomsData - a model defined in Swagger""" # noqa: E501 + """CustomsData - a model defined in Purplship""" # noqa: E501 self._aes = None self._eel_pfc = None self._content_type = None diff --git a/purplship/models/customs_list.py b/purplship/models/customs_list.py new file mode 100644 index 0000000..cfa2a95 --- /dev/null +++ b/purplship/models/customs_list.py @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + Purplship Open Source Multi-carrier Shipping API + + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 + + OpenAPI spec version: v1-2021.2 + Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CustomsList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next': 'str', + 'previous': 'str', + 'results': 'list[Customs]' + } + + attribute_map = { + 'next': 'next', + 'previous': 'previous', + 'results': 'results' + } + + def __init__(self, next=None, previous=None, results=None): # noqa: E501 + """CustomsList - a model defined in Purplship""" # noqa: E501 + self._next = None + self._previous = None + self._results = None + self.discriminator = None + if next is not None: + self.next = next + if previous is not None: + self.previous = previous + self.results = results + + @property + def next(self): + """Gets the next of this CustomsList. # noqa: E501 + + + :return: The next of this CustomsList. # noqa: E501 + :rtype: str + """ + return self._next + + @next.setter + def next(self, next): + """Sets the next of this CustomsList. + + + :param next: The next of this CustomsList. # noqa: E501 + :type: str + """ + + self._next = next + + @property + def previous(self): + """Gets the previous of this CustomsList. # noqa: E501 + + + :return: The previous of this CustomsList. # noqa: E501 + :rtype: str + """ + return self._previous + + @previous.setter + def previous(self, previous): + """Sets the previous of this CustomsList. + + + :param previous: The previous of this CustomsList. # noqa: E501 + :type: str + """ + + self._previous = previous + + @property + def results(self): + """Gets the results of this CustomsList. # noqa: E501 + + + :return: The results of this CustomsList. # noqa: E501 + :rtype: list[Customs] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this CustomsList. + + + :param results: The results of this CustomsList. # noqa: E501 + :type: list[Customs] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CustomsList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CustomsList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/purplship/models/error_response.py b/purplship/models/error_response.py index 47104cf..a64a0b6 100644 --- a/purplship/models/error_response.py +++ b/purplship/models/error_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -36,7 +36,7 @@ class ErrorResponse(object): } def __init__(self, messages=None): # noqa: E501 - """ErrorResponse - a model defined in Swagger""" # noqa: E501 + """ErrorResponse - a model defined in Purplship""" # noqa: E501 self._messages = None self.discriminator = None if messages is not None: diff --git a/purplship/models/label_printing_request.py b/purplship/models/label_printing_request.py index 27cac44..a6a0b76 100644 --- a/purplship/models/label_printing_request.py +++ b/purplship/models/label_printing_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,7 @@ class LabelPrintingRequest(object): } def __init__(self, name=None, label=None): # noqa: E501 - """LabelPrintingRequest - a model defined in Swagger""" # noqa: E501 + """LabelPrintingRequest - a model defined in Purplship""" # noqa: E501 self._name = None self._label = None self.discriminator = None diff --git a/purplship/models/message.py b/purplship/models/message.py index 95b7442..0f00d9e 100644 --- a/purplship/models/message.py +++ b/purplship/models/message.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -44,7 +44,7 @@ class Message(object): } def __init__(self, carrier_name=None, carrier_id=None, message=None, code=None, details=None): # noqa: E501 - """Message - a model defined in Swagger""" # noqa: E501 + """Message - a model defined in Purplship""" # noqa: E501 self._carrier_name = None self._carrier_id = None self._message = None diff --git a/purplship/models/operation.py b/purplship/models/operation.py index fc73640..a05a4c9 100644 --- a/purplship/models/operation.py +++ b/purplship/models/operation.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,7 @@ class Operation(object): } def __init__(self, operation=None, success=None): # noqa: E501 - """Operation - a model defined in Swagger""" # noqa: E501 + """Operation - a model defined in Purplship""" # noqa: E501 self._operation = None self._success = None self.discriminator = None diff --git a/purplship/models/operation_confirmation.py b/purplship/models/operation_confirmation.py index 95837d8..de76ad7 100644 --- a/purplship/models/operation_confirmation.py +++ b/purplship/models/operation_confirmation.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,7 +42,7 @@ class OperationConfirmation(object): } def __init__(self, operation=None, success=None, carrier_name=None, carrier_id=None): # noqa: E501 - """OperationConfirmation - a model defined in Swagger""" # noqa: E501 + """OperationConfirmation - a model defined in Purplship""" # noqa: E501 self._operation = None self._success = None self._carrier_name = None diff --git a/purplship/models/operation_response.py b/purplship/models/operation_response.py index 7b739ab..cc78fd5 100644 --- a/purplship/models/operation_response.py +++ b/purplship/models/operation_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,7 @@ class OperationResponse(object): } def __init__(self, messages=None, confirmation=None): # noqa: E501 - """OperationResponse - a model defined in Swagger""" # noqa: E501 + """OperationResponse - a model defined in Purplship""" # noqa: E501 self._messages = None self._confirmation = None self.discriminator = None diff --git a/purplship/models/parcel.py b/purplship/models/parcel.py index 42ec669..29680d8 100644 --- a/purplship/models/parcel.py +++ b/purplship/models/parcel.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -58,7 +58,7 @@ class Parcel(object): } def __init__(self, id=None, weight=None, width=None, height=None, length=None, packaging_type=None, package_preset=None, description=None, content=None, is_document=False, weight_unit=None, dimension_unit=None): # noqa: E501 - """Parcel - a model defined in Swagger""" # noqa: E501 + """Parcel - a model defined in Purplship""" # noqa: E501 self._id = None self._weight = None self._width = None diff --git a/purplship/models/parcel_data.py b/purplship/models/parcel_data.py index 1aa0014..90b90c7 100644 --- a/purplship/models/parcel_data.py +++ b/purplship/models/parcel_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -56,7 +56,7 @@ class ParcelData(object): } def __init__(self, weight=None, width=None, height=None, length=None, packaging_type=None, package_preset=None, description=None, content=None, is_document=False, weight_unit=None, dimension_unit=None): # noqa: E501 - """ParcelData - a model defined in Swagger""" # noqa: E501 + """ParcelData - a model defined in Purplship""" # noqa: E501 self._weight = None self._width = None self._height = None diff --git a/purplship/models/parcel_list.py b/purplship/models/parcel_list.py new file mode 100644 index 0000000..9095151 --- /dev/null +++ b/purplship/models/parcel_list.py @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + Purplship Open Source Multi-carrier Shipping API + + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 + + OpenAPI spec version: v1-2021.2 + Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ParcelList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next': 'str', + 'previous': 'str', + 'results': 'list[Parcel]' + } + + attribute_map = { + 'next': 'next', + 'previous': 'previous', + 'results': 'results' + } + + def __init__(self, next=None, previous=None, results=None): # noqa: E501 + """ParcelList - a model defined in Purplship""" # noqa: E501 + self._next = None + self._previous = None + self._results = None + self.discriminator = None + if next is not None: + self.next = next + if previous is not None: + self.previous = previous + self.results = results + + @property + def next(self): + """Gets the next of this ParcelList. # noqa: E501 + + + :return: The next of this ParcelList. # noqa: E501 + :rtype: str + """ + return self._next + + @next.setter + def next(self, next): + """Sets the next of this ParcelList. + + + :param next: The next of this ParcelList. # noqa: E501 + :type: str + """ + + self._next = next + + @property + def previous(self): + """Gets the previous of this ParcelList. # noqa: E501 + + + :return: The previous of this ParcelList. # noqa: E501 + :rtype: str + """ + return self._previous + + @previous.setter + def previous(self, previous): + """Sets the previous of this ParcelList. + + + :param previous: The previous of this ParcelList. # noqa: E501 + :type: str + """ + + self._previous = previous + + @property + def results(self): + """Gets the results of this ParcelList. # noqa: E501 + + + :return: The results of this ParcelList. # noqa: E501 + :rtype: list[Parcel] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this ParcelList. + + + :param results: The results of this ParcelList. # noqa: E501 + :type: list[Parcel] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ParcelList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ParcelList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/purplship/models/payment.py b/purplship/models/payment.py index 1065655..12315eb 100644 --- a/purplship/models/payment.py +++ b/purplship/models/payment.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -45,8 +45,8 @@ class Payment(object): 'contact': 'contact' } - def __init__(self, id=None, paid_by=None, amount=None, currency=None, account_number=None, contact=None): # noqa: E501 - """Payment - a model defined in Swagger""" # noqa: E501 + def __init__(self, id=None, paid_by='sender', amount=None, currency=None, account_number=None, contact=None): # noqa: E501 + """Payment - a model defined in Purplship""" # noqa: E501 self._id = None self._paid_by = None self._amount = None @@ -56,7 +56,8 @@ def __init__(self, id=None, paid_by=None, amount=None, currency=None, account_nu self.discriminator = None if id is not None: self.id = id - self.paid_by = paid_by + if paid_by is not None: + self.paid_by = paid_by if amount is not None: self.amount = amount self.currency = currency @@ -108,8 +109,6 @@ def paid_by(self, paid_by): :param paid_by: The paid_by of this Payment. # noqa: E501 :type: str """ - if paid_by is None: - raise ValueError("Invalid value for `paid_by`, must not be `None`") # noqa: E501 allowed_values = ["sender", "recipient", "third_party"] # noqa: E501 if paid_by not in allowed_values: raise ValueError( diff --git a/purplship/models/payment_data.py b/purplship/models/payment_data.py index 7c2315c..4c16015 100644 --- a/purplship/models/payment_data.py +++ b/purplship/models/payment_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -43,15 +43,16 @@ class PaymentData(object): 'contact': 'contact' } - def __init__(self, paid_by=None, amount=None, currency=None, account_number=None, contact=None): # noqa: E501 - """PaymentData - a model defined in Swagger""" # noqa: E501 + def __init__(self, paid_by='sender', amount=None, currency=None, account_number=None, contact=None): # noqa: E501 + """PaymentData - a model defined in Purplship""" # noqa: E501 self._paid_by = None self._amount = None self._currency = None self._account_number = None self._contact = None self.discriminator = None - self.paid_by = paid_by + if paid_by is not None: + self.paid_by = paid_by if amount is not None: self.amount = amount self.currency = currency @@ -80,8 +81,6 @@ def paid_by(self, paid_by): :param paid_by: The paid_by of this PaymentData. # noqa: E501 :type: str """ - if paid_by is None: - raise ValueError("Invalid value for `paid_by`, must not be `None`") # noqa: E501 allowed_values = ["sender", "recipient", "third_party"] # noqa: E501 if paid_by not in allowed_values: raise ValueError( diff --git a/purplship/models/pickup.py b/purplship/models/pickup.py index 4c2a640..345a5fa 100644 --- a/purplship/models/pickup.py +++ b/purplship/models/pickup.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -62,7 +62,7 @@ class Pickup(object): } def __init__(self, id=None, carrier_name=None, carrier_id=None, confirmation_number=None, pickup_date=None, pickup_charge=None, ready_time=None, closing_time=None, address=None, parcels=None, instruction=None, package_location=None, options=None, test_mode=None): # noqa: E501 - """Pickup - a model defined in Swagger""" # noqa: E501 + """Pickup - a model defined in Purplship""" # noqa: E501 self._id = None self._carrier_name = None self._carrier_id = None diff --git a/purplship/models/pickup_cancel_data.py b/purplship/models/pickup_cancel_data.py index f3e79ab..d16fe28 100644 --- a/purplship/models/pickup_cancel_data.py +++ b/purplship/models/pickup_cancel_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -36,7 +36,7 @@ class PickupCancelData(object): } def __init__(self, reason=None): # noqa: E501 - """PickupCancelData - a model defined in Swagger""" # noqa: E501 + """PickupCancelData - a model defined in Purplship""" # noqa: E501 self._reason = None self.discriminator = None if reason is not None: diff --git a/purplship/models/pickup_cancel_request.py b/purplship/models/pickup_cancel_request.py index fbb1317..a062e54 100644 --- a/purplship/models/pickup_cancel_request.py +++ b/purplship/models/pickup_cancel_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -42,7 +42,7 @@ class PickupCancelRequest(object): } def __init__(self, confirmation_number=None, address=None, pickup_date=None, reason=None): # noqa: E501 - """PickupCancelRequest - a model defined in Swagger""" # noqa: E501 + """PickupCancelRequest - a model defined in Purplship""" # noqa: E501 self._confirmation_number = None self._address = None self._pickup_date = None diff --git a/purplship/models/pickup_data.py b/purplship/models/pickup_data.py index 805e215..91f4808 100644 --- a/purplship/models/pickup_data.py +++ b/purplship/models/pickup_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -50,7 +50,7 @@ class PickupData(object): } def __init__(self, pickup_date=None, address=None, ready_time=None, closing_time=None, instruction=None, package_location=None, options=None, tracking_numbers=None): # noqa: E501 - """PickupData - a model defined in Swagger""" # noqa: E501 + """PickupData - a model defined in Purplship""" # noqa: E501 self._pickup_date = None self._address = None self._ready_time = None diff --git a/purplship/models/pickup_list.py b/purplship/models/pickup_list.py new file mode 100644 index 0000000..d86e1a0 --- /dev/null +++ b/purplship/models/pickup_list.py @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + Purplship Open Source Multi-carrier Shipping API + + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 + + OpenAPI spec version: v1-2021.2 + Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PickupList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next': 'str', + 'previous': 'str', + 'results': 'list[Pickup]' + } + + attribute_map = { + 'next': 'next', + 'previous': 'previous', + 'results': 'results' + } + + def __init__(self, next=None, previous=None, results=None): # noqa: E501 + """PickupList - a model defined in Purplship""" # noqa: E501 + self._next = None + self._previous = None + self._results = None + self.discriminator = None + if next is not None: + self.next = next + if previous is not None: + self.previous = previous + self.results = results + + @property + def next(self): + """Gets the next of this PickupList. # noqa: E501 + + + :return: The next of this PickupList. # noqa: E501 + :rtype: str + """ + return self._next + + @next.setter + def next(self, next): + """Sets the next of this PickupList. + + + :param next: The next of this PickupList. # noqa: E501 + :type: str + """ + + self._next = next + + @property + def previous(self): + """Gets the previous of this PickupList. # noqa: E501 + + + :return: The previous of this PickupList. # noqa: E501 + :rtype: str + """ + return self._previous + + @previous.setter + def previous(self, previous): + """Sets the previous of this PickupList. + + + :param previous: The previous of this PickupList. # noqa: E501 + :type: str + """ + + self._previous = previous + + @property + def results(self): + """Gets the results of this PickupList. # noqa: E501 + + + :return: The results of this PickupList. # noqa: E501 + :rtype: list[Pickup] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this PickupList. + + + :param results: The results of this PickupList. # noqa: E501 + :type: list[Pickup] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PickupList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PickupList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/purplship/models/pickup_request.py b/purplship/models/pickup_request.py index 9d5c0f7..4c99e78 100644 --- a/purplship/models/pickup_request.py +++ b/purplship/models/pickup_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -50,7 +50,7 @@ class PickupRequest(object): } def __init__(self, pickup_date=None, address=None, parcels=None, ready_time=None, closing_time=None, instruction=None, package_location=None, options=None): # noqa: E501 - """PickupRequest - a model defined in Swagger""" # noqa: E501 + """PickupRequest - a model defined in Purplship""" # noqa: E501 self._pickup_date = None self._address = None self._parcels = None diff --git a/purplship/models/pickup_response.py b/purplship/models/pickup_response.py index 33837d8..f1411ad 100644 --- a/purplship/models/pickup_response.py +++ b/purplship/models/pickup_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,7 @@ class PickupResponse(object): } def __init__(self, messages=None, pickup=None): # noqa: E501 - """PickupResponse - a model defined in Swagger""" # noqa: E501 + """PickupResponse - a model defined in Purplship""" # noqa: E501 self._messages = None self._pickup = None self.discriminator = None diff --git a/purplship/models/pickup_update_data.py b/purplship/models/pickup_update_data.py index 143c1c1..a31678a 100644 --- a/purplship/models/pickup_update_data.py +++ b/purplship/models/pickup_update_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -52,7 +52,7 @@ class PickupUpdateData(object): } def __init__(self, pickup_date=None, address=None, ready_time=None, closing_time=None, instruction=None, package_location=None, options=None, tracking_numbers=None, confirmation_number=None): # noqa: E501 - """PickupUpdateData - a model defined in Swagger""" # noqa: E501 + """PickupUpdateData - a model defined in Purplship""" # noqa: E501 self._pickup_date = None self._address = None self._ready_time = None diff --git a/purplship/models/pickup_update_request.py b/purplship/models/pickup_update_request.py index e8283e0..f8962ba 100644 --- a/purplship/models/pickup_update_request.py +++ b/purplship/models/pickup_update_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -52,7 +52,7 @@ class PickupUpdateRequest(object): } def __init__(self, pickup_date=None, address=None, parcels=None, confirmation_number=None, ready_time=None, closing_time=None, instruction=None, package_location=None, options=None): # noqa: E501 - """PickupUpdateRequest - a model defined in Swagger""" # noqa: E501 + """PickupUpdateRequest - a model defined in Purplship""" # noqa: E501 self._pickup_date = None self._address = None self._parcels = None diff --git a/purplship/models/rate.py b/purplship/models/rate.py index f8324c3..4ec2927 100644 --- a/purplship/models/rate.py +++ b/purplship/models/rate.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -62,7 +62,7 @@ class Rate(object): } def __init__(self, id=None, carrier_name=None, carrier_id=None, currency=None, service=None, discount=None, base_charge=None, total_charge=None, duties_and_taxes=None, transit_days=None, extra_charges=None, meta=None, carrier_ref=None, test_mode=None): # noqa: E501 - """Rate - a model defined in Swagger""" # noqa: E501 + """Rate - a model defined in Purplship""" # noqa: E501 self._id = None self._carrier_name = None self._carrier_id = None diff --git a/purplship/models/rate_request.py b/purplship/models/rate_request.py index 45c8281..cfae7ba 100644 --- a/purplship/models/rate_request.py +++ b/purplship/models/rate_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -48,7 +48,7 @@ class RateRequest(object): } def __init__(self, shipper=None, recipient=None, parcels=None, services=None, options=None, reference=None, carrier_ids=None): # noqa: E501 - """RateRequest - a model defined in Swagger""" # noqa: E501 + """RateRequest - a model defined in Purplship""" # noqa: E501 self._shipper = None self._recipient = None self._parcels = None diff --git a/purplship/models/rate_response.py b/purplship/models/rate_response.py index 9c6d7c0..fea3b12 100644 --- a/purplship/models/rate_response.py +++ b/purplship/models/rate_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,7 @@ class RateResponse(object): } def __init__(self, messages=None, rates=None): # noqa: E501 - """RateResponse - a model defined in Swagger""" # noqa: E501 + """RateResponse - a model defined in Purplship""" # noqa: E501 self._messages = None self._rates = None self.discriminator = None diff --git a/purplship/models/references.py b/purplship/models/references.py index 70fabbc..eb2c563 100644 --- a/purplship/models/references.py +++ b/purplship/models/references.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -56,7 +56,7 @@ class References(object): } def __init__(self, countries=None, currencies=None, carriers=None, customs_content_type=None, incoterms=None, states=None, services=None, options=None, package_presets=None, packaging_types=None, payment_types=None): # noqa: E501 - """References - a model defined in Swagger""" # noqa: E501 + """References - a model defined in Purplship""" # noqa: E501 self._countries = None self._currencies = None self._carriers = None diff --git a/purplship/models/shipment.py b/purplship/models/shipment.py index f1986a1..3357b40 100644 --- a/purplship/models/shipment.py +++ b/purplship/models/shipment.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -86,7 +86,7 @@ class Shipment(object): } def __init__(self, id=None, status='created', carrier_name=None, carrier_id=None, label=None, tracking_number=None, shipment_identifier=None, selected_rate=None, selected_rate_id=None, rates=None, tracking_url=None, service=None, shipper=None, recipient=None, parcels=None, services=None, options=None, payment=None, customs=None, reference=None, label_type=None, carrier_ids=None, meta=None, created_at=None, test_mode=None, messages=None): # noqa: E501 - """Shipment - a model defined in Swagger""" # noqa: E501 + """Shipment - a model defined in Purplship""" # noqa: E501 self._id = None self._status = None self._carrier_name = None @@ -205,7 +205,7 @@ def status(self, status): :param status: The status of this Shipment. # noqa: E501 :type: str """ - allowed_values = ["created", "purchased", "transit", "delivered"] # noqa: E501 + allowed_values = ["created", "purchased", "shipped", "transit", "delivered"] # noqa: E501 if status not in allowed_values: raise ValueError( "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 diff --git a/purplship/models/shipment_cancel_request.py b/purplship/models/shipment_cancel_request.py index 8967c34..a3d8fd5 100644 --- a/purplship/models/shipment_cancel_request.py +++ b/purplship/models/shipment_cancel_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -40,7 +40,7 @@ class ShipmentCancelRequest(object): } def __init__(self, shipment_identifier=None, service=None, options=None): # noqa: E501 - """ShipmentCancelRequest - a model defined in Swagger""" # noqa: E501 + """ShipmentCancelRequest - a model defined in Purplship""" # noqa: E501 self._shipment_identifier = None self._service = None self._options = None diff --git a/purplship/models/shipment_data.py b/purplship/models/shipment_data.py index ef619b3..fdff615 100644 --- a/purplship/models/shipment_data.py +++ b/purplship/models/shipment_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -54,7 +54,7 @@ class ShipmentData(object): } def __init__(self, shipper=None, recipient=None, parcels=None, options=None, payment=None, customs=None, reference=None, label_type='PDF', services=None, carrier_ids=None): # noqa: E501 - """ShipmentData - a model defined in Swagger""" # noqa: E501 + """ShipmentData - a model defined in Purplship""" # noqa: E501 self._shipper = None self._recipient = None self._parcels = None diff --git a/purplship/models/shipment_list.py b/purplship/models/shipment_list.py new file mode 100644 index 0000000..36bd929 --- /dev/null +++ b/purplship/models/shipment_list.py @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + Purplship Open Source Multi-carrier Shipping API + + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 + + OpenAPI spec version: v1-2021.2 + Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ShipmentList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next': 'str', + 'previous': 'str', + 'results': 'list[Shipment]' + } + + attribute_map = { + 'next': 'next', + 'previous': 'previous', + 'results': 'results' + } + + def __init__(self, next=None, previous=None, results=None): # noqa: E501 + """ShipmentList - a model defined in Purplship""" # noqa: E501 + self._next = None + self._previous = None + self._results = None + self.discriminator = None + if next is not None: + self.next = next + if previous is not None: + self.previous = previous + self.results = results + + @property + def next(self): + """Gets the next of this ShipmentList. # noqa: E501 + + + :return: The next of this ShipmentList. # noqa: E501 + :rtype: str + """ + return self._next + + @next.setter + def next(self, next): + """Sets the next of this ShipmentList. + + + :param next: The next of this ShipmentList. # noqa: E501 + :type: str + """ + + self._next = next + + @property + def previous(self): + """Gets the previous of this ShipmentList. # noqa: E501 + + + :return: The previous of this ShipmentList. # noqa: E501 + :rtype: str + """ + return self._previous + + @previous.setter + def previous(self, previous): + """Sets the previous of this ShipmentList. + + + :param previous: The previous of this ShipmentList. # noqa: E501 + :type: str + """ + + self._previous = previous + + @property + def results(self): + """Gets the results of this ShipmentList. # noqa: E501 + + + :return: The results of this ShipmentList. # noqa: E501 + :rtype: list[Shipment] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this ShipmentList. + + + :param results: The results of this ShipmentList. # noqa: E501 + :type: list[Shipment] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ShipmentList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ShipmentList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/purplship/models/shipment_purchase_data.py b/purplship/models/shipment_purchase_data.py index a4f945b..626b620 100644 --- a/purplship/models/shipment_purchase_data.py +++ b/purplship/models/shipment_purchase_data.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -40,7 +40,7 @@ class ShipmentPurchaseData(object): } def __init__(self, selected_rate_id=None, label_type='PDF', payment=None): # noqa: E501 - """ShipmentPurchaseData - a model defined in Swagger""" # noqa: E501 + """ShipmentPurchaseData - a model defined in Purplship""" # noqa: E501 self._selected_rate_id = None self._label_type = None self._payment = None diff --git a/purplship/models/shipping_request.py b/purplship/models/shipping_request.py index 2fabf36..0e4c18c 100644 --- a/purplship/models/shipping_request.py +++ b/purplship/models/shipping_request.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -54,7 +54,7 @@ class ShippingRequest(object): } def __init__(self, shipper=None, recipient=None, parcels=None, options=None, payment=None, customs=None, reference=None, label_type='PDF', selected_rate_id=None, rates=None): # noqa: E501 - """ShippingRequest - a model defined in Swagger""" # noqa: E501 + """ShippingRequest - a model defined in Purplship""" # noqa: E501 self._shipper = None self._recipient = None self._parcels = None diff --git a/purplship/models/tracker_list.py b/purplship/models/tracker_list.py new file mode 100644 index 0000000..1f74045 --- /dev/null +++ b/purplship/models/tracker_list.py @@ -0,0 +1,163 @@ +# coding: utf-8 + +""" + Purplship Open Source Multi-carrier Shipping API + + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 + + OpenAPI spec version: v1-2021.2 + Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TrackerList(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next': 'str', + 'previous': 'str', + 'results': 'list[TrackingStatus]' + } + + attribute_map = { + 'next': 'next', + 'previous': 'previous', + 'results': 'results' + } + + def __init__(self, next=None, previous=None, results=None): # noqa: E501 + """TrackerList - a model defined in Purplship""" # noqa: E501 + self._next = None + self._previous = None + self._results = None + self.discriminator = None + if next is not None: + self.next = next + if previous is not None: + self.previous = previous + self.results = results + + @property + def next(self): + """Gets the next of this TrackerList. # noqa: E501 + + + :return: The next of this TrackerList. # noqa: E501 + :rtype: str + """ + return self._next + + @next.setter + def next(self, next): + """Sets the next of this TrackerList. + + + :param next: The next of this TrackerList. # noqa: E501 + :type: str + """ + + self._next = next + + @property + def previous(self): + """Gets the previous of this TrackerList. # noqa: E501 + + + :return: The previous of this TrackerList. # noqa: E501 + :rtype: str + """ + return self._previous + + @previous.setter + def previous(self, previous): + """Sets the previous of this TrackerList. + + + :param previous: The previous of this TrackerList. # noqa: E501 + :type: str + """ + + self._previous = previous + + @property + def results(self): + """Gets the results of this TrackerList. # noqa: E501 + + + :return: The results of this TrackerList. # noqa: E501 + :rtype: list[TrackingStatus] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TrackerList. + + + :param results: The results of this TrackerList. # noqa: E501 + :type: list[TrackingStatus] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TrackerList, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TrackerList): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/purplship/models/tracking_event.py b/purplship/models/tracking_event.py index c242c74..a56400d 100644 --- a/purplship/models/tracking_event.py +++ b/purplship/models/tracking_event.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -32,8 +32,7 @@ class TrackingEvent(object): 'description': 'str', 'location': 'str', 'code': 'str', - 'time': 'str', - 'signatory': 'str' + 'time': 'str' } attribute_map = { @@ -41,28 +40,27 @@ class TrackingEvent(object): 'description': 'description', 'location': 'location', 'code': 'code', - 'time': 'time', - 'signatory': 'signatory' + 'time': 'time' } - def __init__(self, _date=None, description=None, location=None, code=None, time=None, signatory=None): # noqa: E501 - """TrackingEvent - a model defined in Swagger""" # noqa: E501 + def __init__(self, _date=None, description=None, location=None, code=None, time=None): # noqa: E501 + """TrackingEvent - a model defined in Purplship""" # noqa: E501 self.__date = None self._description = None self._location = None self._code = None self._time = None - self._signatory = None self.discriminator = None - self._date = _date - self.description = description - self.location = location + if _date is not None: + self._date = _date + if description is not None: + self.description = description + if location is not None: + self.location = location if code is not None: self.code = code if time is not None: self.time = time - if signatory is not None: - self.signatory = signatory @property def _date(self): @@ -84,8 +82,6 @@ def _date(self, _date): :param _date: The _date of this TrackingEvent. # noqa: E501 :type: str """ - if _date is None: - raise ValueError("Invalid value for `_date`, must not be `None`") # noqa: E501 self.__date = _date @@ -109,8 +105,6 @@ def description(self, description): :param description: The description of this TrackingEvent. # noqa: E501 :type: str """ - if description is None: - raise ValueError("Invalid value for `description`, must not be `None`") # noqa: E501 self._description = description @@ -134,8 +128,6 @@ def location(self, location): :param location: The location of this TrackingEvent. # noqa: E501 :type: str """ - if location is None: - raise ValueError("Invalid value for `location`, must not be `None`") # noqa: E501 self._location = location @@ -185,29 +177,6 @@ def time(self, time): self._time = time - @property - def signatory(self): - """Gets the signatory of this TrackingEvent. # noqa: E501 - - The tracking signature on delivery # noqa: E501 - - :return: The signatory of this TrackingEvent. # noqa: E501 - :rtype: str - """ - return self._signatory - - @signatory.setter - def signatory(self, signatory): - """Sets the signatory of this TrackingEvent. - - The tracking signature on delivery # noqa: E501 - - :param signatory: The signatory of this TrackingEvent. # noqa: E501 - :type: str - """ - - self._signatory = signatory - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/purplship/models/tracking_response.py b/purplship/models/tracking_response.py index 679ecaf..579a25f 100644 --- a/purplship/models/tracking_response.py +++ b/purplship/models/tracking_response.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -38,7 +38,7 @@ class TrackingResponse(object): } def __init__(self, messages=None, tracking=None): # noqa: E501 - """TrackingResponse - a model defined in Swagger""" # noqa: E501 + """TrackingResponse - a model defined in Purplship""" # noqa: E501 self._messages = None self._tracking = None self.discriminator = None diff --git a/purplship/models/tracking_status.py b/purplship/models/tracking_status.py index 43baacb..baf1531 100644 --- a/purplship/models/tracking_status.py +++ b/purplship/models/tracking_status.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -33,6 +33,7 @@ class TrackingStatus(object): 'carrier_id': 'str', 'tracking_number': 'str', 'events': 'list[TrackingEvent]', + 'delivered': 'bool', 'test_mode': 'bool' } @@ -42,16 +43,18 @@ class TrackingStatus(object): 'carrier_id': 'carrier_id', 'tracking_number': 'tracking_number', 'events': 'events', + 'delivered': 'delivered', 'test_mode': 'test_mode' } - def __init__(self, id=None, carrier_name=None, carrier_id=None, tracking_number=None, events=None, test_mode=None): # noqa: E501 - """TrackingStatus - a model defined in Swagger""" # noqa: E501 + def __init__(self, id=None, carrier_name=None, carrier_id=None, tracking_number=None, events=None, delivered=None, test_mode=None): # noqa: E501 + """TrackingStatus - a model defined in Purplship""" # noqa: E501 self._id = None self._carrier_name = None self._carrier_id = None self._tracking_number = None self._events = None + self._delivered = None self._test_mode = None self.discriminator = None if id is not None: @@ -61,6 +64,8 @@ def __init__(self, id=None, carrier_name=None, carrier_id=None, tracking_number= self.tracking_number = tracking_number if events is not None: self.events = events + if delivered is not None: + self.delivered = delivered self.test_mode = test_mode @property @@ -184,11 +189,34 @@ def events(self, events): self._events = events + @property + def delivered(self): + """Gets the delivered of this TrackingStatus. # noqa: E501 + + Specified whether the related shipment was delivered # noqa: E501 + + :return: The delivered of this TrackingStatus. # noqa: E501 + :rtype: bool + """ + return self._delivered + + @delivered.setter + def delivered(self, delivered): + """Sets the delivered of this TrackingStatus. + + Specified whether the related shipment was delivered # noqa: E501 + + :param delivered: The delivered of this TrackingStatus. # noqa: E501 + :type: bool + """ + + self._delivered = delivered + @property def test_mode(self): """Gets the test_mode of this TrackingStatus. # noqa: E501 - Specified whether it was created with a carrier in test mode # noqa: E501 + Specified whether the object was created with a carrier in test mode # noqa: E501 :return: The test_mode of this TrackingStatus. # noqa: E501 :rtype: bool @@ -199,7 +227,7 @@ def test_mode(self): def test_mode(self, test_mode): """Sets the test_mode of this TrackingStatus. - Specified whether it was created with a carrier in test mode # noqa: E501 + Specified whether the object was created with a carrier in test mode # noqa: E501 :param test_mode: The test_mode of this TrackingStatus. # noqa: E501 :type: bool diff --git a/purplship/rest.py b/purplship/rest.py index e505de4..8e51569 100644 --- a/purplship/rest.py +++ b/purplship/rest.py @@ -5,7 +5,7 @@ Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1-2021.0 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com Generated by: https://github.com/swagger-api/swagger-codegen.git """ diff --git a/requirements.txt b/requirements.txt index a486bbf..5ef4170 100755 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,4 @@ -certifi >= 14.05.14 -six >= 1.10 -python_dateutil >= 2.5.3 -setuptools >= 21.0.0 -urllib3 >= 1.15.1 +twine +wheel --e .[dev] +-e . diff --git a/setup.py b/setup.py index 5c5b65d..4d6abca 100755 --- a/setup.py +++ b/setup.py @@ -1,34 +1,32 @@ # coding: utf-8 """ - PurplShip Multi-carrier API + Purplship Open Source Multi-carrier Shipping API - PurplShip is a Multi-carrier Shipping API that simplifies the integration of logistic carrier services # noqa: E501 + Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services The **proxy** endpoints are stateless and forwards calls to carriers web services. # noqa: E501 - OpenAPI spec version: v1 + OpenAPI spec version: v1-2021.2 Contact: hello@purplship.com + Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from setuptools import setup, find_packages # noqa: H301 + with open("README.md", "r") as fh: long_description = fh.read() NAME = "purplship-python" -VERSION = "2021.0" - -DEV_REQUIRES = [ - "wheel", - "twine" -] - -REQUIRES = [ - "certifi>=2017.4.17", - "python-dateutil>=2.1", - "six>=1.10", - "urllib3>=1.23" -] +VERSION = "2021.2" + +# To install the library, run the following +# +# python setup.py install +# +# prerequisite: setuptools +# http://pypi.python.org/pypi/setuptools + +REQUIRES = ["urllib3 >= 1.15", "six >= 1.10", "certifi", "python-dateutil"] setup( @@ -41,7 +39,6 @@ url="https://github.com/PurplShip/purplship-python-client", keywords=["Purplship", "Multi-carrier API", "Shipping API"], install_requires=REQUIRES, - extras_require={'dev': DEV_REQUIRES}, packages=find_packages(exclude=["test*"]), include_package_data=True, python_requires='>=3.4',