Merge pull request #7 from PurplShip/purplship-python-client-2020.8.2

Purplship python client 2020.8.2

README.md

@@ -6,7 +6,7 @@ Visit [purplship.com](https://purplship.com) to deploy your private cloud multi-
 
 ## Documentation
 
-See the full [Python API docs](https://docs.purplship.com).
+See the full [Python API docs](https://docs.purplship.com/#/guide).
 
 ## Requirements
 
@@ -49,6 +49,39 @@ except ApiException as e:
 
 ```
 
+## Documentation For Models
+
+- [Address](docs/Address.md)
+- [AddressData](docs/AddressData.md)
+- [Card](docs/Card.md)
+- [CarrierSettings](docs/CarrierSettings.md)
+- [Charge](docs/Charge.md)
+- [Commodity](docs/Commodity.md)
+- [Customs](docs/Customs.md)
+- [CustomsData](docs/CustomsData.md)
+- [Doc](docs/Doc.md)
+- [ErrorResponse](docs/ErrorResponse.md)
+- [Invoice](docs/Invoice.md)
+- [LabelPrintingRequest](docs/LabelPrintingRequest.md)
+- [Message](docs/Message.md)
+- [Parcel](docs/Parcel.md)
+- [ParcelData](docs/ParcelData.md)
+- [Payment](docs/Payment.md)
+- [PaymentData](docs/PaymentData.md)
+- [Rate](docs/Rate.md)
+- [RateRequest](docs/RateRequest.md)
+- [RateResponse](docs/RateResponse.md)
+- [References](docs/References.md)
+- [Shipment](docs/Shipment.md)
+- [ShipmentData](docs/ShipmentData.md)
+- [ShipmentPurchaseData](docs/ShipmentPurchaseData.md)
+- [ShipmentResponse](docs/ShipmentResponse.md)
+- [ShippingRequest](docs/ShippingRequest.md)
+- [TrackingDetails](docs/TrackingDetails.md)
+- [TrackingEvent](docs/TrackingEvent.md)
+- [TrackingResponse](docs/TrackingResponse.md)
+- [TrackingStatus](docs/TrackingStatus.md)
+
 ## Author
 
 PurplShip Team | hello@purplship.com | [purplship.com](https://purplship.com)

docs/Address.md

@@ -0,0 +1,24 @@
+# Address
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A unique identifier | [optional] 
+**postal_code** | **str** | The address postal code | [optional] 
+**city** | **str** |  The address city. <br/> **(required to create as shipment)**  | [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 <br/> **(required to create as shipment)**  | [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.<br/> Note that the expected format is: **1 514 0000000**  Country Code | Area Code | Phone --- | --- | --- 1 | 514 | 0000000  | [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] 
+**address_line1** | **str** |  The address line with street number <br/> **(required to create as shipment)**  | [optional] 
+**address_line2** | **str** | The address line with suite number | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/AddressData.md

@@ -0,0 +1,23 @@
+# AddressData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**postal_code** | **str** | The address postal code | [optional] 
+**city** | **str** |  The address city. <br/> **(required to create as shipment)**  | [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 <br/> **(required to create as shipment)**  | [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.<br/> Note that the expected format is: **1 514 0000000**  Country Code | Area Code | Phone --- | --- | --- 1 | 514 | 0000000  | [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] 
+**address_line1** | **str** |  The address line with street number <br/> **(required to create as shipment)**  | [optional] 
+**address_line2** | **str** | The address line with suite number | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Card.md

@@ -0,0 +1,16 @@
+# Card
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **str** | The credit card type | 
+**number** | **str** | The credit card number | 
+**expiry_month** | **str** | The credit card expiry month (MM) | 
+**expiry_year** | **str** | The credit card expiry year (YYYY) | 
+**security_code** | **str** | The credit card security code often at the back (000) | 
+**name** | **str** | The name inscribed on the credit card | [optional] 
+**postal_code** | **str** | The credit card registration address postal code | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/CarrierSettings.md

@@ -0,0 +1,13 @@
+# CarrierSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A unique address identifier | 
+**carrier_name** | **str** | Indicates a carrier (type) | 
+**carrier_id** | **str** | Indicates a specific carrier configuration name. | 
+**test** | **bool** |  The test flag indicates whether to use a carrier configured for test.   | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Charge.md

@@ -0,0 +1,12 @@
+# Charge
+
+## 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] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Commodity.md

@@ -0,0 +1,24 @@
+# Commodity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A unique identifier | [optional] 
+**postal_code** | **str** | The address postal code | [optional] 
+**city** | **str** |  The address city. <br/> **(required to create as shipment)**  | [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 <br/> **(required to create as shipment)**  | [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.<br/> Note that the expected format is: **1 514 0000000**  Country Code | Area Code | Phone --- | --- | --- 1 | 514 | 0000000  | [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] 
+**address_line1** | **str** |  The address line with street number <br/> **(required to create as shipment)**  | [optional] 
+**address_line2** | **str** | The address line with suite number | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Customs.md

@@ -0,0 +1,18 @@
+# Customs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A unique identifier | [optional] 
+**no_eei** | **str** |  | [optional] 
+**aes** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**terms_of_trade** | **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** | [**Invoice**](Invoice.md) |  | [optional] 
+**commercial_invoice** | **bool** | Indicates if the shipment is commercial | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/CustomsData.md

@@ -0,0 +1,17 @@
+# CustomsData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**no_eei** | **str** |  | [optional] 
+**aes** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**terms_of_trade** | **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** | [**Invoice**](Invoice.md) |  | [optional] 
+**commercial_invoice** | **bool** | Indicates if the shipment is commercial | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Doc.md

@@ -0,0 +1,12 @@
+# Doc
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **str** | The document type | 
+**image** | **str** | encoded base64 string of the document | 
+**format** | **str** | The document format | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/ErrorResponse.md

@@ -0,0 +1,10 @@
+# ErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**list[Message]**](Message.md) | The list of error messages | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Invoice.md

@@ -0,0 +1,13 @@
+# Invoice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_date** | **str** | The invoice date | 
+**identifier** | **str** | The internal invoice document identifier | [optional] 
+**type** | **str** | The invoice type | [optional] 
+**copies** | **int** | The number of invoice copies | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/LabelPrintingRequest.md

@@ -0,0 +1,11 @@
+# LabelPrintingRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  PDF file name.  eg: shipment-[trackingNumber]  | 
+**label** | **str** | Shipment base64 label | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Message.md

@@ -0,0 +1,14 @@
+# Message
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_name** | **str** | The targeted carrier | 
+**carrier_id** | **str** | The targeted carrier name (unique identifier) | 
+**message** | **str** | The error or warning message | [optional] 
+**code** | **str** | The message code | [optional] 
+**details** | **dict(str, str)** | any additional details | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Parcel.md

@@ -0,0 +1,21 @@
+# Parcel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A unique identifier | [optional] 
+**weight** | **float** | The parcel's weight | [optional] 
+**width** | **float** | The parcel's width | [optional] 
+**height** | **float** | The parcel's height | [optional] 
+**length** | **float** | The parcel's length | [optional] 
+**packaging_type** | **str** |  The parcel's packaging type.  **Note that the packaging is optional when using a package preset**  values: <br/>- **envelope**<br/>- **pak**<br/>- **tube**<br/>- **pallet**<br/>- **small_box**<br/>- **medium_box**<br/>- **your_packaging**  For specific carriers packaging type, please consult the API reference.  | [optional] 
+**package_preset** | **str** |  The parcel's package preset.  For specific carriers package preset, please consult the API reference.  | [optional] 
+**description** | **str** | The parcel's description | [optional] 
+**content** | **str** | The parcel's content description | [optional] 
+**is_document** | **bool** | Indicates if the parcel is composed of documents only | [optional] [default to False]
+**weight_unit** | **str** | The parcel's weight unit | [optional] 
+**dimension_unit** | **str** | The parcel's dimension unit | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/ParcelData.md

@@ -0,0 +1,20 @@
+# ParcelData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**weight** | **float** | The parcel's weight | [optional] 
+**width** | **float** | The parcel's width | [optional] 
+**height** | **float** | The parcel's height | [optional] 
+**length** | **float** | The parcel's length | [optional] 
+**packaging_type** | **str** |  The parcel's packaging type.  **Note that the packaging is optional when using a package preset**  values: <br/>- **envelope**<br/>- **pak**<br/>- **tube**<br/>- **pallet**<br/>- **small_box**<br/>- **medium_box**<br/>- **your_packaging**  For specific carriers packaging type, please consult the API reference.  | [optional] 
+**package_preset** | **str** |  The parcel's package preset.  For specific carriers package preset, please consult the API reference.  | [optional] 
+**description** | **str** | The parcel's description | [optional] 
+**content** | **str** | The parcel's content description | [optional] 
+**is_document** | **bool** | Indicates if the parcel is composed of documents only | [optional] [default to False]
+**weight_unit** | **str** | The parcel's weight unit | [optional] 
+**dimension_unit** | **str** | The parcel's dimension unit | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Payment.md

@@ -0,0 +1,16 @@
+# Payment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A unique identifier | [optional] 
+**paid_by** | **str** | The payment payer | 
+**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] 
+**credit_card** | [**Card**](Card.md) |  | [optional] 
+**contact** | [**Address**](Address.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/PaymentData.md

@@ -0,0 +1,15 @@
+# PaymentData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**paid_by** | **str** | The payment payer | 
+**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] 
+**credit_card** | [**Card**](Card.md) |  | [optional] 
+**contact** | [**Address**](Address.md) |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/Rate.md

@@ -0,0 +1,22 @@
+# Rate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **str** | A unique identifier | [optional] 
+**carrier_name** | **str** | The rate's carrier | 
+**carrier_id** | **str** | The targeted carrier's name (unique identifier) | 
+**currency** | **str** | The rate monetary values currency code | 
+**service** | **str** | The carrier's rate (quote) service | [optional] 
+**discount** | **float** | The monetary amount of the discount on the rate | [optional] 
+**base_charge** | **float** |  The rate's monetary amount of the base charge.<br/> This is the net amount of the rate before additional charges  | [optional] 
+**total_charge** | **float** |  The rate's monetary amount of the total charge.<br/> This is the gross amount of the rate after adding the additional charges  | [optional] 
+**duties_and_taxes** | **float** | The monetary amount of the duties and taxes if applied | [optional] 
+**transit_days** | **int** | The estimated delivery transit days | [optional] 
+**extra_charges** | [**list[Charge]**](Charge.md) | list of the rate's additional charges | [optional] 
+**meta** | **object** | provider specific metadata | [optional] 
+**carrier_ref** | **str** | The system carrier configuration id | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/RateRequest.md

@@ -0,0 +1,16 @@
+# RateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipper** | [**Address**](Address.md) |  | 
+**recipient** | [**Address**](Address.md) |  | 
+**parcels** | [**list[Parcel]**](Parcel.md) | The shipment's parcels | 
+**services** | **list[str]** |  The requested carrier service for the shipment.<br/> Please consult the API reference for specific carriers services.  Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier.  | [optional] 
+**options** | **object** |  The options available for the shipment.  Please consult the API reference for additional specific carriers options.  | [optional] 
+**reference** | **str** | The shipment reference | [optional] 
+**carrier_ids** | **list[str]** |  The list of configured carriers you wish to get rates from.  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+

docs/RateResponse.md

@@ -0,0 +1,11 @@
+# RateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**list[Message]**](Message.md) | The list of note, error or warning messages | [optional] 
+**rates** | [**list[Rate]**](Rate.md) | The list of returned rates | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+