This repository has been archived by the owner on Jan 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
generate and release node client for 2021.11 edition
- Loading branch information
Showing
84 changed files
with
787 additions
and
289 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,15 +2,15 @@ | |
|
|
||
| Purplship is a Multi-carrier Shipping API that simplifies the integration of logistic carrier services. | ||
|
|
||
| Visit [purplship.com](https://purplship.com) to deploy your private cloud multi-carrier shipping API instance. | ||
| Visit [purplship.com](https://next.purplship.com) to deploy your private cloud multi-carrier shipping API instance. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See the full [Python API docs](https://next.purplship.com/docs/reference). | ||
|
|
||
| ## Requirements | ||
|
|
||
| Python 3.4+ | ||
| Python >= 3.6 | ||
|
|
||
| ## Installation & Usage | ||
|
|
||
|
|
@@ -65,6 +65,7 @@ except ApiException as e: | |
| - [Duty](docs/Duty.md) | ||
| - [ErrorResponse](docs/ErrorResponse.md) | ||
| - [Message](docs/Message.md) | ||
| - [Metadata](docs/Metadata.md) | ||
| - [Operation](docs/Operation.md) | ||
| - [OperationConfirmation](docs/OperationConfirmation.md) | ||
| - [OperationResponse](docs/OperationResponse.md) | ||
|
|
@@ -107,4 +108,4 @@ except ApiException as e: | |
|
|
||
| ## Author | ||
|
|
||
| PurplShip Team | [email protected] | [purplship.com](https://purplship.com) | ||
| Purplship Team | [email protected] | [purplship.com](https://purplship.com) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # Metadata | ||
|
|
||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **app_name** | **str** | | | ||
| **app_version** | **str** | | | ||
| **app_website** | **str** | | | ||
| **multi_organizations** | **bool** | | | ||
| **admin** | **str** | | | ||
| **openapi** | **str** | | | ||
| **graphql** | **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) | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes | |
| **recipient** | [**AddressData**](AddressData.md) | | | ||
| **parcels** | [**[ParcelData]**](ParcelData.md) | The shipment's parcels | | ||
| **services** | **[str], none_type** | The requested carrier service for the shipment.<br/> Please consult [the reference](#operation/references) 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** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | The options available for the shipment. Please consult [the reference](#operation/references) for additional specific carriers options. | [optional] | ||
| **options** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | <details> <summary>The options available for the shipment.</summary> ``` { \"currency\": \"USD\", \"insurance\": 100.00, \"cash_on_delivery\": 30.00, \"shipment_date\": \"2020-01-01\", \"dangerous_good\": true, \"declared_value\": 150.00, \"email_notification\": true, \"email_notification_to\": [email protected], \"signature_confirmation\": true, } ``` Please check the docs for carrier specific options. </details> | [optional] | ||
| **reference** | **str, none_type** | The shipment reference | [optional] | ||
| **carrier_ids** | **[str], none_type** | The list of configured carriers you wish to get rates from. | [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] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -22,7 +22,7 @@ Name | Type | Description | Notes | |
| **tracking_url** | **str, none_type** | The shipment tracking url | [optional] | ||
| **service** | **str, none_type** | The selected service | [optional] | ||
| **services** | **[str], none_type** | The carriers services requested for the shipment. Please consult [the reference](#operation/references) for specific carriers services.<br/> Note that this is a list because on a Multi-carrier rate request you could specify a service per carrier. | [optional] | ||
| **options** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | The options available for the shipment.<br/> Please consult [the reference](#operation/references) for additional specific carriers options. | [optional] | ||
| **options** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | <details> <summary>The options available for the shipment.</summary> ``` { \"currency\": \"USD\", \"insurance\": 100.00, \"cash_on_delivery\": 30.00, \"shipment_date\": \"2020-01-01\", \"dangerous_good\": true, \"declared_value\": 150.00, \"email_notification\": true, \"email_notification_to\": [email protected], \"signature_confirmation\": true, } ``` Please check the docs for carrier specific options. </details> | [optional] | ||
| **payment** | [**Payment**](Payment.md) | | [optional] | ||
| **customs** | [**Customs**](Customs.md) | | [optional] | ||
| **reference** | **str, none_type** | The shipment reference | [optional] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes | |
| **shipper** | [**AddressData**](AddressData.md) | | | ||
| **recipient** | [**AddressData**](AddressData.md) | | | ||
| **parcels** | [**[ParcelData]**](ParcelData.md) | The shipment's parcels | | ||
| **options** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | The options available for the shipment.<br/> Please consult [the reference](#operation/references) for additional specific carriers options. | [optional] | ||
| **options** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | <details> <summary>The options available for the shipment.</summary> ``` { \"currency\": \"USD\", \"insurance\": 100.00, \"cash_on_delivery\": 30.00, \"shipment_date\": \"2020-01-01\", \"dangerous_good\": true, \"declared_value\": 150.00, \"email_notification\": true, \"email_notification_to\": [email protected], \"signature_confirmation\": true, } ``` Please check the docs for carrier specific options. </details> | [optional] | ||
| **payment** | [**Payment**](Payment.md) | | [optional] | ||
| **customs** | [**CustomsData**](CustomsData.md) | | [optional] | ||
| **reference** | **str, none_type** | The shipment reference | [optional] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ Name | Type | Description | Notes | |
| **payment** | [**Payment**](Payment.md) | | | ||
| **selected_rate_id** | **str** | The shipment selected rate. | | ||
| **rates** | [**[Rate]**](Rate.md) | The list for shipment rates fetched previously | | ||
| **options** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | The options available for the shipment.<br/> Please consult [the reference](#operation/references) for additional specific carriers options. | [optional] | ||
| **options** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | <details> <summary>The options available for the shipment.</summary> ``` { \"currency\": \"USD\", \"insurance\": 100.00, \"cash_on_delivery\": 30.00, \"shipment_date\": \"2020-01-01\", \"dangerous_good\": true, \"declared_value\": 150.00, \"email_notification\": true, \"email_notification_to\": [email protected], \"signature_confirmation\": true, } ``` Please check the docs for carrier specific options. </details> | [optional] | ||
| **customs** | [**CustomsData**](CustomsData.md) | | [optional] | ||
| **reference** | **str, none_type** | The shipment reference | [optional] | ||
| **label_type** | **str** | The shipment label file type. | [optional] if omitted the server will use the default value of "PDF" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ | |
| """ | ||
| Purplship API | ||
| The version of the OpenAPI document: 2021.10 | ||
| The version of the OpenAPI document: 2021.11 | ||
| Contact: [email protected] | ||
| Generated by: https://openapi-generator.tech | ||
| """ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| """ | ||
| Purplship API | ||
| ## API Reference Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Purplship API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Purplship API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2021.10`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Purplship utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"next\": \"/v1/shipments?limit=25&offset=25\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ ] } ``` ## Environments The Purplship API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. # noqa: E501 | ||
| ## API Reference Purplship is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Purplship API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Purplship API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2021.11`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Purplship utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"next\": \"/v1/shipments?limit=25&offset=25\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ ] } ``` ## Environments The Purplship API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. # noqa: E501 | ||
| The version of the OpenAPI document: 2021.10 | ||
| The version of the OpenAPI document: 2021.11 | ||
| Contact: [email protected] | ||
| Generated by: https://openapi-generator.tech | ||
| """ | ||
|
|
||
Oops, something went wrong.