Merge pull request #14 from purplship/purplship-2021.7-client

generate Python client for Purplship Server 2021.7 Edition

README.md

@@ -50,50 +50,62 @@ except ApiException as e:
 
 ## Documentation For Models
 
-- [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)
-- [Operation](docs/Operation.md)
-- [OperationConfirmation](docs/OperationConfirmation.md)
-- [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)
-- [PickupUpdateRequest](docs/PickupUpdateRequest.md)
-- [Rate](docs/Rate.md)
-- [RateRequest](docs/RateRequest.md)
-- [RateResponse](docs/RateResponse.md)
-- [References](docs/References.md)
-- [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)
+ - [AccessToken](docs/AccessToken.md)
+ - [Address](docs/Address.md)
+ - [AddressData](docs/AddressData.md)
+ - [AddressList](docs/AddressList.md)
+ - [AddressValidation](docs/AddressValidation.md)
+ - [CarrierList](docs/CarrierList.md)
+ - [CarrierSettings](docs/CarrierSettings.md)
+ - [Charge](docs/Charge.md)
+ - [Commodity](docs/Commodity.md)
+ - [CommodityData](docs/CommodityData.md)
+ - [Customs](docs/Customs.md)
+ - [CustomsData](docs/CustomsData.md)
+ - [CustomsList](docs/CustomsList.md)
+ - [Duty](docs/Duty.md)
+ - [ErrorResponse](docs/ErrorResponse.md)
+ - [Message](docs/Message.md)
+ - [Operation](docs/Operation.md)
+ - [OperationConfirmation](docs/OperationConfirmation.md)
+ - [OperationResponse](docs/OperationResponse.md)
+ - [Parcel](docs/Parcel.md)
+ - [ParcelData](docs/ParcelData.md)
+ - [ParcelList](docs/ParcelList.md)
+ - [Payment](docs/Payment.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)
+ - [PickupUpdateRequest](docs/PickupUpdateRequest.md)
+ - [Rate](docs/Rate.md)
+ - [RateRequest](docs/RateRequest.md)
+ - [RateResponse](docs/RateResponse.md)
+ - [References](docs/References.md)
+ - [Shipment](docs/Shipment.md)
+ - [ShipmentCancelRequest](docs/ShipmentCancelRequest.md)
+ - [ShipmentData](docs/ShipmentData.md)
+ - [ShipmentList](docs/ShipmentList.md)
+ - [ShipmentPurchaseData](docs/ShipmentPurchaseData.md)
+ - [ShipmentRateData](docs/ShipmentRateData.md)
+ - [ShippingRequest](docs/ShippingRequest.md)
+ - [TokenObtainPair](docs/TokenObtainPair.md)
+ - [TokenPair](docs/TokenPair.md)
+ - [TokenRefresh](docs/TokenRefresh.md)
+ - [TokenVerify](docs/TokenVerify.md)
+ - [TrackerList](docs/TrackerList.md)
+ - [TrackingEvent](docs/TrackingEvent.md)
+ - [TrackingResponse](docs/TrackingResponse.md)
+ - [TrackingStatus](docs/TrackingStatus.md)
+ - [Webhook](docs/Webhook.md)
+ - [WebhookData](docs/WebhookData.md)
+ - [WebhookList](docs/WebhookList.md)
+ - [WebhookTestRequest](docs/WebhookTestRequest.md)
+
 
 
 ## Author

docs/AccessToken.md

@@ -0,0 +1,12 @@
+# AccessToken
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access** | **str** |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
+
+

docs/Address.md

@@ -1,23 +1,28 @@
 # Address
 
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **str** | A unique identifier | [optional] 
-**postal_code** | **str** |  The address postal code  **(required for shipment purchase)**  | [optional] 
-**city** | **str** |  The address city.  **(required for shipment purchase)**  | [optional] 
-**federal_tax_id** | **str** | The party frederal tax id | [optional] 
-**state_tax_id** | **str** | The party state id | [optional] 
-**person_name** | **str** |  attention to  **(required for shipment purchase)**  | [optional] 
-**company_name** | **str** | The company name if the party is a company | [optional] 
 **country_code** | **str** | The address country code | 
