diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index efb61afa..75aedb44 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1,2 @@ -* @goshippo/core-enablement \ No newline at end of file +* @goshippo/core-enablement +* @AdrianCollinsShippo \ No newline at end of file diff --git a/.github/workflows/sdk_validation.yaml b/.github/workflows/sdk_validation.yaml index 7ad0b7de..2bf41ce7 100644 --- a/.github/workflows/sdk_validation.yaml +++ b/.github/workflows/sdk_validation.yaml @@ -16,7 +16,7 @@ jobs: env: SHIPPO_TOKEN: ${{ secrets.SHIPPO_TOKEN }} concurrency: - group: javascript-sdk-check + group: javascript-sdk-check-${{ github.event.pull_request.number }} steps: - name: Check out repository uses: actions/checkout@v4 diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index ac34ae1a..71a300b4 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 4f7e8ab5-4c00-496a-9710-e7c707e4ee78 management: - docChecksum: 2edac3552b0c3728ec7bf25184e0a6c1 + docChecksum: d17362762d19f1f23211a71e568bf249 docVersion: "2018-02-08" speakeasyVersion: 1.401.2 generationVersion: 2.421.3 - releaseVersion: 2.7.0 - configChecksum: 7d0b17641f66d384d0abdc2e823329aa + releaseVersion: 2.9.0 + configChecksum: 7cb0a08231e81fb1627156dac475b54f repoURL: https://github.com/goshippo/shippo-javascript-sdk.git installationURL: https://github.com/goshippo/shippo-javascript-sdk published: true @@ -844,6 +844,7 @@ examples: ListAddresses: speakeasy-default-list-addresses: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -936,6 +937,7 @@ examples: ListCarrierAccounts: speakeasy-default-list-carrier-accounts: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -995,7 +997,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} @@ -1012,6 +1014,7 @@ examples: ListCustomsDeclarations: speakeasy-default-list-customs-declarations: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1041,6 +1044,7 @@ examples: ListCustomsItems: speakeasy-default-list-customs-items: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1103,6 +1107,7 @@ examples: ListManifests: speakeasy-default-list-manifests: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1182,6 +1187,7 @@ examples: ListParcels: speakeasy-default-list-parcels: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1285,7 +1291,7 @@ examples: SHIPPO-API-VERSION: "2018-02-08" responses: "200": - application/json: [{"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"name": "Priority Mail Express", "token": "usps_priority_express", "parent_servicelevel": {"name": "Priority Mail Express", "token": "usps_priority_express"}}, {"name": "Priority Mail Express", "token": "usps_priority_express", "parent_servicelevel": {"name": "Priority Mail Express", "token": "usps_priority_express"}}]}, {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"name": "Priority Mail Express", "token": "usps_priority_express", "parent_servicelevel": {"name": "Priority Mail Express", "token": "usps_priority_express"}}, {"name": "Priority Mail Express", "token": "usps_priority_express", "parent_servicelevel": {"name": "Priority Mail Express", "token": "usps_priority_express"}}]}, {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": []}] + application/json: [{"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}, {"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}]}, {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}, {"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}]}, {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": []}] CreateServiceGroup: speakeasy-default-create-service-group: parameters: @@ -1295,7 +1301,7 @@ examples: application/json: {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "service_levels": [{"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}]} responses: "201": - application/json: {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"name": "Priority Mail Express", "token": "usps_priority_express", "parent_servicelevel": {"name": "Priority Mail Express", "token": "usps_priority_express"}}, {"name": "Priority Mail Express", "token": "usps_priority_express", "parent_servicelevel": {"name": "Priority Mail Express", "token": "usps_priority_express"}}]} + application/json: {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}, {"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}]} UpdateServiceGroup: speakeasy-default-update-service-group: parameters: @@ -1305,7 +1311,7 @@ examples: application/json: {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}, {"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}, {"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}]} responses: "200": - application/json: {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"name": "Priority Mail Express", "token": "usps_priority_express", "parent_servicelevel": {"name": "Priority Mail Express", "token": "usps_priority_express"}}, {"name": "Priority Mail Express", "token": "usps_priority_express", "parent_servicelevel": {"name": "Priority Mail Express", "token": "usps_priority_express"}}]} + application/json: {"description": "USPS shipping options", "flat_rate": "5", "flat_rate_currency": "USD", "free_shipping_threshold_currency": "USD", "free_shipping_threshold_min": "5", "name": "USPS Shipping", "rate_adjustment": 15, "type": "FLAT_RATE", "object_id": "80feb1633d4a43c898f005850", "is_active": true, "service_levels": [{"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}, {"account_object_id": "80feb1633d4a43c898f0058506cfd82d", "service_level_token": "ups_next_day_air_saver"}]} DeleteServiceGroup: speakeasy-default-delete-service-group: parameters: @@ -1316,6 +1322,7 @@ examples: ListShipments: speakeasy-default-list-shipments: parameters: + query: {} header: SHIPPO-API-VERSION: "2018-02-08" responses: @@ -1379,7 +1386,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"} @@ -1443,6 +1450,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 56cee865..3ddd7beb 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: true typescript: - version: 2.7.0 + version: 2.9.0 additionalDependencies: dependencies: {} devDependencies: @@ -26,8 +26,10 @@ typescript: license: MIT author: Shippo clientServerStatusCodesAsErrors: true + defaultErrorName: SDKError enumFormat: union flattenGlobalSecurity: true + flatteningOrder: body-first imports: option: openapi paths: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 688e81af..bf83b0b2 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,8 +2,8 @@ speakeasyVersion: 1.401.2 sources: openapi: sourceNamespace: openapi - sourceRevisionDigest: sha256:097cfbf7ac9aa82850a70d3a3f6b6d2064ceebf06ad477577b59cd74083a861a - sourceBlobDigest: sha256:d20d1d724adbc75bf8db343aa4c16e626daaadbb57e55e4d1b486ea2277b1bb5 + sourceRevisionDigest: sha256:cee6468382dc776b98a5e3781bae0e16549785fea91beddd71eba715c01bf797 + sourceBlobDigest: sha256:481f6638b89baad7d8f2c108f74fc028b9999cc9708a00e72688330c720262e7 tags: - latest - main @@ -11,8 +11,10 @@ targets: first-target: source: openapi sourceNamespace: openapi - sourceRevisionDigest: sha256:097cfbf7ac9aa82850a70d3a3f6b6d2064ceebf06ad477577b59cd74083a861a - sourceBlobDigest: sha256:d20d1d724adbc75bf8db343aa4c16e626daaadbb57e55e4d1b486ea2277b1bb5 + sourceRevisionDigest: sha256:cee6468382dc776b98a5e3781bae0e16549785fea91beddd71eba715c01bf797 + sourceBlobDigest: sha256:481f6638b89baad7d8f2c108f74fc028b9999cc9708a00e72688330c720262e7 + codeSamplesNamespace: openapi-code-samples + codeSamplesRevisionDigest: sha256:6ff8e5aa52c68832681ef40cda89b11535f6a263a349c1eef401c0f44b74e513 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest @@ -29,3 +31,7 @@ workflow: publish: npm: token: $npm_token + codeSamples: + output: "" + registry: + location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml index a5d767fd..c0ab4da1 100644 --- a/.speakeasy/workflow.yaml +++ b/.speakeasy/workflow.yaml @@ -13,3 +13,7 @@ targets: publish: npm: token: $npm_token + codeSamples: + registry: + location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples + blocking: false diff --git a/RELEASES.md b/RELEASES.md index ee508b2f..d320d1eb 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -296,4 +296,14 @@ Based on: ### Generated - [typescript v2.7.0] . ### Releases -- [NPM v2.7.0] https://www.npmjs.com/package/shippo/v/2.7.0 - . \ No newline at end of file +- [NPM v2.7.0] https://www.npmjs.com/package/shippo/v/2.7.0 - . + +## 2024-11-18 19:17:03 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v2.9.0] . +### Releases +- [NPM v2.9.0] https://www.npmjs.com/package/shippo/v/2.9.0 - . \ No newline at end of file diff --git a/docs/models/components/instanttransactioncreaterequest.md b/docs/models/components/instanttransactioncreaterequest.md index 41f8729e..ccc41cad 100644 --- a/docs/models/components/instanttransactioncreaterequest.md +++ b/docs/models/components/instanttransactioncreaterequest.md @@ -198,6 +198,7 @@ let value: InstantTransactionCreateRequest = { "", ], }, + order: "adcfdddf8ec64b84ad22772bce3ea37a", }; ``` @@ -210,4 +211,5 @@ let value: InstantTransactionCreateRequest = { | `labelFileType` | [components.LabelFileType](../../models/components/labelfiletype.md) | :heavy_minus_sign: | N/A | PDF | | `metadata` | *string* | :heavy_minus_sign: | N/A | Order ID #12345 | | `servicelevelToken` | *string* | :heavy_check_mark: | N/A | usps_priority | -| `shipment` | [components.ShipmentCreateRequest](../../models/components/shipmentcreaterequest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `shipment` | [components.ShipmentCreateRequest](../../models/components/shipmentcreaterequest.md) | :heavy_check_mark: | N/A | | +| `order` | *string* | :heavy_minus_sign: | N/A | adcfdddf8ec64b84ad22772bce3ea37a | \ No newline at end of file diff --git a/docs/models/components/servicegroup.md b/docs/models/components/servicegroup.md index fc0d834b..751ee464 100644 --- a/docs/models/components/servicegroup.md +++ b/docs/models/components/servicegroup.md @@ -18,12 +18,8 @@ let value: ServiceGroup = { isActive: true, serviceLevels: [ { - name: "Priority Mail Express", - token: "usps_priority_express", - parentServicelevel: { - name: "Priority Mail Express", - token: "usps_priority_express", - }, + accountObjectId: "80feb1633d4a43c898f0058506cfd82d", + serviceLevelToken: "ups_next_day_air_saver", }, ], }; @@ -43,4 +39,4 @@ let value: ServiceGroup = { | `type` | [components.ServiceGroupTypeEnum](../../models/components/servicegrouptypeenum.md) | :heavy_check_mark: | The type of the service group.

