From f53a0a9c4017bc68bf7949e47848cb36426f0003 Mon Sep 17 00:00:00 2001 From: Randall Keur Date: Thu, 31 Oct 2024 16:09:21 -0400 Subject: [PATCH 1/8] clean up on: portion to remove workflow call and re-organize pull_requests section --- .github/workflows/sdk_validation.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/sdk_validation.yaml b/.github/workflows/sdk_validation.yaml index 5053af38..433a3143 100644 --- a/.github/workflows/sdk_validation.yaml +++ b/.github/workflows/sdk_validation.yaml @@ -1,9 +1,13 @@ name: Validate on: - workflow_call: pull_request: - types: [ opened, reopened, synchronize ] + branches: + - main + types: + - opened + - reopened + - synchronize jobs: check: From 28f9cff7097700cbd5f1641f819f4dcf8fe67337 Mon Sep 17 00:00:00 2001 From: Randall Keur Date: Thu, 7 Nov 2024 19:37:25 -0500 Subject: [PATCH 2/8] update tests to verify passing order object id works with updated api spec --- tests/helpers_custom.py | 10 ++++++++-- tests/test_instalabel.py | 7 ++++--- tests/test_purchase_label.py | 6 +++--- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/tests/helpers_custom.py b/tests/helpers_custom.py index 86501b55..55707c56 100644 --- a/tests/helpers_custom.py +++ b/tests/helpers_custom.py @@ -1,7 +1,8 @@ +import string from typing import List -from shippo.models.components import CarriersEnum, CarrierAccount -from shippo.models.operations import ListCarrierAccountsRequest +from shippo.models.components import CarriersEnum, CarrierAccount, Order +from shippo.models.operations import ListCarrierAccountsRequest, ListOrdersRequest import shippo @@ -15,3 +16,8 @@ def get_carrier_accounts(api: shippo.Shippo, carrier: CarriersEnum) -> List[Carr carrier=carrier )) return carrier_accounts.results + + +def get_order_object_id(api: shippo.Shippo) -> string: + orders = api.orders.list(request=ListOrdersRequest()) + return orders.results[0].object_id diff --git a/tests/test_instalabel.py b/tests/test_instalabel.py index 8068ce6e..1255ada7 100644 --- a/tests/test_instalabel.py +++ b/tests/test_instalabel.py @@ -2,7 +2,7 @@ from shippo.models.components import CarriersEnum, DistanceUnitEnum, WeightUnitEnum, \ AddressCreateRequest, ParcelCreateRequest, ShipmentCreateRequest, \ InstantTransactionCreateRequest, Transaction -from tests.helpers_custom import get_carrier_account +from tests.helpers_custom import get_carrier_account, get_order_object_id # https://docs.goshippo.com/docs/guides_general/single_call/ @@ -46,8 +46,9 @@ def test_instalabel(self, api: shippo.Shippo): mass_unit=WeightUnitEnum.LB ) ] - ) - )) + ), + order=get_order_object_id(api)), + ) assert transaction is not None assert isinstance(transaction, Transaction) assert transaction.rate.object_id is not None diff --git a/tests/test_purchase_label.py b/tests/test_purchase_label.py index a1c4425f..7ce76b82 100644 --- a/tests/test_purchase_label.py +++ b/tests/test_purchase_label.py @@ -1,7 +1,7 @@ import shippo from shippo.models.components import CarriersEnum, DistanceUnitEnum, WeightUnitEnum, \ AddressCreateRequest, ShipmentCreateRequest, TransactionCreateRequest, ParcelCreateRequest, Transaction -from tests.helpers_custom import get_carrier_accounts +from tests.helpers_custom import get_carrier_accounts, get_order_object_id # https://docs.goshippo.com/docs/stories/single_rating_guide/ @@ -48,7 +48,7 @@ def test_purchase_label(self, api: shippo.Shippo): assert shipment is not None transaction = api.transactions.create( - TransactionCreateRequest(rate=shipment.rates[0].object_id) + TransactionCreateRequest(rate=shipment.rates[0].object_id, order=get_order_object_id(api)) ) assert transaction is not None @@ -101,7 +101,7 @@ def test_purchase_label_using_reference_ids(self, api: shippo.Shippo): assert shipment.address_return.object_id == address_from.object_id transaction = api.transactions.create( - TransactionCreateRequest(rate=shipment.rates[0].object_id) + TransactionCreateRequest(rate=shipment.rates[0].object_id, order=get_order_object_id(api)) ) assert transaction is not None assert isinstance(transaction, Transaction) From 7f715b0f746b665fcb727b6c8901cb846e4adf6b Mon Sep 17 00:00:00 2001 From: Randall Keur Date: Thu, 7 Nov 2024 19:40:41 -0500 Subject: [PATCH 3/8] speakeasy generate based upon updated public api spec, re-ran tests verifying behavior works --- .speakeasy/gen.lock | 27 ++++++++----- .speakeasy/gen.yaml | 3 +- .../instanttransactioncreaterequest.md | 3 +- .../components/transactioncreaterequest.md | 3 +- docs/models/internal/globals.md | 6 +-- .../operations/addshipmentstobatchglobals.md | 6 +-- .../models/operations/createaddressglobals.md | 6 +-- docs/models/operations/createbatchglobals.md | 6 +-- .../operations/createcarrieraccountglobals.md | 6 +-- .../createcustomsdeclarationglobals.md | 6 +-- .../operations/createcustomsitemglobals.md | 6 +-- .../operations/createliverateglobals.md | 6 +-- .../operations/createmanifestglobals.md | 6 +-- docs/models/operations/createorderglobals.md | 6 +-- docs/models/operations/createparcelglobals.md | 6 +-- docs/models/operations/createpickupglobals.md | 6 +-- docs/models/operations/createrefundglobals.md | 6 +-- .../operations/createservicegroupglobals.md | 6 +-- .../operations/createshipmentglobals.md | 6 +-- .../operations/createshippoaccountglobals.md | 6 +-- docs/models/operations/createtrackglobals.md | 6 +-- .../operations/createtransactionglobals.md | 6 +-- .../createuserparceltemplateglobals.md | 6 +-- .../deletedefaultparceltemplateglobals.md | 6 +-- .../operations/deleteservicegroupglobals.md | 6 +-- .../deleteuserparceltemplateglobals.md | 6 +-- docs/models/operations/getaddressglobals.md | 6 +-- docs/models/operations/getbatchglobals.md | 6 +-- .../operations/getcarrieraccountglobals.md | 6 +-- .../getcarrierparceltemplateglobals.md | 6 +-- .../getcarrierregistrationstatusglobals.md | 6 +-- .../getcustomsdeclarationglobals.md | 6 +-- .../operations/getcustomsitemglobals.md | 6 +-- .../getdefaultparceltemplateglobals.md | 6 +-- docs/models/operations/getmanifestglobals.md | 6 +-- docs/models/operations/getorderglobals.md | 6 +-- docs/models/operations/getparcelglobals.md | 6 +-- docs/models/operations/getrateglobals.md | 6 +-- docs/models/operations/getrefundglobals.md | 6 +-- docs/models/operations/getshipmentglobals.md | 6 +-- .../operations/getshippoaccountglobals.md | 6 +-- docs/models/operations/gettrackglobals.md | 6 +-- .../operations/gettransactionglobals.md | 6 +-- .../getuserparceltemplateglobals.md | 6 +-- .../operations/initiateoauth2signinglobals.md | 6 +-- .../models/operations/listaddressesglobals.md | 6 +-- .../operations/listcarrieraccountsglobals.md | 6 +-- .../listcarrierparceltemplatesglobals.md | 6 +-- .../listcustomsdeclarationsglobals.md | 6 +-- .../operations/listcustomsitemsglobals.md | 6 +-- .../models/operations/listmanifestsglobals.md | 6 +-- docs/models/operations/listordersglobals.md | 6 +-- docs/models/operations/listparcelsglobals.md | 6 +-- docs/models/operations/listrefundsglobals.md | 6 +-- .../operations/listservicegroupsglobals.md | 6 +-- .../listshipmentratesbycurrencycodeglobals.md | 6 +-- .../operations/listshipmentratesglobals.md | 6 +-- .../models/operations/listshipmentsglobals.md | 6 +-- .../operations/listshippoaccountsglobals.md | 6 +-- .../operations/listtransactionsglobals.md | 6 +-- .../listuserparceltemplatesglobals.md | 6 +-- .../models/operations/purchasebatchglobals.md | 6 +-- .../registercarrieraccountglobals.md | 6 +-- .../removeshipmentsfrombatchglobals.md | 6 +-- .../operations/updatecarrieraccountglobals.md | 6 +-- .../updatedefaultparceltemplateglobals.md | 6 +-- .../operations/updateservicegroupglobals.md | 6 +-- .../operations/updateshippoaccountglobals.md | 6 +-- .../updateuserparceltemplateglobals.md | 6 +-- .../operations/validateaddressglobals.md | 6 +-- docs/sdks/addresses/README.md | 19 ++++------ docs/sdks/batches/README.md | 32 +++++++--------- docs/sdks/carrieraccounts/README.md | 38 ++++++++----------- docs/sdks/carrierparceltemplates/README.md | 9 ++--- docs/sdks/customsdeclarations/README.md | 14 +++---- docs/sdks/customsitems/README.md | 14 +++---- docs/sdks/manifests/README.md | 14 +++---- docs/sdks/orders/README.md | 14 +++---- docs/sdks/parcels/README.md | 14 +++---- docs/sdks/pickups/README.md | 4 +- docs/sdks/rates/README.md | 14 +++---- docs/sdks/ratesatcheckout/README.md | 19 ++++------ docs/sdks/refunds/README.md | 14 +++---- docs/sdks/servicegroups/README.md | 19 ++++------ docs/sdks/shipments/README.md | 14 +++---- docs/sdks/shippoaccounts/README.md | 29 +++++++------- docs/sdks/trackingstatus/README.md | 9 ++--- docs/sdks/transactions/README.md | 15 ++++---- docs/sdks/userparceltemplates/README.md | 24 +++++------- docs/sdks/webhooks/README.md | 28 ++++++-------- pylintrc | 2 +- setup.py | 2 +- .../instanttransactioncreaterequest.py | 1 + .../components/transactioncreaterequest.py | 1 + src/shippo/models/internal/globals.py | 2 +- .../models/operations/addshipmentstobatch.py | 2 +- src/shippo/models/operations/createaddress.py | 2 +- src/shippo/models/operations/createbatch.py | 2 +- .../models/operations/createcarrieraccount.py | 2 +- .../operations/createcustomsdeclaration.py | 2 +- .../models/operations/createcustomsitem.py | 2 +- .../models/operations/createliverate.py | 2 +- .../models/operations/createmanifest.py | 2 +- src/shippo/models/operations/createorder.py | 2 +- src/shippo/models/operations/createparcel.py | 2 +- src/shippo/models/operations/createpickup.py | 2 +- src/shippo/models/operations/createrefund.py | 2 +- .../models/operations/createservicegroup.py | 2 +- .../models/operations/createshipment.py | 2 +- .../models/operations/createshippoaccount.py | 2 +- src/shippo/models/operations/createtrack.py | 2 +- .../models/operations/createtransaction.py | 2 +- .../operations/createuserparceltemplate.py | 2 +- .../operations/deletedefaultparceltemplate.py | 2 +- .../models/operations/deleteservicegroup.py | 2 +- .../operations/deleteuserparceltemplate.py | 2 +- src/shippo/models/operations/getaddress.py | 2 +- src/shippo/models/operations/getbatch.py | 2 +- .../models/operations/getcarrieraccount.py | 2 +- .../operations/getcarrierparceltemplate.py | 2 +- .../getcarrierregistrationstatus.py | 2 +- .../operations/getcustomsdeclaration.py | 2 +- .../models/operations/getcustomsitem.py | 2 +- .../operations/getdefaultparceltemplate.py | 2 +- src/shippo/models/operations/getmanifest.py | 2 +- src/shippo/models/operations/getorder.py | 2 +- src/shippo/models/operations/getparcel.py | 2 +- src/shippo/models/operations/getrate.py | 2 +- src/shippo/models/operations/getrefund.py | 2 +- src/shippo/models/operations/getshipment.py | 2 +- .../models/operations/getshippoaccount.py | 2 +- src/shippo/models/operations/gettrack.py | 2 +- .../models/operations/gettransaction.py | 2 +- .../operations/getuserparceltemplate.py | 2 +- .../models/operations/initiateoauth2signin.py | 2 +- src/shippo/models/operations/listaddresses.py | 2 +- .../models/operations/listcarrieraccounts.py | 2 +- .../operations/listcarrierparceltemplates.py | 2 +- .../operations/listcustomsdeclarations.py | 2 +- .../models/operations/listcustomsitems.py | 2 +- src/shippo/models/operations/listmanifests.py | 2 +- src/shippo/models/operations/listorders.py | 2 +- src/shippo/models/operations/listparcels.py | 2 +- src/shippo/models/operations/listrefunds.py | 2 +- .../models/operations/listservicegroups.py | 2 +- .../models/operations/listshipmentrates.py | 2 +- .../listshipmentratesbycurrencycode.py | 2 +- src/shippo/models/operations/listshipments.py | 2 +- .../models/operations/listshippoaccounts.py | 2 +- .../models/operations/listtransactions.py | 2 +- .../operations/listuserparceltemplates.py | 2 +- src/shippo/models/operations/purchasebatch.py | 2 +- .../operations/registercarrieraccount.py | 2 +- .../operations/removeshipmentsfrombatch.py | 2 +- .../models/operations/updatecarrieraccount.py | 2 +- .../operations/updatedefaultparceltemplate.py | 2 +- .../models/operations/updateservicegroup.py | 2 +- .../models/operations/updateshippoaccount.py | 2 +- .../operations/updateuserparceltemplate.py | 2 +- .../models/operations/validateaddress.py | 2 +- src/shippo/sdk.py | 2 +- src/shippo/sdkconfiguration.py | 6 +-- src/shippo/shippo_accounts.py | 10 ++--- 163 files changed, 455 insertions(+), 490 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index fe1dcfcb..98670348 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 986026b6-d725-4b86-9c4d-67f6e6904a30 management: - docChecksum: 2edac3552b0c3728ec7bf25184e0a6c1 + docChecksum: 42b42bf2fe502c9e9e2415f189917846 docVersion: "2018-02-08" - speakeasyVersion: 1.401.2 - generationVersion: 2.421.3 - releaseVersion: 3.7.1 - configChecksum: 749a4f6a4afb8aae74a7ccadfe5aabb1 + speakeasyVersion: 1.434.2 + generationVersion: 2.452.0 + releaseVersion: 3.8.0 + configChecksum: 55c3f4fd3a9b85e1e763424de3c5b972 repoURL: https://github.com/goshippo/shippo-python-sdk.git installationURL: https://github.com/goshippo/shippo-python-sdk.git published: true @@ -14,7 +14,7 @@ features: python: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.4 - core: 4.8.10 + core: 4.8.15 flattening: 2.81.1 globalSecurity: 2.83.7 globalSecurityCallbacks: 0.1.0 @@ -27,7 +27,8 @@ features: nullables: 0.1.0 responseFormat: 0.1.0 sdkHooks: 0.1.0 - unions: 2.82.9 + tests: 0.4.0 + unions: 2.82.10 webhooks: 1.0.0 generatedFiles: - .gitattributes @@ -748,6 +749,7 @@ examples: ListAddresses: speakeasy-default-list-addresses: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -840,6 +842,7 @@ examples: ListCarrierAccounts: speakeasy-default-list-carrier-accounts: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -899,7 +902,7 @@ examples: header: SHIPPO-API-VERSION: "2018-02-08" requestBody: - application/json: {"carrier": "correos"} + application/json: {"carrier": "ups", "parameters": {"billing_address_city": "San Francisco", "billing_address_country_iso2": "US", "billing_address_state": "CA", "billing_address_street1": "731 Market St", "billing_address_street2": "STE 200", "billing_address_zip": "94103", "company": "Shippo", "email": "hippo@shippo.com", "full_name": "Shippo Meister", "phone": "1112223333", "pickup_address_city": "San Francisco", "pickup_address_country_iso2": "US", "pickup_address_same_as_billing_address": false, "pickup_address_state": "CA", "pickup_address_street1": "731 Market St", "pickup_address_street2": "STE 200", "pickup_address_zip": "94103", "ups_agreements": true}} responses: "201": application/json: {"account_id": "****", "carrier": "usps", "parameters": {"first_name": "Marlene", "last_name": "Kilback", "phone_number": "(569) 519-5316", "from_address_st": "", "from_address_city": "", "from_address_state": "", "from_address_zip": "", "from_address_country_iso2": ""}, "carrier_name": "USPS", "is_shippo_account": false, "object_id": "6aa34d5f6865448fbb1ee93636e98999", "object_owner": "bob+22@gmail.com", "service_levels": [{"name": "Priority Mail Express", "token": "usps_priority_express", "supports_return_labels": true}], "test": false} @@ -916,6 +919,7 @@ examples: ListCustomsDeclarations: speakeasy-default-list-customs-declarations: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -945,6 +949,7 @@ examples: ListCustomsItems: speakeasy-default-list-customs-items: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1007,6 +1012,7 @@ examples: ListManifests: speakeasy-default-list-manifests: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1086,6 +1092,7 @@ examples: ListParcels: speakeasy-default-list-parcels: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1220,6 +1227,7 @@ examples: ListShipments: speakeasy-default-list-shipments: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1283,7 +1291,7 @@ examples: header: SHIPPO-API-VERSION: "2018-02-08" requestBody: - application/json: {"async": false, "label_file_type": "PDF_4x6", "metadata": "Order ID #12345", "rate": "ec9f0d3adc9441449c85d315f0997fd5"} + application/json: {"async": false, "label_file_type": "PDF_4x6", "metadata": "Order ID #12345", "rate": "ec9f0d3adc9441449c85d315f0997fd5", "order": "adcfdddf8ec64b84ad22772bce3ea37a"} responses: "201": application/json: {"created_by": {"first_name": "Shwan", "last_name": "Ippotle", "username": "shippotle@shippo.com"}, "label_file_type": "PDF_4x6", "label_url": "https://shippo-delivery.s3.amazonaws.com/70ae8117ee1749e393f249d5b77c45e0.pdf?Signature=vDw1ltcyGveVR1OQoUDdzC43BY8%3D&Expires=1437093830&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA", "messages": [{"source": "UPS", "code": "carrier_timeout", "text": "UPS API did not respond. Please try again in a few minutes."}, {"source": "UPS", "code": "carrier_timeout", "text": "UPS API did not respond. Please try again in a few minutes."}], "object_id": "915d94940ea54c3a80cbfa328722f5a1", "object_owner": "shippotle@shippo.com", "parcel": "e94c7fdfdc7b495dbb390a28d929d90a", "qr_code_url": "https://shippo-delivery.s3.amazonaws.com/96_qr_code.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA", "rate": {"amount": "5.5", "amount_local": "5.5", "currency": "USD", "currency_local": "USD", "object_id": "adcfdddf8ec64b84ad22772bce3ea37a", "provider": "USPS", "carrier_account": "078870331023437cb917f5187429b093", "servicelevel_name": "Priority Mail", "servicelevel_token": "fedex_ground"}, "status": "SUCCESS", "tracking_number": "9499907123456123456781", "tracking_status": "DELIVERED", "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9499907123456123456781"} @@ -1347,6 +1355,7 @@ examples: ListShippoAccounts: speakeasy-default-list-shippo-accounts: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 59e1eeb6..d4ad0d26 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -11,8 +11,9 @@ generation: requestResponseComponentNamesFeb2024: true auth: oAuth2ClientCredentialsEnabled: true + oAuth2PasswordEnabled: false python: - version: 3.7.1 + version: 3.8.0 additionalDependencies: dependencies: {} extraDependencies: diff --git a/docs/models/components/instanttransactioncreaterequest.md b/docs/models/components/instanttransactioncreaterequest.md index 49848ceb..56e19657 100644 --- a/docs/models/components/instanttransactioncreaterequest.md +++ b/docs/models/components/instanttransactioncreaterequest.md @@ -10,4 +10,5 @@ | `shipment` | [components.ShipmentCreateRequest](../../models/components/shipmentcreaterequest.md) | :heavy_check_mark: | N/A | | | `async_` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `label_file_type` | [Optional[components.LabelFileType]](../../models/components/labelfiletype.md) | :heavy_minus_sign: | N/A | PDF | -| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | Order ID #12345 | \ No newline at end of file +| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | Order ID #12345 | +| `order` | *Optional[str]* | :heavy_minus_sign: | N/A | adcfdddf8ec64b84ad22772bce3ea37a | \ No newline at end of file diff --git a/docs/models/components/transactioncreaterequest.md b/docs/models/components/transactioncreaterequest.md index 1bb83db7..c692a868 100644 --- a/docs/models/components/transactioncreaterequest.md +++ b/docs/models/components/transactioncreaterequest.md @@ -8,4 +8,5 @@ | `rate` | *str* | :heavy_check_mark: | N/A | ec9f0d3adc9441449c85d315f0997fd5 | | `async_` | *Optional[bool]* | :heavy_minus_sign: | N/A | false | | `label_file_type` | [Optional[components.LabelFileTypeEnum]](../../models/components/labelfiletypeenum.md) | :heavy_minus_sign: | Print format of the label. If empty, will use the default format set from
the Shippo dashboard. | PDF_4x6 | -| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | Order ID #12345 | \ No newline at end of file +| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | Order ID #12345 | +| `order` | *Optional[str]* | :heavy_minus_sign: | N/A | adcfdddf8ec64b84ad22772bce3ea37a | \ No newline at end of file diff --git a/docs/models/internal/globals.md b/docs/models/internal/globals.md index 73b89f5d..d9886574 100644 --- a/docs/models/internal/globals.md +++ b/docs/models/internal/globals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/addshipmentstobatchglobals.md b/docs/models/operations/addshipmentstobatchglobals.md index 554d3b3c..716b4714 100644 --- a/docs/models/operations/addshipmentstobatchglobals.md +++ b/docs/models/operations/addshipmentstobatchglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createaddressglobals.md b/docs/models/operations/createaddressglobals.md index ec7e643b..6f219653 100644 --- a/docs/models/operations/createaddressglobals.md +++ b/docs/models/operations/createaddressglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createbatchglobals.md b/docs/models/operations/createbatchglobals.md index c723b5aa..1f9d5b41 100644 --- a/docs/models/operations/createbatchglobals.md +++ b/docs/models/operations/createbatchglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createcarrieraccountglobals.md b/docs/models/operations/createcarrieraccountglobals.md index 0af9be6c..6a184378 100644 --- a/docs/models/operations/createcarrieraccountglobals.md +++ b/docs/models/operations/createcarrieraccountglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createcustomsdeclarationglobals.md b/docs/models/operations/createcustomsdeclarationglobals.md index cde958d0..c553e295 100644 --- a/docs/models/operations/createcustomsdeclarationglobals.md +++ b/docs/models/operations/createcustomsdeclarationglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createcustomsitemglobals.md b/docs/models/operations/createcustomsitemglobals.md index 60328c10..a57ecac0 100644 --- a/docs/models/operations/createcustomsitemglobals.md +++ b/docs/models/operations/createcustomsitemglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createliverateglobals.md b/docs/models/operations/createliverateglobals.md index 49dc7aa4..6e05940c 100644 --- a/docs/models/operations/createliverateglobals.md +++ b/docs/models/operations/createliverateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createmanifestglobals.md b/docs/models/operations/createmanifestglobals.md index 4255313c..dd896e00 100644 --- a/docs/models/operations/createmanifestglobals.md +++ b/docs/models/operations/createmanifestglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createorderglobals.md b/docs/models/operations/createorderglobals.md index 75359363..8073d558 100644 --- a/docs/models/operations/createorderglobals.md +++ b/docs/models/operations/createorderglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createparcelglobals.md b/docs/models/operations/createparcelglobals.md index ef7349b5..9a2f6d79 100644 --- a/docs/models/operations/createparcelglobals.md +++ b/docs/models/operations/createparcelglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createpickupglobals.md b/docs/models/operations/createpickupglobals.md index 2b7ffef2..a787299d 100644 --- a/docs/models/operations/createpickupglobals.md +++ b/docs/models/operations/createpickupglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createrefundglobals.md b/docs/models/operations/createrefundglobals.md index f4063e44..e6696f19 100644 --- a/docs/models/operations/createrefundglobals.md +++ b/docs/models/operations/createrefundglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createservicegroupglobals.md b/docs/models/operations/createservicegroupglobals.md index 8b083362..769933c9 100644 --- a/docs/models/operations/createservicegroupglobals.md +++ b/docs/models/operations/createservicegroupglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createshipmentglobals.md b/docs/models/operations/createshipmentglobals.md index d5051b04..ac929f5a 100644 --- a/docs/models/operations/createshipmentglobals.md +++ b/docs/models/operations/createshipmentglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createshippoaccountglobals.md b/docs/models/operations/createshippoaccountglobals.md index 932e9146..09990bb6 100644 --- a/docs/models/operations/createshippoaccountglobals.md +++ b/docs/models/operations/createshippoaccountglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createtrackglobals.md b/docs/models/operations/createtrackglobals.md index bc8b4db9..a0c92a2d 100644 --- a/docs/models/operations/createtrackglobals.md +++ b/docs/models/operations/createtrackglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createtransactionglobals.md b/docs/models/operations/createtransactionglobals.md index d8c90c73..9fa94631 100644 --- a/docs/models/operations/createtransactionglobals.md +++ b/docs/models/operations/createtransactionglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/createuserparceltemplateglobals.md b/docs/models/operations/createuserparceltemplateglobals.md index 99dd248c..8aec1dfd 100644 --- a/docs/models/operations/createuserparceltemplateglobals.md +++ b/docs/models/operations/createuserparceltemplateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/deletedefaultparceltemplateglobals.md b/docs/models/operations/deletedefaultparceltemplateglobals.md index 679d9119..ce917f8d 100644 --- a/docs/models/operations/deletedefaultparceltemplateglobals.md +++ b/docs/models/operations/deletedefaultparceltemplateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/deleteservicegroupglobals.md b/docs/models/operations/deleteservicegroupglobals.md index 98c8e236..0838045d 100644 --- a/docs/models/operations/deleteservicegroupglobals.md +++ b/docs/models/operations/deleteservicegroupglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/deleteuserparceltemplateglobals.md b/docs/models/operations/deleteuserparceltemplateglobals.md index 492523fb..7ea46ad4 100644 --- a/docs/models/operations/deleteuserparceltemplateglobals.md +++ b/docs/models/operations/deleteuserparceltemplateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getaddressglobals.md b/docs/models/operations/getaddressglobals.md index c4d5bf5f..386979a0 100644 --- a/docs/models/operations/getaddressglobals.md +++ b/docs/models/operations/getaddressglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getbatchglobals.md b/docs/models/operations/getbatchglobals.md index e189eb8d..2fd1921f 100644 --- a/docs/models/operations/getbatchglobals.md +++ b/docs/models/operations/getbatchglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getcarrieraccountglobals.md b/docs/models/operations/getcarrieraccountglobals.md index 3d3f2416..30c68536 100644 --- a/docs/models/operations/getcarrieraccountglobals.md +++ b/docs/models/operations/getcarrieraccountglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getcarrierparceltemplateglobals.md b/docs/models/operations/getcarrierparceltemplateglobals.md index 2ab2ff71..91c43622 100644 --- a/docs/models/operations/getcarrierparceltemplateglobals.md +++ b/docs/models/operations/getcarrierparceltemplateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getcarrierregistrationstatusglobals.md b/docs/models/operations/getcarrierregistrationstatusglobals.md index 8950293b..1593e20d 100644 --- a/docs/models/operations/getcarrierregistrationstatusglobals.md +++ b/docs/models/operations/getcarrierregistrationstatusglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getcustomsdeclarationglobals.md b/docs/models/operations/getcustomsdeclarationglobals.md index 9b6e9e1f..f50fbdd3 100644 --- a/docs/models/operations/getcustomsdeclarationglobals.md +++ b/docs/models/operations/getcustomsdeclarationglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getcustomsitemglobals.md b/docs/models/operations/getcustomsitemglobals.md index a370da9f..f4251186 100644 --- a/docs/models/operations/getcustomsitemglobals.md +++ b/docs/models/operations/getcustomsitemglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getdefaultparceltemplateglobals.md b/docs/models/operations/getdefaultparceltemplateglobals.md index 32db084c..104c8fae 100644 --- a/docs/models/operations/getdefaultparceltemplateglobals.md +++ b/docs/models/operations/getdefaultparceltemplateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getmanifestglobals.md b/docs/models/operations/getmanifestglobals.md index f9060c0d..ba2810f4 100644 --- a/docs/models/operations/getmanifestglobals.md +++ b/docs/models/operations/getmanifestglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getorderglobals.md b/docs/models/operations/getorderglobals.md index 9e9bcddb..61b06d74 100644 --- a/docs/models/operations/getorderglobals.md +++ b/docs/models/operations/getorderglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getparcelglobals.md b/docs/models/operations/getparcelglobals.md index e6aa36bd..0e29f5f5 100644 --- a/docs/models/operations/getparcelglobals.md +++ b/docs/models/operations/getparcelglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getrateglobals.md b/docs/models/operations/getrateglobals.md index 23e2813f..bfb1a13b 100644 --- a/docs/models/operations/getrateglobals.md +++ b/docs/models/operations/getrateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getrefundglobals.md b/docs/models/operations/getrefundglobals.md index f9a5b7a2..b1f2afe6 100644 --- a/docs/models/operations/getrefundglobals.md +++ b/docs/models/operations/getrefundglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getshipmentglobals.md b/docs/models/operations/getshipmentglobals.md index 733aa1f9..b3b9937a 100644 --- a/docs/models/operations/getshipmentglobals.md +++ b/docs/models/operations/getshipmentglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getshippoaccountglobals.md b/docs/models/operations/getshippoaccountglobals.md index 09f5c0b8..d591ffaa 100644 --- a/docs/models/operations/getshippoaccountglobals.md +++ b/docs/models/operations/getshippoaccountglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/gettrackglobals.md b/docs/models/operations/gettrackglobals.md index b1547750..ac866aca 100644 --- a/docs/models/operations/gettrackglobals.md +++ b/docs/models/operations/gettrackglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/gettransactionglobals.md b/docs/models/operations/gettransactionglobals.md index 324c727f..d138a4ea 100644 --- a/docs/models/operations/gettransactionglobals.md +++ b/docs/models/operations/gettransactionglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/getuserparceltemplateglobals.md b/docs/models/operations/getuserparceltemplateglobals.md index 9fe866eb..3c0b515d 100644 --- a/docs/models/operations/getuserparceltemplateglobals.md +++ b/docs/models/operations/getuserparceltemplateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/initiateoauth2signinglobals.md b/docs/models/operations/initiateoauth2signinglobals.md index 6412f4b4..d5818775 100644 --- a/docs/models/operations/initiateoauth2signinglobals.md +++ b/docs/models/operations/initiateoauth2signinglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listaddressesglobals.md b/docs/models/operations/listaddressesglobals.md index 373cc8e7..40d7dfae 100644 --- a/docs/models/operations/listaddressesglobals.md +++ b/docs/models/operations/listaddressesglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listcarrieraccountsglobals.md b/docs/models/operations/listcarrieraccountsglobals.md index 8209d797..71e58a3f 100644 --- a/docs/models/operations/listcarrieraccountsglobals.md +++ b/docs/models/operations/listcarrieraccountsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listcarrierparceltemplatesglobals.md b/docs/models/operations/listcarrierparceltemplatesglobals.md index f2cc1d01..ab5d1e15 100644 --- a/docs/models/operations/listcarrierparceltemplatesglobals.md +++ b/docs/models/operations/listcarrierparceltemplatesglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listcustomsdeclarationsglobals.md b/docs/models/operations/listcustomsdeclarationsglobals.md index 3c2a7972..0b8b57d1 100644 --- a/docs/models/operations/listcustomsdeclarationsglobals.md +++ b/docs/models/operations/listcustomsdeclarationsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listcustomsitemsglobals.md b/docs/models/operations/listcustomsitemsglobals.md index 7ea7c698..77bdb83b 100644 --- a/docs/models/operations/listcustomsitemsglobals.md +++ b/docs/models/operations/listcustomsitemsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listmanifestsglobals.md b/docs/models/operations/listmanifestsglobals.md index e71652ca..b150485e 100644 --- a/docs/models/operations/listmanifestsglobals.md +++ b/docs/models/operations/listmanifestsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listordersglobals.md b/docs/models/operations/listordersglobals.md index a01e3cf3..b8f4b5cc 100644 --- a/docs/models/operations/listordersglobals.md +++ b/docs/models/operations/listordersglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listparcelsglobals.md b/docs/models/operations/listparcelsglobals.md index 3651df14..46e0e11f 100644 --- a/docs/models/operations/listparcelsglobals.md +++ b/docs/models/operations/listparcelsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listrefundsglobals.md b/docs/models/operations/listrefundsglobals.md index 9af4f750..21ff3f3b 100644 --- a/docs/models/operations/listrefundsglobals.md +++ b/docs/models/operations/listrefundsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listservicegroupsglobals.md b/docs/models/operations/listservicegroupsglobals.md index 66158181..3f76a78f 100644 --- a/docs/models/operations/listservicegroupsglobals.md +++ b/docs/models/operations/listservicegroupsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listshipmentratesbycurrencycodeglobals.md b/docs/models/operations/listshipmentratesbycurrencycodeglobals.md index c87a0f46..5184b8cb 100644 --- a/docs/models/operations/listshipmentratesbycurrencycodeglobals.md +++ b/docs/models/operations/listshipmentratesbycurrencycodeglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listshipmentratesglobals.md b/docs/models/operations/listshipmentratesglobals.md index 06ce3dfa..cd054cb1 100644 --- a/docs/models/operations/listshipmentratesglobals.md +++ b/docs/models/operations/listshipmentratesglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listshipmentsglobals.md b/docs/models/operations/listshipmentsglobals.md index 925db496..201a32e8 100644 --- a/docs/models/operations/listshipmentsglobals.md +++ b/docs/models/operations/listshipmentsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listshippoaccountsglobals.md b/docs/models/operations/listshippoaccountsglobals.md index 627ed2a3..a8816d03 100644 --- a/docs/models/operations/listshippoaccountsglobals.md +++ b/docs/models/operations/listshippoaccountsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listtransactionsglobals.md b/docs/models/operations/listtransactionsglobals.md index 1e2b3839..3fc9ae8a 100644 --- a/docs/models/operations/listtransactionsglobals.md +++ b/docs/models/operations/listtransactionsglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/listuserparceltemplatesglobals.md b/docs/models/operations/listuserparceltemplatesglobals.md index bafc6f38..0625a671 100644 --- a/docs/models/operations/listuserparceltemplatesglobals.md +++ b/docs/models/operations/listuserparceltemplatesglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/purchasebatchglobals.md b/docs/models/operations/purchasebatchglobals.md index f607e26b..b4414ba1 100644 --- a/docs/models/operations/purchasebatchglobals.md +++ b/docs/models/operations/purchasebatchglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/registercarrieraccountglobals.md b/docs/models/operations/registercarrieraccountglobals.md index 7a72c7b6..93100f3f 100644 --- a/docs/models/operations/registercarrieraccountglobals.md +++ b/docs/models/operations/registercarrieraccountglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/removeshipmentsfrombatchglobals.md b/docs/models/operations/removeshipmentsfrombatchglobals.md index 8c8d77ec..60f199b1 100644 --- a/docs/models/operations/removeshipmentsfrombatchglobals.md +++ b/docs/models/operations/removeshipmentsfrombatchglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/updatecarrieraccountglobals.md b/docs/models/operations/updatecarrieraccountglobals.md index ef30da32..92ae375c 100644 --- a/docs/models/operations/updatecarrieraccountglobals.md +++ b/docs/models/operations/updatecarrieraccountglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/updatedefaultparceltemplateglobals.md b/docs/models/operations/updatedefaultparceltemplateglobals.md index 7acb20dd..f88a60b8 100644 --- a/docs/models/operations/updatedefaultparceltemplateglobals.md +++ b/docs/models/operations/updatedefaultparceltemplateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/updateservicegroupglobals.md b/docs/models/operations/updateservicegroupglobals.md index 386b3746..a416d8aa 100644 --- a/docs/models/operations/updateservicegroupglobals.md +++ b/docs/models/operations/updateservicegroupglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/updateshippoaccountglobals.md b/docs/models/operations/updateshippoaccountglobals.md index 2177db4d..3358b977 100644 --- a/docs/models/operations/updateshippoaccountglobals.md +++ b/docs/models/operations/updateshippoaccountglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/updateuserparceltemplateglobals.md b/docs/models/operations/updateuserparceltemplateglobals.md index 482f52a5..eb01d576 100644 --- a/docs/models/operations/updateuserparceltemplateglobals.md +++ b/docs/models/operations/updateuserparceltemplateglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/models/operations/validateaddressglobals.md b/docs/models/operations/validateaddressglobals.md index d9164b29..d79d74f1 100644 --- a/docs/models/operations/validateaddressglobals.md +++ b/docs/models/operations/validateaddressglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | String used to pick a non-default API version to use | 2018-02-08 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippo_api_version` | *Optional[str]* | :heavy_minus_sign: | Optional string used to pick a non-default API version to use. See our API version guide. | 2018-02-08 | \ No newline at end of file diff --git a/docs/sdks/addresses/README.md b/docs/sdks/addresses/README.md index 459c0cc6..84b9c13f 100644 --- a/docs/sdks/addresses/README.md +++ b/docs/sdks/addresses/README.md @@ -49,10 +49,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -105,10 +104,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -145,10 +143,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## validate @@ -185,6 +182,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/batches/README.md b/docs/sdks/batches/README.md index e8a60935..b145eeb2 100644 --- a/docs/sdks/batches/README.md +++ b/docs/sdks/batches/README.md @@ -361,10 +361,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -404,10 +403,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## add_shipments @@ -425,7 +423,7 @@ s = shippo.Shippo( ) -res = s.batches.add_shipments(batch_id='', request_body=[ +res = s.batches.add_shipments(request_body=[ components.BatchShipmentCreateRequest( shipment=components.ShipmentCreateRequest( address_from=components.AddressCreateRequest( @@ -1074,7 +1072,7 @@ res = s.batches.add_shipments(batch_id='', request_body=[ metadata='SHIPMENT #1', servicelevel_token='fedex_ground', ), -]) +], batch_id='') if res is not None: # handle response @@ -1095,10 +1093,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## purchase @@ -1138,10 +1135,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## remove_shipments @@ -1158,11 +1154,11 @@ s = shippo.Shippo( ) -res = s.batches.remove_shipments(batch_id='', request_body=[ +res = s.batches.remove_shipments(request_body=[ '', '', '', -]) +], batch_id='') if res is not None: # handle response @@ -1183,6 +1179,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/carrieraccounts/README.md b/docs/sdks/carrieraccounts/README.md index 34ebc6b4..665e0795 100644 --- a/docs/sdks/carrieraccounts/README.md +++ b/docs/sdks/carrieraccounts/README.md @@ -57,10 +57,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -113,10 +112,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -153,10 +151,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## update @@ -222,10 +219,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## initiate_oauth2_signin @@ -264,13 +260,12 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | errors.InitiateOauth2SigninResponseBody | 400 | application/json | | errors.InitiateOauth2SigninCarrierAccountsResponseBody | 401 | application/json | | errors.InitiateOauth2SigninCarrierAccountsResponseResponseBody | 404 | application/json | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## register @@ -289,7 +284,7 @@ s = shippo.Shippo( res = s.carrier_accounts.register(request=components.CarrierAccountUPSCreateRequest( - carrier='correos', + carrier='ups', parameters=components.CarrierAccountUPSCreateRequestParameters( billing_address_city='San Francisco', billing_address_country_iso2='US', @@ -301,7 +296,7 @@ res = s.carrier_accounts.register(request=components.CarrierAccountUPSCreateRequ pickup_address_state='CA', pickup_address_street1='731 Market St', pickup_address_zip='94103', - ups_agreements=False, + ups_agreements=True, billing_address_street2='STE 200', company='Shippo', email='hippo@shippo.com', @@ -330,10 +325,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get_registration_status @@ -371,6 +365,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/carrierparceltemplates/README.md b/docs/sdks/carrierparceltemplates/README.md index c0db123c..0c71bad9 100644 --- a/docs/sdks/carrierparceltemplates/README.md +++ b/docs/sdks/carrierparceltemplates/README.md @@ -54,10 +54,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -94,6 +93,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/customsdeclarations/README.md b/docs/sdks/customsdeclarations/README.md index d20ec470..12c38b00 100644 --- a/docs/sdks/customsdeclarations/README.md +++ b/docs/sdks/customsdeclarations/README.md @@ -49,10 +49,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -146,10 +145,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -187,6 +185,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/customsitems/README.md b/docs/sdks/customsitems/README.md index ed291747..8dc4a1a9 100644 --- a/docs/sdks/customsitems/README.md +++ b/docs/sdks/customsitems/README.md @@ -48,10 +48,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -100,10 +99,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -141,6 +139,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/manifests/README.md b/docs/sdks/manifests/README.md index 7fea458a..ef4193e4 100644 --- a/docs/sdks/manifests/README.md +++ b/docs/sdks/manifests/README.md @@ -54,10 +54,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -117,10 +116,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -157,6 +155,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/orders/README.md b/docs/sdks/orders/README.md index b42c3d61..baf9a230 100644 --- a/docs/sdks/orders/README.md +++ b/docs/sdks/orders/README.md @@ -64,10 +64,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -167,10 +166,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -207,6 +205,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/parcels/README.md b/docs/sdks/parcels/README.md index 12aa640d..9f6a316e 100644 --- a/docs/sdks/parcels/README.md +++ b/docs/sdks/parcels/README.md @@ -52,10 +52,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -114,10 +113,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -154,6 +152,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/pickups/README.md b/docs/sdks/pickups/README.md index 9989b9c3..7e33a780 100644 --- a/docs/sdks/pickups/README.md +++ b/docs/sdks/pickups/README.md @@ -76,6 +76,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/rates/README.md b/docs/sdks/rates/README.md index f6e1cb49..ccfc15b9 100644 --- a/docs/sdks/rates/README.md +++ b/docs/sdks/rates/README.md @@ -47,10 +47,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## list_shipment_rates @@ -89,10 +88,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## list_shipment_rates_by_currency_code @@ -139,6 +137,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/ratesatcheckout/README.md b/docs/sdks/ratesatcheckout/README.md index e31ace43..db592ff0 100644 --- a/docs/sdks/ratesatcheckout/README.md +++ b/docs/sdks/ratesatcheckout/README.md @@ -95,10 +95,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get_default_parcel_template @@ -129,10 +128,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## update_default_parcel_template @@ -172,10 +170,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## delete_default_parcel_template @@ -200,6 +197,6 @@ s.rates_at_checkout.delete_default_parcel_template() ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/refunds/README.md b/docs/sdks/refunds/README.md index 81b6e3ef..860f9b5c 100644 --- a/docs/sdks/refunds/README.md +++ b/docs/sdks/refunds/README.md @@ -52,10 +52,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## list @@ -86,10 +85,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -126,6 +124,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/servicegroups/README.md b/docs/sdks/servicegroups/README.md index e6721aae..995f323b 100644 --- a/docs/sdks/servicegroups/README.md +++ b/docs/sdks/servicegroups/README.md @@ -43,10 +43,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -99,10 +98,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## update @@ -165,10 +163,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## delete @@ -199,6 +196,6 @@ s.service_groups.delete(service_group_id='') ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/shipments/README.md b/docs/sdks/shipments/README.md index 10cc3bcb..8cb1d144 100644 --- a/docs/sdks/shipments/README.md +++ b/docs/sdks/shipments/README.md @@ -69,10 +69,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -355,10 +354,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -395,6 +393,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/shippoaccounts/README.md b/docs/sdks/shippoaccounts/README.md index e35839b5..e58dfc75 100644 --- a/docs/sdks/shippoaccounts/README.md +++ b/docs/sdks/shippoaccounts/README.md @@ -5,7 +5,7 @@ Shippo Accounts are used by Shippo Platform Accounts to create and manage Managed Shippo Accounts. Managed Shippo Accounts are headless accounts that represent your customers. They are opaque to your end customers, meaning customers do not need to create their own Shippo login or have a billing relationship with Shippo. -They can be used by marketplaces, e-commerce platforms, and third-party logistics providers who want to offer, seamless, built-in shipping functionality to their customers. +They can be used by marketplaces, e-commerce platforms, and third-party logistics providers who want to offer, seamless, built-in shipping functionality to their customers. See our guide for more details. ### Available Operations @@ -17,7 +17,7 @@ They can be used by marketplaces, e-commerce platforms, and third-party logistic ## list -Returns a list of Shippo Accounts objects +Returns a list of Shippo Managed Accounts objects. ### Example Usage @@ -51,14 +51,13 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create -Creates a Shippo Account object +Creates a new Shippo Managed Account. ### Example Usage @@ -97,14 +96,13 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get -Returns a Shippo Account using an object ID +Returns a Shippo Managed Account using an object ID. ### Example Usage @@ -137,14 +135,13 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## update -Updates a Shippo Account object +Updates a Shippo Managed Account using an object ID. ### Example Usage @@ -184,6 +181,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/trackingstatus/README.md b/docs/sdks/trackingstatus/README.md index ac166a82..94c7815c 100644 --- a/docs/sdks/trackingstatus/README.md +++ b/docs/sdks/trackingstatus/README.md @@ -62,10 +62,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -103,6 +102,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/transactions/README.md b/docs/sdks/transactions/README.md index 2fd3f075..544db92f 100644 --- a/docs/sdks/transactions/README.md +++ b/docs/sdks/transactions/README.md @@ -51,10 +51,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -77,6 +76,7 @@ res = s.transactions.create(request=components.TransactionCreateRequest( async_=False, label_file_type=components.LabelFileTypeEnum.PDF_4X6, metadata='Order ID #12345', + order='adcfdddf8ec64b84ad22772bce3ea37a', )) if res is not None: @@ -97,10 +97,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -137,6 +136,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/userparceltemplates/README.md b/docs/sdks/userparceltemplates/README.md index d2be5b93..497b6a11 100644 --- a/docs/sdks/userparceltemplates/README.md +++ b/docs/sdks/userparceltemplates/README.md @@ -48,10 +48,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## create @@ -98,10 +97,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## delete @@ -132,10 +130,9 @@ s.user_parcel_templates.delete(user_parcel_template_object_id='') ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get @@ -173,10 +170,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## update @@ -223,6 +219,6 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/webhooks/README.md b/docs/sdks/webhooks/README.md index df94c34b..5641c0a6 100644 --- a/docs/sdks/webhooks/README.md +++ b/docs/sdks/webhooks/README.md @@ -59,10 +59,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## list_webhooks @@ -93,10 +92,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## get_webhook @@ -133,10 +131,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## update_webhook @@ -154,12 +151,12 @@ s = shippo.Shippo( ) -res = s.webhooks.update_webhook(webhook_id='', webhook_update_request=components.WebhookUpdateRequest( +res = s.webhooks.update_webhook(webhook_update_request=components.WebhookUpdateRequest( event=components.WebhookEventTypeEnum.BATCH_CREATED, url='https://example.com/shippo-webhook', active=True, is_test=False, -)) +), webhook_id='') if res is not None: # handle response @@ -180,10 +177,9 @@ if res is not None: ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | - +| errors.SDKError | 4XX, 5XX | \*/\* | ## delete_webhook @@ -214,6 +210,6 @@ s.webhooks.delete_webhook(webhook_id='') ### Errors -| Error Object | Status Code | Content Type | +| Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | -| errors.SDKError | 4xx-5xx | */* | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/pylintrc b/pylintrc index 19be9c92..30db5ac4 100644 --- a/pylintrc +++ b/pylintrc @@ -184,7 +184,7 @@ good-names=i, # Good variable names regexes, separated by a comma. If names match any regex, # they will always be accepted -good-names-rgxs= +good-names-rgxs=^[A-Z][a-zA-Z0-9]*$ # Include a hint for the correct naming format with invalid-name. include-naming-hint=no diff --git a/setup.py b/setup.py index d4996050..227cfcd5 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ setuptools.setup( name='shippo', - version='3.7.1', + version='3.8.0', author='Shippo', description='Shipping API Python library (USPS, FedEx, UPS and more)', license = 'MIT License', diff --git a/src/shippo/models/components/instanttransactioncreaterequest.py b/src/shippo/models/components/instanttransactioncreaterequest.py index db5607b3..d100b829 100644 --- a/src/shippo/models/components/instanttransactioncreaterequest.py +++ b/src/shippo/models/components/instanttransactioncreaterequest.py @@ -30,5 +30,6 @@ class InstantTransactionCreateRequest: async_: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('async'), 'exclude': lambda f: f is None }}) label_file_type: Optional[LabelFileType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('label_file_type'), 'exclude': lambda f: f is None }}) metadata: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) + order: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) diff --git a/src/shippo/models/components/transactioncreaterequest.py b/src/shippo/models/components/transactioncreaterequest.py index 9d2dd2d8..7f54290b 100644 --- a/src/shippo/models/components/transactioncreaterequest.py +++ b/src/shippo/models/components/transactioncreaterequest.py @@ -18,5 +18,6 @@ class TransactionCreateRequest: the Shippo dashboard. """ metadata: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) + order: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('order'), 'exclude': lambda f: f is None }}) diff --git a/src/shippo/models/internal/globals.py b/src/shippo/models/internal/globals.py index 369fa5b3..e3947c11 100644 --- a/src/shippo/models/internal/globals.py +++ b/src/shippo/models/internal/globals.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class Globals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/addshipmentstobatch.py b/src/shippo/models/operations/addshipmentstobatch.py index 4be710bc..b43044d2 100644 --- a/src/shippo/models/operations/addshipmentstobatch.py +++ b/src/shippo/models/operations/addshipmentstobatch.py @@ -9,7 +9,7 @@ @dataclasses.dataclass class AddShipmentsToBatchGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createaddress.py b/src/shippo/models/operations/createaddress.py index 02a011ff..e85f6364 100644 --- a/src/shippo/models/operations/createaddress.py +++ b/src/shippo/models/operations/createaddress.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateAddressGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createbatch.py b/src/shippo/models/operations/createbatch.py index 8cb94658..58800b78 100644 --- a/src/shippo/models/operations/createbatch.py +++ b/src/shippo/models/operations/createbatch.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateBatchGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createcarrieraccount.py b/src/shippo/models/operations/createcarrieraccount.py index 89e08fbf..01732cf2 100644 --- a/src/shippo/models/operations/createcarrieraccount.py +++ b/src/shippo/models/operations/createcarrieraccount.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateCarrierAccountGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createcustomsdeclaration.py b/src/shippo/models/operations/createcustomsdeclaration.py index 3b937752..1626a822 100644 --- a/src/shippo/models/operations/createcustomsdeclaration.py +++ b/src/shippo/models/operations/createcustomsdeclaration.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateCustomsDeclarationGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createcustomsitem.py b/src/shippo/models/operations/createcustomsitem.py index 334becf6..35e31283 100644 --- a/src/shippo/models/operations/createcustomsitem.py +++ b/src/shippo/models/operations/createcustomsitem.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateCustomsItemGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createliverate.py b/src/shippo/models/operations/createliverate.py index e137af0f..1e709852 100644 --- a/src/shippo/models/operations/createliverate.py +++ b/src/shippo/models/operations/createliverate.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateLiveRateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createmanifest.py b/src/shippo/models/operations/createmanifest.py index 4d2f0bc5..7421e0e1 100644 --- a/src/shippo/models/operations/createmanifest.py +++ b/src/shippo/models/operations/createmanifest.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateManifestGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createorder.py b/src/shippo/models/operations/createorder.py index 52925dae..dd8a19ea 100644 --- a/src/shippo/models/operations/createorder.py +++ b/src/shippo/models/operations/createorder.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateOrderGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createparcel.py b/src/shippo/models/operations/createparcel.py index 0d9dcc4e..34177a6d 100644 --- a/src/shippo/models/operations/createparcel.py +++ b/src/shippo/models/operations/createparcel.py @@ -10,7 +10,7 @@ @dataclasses.dataclass class CreateParcelGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createpickup.py b/src/shippo/models/operations/createpickup.py index 563b74eb..c4a5394b 100644 --- a/src/shippo/models/operations/createpickup.py +++ b/src/shippo/models/operations/createpickup.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreatePickupGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createrefund.py b/src/shippo/models/operations/createrefund.py index 5db326aa..4b2b788f 100644 --- a/src/shippo/models/operations/createrefund.py +++ b/src/shippo/models/operations/createrefund.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateRefundGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createservicegroup.py b/src/shippo/models/operations/createservicegroup.py index 74a4451d..a7d4b55b 100644 --- a/src/shippo/models/operations/createservicegroup.py +++ b/src/shippo/models/operations/createservicegroup.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateServiceGroupGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createshipment.py b/src/shippo/models/operations/createshipment.py index 936bc4f0..84a182e6 100644 --- a/src/shippo/models/operations/createshipment.py +++ b/src/shippo/models/operations/createshipment.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateShipmentGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createshippoaccount.py b/src/shippo/models/operations/createshippoaccount.py index ef69cce5..190cc8ba 100644 --- a/src/shippo/models/operations/createshippoaccount.py +++ b/src/shippo/models/operations/createshippoaccount.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateShippoAccountGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createtrack.py b/src/shippo/models/operations/createtrack.py index ab83d17e..2ecfdac2 100644 --- a/src/shippo/models/operations/createtrack.py +++ b/src/shippo/models/operations/createtrack.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateTrackGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createtransaction.py b/src/shippo/models/operations/createtransaction.py index e127146b..7b0fb4c4 100644 --- a/src/shippo/models/operations/createtransaction.py +++ b/src/shippo/models/operations/createtransaction.py @@ -10,7 +10,7 @@ @dataclasses.dataclass class CreateTransactionGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/createuserparceltemplate.py b/src/shippo/models/operations/createuserparceltemplate.py index 2011b67b..1330eca6 100644 --- a/src/shippo/models/operations/createuserparceltemplate.py +++ b/src/shippo/models/operations/createuserparceltemplate.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class CreateUserParcelTemplateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/deletedefaultparceltemplate.py b/src/shippo/models/operations/deletedefaultparceltemplate.py index 9cfab7e1..0717edfb 100644 --- a/src/shippo/models/operations/deletedefaultparceltemplate.py +++ b/src/shippo/models/operations/deletedefaultparceltemplate.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class DeleteDefaultParcelTemplateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/deleteservicegroup.py b/src/shippo/models/operations/deleteservicegroup.py index b85e8adc..6ce7a904 100644 --- a/src/shippo/models/operations/deleteservicegroup.py +++ b/src/shippo/models/operations/deleteservicegroup.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class DeleteServiceGroupGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/deleteuserparceltemplate.py b/src/shippo/models/operations/deleteuserparceltemplate.py index 99754762..1d532b16 100644 --- a/src/shippo/models/operations/deleteuserparceltemplate.py +++ b/src/shippo/models/operations/deleteuserparceltemplate.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class DeleteUserParcelTemplateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getaddress.py b/src/shippo/models/operations/getaddress.py index 217d7ad1..6d2c49f5 100644 --- a/src/shippo/models/operations/getaddress.py +++ b/src/shippo/models/operations/getaddress.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetAddressGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getbatch.py b/src/shippo/models/operations/getbatch.py index 98cf702f..6adb1497 100644 --- a/src/shippo/models/operations/getbatch.py +++ b/src/shippo/models/operations/getbatch.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetBatchGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getcarrieraccount.py b/src/shippo/models/operations/getcarrieraccount.py index 4f8fd05c..21213a60 100644 --- a/src/shippo/models/operations/getcarrieraccount.py +++ b/src/shippo/models/operations/getcarrieraccount.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetCarrierAccountGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getcarrierparceltemplate.py b/src/shippo/models/operations/getcarrierparceltemplate.py index 09582542..f2ff89c4 100644 --- a/src/shippo/models/operations/getcarrierparceltemplate.py +++ b/src/shippo/models/operations/getcarrierparceltemplate.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetCarrierParcelTemplateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getcarrierregistrationstatus.py b/src/shippo/models/operations/getcarrierregistrationstatus.py index 8ab90fc8..5218a6c9 100644 --- a/src/shippo/models/operations/getcarrierregistrationstatus.py +++ b/src/shippo/models/operations/getcarrierregistrationstatus.py @@ -9,7 +9,7 @@ @dataclasses.dataclass class GetCarrierRegistrationStatusGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getcustomsdeclaration.py b/src/shippo/models/operations/getcustomsdeclaration.py index 77a9e8e4..9a04acb8 100644 --- a/src/shippo/models/operations/getcustomsdeclaration.py +++ b/src/shippo/models/operations/getcustomsdeclaration.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetCustomsDeclarationGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getcustomsitem.py b/src/shippo/models/operations/getcustomsitem.py index 38842f2c..a7b6f12f 100644 --- a/src/shippo/models/operations/getcustomsitem.py +++ b/src/shippo/models/operations/getcustomsitem.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetCustomsItemGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getdefaultparceltemplate.py b/src/shippo/models/operations/getdefaultparceltemplate.py index 027dba79..82b9b356 100644 --- a/src/shippo/models/operations/getdefaultparceltemplate.py +++ b/src/shippo/models/operations/getdefaultparceltemplate.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetDefaultParcelTemplateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getmanifest.py b/src/shippo/models/operations/getmanifest.py index 46c6af8c..27c0e3cc 100644 --- a/src/shippo/models/operations/getmanifest.py +++ b/src/shippo/models/operations/getmanifest.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetManifestGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getorder.py b/src/shippo/models/operations/getorder.py index 7d709cfd..57b04f71 100644 --- a/src/shippo/models/operations/getorder.py +++ b/src/shippo/models/operations/getorder.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetOrderGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getparcel.py b/src/shippo/models/operations/getparcel.py index 6b8aef1f..36488f75 100644 --- a/src/shippo/models/operations/getparcel.py +++ b/src/shippo/models/operations/getparcel.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetParcelGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getrate.py b/src/shippo/models/operations/getrate.py index 6278267f..725deb69 100644 --- a/src/shippo/models/operations/getrate.py +++ b/src/shippo/models/operations/getrate.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetRateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getrefund.py b/src/shippo/models/operations/getrefund.py index 7aac7d28..758d6d64 100644 --- a/src/shippo/models/operations/getrefund.py +++ b/src/shippo/models/operations/getrefund.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetRefundGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getshipment.py b/src/shippo/models/operations/getshipment.py index 77645d44..f81f638f 100644 --- a/src/shippo/models/operations/getshipment.py +++ b/src/shippo/models/operations/getshipment.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetShipmentGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getshippoaccount.py b/src/shippo/models/operations/getshippoaccount.py index 42316c40..2a501c68 100644 --- a/src/shippo/models/operations/getshippoaccount.py +++ b/src/shippo/models/operations/getshippoaccount.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetShippoAccountGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/gettrack.py b/src/shippo/models/operations/gettrack.py index 62286a18..3262ef3c 100644 --- a/src/shippo/models/operations/gettrack.py +++ b/src/shippo/models/operations/gettrack.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetTrackGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/gettransaction.py b/src/shippo/models/operations/gettransaction.py index 286674d2..51b08d05 100644 --- a/src/shippo/models/operations/gettransaction.py +++ b/src/shippo/models/operations/gettransaction.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetTransactionGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/getuserparceltemplate.py b/src/shippo/models/operations/getuserparceltemplate.py index 1afba700..20c7527d 100644 --- a/src/shippo/models/operations/getuserparceltemplate.py +++ b/src/shippo/models/operations/getuserparceltemplate.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class GetUserParcelTemplateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/initiateoauth2signin.py b/src/shippo/models/operations/initiateoauth2signin.py index dd0c1200..9295f55b 100644 --- a/src/shippo/models/operations/initiateoauth2signin.py +++ b/src/shippo/models/operations/initiateoauth2signin.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class InitiateOauth2SigninGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listaddresses.py b/src/shippo/models/operations/listaddresses.py index 198be0ba..c6745c0f 100644 --- a/src/shippo/models/operations/listaddresses.py +++ b/src/shippo/models/operations/listaddresses.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListAddressesGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listcarrieraccounts.py b/src/shippo/models/operations/listcarrieraccounts.py index 6a910a90..f6a8118a 100644 --- a/src/shippo/models/operations/listcarrieraccounts.py +++ b/src/shippo/models/operations/listcarrieraccounts.py @@ -9,7 +9,7 @@ @dataclasses.dataclass class ListCarrierAccountsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listcarrierparceltemplates.py b/src/shippo/models/operations/listcarrierparceltemplates.py index 99d49ff1..2f78800b 100644 --- a/src/shippo/models/operations/listcarrierparceltemplates.py +++ b/src/shippo/models/operations/listcarrierparceltemplates.py @@ -9,7 +9,7 @@ @dataclasses.dataclass class ListCarrierParcelTemplatesGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listcustomsdeclarations.py b/src/shippo/models/operations/listcustomsdeclarations.py index 00b7bb35..48b2038a 100644 --- a/src/shippo/models/operations/listcustomsdeclarations.py +++ b/src/shippo/models/operations/listcustomsdeclarations.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListCustomsDeclarationsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listcustomsitems.py b/src/shippo/models/operations/listcustomsitems.py index 38080e31..e85b4668 100644 --- a/src/shippo/models/operations/listcustomsitems.py +++ b/src/shippo/models/operations/listcustomsitems.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListCustomsItemsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listmanifests.py b/src/shippo/models/operations/listmanifests.py index 31944949..30049cb2 100644 --- a/src/shippo/models/operations/listmanifests.py +++ b/src/shippo/models/operations/listmanifests.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListManifestsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listorders.py b/src/shippo/models/operations/listorders.py index 9ac91a94..bf702899 100644 --- a/src/shippo/models/operations/listorders.py +++ b/src/shippo/models/operations/listorders.py @@ -10,7 +10,7 @@ @dataclasses.dataclass class ListOrdersGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listparcels.py b/src/shippo/models/operations/listparcels.py index d7acfc22..32f15d86 100644 --- a/src/shippo/models/operations/listparcels.py +++ b/src/shippo/models/operations/listparcels.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListParcelsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listrefunds.py b/src/shippo/models/operations/listrefunds.py index 133ecd42..5f564170 100644 --- a/src/shippo/models/operations/listrefunds.py +++ b/src/shippo/models/operations/listrefunds.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListRefundsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listservicegroups.py b/src/shippo/models/operations/listservicegroups.py index c4c419d1..643b6686 100644 --- a/src/shippo/models/operations/listservicegroups.py +++ b/src/shippo/models/operations/listservicegroups.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListServiceGroupsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listshipmentrates.py b/src/shippo/models/operations/listshipmentrates.py index c2b93cfb..93ecd74f 100644 --- a/src/shippo/models/operations/listshipmentrates.py +++ b/src/shippo/models/operations/listshipmentrates.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListShipmentRatesGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listshipmentratesbycurrencycode.py b/src/shippo/models/operations/listshipmentratesbycurrencycode.py index 15ac67c4..f37225c9 100644 --- a/src/shippo/models/operations/listshipmentratesbycurrencycode.py +++ b/src/shippo/models/operations/listshipmentratesbycurrencycode.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListShipmentRatesByCurrencyCodeGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listshipments.py b/src/shippo/models/operations/listshipments.py index 66db1650..3c415b12 100644 --- a/src/shippo/models/operations/listshipments.py +++ b/src/shippo/models/operations/listshipments.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListShipmentsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listshippoaccounts.py b/src/shippo/models/operations/listshippoaccounts.py index bfa7db23..5e361c29 100644 --- a/src/shippo/models/operations/listshippoaccounts.py +++ b/src/shippo/models/operations/listshippoaccounts.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListShippoAccountsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listtransactions.py b/src/shippo/models/operations/listtransactions.py index 70abfcf3..92ff3b1a 100644 --- a/src/shippo/models/operations/listtransactions.py +++ b/src/shippo/models/operations/listtransactions.py @@ -10,7 +10,7 @@ @dataclasses.dataclass class ListTransactionsGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/listuserparceltemplates.py b/src/shippo/models/operations/listuserparceltemplates.py index c8c5278e..5b77b743 100644 --- a/src/shippo/models/operations/listuserparceltemplates.py +++ b/src/shippo/models/operations/listuserparceltemplates.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ListUserParcelTemplatesGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/purchasebatch.py b/src/shippo/models/operations/purchasebatch.py index 9bd70452..b6c2012a 100644 --- a/src/shippo/models/operations/purchasebatch.py +++ b/src/shippo/models/operations/purchasebatch.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class PurchaseBatchGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/registercarrieraccount.py b/src/shippo/models/operations/registercarrieraccount.py index 3cebdcca..5a1cd021 100644 --- a/src/shippo/models/operations/registercarrieraccount.py +++ b/src/shippo/models/operations/registercarrieraccount.py @@ -23,7 +23,7 @@ @dataclasses.dataclass class RegisterCarrierAccountGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/removeshipmentsfrombatch.py b/src/shippo/models/operations/removeshipmentsfrombatch.py index 6b389a69..d34a96a8 100644 --- a/src/shippo/models/operations/removeshipmentsfrombatch.py +++ b/src/shippo/models/operations/removeshipmentsfrombatch.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class RemoveShipmentsFromBatchGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/updatecarrieraccount.py b/src/shippo/models/operations/updatecarrieraccount.py index a7f3aadf..c548ac46 100644 --- a/src/shippo/models/operations/updatecarrieraccount.py +++ b/src/shippo/models/operations/updatecarrieraccount.py @@ -9,7 +9,7 @@ @dataclasses.dataclass class UpdateCarrierAccountGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/updatedefaultparceltemplate.py b/src/shippo/models/operations/updatedefaultparceltemplate.py index 0299c1cd..9bcf997e 100644 --- a/src/shippo/models/operations/updatedefaultparceltemplate.py +++ b/src/shippo/models/operations/updatedefaultparceltemplate.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class UpdateDefaultParcelTemplateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/updateservicegroup.py b/src/shippo/models/operations/updateservicegroup.py index 764030fa..067ad6f7 100644 --- a/src/shippo/models/operations/updateservicegroup.py +++ b/src/shippo/models/operations/updateservicegroup.py @@ -8,6 +8,6 @@ @dataclasses.dataclass class UpdateServiceGroupGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/updateshippoaccount.py b/src/shippo/models/operations/updateshippoaccount.py index 809071c9..109db6c7 100644 --- a/src/shippo/models/operations/updateshippoaccount.py +++ b/src/shippo/models/operations/updateshippoaccount.py @@ -9,7 +9,7 @@ @dataclasses.dataclass class UpdateShippoAccountGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/updateuserparceltemplate.py b/src/shippo/models/operations/updateuserparceltemplate.py index 087c6140..87c545c1 100644 --- a/src/shippo/models/operations/updateuserparceltemplate.py +++ b/src/shippo/models/operations/updateuserparceltemplate.py @@ -9,7 +9,7 @@ @dataclasses.dataclass class UpdateUserParcelTemplateGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/models/operations/validateaddress.py b/src/shippo/models/operations/validateaddress.py index bf15a374..deafeb88 100644 --- a/src/shippo/models/operations/validateaddress.py +++ b/src/shippo/models/operations/validateaddress.py @@ -8,7 +8,7 @@ @dataclasses.dataclass class ValidateAddressGlobals: shippo_api_version: Optional[str] = dataclasses.field(default=None, metadata={'header': { 'field_name': 'SHIPPO-API-VERSION', 'style': 'simple', 'explode': False }}) - r"""String used to pick a non-default API version to use""" + r"""Optional string used to pick a non-default API version to use. See our API version guide.""" diff --git a/src/shippo/sdk.py b/src/shippo/sdk.py index da77ea1e..38db40fe 100644 --- a/src/shippo/sdk.py +++ b/src/shippo/sdk.py @@ -164,7 +164,7 @@ class Shippo: shippo_accounts: ShippoAccounts r"""Shippo Accounts are used by Shippo Platform Accounts to create and manage Managed Shippo Accounts. Managed Shippo Accounts are headless accounts that represent your customers. They are opaque to your end customers, meaning customers do not need to create their own Shippo login or have a billing relationship with Shippo. - They can be used by marketplaces, e-commerce platforms, and third-party logistics providers who want to offer, seamless, built-in shipping functionality to their customers. + They can be used by marketplaces, e-commerce platforms, and third-party logistics providers who want to offer, seamless, built-in shipping functionality to their customers. See our guide for more details. """ webhooks: Webhooks diff --git a/src/shippo/sdkconfiguration.py b/src/shippo/sdkconfiguration.py index aebf9448..27206047 100644 --- a/src/shippo/sdkconfiguration.py +++ b/src/shippo/sdkconfiguration.py @@ -24,9 +24,9 @@ class SDKConfiguration: server_idx: Optional[int] = 0 language: str = 'python' openapi_doc_version: str = '2018-02-08' - sdk_version: str = '3.7.1' - gen_version: str = '2.421.3' - user_agent: str = 'speakeasy-sdk/python 3.7.1 2.421.3 2018-02-08 shippo' + sdk_version: str = '3.8.0' + gen_version: str = '2.452.0' + user_agent: str = 'speakeasy-sdk/python 3.8.0 2.452.0 2018-02-08 shippo' retry_config: Optional[RetryConfig] = None def __post_init__(self): diff --git a/src/shippo/shippo_accounts.py b/src/shippo/shippo_accounts.py index 5efdbc50..6940fd51 100644 --- a/src/shippo/shippo_accounts.py +++ b/src/shippo/shippo_accounts.py @@ -10,7 +10,7 @@ class ShippoAccounts: r"""Shippo Accounts are used by Shippo Platform Accounts to create and manage Managed Shippo Accounts. Managed Shippo Accounts are headless accounts that represent your customers. They are opaque to your end customers, meaning customers do not need to create their own Shippo login or have a billing relationship with Shippo. - They can be used by marketplaces, e-commerce platforms, and third-party logistics providers who want to offer, seamless, built-in shipping functionality to their customers. + They can be used by marketplaces, e-commerce platforms, and third-party logistics providers who want to offer, seamless, built-in shipping functionality to their customers. See our guide for more details. """ sdk_configuration: SDKConfiguration @@ -22,7 +22,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def list(self, page: Optional[int] = None, results: Optional[int] = None) -> components.ShippoAccountPaginatedList: r"""List all Shippo Accounts - Returns a list of Shippo Accounts objects + Returns a list of Shippo Managed Accounts objects. """ hook_ctx = HookContext(operation_id='ListShippoAccounts', oauth2_scopes=[], security_source=self.sdk_configuration.security) request = operations.ListShippoAccountsRequest( @@ -87,7 +87,7 @@ def list(self, page: Optional[int] = None, results: Optional[int] = None) -> com def create(self, request: components.ShippoAccountUpdateRequest) -> components.ShippoAccount: r"""Create a Shippo Account - Creates a Shippo Account object + Creates a new Shippo Managed Account. """ hook_ctx = HookContext(operation_id='CreateShippoAccount', oauth2_scopes=[], security_source=self.sdk_configuration.security) _globals = operations.CreateShippoAccountGlobals( @@ -151,7 +151,7 @@ def create(self, request: components.ShippoAccountUpdateRequest) -> components.S def get(self, shippo_account_id: str) -> components.ShippoAccount: r"""Retrieve a Shippo Account - Returns a Shippo Account using an object ID + Returns a Shippo Managed Account using an object ID. """ hook_ctx = HookContext(operation_id='GetShippoAccount', oauth2_scopes=[], security_source=self.sdk_configuration.security) request = operations.GetShippoAccountRequest( @@ -214,7 +214,7 @@ def get(self, shippo_account_id: str) -> components.ShippoAccount: def update(self, shippo_account_id: str, shippo_account_update_request: Optional[components.ShippoAccountUpdateRequest] = None) -> components.ShippoAccount: r"""Update a Shippo Account - Updates a Shippo Account object + Updates a Shippo Managed Account using an object ID. """ hook_ctx = HookContext(operation_id='UpdateShippoAccount', oauth2_scopes=[], security_source=self.sdk_configuration.security) request = operations.UpdateShippoAccountRequest( From feab9d3c2bbdae22902e91eeb424d39f1fd7c5cc Mon Sep 17 00:00:00 2001 From: Randall Keur Date: Thu, 7 Nov 2024 19:51:23 -0500 Subject: [PATCH 4/8] add test for creating an order --- tests/test_create_order.py | 74 ++++++++++++++++++++++++++++++++++++++ tests/test_instalabel.py | 2 +- 2 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 tests/test_create_order.py diff --git a/tests/test_create_order.py b/tests/test_create_order.py new file mode 100644 index 00000000..e1b77b83 --- /dev/null +++ b/tests/test_create_order.py @@ -0,0 +1,74 @@ +from dateutil.parser import isoparse + +import shippo +from shippo.models.components import OrderCreateRequest, LineItemBase, WeightUnitEnum, AddressCreateRequest, \ + OrderStatusEnum + + +class TestCreateOrder: + + def test_create_order(self, api: shippo.Shippo): + order = api.orders.create(request=OrderCreateRequest( + placed_at='2016-09-23T01:28:12Z', + to_address=AddressCreateRequest( + country='US', + name='Shwan Ippotle', + company='Shippo', + street1='215 Clayton St.', + street3='', + street_no='', + city='San Francisco', + state='CA', + zip='94117', + phone='+1 555 341 9393', + email='shippotle@shippo.com', + is_residential=True, + metadata='Customer ID 123456', + validate=True, + ), + currency='USD', + notes='This customer is a VIP', + order_number='#1068', + order_status=OrderStatusEnum.PAID, + shipping_cost='12.83', + shipping_cost_currency='USD', + shipping_method='USPS First Class Package', + subtotal_price='12.1', + total_price='24.93', + total_tax='0.0', + weight='0.4', + weight_unit=WeightUnitEnum.LB, + from_address=AddressCreateRequest( + country='US', + name='Shwan Ippotle', + company='Shippo', + street1='215 Clayton St.', + street3='', + street_no='', + city='San Francisco', + state='CA', + zip='94117', + phone='+1 555 341 9393', + email='shippotle@shippo.com', + is_residential=True, + metadata='Customer ID 123456', + validate=True, + ), + line_items=[ + LineItemBase( + currency='USD', + manufacture_country='US', + max_delivery_time=isoparse('2016-07-23T00:00:00Z'), + max_ship_time=isoparse('2016-07-23T00:00:00Z'), + quantity=20, + sku='HM-123', + title='Hippo Magazines', + total_price='12.1', + variant_title='June Edition', + weight='0.4', + weight_unit=WeightUnitEnum.LB, + ), + ], + )) + + assert order is not None diff --git a/tests/test_instalabel.py b/tests/test_instalabel.py index 1255ada7..8c537baf 100644 --- a/tests/test_instalabel.py +++ b/tests/test_instalabel.py @@ -47,7 +47,7 @@ def test_instalabel(self, api: shippo.Shippo): ) ] ), - order=get_order_object_id(api)), + order=get_order_object_id(api)), ) assert transaction is not None assert isinstance(transaction, Transaction) From fdbc330a1676fdf7ae37a0f1d24cfdf635d87a3e Mon Sep 17 00:00:00 2001 From: Randall Keur Date: Thu, 7 Nov 2024 19:59:54 -0500 Subject: [PATCH 5/8] force the order to be created first --- tests/test_create_order.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/test_create_order.py b/tests/test_create_order.py index e1b77b83..4d1f16ca 100644 --- a/tests/test_create_order.py +++ b/tests/test_create_order.py @@ -1,3 +1,4 @@ +import pytest from dateutil.parser import isoparse import shippo @@ -7,6 +8,7 @@ class TestCreateOrder: + @pytest.mark.run(order=1) def test_create_order(self, api: shippo.Shippo): order = api.orders.create(request=OrderCreateRequest( placed_at='2016-09-23T01:28:12Z', From add544a3fffd50e01389e56af0fef7faa069354c Mon Sep 17 00:00:00 2001 From: Randall Keur Date: Thu, 7 Nov 2024 20:03:02 -0500 Subject: [PATCH 6/8] expand python versions --- .github/workflows/sdk_validation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sdk_validation.yaml b/.github/workflows/sdk_validation.yaml index 433a3143..77057649 100644 --- a/.github/workflows/sdk_validation.yaml +++ b/.github/workflows/sdk_validation.yaml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: [ '3.8', '3.11' ] + python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ] name: Python ${{ matrix.python-version }} timeout-minutes: 10 env: From 4e491e1c35f936867adecc48318470d5f9019aba Mon Sep 17 00:00:00 2001 From: Randall Keur Date: Thu, 7 Nov 2024 20:07:02 -0500 Subject: [PATCH 7/8] remove concurrency group --- .github/workflows/sdk_validation.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/sdk_validation.yaml b/.github/workflows/sdk_validation.yaml index 77057649..e7a831f1 100644 --- a/.github/workflows/sdk_validation.yaml +++ b/.github/workflows/sdk_validation.yaml @@ -19,8 +19,6 @@ jobs: timeout-minutes: 10 env: SHIPPO_TOKEN: ${{ secrets.SHIPPO_TOKEN }} - concurrency: - group: python-sdk-check steps: - name: Check out repository uses: actions/checkout@v4 From 78af904ac40c5386a98526de5bc71f5e2086480f Mon Sep 17 00:00:00 2001 From: Randall Keur Date: Mon, 11 Nov 2024 09:18:08 -0500 Subject: [PATCH 8/8] update tests per comments --- tests/helpers_custom.py | 8 ++++++-- tests/test_create_order.py | 14 ++++++++++---- tests/test_instalabel.py | 4 ++-- tests/test_purchase_label.py | 14 +++++++++++--- 4 files changed, 29 insertions(+), 11 deletions(-) diff --git a/tests/helpers_custom.py b/tests/helpers_custom.py index 55707c56..e877e144 100644 --- a/tests/helpers_custom.py +++ b/tests/helpers_custom.py @@ -18,6 +18,10 @@ def get_carrier_accounts(api: shippo.Shippo, carrier: CarriersEnum) -> List[Carr return carrier_accounts.results -def get_order_object_id(api: shippo.Shippo) -> string: +def get_first_order_object_id(api: shippo.Shippo) -> string: + return get_orders(api)[0].object_id + + +def get_orders(api: shippo.Shippo) -> List[Order]: orders = api.orders.list(request=ListOrdersRequest()) - return orders.results[0].object_id + return orders.results \ No newline at end of file diff --git a/tests/test_create_order.py b/tests/test_create_order.py index 4d1f16ca..065162b2 100644 --- a/tests/test_create_order.py +++ b/tests/test_create_order.py @@ -3,14 +3,14 @@ import shippo from shippo.models.components import OrderCreateRequest, LineItemBase, WeightUnitEnum, AddressCreateRequest, \ - OrderStatusEnum + OrderStatusEnum, Order class TestCreateOrder: - @pytest.mark.run(order=1) - def test_create_order(self, api: shippo.Shippo): - order = api.orders.create(request=OrderCreateRequest( + @pytest.fixture + def create_order(self, api: shippo.Shippo): + return api.orders.create(request=OrderCreateRequest( placed_at='2016-09-23T01:28:12Z', to_address=AddressCreateRequest( country='US', @@ -73,4 +73,10 @@ def test_create_order(self, api: shippo.Shippo): ], )) + @pytest.mark.order(1) + def test_create_order(self, create_order): + order = create_order + assert order is not None + assert isinstance(order, Order) + assert order.object_id is not None diff --git a/tests/test_instalabel.py b/tests/test_instalabel.py index 8c537baf..5faa0afa 100644 --- a/tests/test_instalabel.py +++ b/tests/test_instalabel.py @@ -2,7 +2,7 @@ from shippo.models.components import CarriersEnum, DistanceUnitEnum, WeightUnitEnum, \ AddressCreateRequest, ParcelCreateRequest, ShipmentCreateRequest, \ InstantTransactionCreateRequest, Transaction -from tests.helpers_custom import get_carrier_account, get_order_object_id +from tests.helpers_custom import get_carrier_account, get_first_order_object_id # https://docs.goshippo.com/docs/guides_general/single_call/ @@ -47,7 +47,7 @@ def test_instalabel(self, api: shippo.Shippo): ) ] ), - order=get_order_object_id(api)), + order=get_first_order_object_id(api)), ) assert transaction is not None assert isinstance(transaction, Transaction) diff --git a/tests/test_purchase_label.py b/tests/test_purchase_label.py index 7ce76b82..4488279d 100644 --- a/tests/test_purchase_label.py +++ b/tests/test_purchase_label.py @@ -1,7 +1,7 @@ import shippo from shippo.models.components import CarriersEnum, DistanceUnitEnum, WeightUnitEnum, \ AddressCreateRequest, ShipmentCreateRequest, TransactionCreateRequest, ParcelCreateRequest, Transaction -from tests.helpers_custom import get_carrier_accounts, get_order_object_id +from tests.helpers_custom import get_carrier_accounts, get_first_order_object_id # https://docs.goshippo.com/docs/stories/single_rating_guide/ @@ -47,8 +47,12 @@ def test_purchase_label(self, api: shippo.Shippo): )) assert shipment is not None + order_object_id = get_first_order_object_id(api) + assert order_object_id is not None + assert isinstance(order_object_id, str) + transaction = api.transactions.create( - TransactionCreateRequest(rate=shipment.rates[0].object_id, order=get_order_object_id(api)) + TransactionCreateRequest(rate=shipment.rates[0].object_id, order=order_object_id) ) assert transaction is not None @@ -100,8 +104,12 @@ def test_purchase_label_using_reference_ids(self, api: shippo.Shippo): assert shipment.address_from.object_id == address_from.object_id assert shipment.address_return.object_id == address_from.object_id + order_object_id = get_first_order_object_id(api) + assert order_object_id is not None + assert isinstance(order_object_id, str) + transaction = api.transactions.create( - TransactionCreateRequest(rate=shipment.rates[0].object_id, order=get_order_object_id(api)) + TransactionCreateRequest(rate=shipment.rates[0].object_id, order=order_object_id) ) assert transaction is not None assert isinstance(transaction, Transaction)