-**email** | **str** | The party email | [optional] 
-**phone_number** | **str** | The party phone number. | [optional] 
-**state_code** | **str** | The address state code | [optional] 
-**suburb** | **str** | The address suburb if known | [optional] 
-**residential** | **bool** | Indicate if the address is residential or commercial (enterprise) | [optional] [default to False]
-**address_line1** | **str** |  The address line with street number <br/> **(required for shipment purchase)**  | [optional] 
-**address_line2** | **str** | The address line with suite number | [optional] 
+**id** | **str** | A unique identifier | [optional] 
+**postal_code** | **str, none_type** |  The address postal code  **(required for shipment purchase)**  | [optional] 
+**city** | **str, none_type** |  The address city.  **(required for shipment purchase)**  | [optional] 
+**federal_tax_id** | **str, none_type** | The party frederal tax id | [optional] 
+**state_tax_id** | **str, none_type** | The party state id | [optional] 
+**person_name** | **str, none_type** |  attention to  **(required for shipment purchase)**  | [optional] 
+**company_name** | **str, none_type** | The company name if the party is a company | [optional] 
+**email** | **str, none_type** | The party email | [optional] 
+**phone_number** | **str, none_type** | The party phone number. | [optional] 
+**state_code** | **str, none_type** | The address state code | [optional] 
+**suburb** | **str, none_type** | The address suburb if known | [optional] 
+**residential** | **bool, none_type** | Indicate if the address is residential or commercial (enterprise) | [optional]  if omitted the server will use the default value of False
+**address_line1** | **str, none_type** |  The address line with street number <br/> **(required for shipment purchase)**  | [optional] 
+**address_line2** | **str, none_type** | The address line with suite number | [optional] 
+**validate_location** | **bool, none_type** | Indicate if the address should be validated | [optional]  if omitted the server will use the default value of False
+**validation** | [**AddressValidation**](AddressValidation.md) |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
 
+

docs/AddressData.md

@@ -1,22 +1,26 @@
 # AddressData
 
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**postal_code** | **str** |  The address postal code  **(required for shipment purchase)**  | [optional] 
-**city** | **str** |  The address city.  **(required for shipment purchase)**  | [optional] 
-**federal_tax_id** | **str** | The party frederal tax id | [optional] 
-**state_tax_id** | **str** | The party state id | [optional] 
-**person_name** | **str** |  attention to  **(required for shipment purchase)**  | [optional] 
-**company_name** | **str** | The company name if the party is a company | [optional] 
 **country_code** | **str** | The address country code | 
-**email** | **str** | The party email | [optional] 
-**phone_number** | **str** | The party phone number. | [optional] 
-**state_code** | **str** | The address state code | [optional] 
-**suburb** | **str** | The address suburb if known | [optional] 
-**residential** | **bool** | Indicate if the address is residential or commercial (enterprise) | [optional] [default to False]
-**address_line1** | **str** |  The address line with street number <br/> **(required for shipment purchase)**  | [optional] 
-**address_line2** | **str** | The address line with suite number | [optional] 
+**postal_code** | **str, none_type** |  The address postal code  **(required for shipment purchase)**  | [optional] 
+**city** | **str, none_type** |  The address city.  **(required for shipment purchase)**  | [optional] 
+**federal_tax_id** | **str, none_type** | The party frederal tax id | [optional] 
+**state_tax_id** | **str, none_type** | The party state id | [optional] 
+**person_name** | **str, none_type** |  attention to  **(required for shipment purchase)**  | [optional] 
+**company_name** | **str, none_type** | The company name if the party is a company | [optional] 
+**email** | **str, none_type** | The party email | [optional] 
+**phone_number** | **str, none_type** | The party phone number. | [optional] 
+**state_code** | **str, none_type** | The address state code | [optional] 
+**suburb** | **str, none_type** | The address suburb if known | [optional] 
+**residential** | **bool, none_type** | Indicate if the address is residential or commercial (enterprise) | [optional]  if omitted the server will use the default value of False
+**address_line1** | **str, none_type** |  The address line with street number <br/> **(required for shipment purchase)**  | [optional] 
+**address_line2** | **str, none_type** | The address line with suite number | [optional] 
+**validate_location** | **bool, none_type** | Indicate if the address should be validated | [optional]  if omitted the server will use the default value of False
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
 
+

docs/AddressList.md

@@ -1,11 +1,14 @@
 # AddressList
 
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**results** | [**[Address]**](Address.md) |  | 
 **next** | **str** |  | [optional] 
 **previous** | **str** |  | [optional] 