`LIVE_RATE` - Shippo will make a rating request and return real-time rates for the shipping group, only falling back to the specified flat rate amount if no rates match a service level in the service group.

`FLAT_RATE` - Returns a shipping option with the specified flat rate amount.

`FREE_SHIPPING` - Returns a shipping option with a price of $0 only if the total cost of items exceeds the amount defined by `free_shipping_threshold_min` | FLAT_RATE | | `objectId` | *string* | :heavy_check_mark: | The unique identifier of the given Service Group object. | 80feb1633d4a43c898f005850 | | `isActive` | *boolean* | :heavy_minus_sign: | True if the service group is enabled, false otherwise. | true | -| `serviceLevels` | [components.ServiceLevelWithParent](../../models/components/servicelevelwithparent.md)[] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `serviceLevels` | [components.ServiceGroupAccountAndServiceLevel](../../models/components/servicegroupaccountandservicelevel.md)[] | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/servicelevelcanadapostenum.md b/docs/models/components/servicelevelcanadapostenum.md index 8e1999f3..0bd91c4f 100644 --- a/docs/models/components/servicelevelcanadapostenum.md +++ b/docs/models/components/servicelevelcanadapostenum.md @@ -13,6 +13,9 @@ | canada_post_small_packet_usa_air | Small Packet USA Air| | canada_post_tracked_packet_international | Tracked Packet International| | canada_post_small_packet_international_air | Small Package International Air| +| canada_post_small_packet_international_surface | Small Packet International Surface +| canada_post_international_parcel_surface | International Parcel Surface +| canada_post_international_parcel_air | International Parcel Air ## Example Usage @@ -20,11 +23,12 @@ ```typescript import { ServiceLevelCanadaPostEnum } from "shippo/models/components"; -let value: ServiceLevelCanadaPostEnum = "canada_post_small_packet_usa_air"; +let value: ServiceLevelCanadaPostEnum = + "canada_post_small_packet_international_air"; ``` ## Values ```typescript -"canada_post_regular_parcel" | "canada_post_expedited_parcel" | "canada_post_priority" | "canada_post_xpresspost" | "canada_post_xpresspost_international" | "canada_post_xpresspost_usa" | "canada_post_expedited_parcel_usa" | "canada_post_tracked_packet_usa" | "canada_post_small_packet_usa_air" | "canada_post_tracked_packet_international" | "canada_post_small_packet_international_air" +"canada_post_regular_parcel" | "canada_post_expedited_parcel" | "canada_post_priority" | "canada_post_xpresspost" | "canada_post_xpresspost_international" | "canada_post_xpresspost_usa" | "canada_post_expedited_parcel_usa" | "canada_post_tracked_packet_usa" | "canada_post_small_packet_usa_air" | "canada_post_tracked_packet_international" | "canada_post_small_packet_international_air" | "canada_post_small_packet_international_surface" | "canada_post_international_parcel_surface" | "canada_post_international_parcel_air" ``` \ No newline at end of file diff --git a/docs/models/components/transactioncreaterequest.md b/docs/models/components/transactioncreaterequest.md index a7c367a5..e07fa31b 100644 --- a/docs/models/components/transactioncreaterequest.md +++ b/docs/models/components/transactioncreaterequest.md @@ -10,6 +10,7 @@ let value: TransactionCreateRequest = { labelFileType: "PDF_4x6", metadata: "Order ID #12345", rate: "ec9f0d3adc9441449c85d315f0997fd5", + order: "adcfdddf8ec64b84ad22772bce3ea37a", }; ``` @@ -20,4 +21,5 @@ let value: TransactionCreateRequest = { | `async` | *boolean* | :heavy_minus_sign: | N/A | false | | `labelFileType` | [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` | *string* | :heavy_minus_sign: | N/A | Order ID #12345 | -| `rate` | *string* | :heavy_check_mark: | N/A | ec9f0d3adc9441449c85d315f0997fd5 | \ No newline at end of file +| `rate` | *string* | :heavy_check_mark: | N/A | ec9f0d3adc9441449c85d315f0997fd5 | +| `order` | *string* | :heavy_minus_sign: | N/A | adcfdddf8ec64b84ad22772bce3ea37a | \ No newline at end of file diff --git a/docs/models/operations/addshipmentstobatchglobals.md b/docs/models/operations/addshipmentstobatchglobals.md index 9bc1a647..11a9ca66 100644 --- a/docs/models/operations/addshipmentstobatchglobals.md +++ b/docs/models/operations/addshipmentstobatchglobals.md @@ -10,6 +10,6 @@ let value: AddShipmentsToBatchGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 d85b16e9..3b96f29d 100644 --- a/docs/models/operations/createaddressglobals.md +++ b/docs/models/operations/createaddressglobals.md @@ -10,6 +10,6 @@ let value: CreateAddressGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 09b219e1..442e997b 100644 --- a/docs/models/operations/createbatchglobals.md +++ b/docs/models/operations/createbatchglobals.md @@ -10,6 +10,6 @@ let value: CreateBatchGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 42be73fd..96ea9e05 100644 --- a/docs/models/operations/createcarrieraccountglobals.md +++ b/docs/models/operations/createcarrieraccountglobals.md @@ -10,6 +10,6 @@ let value: CreateCarrierAccountGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 65a2a062..9a45ee3c 100644 --- a/docs/models/operations/createcustomsdeclarationglobals.md +++ b/docs/models/operations/createcustomsdeclarationglobals.md @@ -10,6 +10,6 @@ let value: CreateCustomsDeclarationGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 c51a33a3..16c69c7b 100644 --- a/docs/models/operations/createcustomsitemglobals.md +++ b/docs/models/operations/createcustomsitemglobals.md @@ -10,6 +10,6 @@ let value: CreateCustomsItemGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 9c7d636d..dfb220cb 100644 --- a/docs/models/operations/createliverateglobals.md +++ b/docs/models/operations/createliverateglobals.md @@ -10,6 +10,6 @@ let value: CreateLiveRateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 bdcf90c4..1a5a335c 100644 --- a/docs/models/operations/createmanifestglobals.md +++ b/docs/models/operations/createmanifestglobals.md @@ -10,6 +10,6 @@ let value: CreateManifestGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 b6bb492e..ea743e3a 100644 --- a/docs/models/operations/createorderglobals.md +++ b/docs/models/operations/createorderglobals.md @@ -10,6 +10,6 @@ let value: CreateOrderGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 78cd0e1a..5df5e984 100644 --- a/docs/models/operations/createparcelglobals.md +++ b/docs/models/operations/createparcelglobals.md @@ -10,6 +10,6 @@ let value: CreateParcelGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 379a1cda..01c47a2f 100644 --- a/docs/models/operations/createpickupglobals.md +++ b/docs/models/operations/createpickupglobals.md @@ -10,6 +10,6 @@ let value: CreatePickupGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 d22f9122..59f74ab4 100644 --- a/docs/models/operations/createrefundglobals.md +++ b/docs/models/operations/createrefundglobals.md @@ -10,6 +10,6 @@ let value: CreateRefundGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 198c989f..016e95e2 100644 --- a/docs/models/operations/createservicegroupglobals.md +++ b/docs/models/operations/createservicegroupglobals.md @@ -10,6 +10,6 @@ let value: CreateServiceGroupGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 b53c7c46..4f4f6a81 100644 --- a/docs/models/operations/createshipmentglobals.md +++ b/docs/models/operations/createshipmentglobals.md @@ -10,6 +10,6 @@ let value: CreateShipmentGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 7e63f76b..fed151f7 100644 --- a/docs/models/operations/createshippoaccountglobals.md +++ b/docs/models/operations/createshippoaccountglobals.md @@ -10,6 +10,6 @@ let value: CreateShippoAccountGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 cc79dea3..4bb2f1d5 100644 --- a/docs/models/operations/createtrackglobals.md +++ b/docs/models/operations/createtrackglobals.md @@ -10,6 +10,6 @@ let value: CreateTrackGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 9e0a7000..899fc1fe 100644 --- a/docs/models/operations/createtransactionglobals.md +++ b/docs/models/operations/createtransactionglobals.md @@ -10,6 +10,6 @@ let value: CreateTransactionGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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/createtransactionrequestbody.md b/docs/models/operations/createtransactionrequestbody.md index f509877d..c7a06a15 100644 --- a/docs/models/operations/createtransactionrequestbody.md +++ b/docs/models/operations/createtransactionrequestbody.md @@ -248,6 +248,7 @@ let value: CreateTransactionRequestBody = { }, ], }, + order: "adcfdddf8ec64b84ad22772bce3ea37a", }; ``` diff --git a/docs/models/operations/createuserparceltemplateglobals.md b/docs/models/operations/createuserparceltemplateglobals.md index 8b2655f3..4029d92c 100644 --- a/docs/models/operations/createuserparceltemplateglobals.md +++ b/docs/models/operations/createuserparceltemplateglobals.md @@ -10,6 +10,6 @@ let value: CreateUserParcelTemplateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 413db2e0..d09e96e2 100644 --- a/docs/models/operations/deletedefaultparceltemplateglobals.md +++ b/docs/models/operations/deletedefaultparceltemplateglobals.md @@ -10,6 +10,6 @@ let value: DeleteDefaultParcelTemplateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 b9cff088..0322b316 100644 --- a/docs/models/operations/deleteservicegroupglobals.md +++ b/docs/models/operations/deleteservicegroupglobals.md @@ -10,6 +10,6 @@ let value: DeleteServiceGroupGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 e30822da..32bf31f8 100644 --- a/docs/models/operations/deleteuserparceltemplateglobals.md +++ b/docs/models/operations/deleteuserparceltemplateglobals.md @@ -10,6 +10,6 @@ let value: DeleteUserParcelTemplateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 eb2abea4..be68fccd 100644 --- a/docs/models/operations/getaddressglobals.md +++ b/docs/models/operations/getaddressglobals.md @@ -10,6 +10,6 @@ let value: GetAddressGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 c58c7583..68bc01cc 100644 --- a/docs/models/operations/getbatchglobals.md +++ b/docs/models/operations/getbatchglobals.md @@ -10,6 +10,6 @@ let value: GetBatchGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 c59e3c53..fd4f1977 100644 --- a/docs/models/operations/getcarrieraccountglobals.md +++ b/docs/models/operations/getcarrieraccountglobals.md @@ -10,6 +10,6 @@ let value: GetCarrierAccountGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 21327a94..2ef272b5 100644 --- a/docs/models/operations/getcarrierparceltemplateglobals.md +++ b/docs/models/operations/getcarrierparceltemplateglobals.md @@ -10,6 +10,6 @@ let value: GetCarrierParcelTemplateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 3a53cce0..7269174f 100644 --- a/docs/models/operations/getcarrierregistrationstatusglobals.md +++ b/docs/models/operations/getcarrierregistrationstatusglobals.md @@ -10,6 +10,6 @@ let value: GetCarrierRegistrationStatusGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 fe9a8115..1ccdd66e 100644 --- a/docs/models/operations/getcustomsdeclarationglobals.md +++ b/docs/models/operations/getcustomsdeclarationglobals.md @@ -10,6 +10,6 @@ let value: GetCustomsDeclarationGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 d3455d03..e3d6b62b 100644 --- a/docs/models/operations/getcustomsitemglobals.md +++ b/docs/models/operations/getcustomsitemglobals.md @@ -10,6 +10,6 @@ let value: GetCustomsItemGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 281dd582..6df59224 100644 --- a/docs/models/operations/getdefaultparceltemplateglobals.md +++ b/docs/models/operations/getdefaultparceltemplateglobals.md @@ -10,6 +10,6 @@ let value: GetDefaultParcelTemplateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 e74c55f3..b79e4dd4 100644 --- a/docs/models/operations/getmanifestglobals.md +++ b/docs/models/operations/getmanifestglobals.md @@ -10,6 +10,6 @@ let value: GetManifestGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 1a1c96e5..1cfe6476 100644 --- a/docs/models/operations/getorderglobals.md +++ b/docs/models/operations/getorderglobals.md @@ -10,6 +10,6 @@ let value: GetOrderGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 5a6affc5..2d6c3c4d 100644 --- a/docs/models/operations/getparcelglobals.md +++ b/docs/models/operations/getparcelglobals.md @@ -10,6 +10,6 @@ let value: GetParcelGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 c9dbb79e..4fff7b2d 100644 --- a/docs/models/operations/getrateglobals.md +++ b/docs/models/operations/getrateglobals.md @@ -10,6 +10,6 @@ let value: GetRateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 01ff6bce..896af5c0 100644 --- a/docs/models/operations/getrefundglobals.md +++ b/docs/models/operations/getrefundglobals.md @@ -10,6 +10,6 @@ let value: GetRefundGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 79f64d9c..ab85cd4b 100644 --- a/docs/models/operations/getshipmentglobals.md +++ b/docs/models/operations/getshipmentglobals.md @@ -10,6 +10,6 @@ let value: GetShipmentGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 16c613eb..3909afa8 100644 --- a/docs/models/operations/getshippoaccountglobals.md +++ b/docs/models/operations/getshippoaccountglobals.md @@ -10,6 +10,6 @@ let value: GetShippoAccountGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 bb8904af..b079c765 100644 --- a/docs/models/operations/gettrackglobals.md +++ b/docs/models/operations/gettrackglobals.md @@ -10,6 +10,6 @@ let value: GetTrackGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 da72f16a..bf005977 100644 --- a/docs/models/operations/gettransactionglobals.md +++ b/docs/models/operations/gettransactionglobals.md @@ -10,6 +10,6 @@ let value: GetTransactionGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 175606e8..e5f27ada 100644 --- a/docs/models/operations/getuserparceltemplateglobals.md +++ b/docs/models/operations/getuserparceltemplateglobals.md @@ -10,6 +10,6 @@ let value: GetUserParcelTemplateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 bb5a9d1e..12132f9e 100644 --- a/docs/models/operations/initiateoauth2signinglobals.md +++ b/docs/models/operations/initiateoauth2signinglobals.md @@ -10,6 +10,6 @@ let value: InitiateOauth2SigninGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 9d68604f..a4604411 100644 --- a/docs/models/operations/listaddressesglobals.md +++ b/docs/models/operations/listaddressesglobals.md @@ -10,6 +10,6 @@ let value: ListAddressesGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 4121c388..4a55f7e1 100644 --- a/docs/models/operations/listcarrieraccountsglobals.md +++ b/docs/models/operations/listcarrieraccountsglobals.md @@ -10,6 +10,6 @@ let value: ListCarrierAccountsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 9936c0a5..9a0d9654 100644 --- a/docs/models/operations/listcarrierparceltemplatesglobals.md +++ b/docs/models/operations/listcarrierparceltemplatesglobals.md @@ -10,6 +10,6 @@ let value: ListCarrierParcelTemplatesGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 47912209..2a18ea06 100644 --- a/docs/models/operations/listcustomsdeclarationsglobals.md +++ b/docs/models/operations/listcustomsdeclarationsglobals.md @@ -10,6 +10,6 @@ let value: ListCustomsDeclarationsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 b836c0f1..ed817aae 100644 --- a/docs/models/operations/listcustomsitemsglobals.md +++ b/docs/models/operations/listcustomsitemsglobals.md @@ -10,6 +10,6 @@ let value: ListCustomsItemsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 3bea799b..beddf908 100644 --- a/docs/models/operations/listmanifestsglobals.md +++ b/docs/models/operations/listmanifestsglobals.md @@ -10,6 +10,6 @@ let value: ListManifestsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 29f70437..e9800af8 100644 --- a/docs/models/operations/listordersglobals.md +++ b/docs/models/operations/listordersglobals.md @@ -10,6 +10,6 @@ let value: ListOrdersGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 b86200bb..a23ccfcf 100644 --- a/docs/models/operations/listparcelsglobals.md +++ b/docs/models/operations/listparcelsglobals.md @@ -10,6 +10,6 @@ let value: ListParcelsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 8e0648ea..5e29c8b0 100644 --- a/docs/models/operations/listrefundsglobals.md +++ b/docs/models/operations/listrefundsglobals.md @@ -10,6 +10,6 @@ let value: ListRefundsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 dce5b6b1..06e7cfd5 100644 --- a/docs/models/operations/listservicegroupsglobals.md +++ b/docs/models/operations/listservicegroupsglobals.md @@ -10,6 +10,6 @@ let value: ListServiceGroupsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 4917fbf5..ad7594e6 100644 --- a/docs/models/operations/listshipmentratesbycurrencycodeglobals.md +++ b/docs/models/operations/listshipmentratesbycurrencycodeglobals.md @@ -10,6 +10,6 @@ let value: ListShipmentRatesByCurrencyCodeGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 f5be4354..16e754b6 100644 --- a/docs/models/operations/listshipmentratesglobals.md +++ b/docs/models/operations/listshipmentratesglobals.md @@ -10,6 +10,6 @@ let value: ListShipmentRatesGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 aa835b95..4f236b2b 100644 --- a/docs/models/operations/listshipmentsglobals.md +++ b/docs/models/operations/listshipmentsglobals.md @@ -10,6 +10,6 @@ let value: ListShipmentsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 f66aec77..e67a3bd2 100644 --- a/docs/models/operations/listshippoaccountsglobals.md +++ b/docs/models/operations/listshippoaccountsglobals.md @@ -10,6 +10,6 @@ let value: ListShippoAccountsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 ba39b679..c0d9a0b5 100644 --- a/docs/models/operations/listtransactionsglobals.md +++ b/docs/models/operations/listtransactionsglobals.md @@ -10,6 +10,6 @@ let value: ListTransactionsGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 47be7065..86f8f8cf 100644 --- a/docs/models/operations/listuserparceltemplatesglobals.md +++ b/docs/models/operations/listuserparceltemplatesglobals.md @@ -10,6 +10,6 @@ let value: ListUserParcelTemplatesGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 a40cd8ae..642565ad 100644 --- a/docs/models/operations/purchasebatchglobals.md +++ b/docs/models/operations/purchasebatchglobals.md @@ -10,6 +10,6 @@ let value: PurchaseBatchGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 c07a9e55..edfcb7c3 100644 --- a/docs/models/operations/registercarrieraccountglobals.md +++ b/docs/models/operations/registercarrieraccountglobals.md @@ -10,6 +10,6 @@ let value: RegisterCarrierAccountGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 ffc56386..6a3e194e 100644 --- a/docs/models/operations/removeshipmentsfrombatchglobals.md +++ b/docs/models/operations/removeshipmentsfrombatchglobals.md @@ -10,6 +10,6 @@ let value: RemoveShipmentsFromBatchGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 e11178c7..2592f246 100644 --- a/docs/models/operations/updatecarrieraccountglobals.md +++ b/docs/models/operations/updatecarrieraccountglobals.md @@ -10,6 +10,6 @@ let value: UpdateCarrierAccountGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 4143f11c..9e6b0d0f 100644 --- a/docs/models/operations/updatedefaultparceltemplateglobals.md +++ b/docs/models/operations/updatedefaultparceltemplateglobals.md @@ -10,6 +10,6 @@ let value: UpdateDefaultParcelTemplateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 83083c4c..10ce2d0a 100644 --- a/docs/models/operations/updateservicegroupglobals.md +++ b/docs/models/operations/updateservicegroupglobals.md @@ -10,6 +10,6 @@ let value: UpdateServiceGroupGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 9727d7db..23644b08 100644 --- a/docs/models/operations/updateshippoaccountglobals.md +++ b/docs/models/operations/updateshippoaccountglobals.md @@ -10,6 +10,6 @@ let value: UpdateShippoAccountGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 bf9164b6..ab8b819f 100644 --- a/docs/models/operations/updateuserparceltemplateglobals.md +++ b/docs/models/operations/updateuserparceltemplateglobals.md @@ -10,6 +10,6 @@ let value: UpdateUserParcelTemplateGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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 d8a6aed0..ff94b378 100644 --- a/docs/models/operations/validateaddressglobals.md +++ b/docs/models/operations/validateaddressglobals.md @@ -10,6 +10,6 @@ let value: ValidateAddressGlobals = {}; ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shippoApiVersion` | *string* | :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 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `shippoApiVersion` | *string* | :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/carrieraccounts/README.md b/docs/sdks/carrieraccounts/README.md index 5ad30635..4d81961a 100644 --- a/docs/sdks/carrieraccounts/README.md +++ b/docs/sdks/carrieraccounts/README.md @@ -502,7 +502,7 @@ const shippo = new Shippo({ async function run() { const result = await shippo.carrierAccounts.register({ - carrier: "correos", + carrier: "ups", parameters: { billingAddressCity: "San Francisco", billingAddressCountryIso2: "US", @@ -521,7 +521,7 @@ async function run() { pickupAddressStreet1: "731 Market St", pickupAddressStreet2: "STE 200", pickupAddressZip: "94103", - upsAgreements: false, + upsAgreements: true, }, }); @@ -549,7 +549,7 @@ const shippo = new ShippoCore({ async function run() { const res = await carrierAccountsRegister(shippo, { - carrier: "correos", + carrier: "ups", parameters: { billingAddressCity: "San Francisco", billingAddressCountryIso2: "US", @@ -568,7 +568,7 @@ async function run() { pickupAddressStreet1: "731 Market St", pickupAddressStreet2: "STE 200", pickupAddressZip: "94103", - upsAgreements: false, + upsAgreements: true, }, }); diff --git a/docs/sdks/shippoaccounts/README.md b/docs/sdks/shippoaccounts/README.md index 9ad83920..d9f559ee 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 @@ -93,7 +93,7 @@ run(); ## create -Creates a Shippo Account object +Creates a new Shippo Managed Account. ### Example Usage @@ -178,7 +178,7 @@ run(); ## get -Returns a Shippo Account using an object ID +Returns a Shippo Managed Account using an object ID. ### Example Usage @@ -253,7 +253,7 @@ run(); ## update -Updates a Shippo Account object +Updates a Shippo Managed Account using an object ID. ### Example Usage diff --git a/docs/sdks/transactions/README.md b/docs/sdks/transactions/README.md index 877f90f5..95505249 100644 --- a/docs/sdks/transactions/README.md +++ b/docs/sdks/transactions/README.md @@ -113,6 +113,7 @@ async function run() { labelFileType: "PDF_4x6", metadata: "Order ID #12345", rate: "ec9f0d3adc9441449c85d315f0997fd5", + order: "adcfdddf8ec64b84ad22772bce3ea37a", }); // Handle the result @@ -143,6 +144,7 @@ async function run() { labelFileType: "PDF_4x6", metadata: "Order ID #12345", rate: "ec9f0d3adc9441449c85d315f0997fd5", + order: "adcfdddf8ec64b84ad22772bce3ea37a", }); if (!res.ok) { diff --git a/jsr.json b/jsr.json index c3d0fdb7..69e968d8 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "shippo", - "version": "2.7.0", + "version": "2.9.0", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index f76e18ca..e8d060f6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "shippo", - "version": "2.7.0", + "version": "2.9.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "shippo", - "version": "2.7.0", + "version": "2.9.0", "license": "MIT", "devDependencies": { "@types/chai": "^4.3.14", diff --git a/package.json b/package.json index 029c8561..a7c3708d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shippo", - "version": "2.7.0", + "version": "2.9.0", "author": "Shippo", "license": "MIT", "main": "./index.js", diff --git a/src/funcs/shippoAccountsCreate.ts b/src/funcs/shippoAccountsCreate.ts index 474546ba..138445f6 100644 --- a/src/funcs/shippoAccountsCreate.ts +++ b/src/funcs/shippoAccountsCreate.ts @@ -25,7 +25,7 @@ import { Result } from "../types/fp.js"; * Create a Shippo Account * * @remarks - * Creates a Shippo Account object + * Creates a new Shippo Managed Account. */ export async function shippoAccountsCreate( client: ShippoCore, diff --git a/src/funcs/shippoAccountsGet.ts b/src/funcs/shippoAccountsGet.ts index 4c451baf..b378bed9 100644 --- a/src/funcs/shippoAccountsGet.ts +++ b/src/funcs/shippoAccountsGet.ts @@ -26,7 +26,7 @@ import { Result } from "../types/fp.js"; * Retrieve a Shippo Account * * @remarks - * Returns a Shippo Account using an object ID + * Returns a Shippo Managed Account using an object ID. */ export async function shippoAccountsGet( client: ShippoCore, diff --git a/src/funcs/shippoAccountsList.ts b/src/funcs/shippoAccountsList.ts index 2b9513e1..64e4100b 100644 --- a/src/funcs/shippoAccountsList.ts +++ b/src/funcs/shippoAccountsList.ts @@ -26,7 +26,7 @@ import { Result } from "../types/fp.js"; * List all Shippo Accounts * * @remarks - * Returns a list of Shippo Accounts objects + * Returns a list of Shippo Managed Accounts objects. */ export async function shippoAccountsList( client: ShippoCore, diff --git a/src/funcs/shippoAccountsUpdate.ts b/src/funcs/shippoAccountsUpdate.ts index 77ee473c..66eb2892 100644 --- a/src/funcs/shippoAccountsUpdate.ts +++ b/src/funcs/shippoAccountsUpdate.ts @@ -26,7 +26,7 @@ import { Result } from "../types/fp.js"; * Update a Shippo Account * * @remarks - * Updates a Shippo Account object + * Updates a Shippo Managed Account using an object ID. */ export async function shippoAccountsUpdate( client: ShippoCore, diff --git a/src/lib/config.ts b/src/lib/config.ts index c75bc293..c5199d4e 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -59,7 +59,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "2018-02-08", - sdkVersion: "2.7.0", + sdkVersion: "2.9.0", genVersion: "2.421.3", - userAgent: "speakeasy-sdk/typescript 2.7.0 2.421.3 2018-02-08 shippo", + userAgent: "speakeasy-sdk/typescript 2.9.0 2.421.3 2018-02-08 shippo", } as const; diff --git a/src/models/components/instanttransactioncreaterequest.ts b/src/models/components/instanttransactioncreaterequest.ts index b258fd93..9911e02b 100644 --- a/src/models/components/instanttransactioncreaterequest.ts +++ b/src/models/components/instanttransactioncreaterequest.ts @@ -32,6 +32,7 @@ export type InstantTransactionCreateRequest = { metadata?: string | undefined; servicelevelToken: string; shipment: ShipmentCreateRequest; + order?: string | undefined; }; /** @internal */ @@ -67,6 +68,7 @@ export const InstantTransactionCreateRequest$inboundSchema: z.ZodType< metadata: z.string().optional(), servicelevel_token: z.string(), shipment: ShipmentCreateRequest$inboundSchema, + order: z.string().optional(), }).transform((v) => { return remap$(v, { "carrier_account": "carrierAccount", @@ -83,6 +85,7 @@ export type InstantTransactionCreateRequest$Outbound = { metadata?: string | undefined; servicelevel_token: string; shipment: ShipmentCreateRequest$Outbound; + order?: string | undefined; }; /** @internal */ @@ -97,6 +100,7 @@ export const InstantTransactionCreateRequest$outboundSchema: z.ZodType< metadata: z.string().optional(), servicelevelToken: z.string(), shipment: ShipmentCreateRequest$outboundSchema, + order: z.string().optional(), }).transform((v) => { return remap$(v, { carrierAccount: "carrier_account", diff --git a/src/models/components/servicegroup.ts b/src/models/components/servicegroup.ts index 911bbb03..e5a6b42b 100644 --- a/src/models/components/servicegroup.ts +++ b/src/models/components/servicegroup.ts @@ -4,17 +4,17 @@ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; +import { + ServiceGroupAccountAndServiceLevel, + ServiceGroupAccountAndServiceLevel$inboundSchema, + ServiceGroupAccountAndServiceLevel$Outbound, + ServiceGroupAccountAndServiceLevel$outboundSchema, +} from "./servicegroupaccountandservicelevel.js"; import { ServiceGroupTypeEnum, ServiceGroupTypeEnum$inboundSchema, ServiceGroupTypeEnum$outboundSchema, } from "./servicegrouptypeenum.js"; -import { - ServiceLevelWithParent, - ServiceLevelWithParent$inboundSchema, - ServiceLevelWithParent$Outbound, - ServiceLevelWithParent$outboundSchema, -} from "./servicelevelwithparent.js"; export type ServiceGroup = { /** @@ -72,7 +72,7 @@ export type ServiceGroup = { * True if the service group is enabled, false otherwise. */ isActive?: boolean | undefined; - serviceLevels: Array; + serviceLevels: Array; }; /** @internal */ @@ -91,7 +91,7 @@ export const ServiceGroup$inboundSchema: z.ZodType< type: ServiceGroupTypeEnum$inboundSchema, object_id: z.string(), is_active: z.boolean().optional(), - service_levels: z.array(ServiceLevelWithParent$inboundSchema), + service_levels: z.array(ServiceGroupAccountAndServiceLevel$inboundSchema), }).transform((v) => { return remap$(v, { "flat_rate": "flatRate", @@ -117,7 +117,7 @@ export type ServiceGroup$Outbound = { type: string; object_id: string; is_active?: boolean | undefined; - service_levels: Array; + service_levels: Array; }; /** @internal */ @@ -136,7 +136,7 @@ export const ServiceGroup$outboundSchema: z.ZodType< type: ServiceGroupTypeEnum$outboundSchema, objectId: z.string(), isActive: z.boolean().optional(), - serviceLevels: z.array(ServiceLevelWithParent$outboundSchema), + serviceLevels: z.array(ServiceGroupAccountAndServiceLevel$outboundSchema), }).transform((v) => { return remap$(v, { flatRate: "flat_rate", diff --git a/src/models/components/servicelevelcanadapostenum.ts b/src/models/components/servicelevelcanadapostenum.ts index e587df7f..8ef7aa5b 100644 --- a/src/models/components/servicelevelcanadapostenum.ts +++ b/src/models/components/servicelevelcanadapostenum.ts @@ -21,6 +21,9 @@ import { ClosedEnum } from "../../types/enums.js"; * | canada_post_small_packet_usa_air | Small Packet USA Air| * | canada_post_tracked_packet_international | Tracked Packet International| * | canada_post_small_packet_international_air | Small Package International Air| + * | canada_post_small_packet_international_surface | Small Packet International Surface + * | canada_post_international_parcel_surface | International Parcel Surface + * | canada_post_international_parcel_air | International Parcel Air */ export const ServiceLevelCanadaPostEnum = { CanadaPostRegularParcel: "canada_post_regular_parcel", @@ -36,6 +39,11 @@ export const ServiceLevelCanadaPostEnum = { "canada_post_tracked_packet_international", CanadaPostSmallPacketInternationalAir: "canada_post_small_packet_international_air", + CanadaPostSmallPacketInternationalSurface: + "canada_post_small_packet_international_surface", + CanadaPostInternationalParcelSurface: + "canada_post_international_parcel_surface", + CanadaPostInternationalParcelAir: "canada_post_international_parcel_air", } as const; /** * |Token | Service name| @@ -53,6 +61,9 @@ export const ServiceLevelCanadaPostEnum = { * | canada_post_small_packet_usa_air | Small Packet USA Air| * | canada_post_tracked_packet_international | Tracked Packet International| * | canada_post_small_packet_international_air | Small Package International Air| + * | canada_post_small_packet_international_surface | Small Packet International Surface + * | canada_post_international_parcel_surface | International Parcel Surface + * | canada_post_international_parcel_air | International Parcel Air */ export type ServiceLevelCanadaPostEnum = ClosedEnum< typeof ServiceLevelCanadaPostEnum diff --git a/src/models/components/transactioncreaterequest.ts b/src/models/components/transactioncreaterequest.ts index 4fb73cf1..b53c5127 100644 --- a/src/models/components/transactioncreaterequest.ts +++ b/src/models/components/transactioncreaterequest.ts @@ -21,6 +21,7 @@ export type TransactionCreateRequest = { labelFileType?: LabelFileTypeEnum | undefined; metadata?: string | undefined; rate: string; + order?: string | undefined; }; /** @internal */ @@ -33,6 +34,7 @@ export const TransactionCreateRequest$inboundSchema: z.ZodType< label_file_type: LabelFileTypeEnum$inboundSchema.optional(), metadata: z.string().optional(), rate: z.string(), + order: z.string().optional(), }).transform((v) => { return remap$(v, { "label_file_type": "labelFileType", @@ -45,6 +47,7 @@ export type TransactionCreateRequest$Outbound = { label_file_type?: string | undefined; metadata?: string | undefined; rate: string; + order?: string | undefined; }; /** @internal */ @@ -57,6 +60,7 @@ export const TransactionCreateRequest$outboundSchema: z.ZodType< labelFileType: LabelFileTypeEnum$outboundSchema.optional(), metadata: z.string().optional(), rate: z.string(), + order: z.string().optional(), }).transform((v) => { return remap$(v, { labelFileType: "label_file_type", diff --git a/src/models/operations/addshipmentstobatch.ts b/src/models/operations/addshipmentstobatch.ts index 1b40d305..0c224a12 100644 --- a/src/models/operations/addshipmentstobatch.ts +++ b/src/models/operations/addshipmentstobatch.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type AddShipmentsToBatchGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createaddress.ts b/src/models/operations/createaddress.ts index 3fc3244a..edb63cf1 100644 --- a/src/models/operations/createaddress.ts +++ b/src/models/operations/createaddress.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateAddressGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createbatch.ts b/src/models/operations/createbatch.ts index dcba4a03..4ddb82fd 100644 --- a/src/models/operations/createbatch.ts +++ b/src/models/operations/createbatch.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateBatchGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createcarrieraccount.ts b/src/models/operations/createcarrieraccount.ts index 1bf6b810..2f35684d 100644 --- a/src/models/operations/createcarrieraccount.ts +++ b/src/models/operations/createcarrieraccount.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateCarrierAccountGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createcustomsdeclaration.ts b/src/models/operations/createcustomsdeclaration.ts index edd0f37e..51d18ca9 100644 --- a/src/models/operations/createcustomsdeclaration.ts +++ b/src/models/operations/createcustomsdeclaration.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateCustomsDeclarationGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createcustomsitem.ts b/src/models/operations/createcustomsitem.ts index 609b62ce..89c87b88 100644 --- a/src/models/operations/createcustomsitem.ts +++ b/src/models/operations/createcustomsitem.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateCustomsItemGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createliverate.ts b/src/models/operations/createliverate.ts index 32dcb8ed..2e26b621 100644 --- a/src/models/operations/createliverate.ts +++ b/src/models/operations/createliverate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateLiveRateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createmanifest.ts b/src/models/operations/createmanifest.ts index 4a4d457e..0e3c2ae0 100644 --- a/src/models/operations/createmanifest.ts +++ b/src/models/operations/createmanifest.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateManifestGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createorder.ts b/src/models/operations/createorder.ts index 954b6176..a41ea301 100644 --- a/src/models/operations/createorder.ts +++ b/src/models/operations/createorder.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateOrderGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createparcel.ts b/src/models/operations/createparcel.ts index 5ea7169d..f9e508ab 100644 --- a/src/models/operations/createparcel.ts +++ b/src/models/operations/createparcel.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type CreateParcelGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createpickup.ts b/src/models/operations/createpickup.ts index 0a2b5c22..4af9852e 100644 --- a/src/models/operations/createpickup.ts +++ b/src/models/operations/createpickup.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreatePickupGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createrefund.ts b/src/models/operations/createrefund.ts index 5e6b3f17..522c5455 100644 --- a/src/models/operations/createrefund.ts +++ b/src/models/operations/createrefund.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateRefundGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createservicegroup.ts b/src/models/operations/createservicegroup.ts index bac1b070..1d423de6 100644 --- a/src/models/operations/createservicegroup.ts +++ b/src/models/operations/createservicegroup.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateServiceGroupGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createshipment.ts b/src/models/operations/createshipment.ts index e73ba1cd..e3e43fb3 100644 --- a/src/models/operations/createshipment.ts +++ b/src/models/operations/createshipment.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateShipmentGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createshippoaccount.ts b/src/models/operations/createshippoaccount.ts index c4227e42..a467905b 100644 --- a/src/models/operations/createshippoaccount.ts +++ b/src/models/operations/createshippoaccount.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateShippoAccountGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createtrack.ts b/src/models/operations/createtrack.ts index b6458cc9..7355f836 100644 --- a/src/models/operations/createtrack.ts +++ b/src/models/operations/createtrack.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateTrackGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createtransaction.ts b/src/models/operations/createtransaction.ts index cdde030d..d41c99f3 100644 --- a/src/models/operations/createtransaction.ts +++ b/src/models/operations/createtransaction.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type CreateTransactionGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/createuserparceltemplate.ts b/src/models/operations/createuserparceltemplate.ts index f3f264ae..0e649de0 100644 --- a/src/models/operations/createuserparceltemplate.ts +++ b/src/models/operations/createuserparceltemplate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type CreateUserParcelTemplateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/deletedefaultparceltemplate.ts b/src/models/operations/deletedefaultparceltemplate.ts index 9f398bef..e2f87c88 100644 --- a/src/models/operations/deletedefaultparceltemplate.ts +++ b/src/models/operations/deletedefaultparceltemplate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type DeleteDefaultParcelTemplateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/deleteservicegroup.ts b/src/models/operations/deleteservicegroup.ts index 01577317..c4120c42 100644 --- a/src/models/operations/deleteservicegroup.ts +++ b/src/models/operations/deleteservicegroup.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type DeleteServiceGroupGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/deleteuserparceltemplate.ts b/src/models/operations/deleteuserparceltemplate.ts index 5d155b49..3efada72 100644 --- a/src/models/operations/deleteuserparceltemplate.ts +++ b/src/models/operations/deleteuserparceltemplate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type DeleteUserParcelTemplateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getaddress.ts b/src/models/operations/getaddress.ts index b9e7bd17..6b9a6b97 100644 --- a/src/models/operations/getaddress.ts +++ b/src/models/operations/getaddress.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetAddressGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getbatch.ts b/src/models/operations/getbatch.ts index 9c110667..ceb4ed9a 100644 --- a/src/models/operations/getbatch.ts +++ b/src/models/operations/getbatch.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetBatchGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getcarrieraccount.ts b/src/models/operations/getcarrieraccount.ts index 644e8ae9..f6e8dade 100644 --- a/src/models/operations/getcarrieraccount.ts +++ b/src/models/operations/getcarrieraccount.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetCarrierAccountGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getcarrierparceltemplate.ts b/src/models/operations/getcarrierparceltemplate.ts index 19e3d44a..133469e7 100644 --- a/src/models/operations/getcarrierparceltemplate.ts +++ b/src/models/operations/getcarrierparceltemplate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetCarrierParcelTemplateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getcarrierregistrationstatus.ts b/src/models/operations/getcarrierregistrationstatus.ts index e57b19a8..ce8ee724 100644 --- a/src/models/operations/getcarrierregistrationstatus.ts +++ b/src/models/operations/getcarrierregistrationstatus.ts @@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js"; export type GetCarrierRegistrationStatusGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getcustomsdeclaration.ts b/src/models/operations/getcustomsdeclaration.ts index 36e90448..649ebad9 100644 --- a/src/models/operations/getcustomsdeclaration.ts +++ b/src/models/operations/getcustomsdeclaration.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetCustomsDeclarationGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getcustomsitem.ts b/src/models/operations/getcustomsitem.ts index 6c7ba093..86ddd369 100644 --- a/src/models/operations/getcustomsitem.ts +++ b/src/models/operations/getcustomsitem.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetCustomsItemGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getdefaultparceltemplate.ts b/src/models/operations/getdefaultparceltemplate.ts index 990a302f..1d677c95 100644 --- a/src/models/operations/getdefaultparceltemplate.ts +++ b/src/models/operations/getdefaultparceltemplate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetDefaultParcelTemplateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getmanifest.ts b/src/models/operations/getmanifest.ts index 2e074e2c..6a731aab 100644 --- a/src/models/operations/getmanifest.ts +++ b/src/models/operations/getmanifest.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetManifestGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getorder.ts b/src/models/operations/getorder.ts index bab99078..d5d09ada 100644 --- a/src/models/operations/getorder.ts +++ b/src/models/operations/getorder.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetOrderGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getparcel.ts b/src/models/operations/getparcel.ts index 8195d07b..ece2b607 100644 --- a/src/models/operations/getparcel.ts +++ b/src/models/operations/getparcel.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetParcelGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getrate.ts b/src/models/operations/getrate.ts index 1a4b5edb..dc31e2a2 100644 --- a/src/models/operations/getrate.ts +++ b/src/models/operations/getrate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetRateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getrefund.ts b/src/models/operations/getrefund.ts index 91cafc1a..b6605eb2 100644 --- a/src/models/operations/getrefund.ts +++ b/src/models/operations/getrefund.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetRefundGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getshipment.ts b/src/models/operations/getshipment.ts index 19647e7e..1f44c230 100644 --- a/src/models/operations/getshipment.ts +++ b/src/models/operations/getshipment.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetShipmentGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getshippoaccount.ts b/src/models/operations/getshippoaccount.ts index d68da09b..29ccafbf 100644 --- a/src/models/operations/getshippoaccount.ts +++ b/src/models/operations/getshippoaccount.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetShippoAccountGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/gettrack.ts b/src/models/operations/gettrack.ts index 309bffc0..c317990c 100644 --- a/src/models/operations/gettrack.ts +++ b/src/models/operations/gettrack.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetTrackGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/gettransaction.ts b/src/models/operations/gettransaction.ts index 8c382578..807f8a5a 100644 --- a/src/models/operations/gettransaction.ts +++ b/src/models/operations/gettransaction.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetTransactionGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/getuserparceltemplate.ts b/src/models/operations/getuserparceltemplate.ts index 2b5b34be..0837ec5a 100644 --- a/src/models/operations/getuserparceltemplate.ts +++ b/src/models/operations/getuserparceltemplate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type GetUserParcelTemplateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/initiateoauth2signin.ts b/src/models/operations/initiateoauth2signin.ts index 891d0319..ef37f862 100644 --- a/src/models/operations/initiateoauth2signin.ts +++ b/src/models/operations/initiateoauth2signin.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type InitiateOauth2SigninGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listaddresses.ts b/src/models/operations/listaddresses.ts index a316cad6..e2ae72ec 100644 --- a/src/models/operations/listaddresses.ts +++ b/src/models/operations/listaddresses.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListAddressesGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listcarrieraccounts.ts b/src/models/operations/listcarrieraccounts.ts index 4d4a04a1..e9a10a9a 100644 --- a/src/models/operations/listcarrieraccounts.ts +++ b/src/models/operations/listcarrieraccounts.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type ListCarrierAccountsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listcarrierparceltemplates.ts b/src/models/operations/listcarrierparceltemplates.ts index c15842cc..13eebf18 100644 --- a/src/models/operations/listcarrierparceltemplates.ts +++ b/src/models/operations/listcarrierparceltemplates.ts @@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js"; export type ListCarrierParcelTemplatesGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listcustomsdeclarations.ts b/src/models/operations/listcustomsdeclarations.ts index 171e5a04..136f6c2f 100644 --- a/src/models/operations/listcustomsdeclarations.ts +++ b/src/models/operations/listcustomsdeclarations.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListCustomsDeclarationsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listcustomsitems.ts b/src/models/operations/listcustomsitems.ts index 866f1132..05d7453c 100644 --- a/src/models/operations/listcustomsitems.ts +++ b/src/models/operations/listcustomsitems.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListCustomsItemsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listmanifests.ts b/src/models/operations/listmanifests.ts index bb7f3386..a9196baf 100644 --- a/src/models/operations/listmanifests.ts +++ b/src/models/operations/listmanifests.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListManifestsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listorders.ts b/src/models/operations/listorders.ts index ab7f3d13..5fdaa8ba 100644 --- a/src/models/operations/listorders.ts +++ b/src/models/operations/listorders.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type ListOrdersGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listparcels.ts b/src/models/operations/listparcels.ts index 5f6170ea..2b314652 100644 --- a/src/models/operations/listparcels.ts +++ b/src/models/operations/listparcels.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListParcelsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listrefunds.ts b/src/models/operations/listrefunds.ts index 03eb87a4..16b75970 100644 --- a/src/models/operations/listrefunds.ts +++ b/src/models/operations/listrefunds.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListRefundsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listservicegroups.ts b/src/models/operations/listservicegroups.ts index b5196e9a..d51ff361 100644 --- a/src/models/operations/listservicegroups.ts +++ b/src/models/operations/listservicegroups.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListServiceGroupsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listshipmentrates.ts b/src/models/operations/listshipmentrates.ts index 0557130d..ccc9ab3c 100644 --- a/src/models/operations/listshipmentrates.ts +++ b/src/models/operations/listshipmentrates.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListShipmentRatesGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listshipmentratesbycurrencycode.ts b/src/models/operations/listshipmentratesbycurrencycode.ts index ff783e4d..f14e9fec 100644 --- a/src/models/operations/listshipmentratesbycurrencycode.ts +++ b/src/models/operations/listshipmentratesbycurrencycode.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListShipmentRatesByCurrencyCodeGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listshipments.ts b/src/models/operations/listshipments.ts index cbd615ae..a4c5c960 100644 --- a/src/models/operations/listshipments.ts +++ b/src/models/operations/listshipments.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListShipmentsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listshippoaccounts.ts b/src/models/operations/listshippoaccounts.ts index 1bc0c9cc..1a7fcec0 100644 --- a/src/models/operations/listshippoaccounts.ts +++ b/src/models/operations/listshippoaccounts.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListShippoAccountsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listtransactions.ts b/src/models/operations/listtransactions.ts index a873010f..dac94e7b 100644 --- a/src/models/operations/listtransactions.ts +++ b/src/models/operations/listtransactions.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type ListTransactionsGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/listuserparceltemplates.ts b/src/models/operations/listuserparceltemplates.ts index cb6685ce..9dd876d9 100644 --- a/src/models/operations/listuserparceltemplates.ts +++ b/src/models/operations/listuserparceltemplates.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ListUserParcelTemplatesGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/purchasebatch.ts b/src/models/operations/purchasebatch.ts index 3cf9ea59..725f9365 100644 --- a/src/models/operations/purchasebatch.ts +++ b/src/models/operations/purchasebatch.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type PurchaseBatchGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/registercarrieraccount.ts b/src/models/operations/registercarrieraccount.ts index 8d7391b2..c78e06dd 100644 --- a/src/models/operations/registercarrieraccount.ts +++ b/src/models/operations/registercarrieraccount.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type RegisterCarrierAccountGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/removeshipmentsfrombatch.ts b/src/models/operations/removeshipmentsfrombatch.ts index dba49ceb..62bbf3f9 100644 --- a/src/models/operations/removeshipmentsfrombatch.ts +++ b/src/models/operations/removeshipmentsfrombatch.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type RemoveShipmentsFromBatchGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/updatecarrieraccount.ts b/src/models/operations/updatecarrieraccount.ts index ccfd1de7..4867f061 100644 --- a/src/models/operations/updatecarrieraccount.ts +++ b/src/models/operations/updatecarrieraccount.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type UpdateCarrierAccountGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/updatedefaultparceltemplate.ts b/src/models/operations/updatedefaultparceltemplate.ts index 18877cb8..1e66563d 100644 --- a/src/models/operations/updatedefaultparceltemplate.ts +++ b/src/models/operations/updatedefaultparceltemplate.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type UpdateDefaultParcelTemplateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/updateservicegroup.ts b/src/models/operations/updateservicegroup.ts index bcfe1ed8..490cd3e3 100644 --- a/src/models/operations/updateservicegroup.ts +++ b/src/models/operations/updateservicegroup.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type UpdateServiceGroupGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/updateshippoaccount.ts b/src/models/operations/updateshippoaccount.ts index f7ff3603..5ab47636 100644 --- a/src/models/operations/updateshippoaccount.ts +++ b/src/models/operations/updateshippoaccount.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type UpdateShippoAccountGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/updateuserparceltemplate.ts b/src/models/operations/updateuserparceltemplate.ts index 430fe109..297dd53f 100644 --- a/src/models/operations/updateuserparceltemplate.ts +++ b/src/models/operations/updateuserparceltemplate.ts @@ -8,7 +8,7 @@ import * as components from "../components/index.js"; export type UpdateUserParcelTemplateGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/models/operations/validateaddress.ts b/src/models/operations/validateaddress.ts index 93376307..be9a48f6 100644 --- a/src/models/operations/validateaddress.ts +++ b/src/models/operations/validateaddress.ts @@ -7,7 +7,7 @@ import { remap as remap$ } from "../../lib/primitives.js"; export type ValidateAddressGlobals = { /** - * String used to pick a non-default API version to use + * Optional string used to pick a non-default API version to use. See our API version guide. */ shippoApiVersion?: string | undefined; }; diff --git a/src/sdk/shippoaccounts.ts b/src/sdk/shippoaccounts.ts index 917e4d6e..d725965c 100644 --- a/src/sdk/shippoaccounts.ts +++ b/src/sdk/shippoaccounts.ts @@ -15,7 +15,7 @@ export class ShippoAccounts extends ClientSDK { * List all Shippo Accounts * * @remarks - * Returns a list of Shippo Accounts objects + * Returns a list of Shippo Managed Accounts objects. */ async list( page?: number | undefined, @@ -34,7 +34,7 @@ export class ShippoAccounts extends ClientSDK { * Create a Shippo Account * * @remarks - * Creates a Shippo Account object + * Creates a new Shippo Managed Account. */ async create( request: components.ShippoAccountUpdateRequest, @@ -51,7 +51,7 @@ export class ShippoAccounts extends ClientSDK { * Retrieve a Shippo Account * * @remarks - * Returns a Shippo Account using an object ID + * Returns a Shippo Managed Account using an object ID. */ async get( shippoAccountId: string, @@ -68,7 +68,7 @@ export class ShippoAccounts extends ClientSDK { * Update a Shippo Account * * @remarks - * Updates a Shippo Account object + * Updates a Shippo Managed Account using an object ID. */ async update( shippoAccountId: string, diff --git a/test/address.test.ts b/test/address.test.ts new file mode 100644 index 00000000..3b411e94 --- /dev/null +++ b/test/address.test.ts @@ -0,0 +1,24 @@ +import {expect} from 'chai'; +import {describe, it} from 'mocha'; +import {shippoSdk} from "./helpers"; + +describe('TestAddresses', function() { + it('testCreateAddress', async () => { + const address = await shippoSdk.addresses.create({ + name: 'Rachael', + street1: '1092 Indian Summer Ct', + city: 'San Jose', + state: 'CA', + zip: '95122', + country: 'US', + phone: '4159876543', + email: 'rachael@alltheyarnz.com' + }) + + expect(address).to.not.be.null; + expect(address).to.be.an('object'); + expect(address).to.have.property('objectId').that.is.a('string'); + expect(address).to.have.property('name').that.is.equal('Rachael') + expect(address).to.have.property('country').that.is.equal('US'); + }) +}) \ No newline at end of file diff --git a/test/instalabel.test.ts b/test/instalabel.test.ts index e570550a..9bba323c 100644 --- a/test/instalabel.test.ts +++ b/test/instalabel.test.ts @@ -7,41 +7,52 @@ describe('TestInstalabel', function() { it('testInstalabel', async () => { const carrierAccount = await getCarrierAccount(CarriersEnum.Usps); + const addressFrom = await shippoSdk.addresses.create({ + name: "Rachael", + street1: "1092 Indian Summer Ct", + city: "San Jose", + state: "CA", + zip: "95122", + country: "US", + phone: "4159876543", + email: "rachael@alltheyarnz.com" + }) + + const addressTo = await shippoSdk.addresses.create({ + name: "Mr Hippo", + street1: "965 Mission St #572", + city: "San Francisco", + state: "CA", + zip: "94103", + country: "US", + phone: "4151234567", + email: "mrhippo@shippo.com" + }) + + const parcel = await shippoSdk.parcels.create( + { + length: "5", + width: "5", + height: "5", + distanceUnit: DistanceUnitEnum.Cm, + weight: "2", + massUnit: WeightUnitEnum.Lb + } + ) + + const shipment = await shippoSdk.shipments.create( + { + addressFrom: addressFrom, + addressTo: addressTo, + parcels: [ + parcel + ] + }); + const transaction = await shippoSdk.transactions.create({ carrierAccount: carrierAccount.objectId, servicelevelToken: "usps_ground_advantage", - shipment: { - addressFrom: { - name: "Rachael", - street1: "1092 Indian Summer Ct", - city: "San Jose", - state: "CA", - zip: "95122", - country: "US", - phone: "4159876543", - email: "rachael@alltheyarnz.com" - }, - addressTo: { - name: "Mr Hippo", - street1: "965 Mission St #572", - city: "San Francisco", - state: "CA", - zip: "94103", - country: "US", - phone: "4151234567", - email: "mrhippo@shippo.com" - }, - parcels: [ - { - length: "5", - width: "5", - height: "5", - distanceUnit: DistanceUnitEnum.Cm, - weight: "2", - massUnit: WeightUnitEnum.Lb - } - ] - } + shipment: shipment }); expect(transaction).to.not.be.null; diff --git a/test/serviceGroup.test.ts b/test/serviceGroup.test.ts new file mode 100644 index 00000000..9735d2cc --- /dev/null +++ b/test/serviceGroup.test.ts @@ -0,0 +1,24 @@ +import {expect} from 'chai'; +import {describe, it} from 'mocha'; +import {shippoSdk} from "./helpers"; + +describe('TestListServiceGroups', function() { + it('testListServiceGroups', async() => { + const result = await shippoSdk.serviceGroups.list(); + + expect(result).to.not.be.null; + expect(result).to.be.an('array'); + expect(result).to.have.length.greaterThan(0); + + const firstServiceGroup = result[0]; + expect(firstServiceGroup).to.be.an('object'); + expect(firstServiceGroup).to.have.property('objectId').that.is.a('string'); + expect(firstServiceGroup).to.have.property('name').that.is.a('string'); + expect(firstServiceGroup).to.have.property('description').that.is.a('string'); + expect(firstServiceGroup).to.have.property('serviceLevels').that.is.an('array'); + + const firstServiceLevel = firstServiceGroup.serviceLevels[0]; + expect(firstServiceLevel).to.have.property('accountObjectId').that.is.a('string'); + expect(firstServiceLevel).to.have.property('serviceLevelToken').that.is.an('string'); + }) +}) \ No newline at end of file