-**results** | [**list[Address]**](Address.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
 
+

docs/AddressValidation.md

@@ -0,0 +1,14 @@
+# AddressValidation
+
+Specify address validation result
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **bool** | True if the address is valid | 
+**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | validation service details | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
+
+

docs/CarrierList.md

@@ -1,11 +1,14 @@
 # CarrierList
 
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**results** | [**[CarrierSettings]**](CarrierSettings.md) |  | 
 **next** | **str** |  | [optional] 
 **previous** | **str** |  | [optional] 
-**results** | [**list[CarrierSettings]**](CarrierSettings.md) |  | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
 
+

docs/CarrierSettings.md

@@ -1,5 +1,6 @@
 # CarrierSettings
 
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
@@ -8,6 +9,8 @@ Name | Type | Description | Notes
 **carrier_id** | **str** | Indicates a specific carrier configuration name. | 
 **test** | **bool** |  The test flag indicates whether to use a carrier configured for test.   | 
 **active** | **bool** |  The active flag indicates whether the carrier account is active or not.   | 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
 
+

docs/Charge.md

@@ -1,11 +1,15 @@
 # Charge
 
+The pickup cost details
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **str** | The charge description | [optional] 
-**amount** | **float** | The charge monetary value | [optional] 
-**currency** | **str** | The charge amount currency | [optional] 
+**name** | **str, none_type** | The charge description | [optional] 
+**amount** | **float, none_type** | The charge monetary value | [optional] 
+**currency** | **str, none_type** | The charge amount currency | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
 
+

docs/Commodity.md

@@ -1,17 +1,21 @@
 # Commodity
 
+The parcel content items
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**weight** | **float** | The commodity's weight | 
+**weight_unit** | **str** | The commodity's weight unit | 
 **id** | **str** | A unique identifier | [optional] 
-**weight** | **float** | The commodity's weight | 
-**weight_unit** | **str** | The commodity's weight unit | 
-**description** | **str** | A description of the commodity | [optional] 
-**quantity** | **int** | The commodity's quantity (number or item) | [optional] 
-**sku** | **str** | The commodity's sku number | [optional] 
-**value_amount** | **float** | The monetary value of the commodity | [optional] 
-**value_currency** | **str** | The currency of the commodity value amount | [optional] 
-**origin_country** | **str** | The origin or manufacture country | [optional] 
+**description** | **str, none_type** | A description of the commodity | [optional] 
+**quantity** | **int, none_type** | The commodity's quantity (number or item) | [optional] 
+**sku** | **str, none_type** | The commodity's sku number | [optional] 
+**value_amount** | **float, none_type** | The monetary value of the commodity | [optional] 
+**value_currency** | **str, none_type** | The currency of the commodity value amount | [optional] 
+**origin_country** | **str, none_type** | The origin or manufacture country | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
 
+

docs/CommodityData.md

@@ -0,0 +1,19 @@
+# CommodityData
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**weight** | **float** | The commodity's weight | 
+**weight_unit** | **str** | The commodity's weight unit | 
+**description** | **str, none_type** | A description of the commodity | [optional] 
+**quantity** | **int, none_type** | The commodity's quantity (number or item) | [optional] 
+**sku** | **str, none_type** | The commodity's sku number | [optional] 
+**value_amount** | **float, none_type** | The monetary value of the commodity | [optional] 
+**value_currency** | **str, none_type** | The currency of the commodity value amount | [optional] 
+**origin_country** | **str, none_type** | The origin or manufacture country | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
+
+

docs/Customs.md

@@ -1,22 +1,26 @@
 # Customs
 
+
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **str** | A unique identifier | [optional] 
-**aes** | **str** |  | [optional] 
-**eel_pfc** | **str** |  | [optional] 
-**content_type** | **str** |  | [optional] 
-**content_description** | **str** |  | [optional] 
-**incoterm** | **str** | The customs 'term of trade' also known as 'incoterm' | [optional] 
-**commodities** | [**list[Commodity]**](Commodity.md) | The parcel content items | [optional] 
-**duty** | [**Payment**](Payment.md) |  | [optional] 
-**invoice** | **str** | The invoice reference number | [optional] 
-**commercial_invoice** | **bool** | Indicates if the shipment is commercial | [optional] 
-**certify** | **bool** | Indicate that signer certified confirmed all | [optional] 
-**signer** | **str** |  | [optional] 
-**certificate_number** | **str** |  | [optional] 
-**options** | **object** |  | [optional] 
+**aes** | **str, none_type** |  | [optional] 
+**eel_pfc** | **str, none_type** |  | [optional] 
+**content_type** | **str, none_type** |  | [optional] 
+**content_description** | **str, none_type** |  | [optional] 
+**incoterm** | **str, none_type** | The customs 'term of trade' also known as 'incoterm' | [optional] 
+**commodities** | [**[Commodity], none_type**](Commodity.md) | The parcel content items | [optional] 
+**duty** | [**Duty**](Duty.md) |  | [optional] 
+**invoice** | **str, none_type** | The invoice reference number | [optional] 
+**invoice_date** | **str, none_type** | The invoice date | [optional] 
+**commercial_invoice** | **bool, none_type** | Indicates if the shipment is commercial | [optional] 
+**certify** | **bool, none_type** | Indicate that signer certified confirmed all | [optional] 
+**signer** | **str, none_type** |  | [optional] 
+**certificate_number** | **str, none_type** |  | [optional] 
+**options** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** |  | [optional] 
+**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [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)
 
+