chore: 🐝 Update SDK - Generate 2.15.0 (#95)

* fix:SARCH-64 - added tests to verify serialization of carrier registration parameters.

* Restored token to shippoSdk creation.

* Restored param name as well.

* 😠 forgot to put it in an object

* ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.476.2

---------

Co-authored-by: Andy Hopper <[email protected]>
Co-authored-by: speakeasybot <[email protected]>
Co-authored-by: Randall Keur <[email protected]>

Author: 4 people

.gitignore

@@ -1,3 +1,5 @@
+/react-query
+/.speakeasy/reports
 /funcs
 /core.*
 /__tests__

.npmignore

@@ -1,6 +1,10 @@
 **/*
+!/FUNCTIONS.md
+!/RUNTIMES.md
+!/REACT_QUERY.md
 !/**/*.ts
 !/**/*.js
+!/**/*.json
 !/**/*.map
 
 /.eslintrc.js

.speakeasy/gen.lock

@@ -11,8 +11,9 @@ generation:
     requestResponseComponentNamesFeb2024: true
   auth:
     oAuth2ClientCredentialsEnabled: true
+    oAuth2PasswordEnabled: false
 typescript:
-  version: 2.14.1
+  version: 2.15.0
   additionalDependencies:
     dependencies: {}
     devDependencies:
@@ -27,6 +28,7 @@ typescript:
   author: Shippo
   clientServerStatusCodesAsErrors: true
   defaultErrorName: SDKError
+  enableCustomCodeRegions: false
   enableReactQuery: false
   enumFormat: union
   flattenGlobalSecurity: true

.speakeasy/gen.yaml

@@ -1,20 +1,21 @@
-speakeasyVersion: 1.401.2
+speakeasyVersion: 1.476.2
 sources:
     openapi:
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:67380a5740d2ebf50c6b5d4ecd48d398c184e281c8302c0d0306220da7535048
-        sourceBlobDigest: sha256:d1d1d6dbb27ba9c1d86549fa879da10167c9890d2d3443c087c7b8555971a12c
+        sourceRevisionDigest: sha256:a97e08b53dbf31ed912244acc6e5a635c88662f3ee098bdfbf2f5ca6735da649
+        sourceBlobDigest: sha256:9331910575a380f9073bf9d31fb81996067da3d0ee449b0513dbe10790790b37
         tags:
             - latest
-            - main
+            - speakeasy-sdk-regen-1732753737
+            - "2018-02-08"
 targets:
     first-target:
         source: openapi
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:67380a5740d2ebf50c6b5d4ecd48d398c184e281c8302c0d0306220da7535048
-        sourceBlobDigest: sha256:d1d1d6dbb27ba9c1d86549fa879da10167c9890d2d3443c087c7b8555971a12c
-        codeSamplesNamespace: openapi-code-samples
-        codeSamplesRevisionDigest: sha256:df1a9ca170bc417e1e111efbc10b1f07765943764cb1cbd046d9b6efc18cfc43
+        sourceRevisionDigest: sha256:a97e08b53dbf31ed912244acc6e5a635c88662f3ee098bdfbf2f5ca6735da649
+        sourceBlobDigest: sha256:9331910575a380f9073bf9d31fb81996067da3d0ee449b0513dbe10790790b37
+        codeSamplesNamespace: openapi-typescript-code-samples
+        codeSamplesRevisionDigest: sha256:901b7bcb7f9e68c9d73222a8a8a552330fdd6969a0e98a2a531ce8bac865e651
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -32,6 +33,6 @@ workflow:
                 npm:
                     token: $npm_token
             codeSamples:
-                output: ""
                 registry:
-                    location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
+                    location: registry.speakeasyapi.dev/shippo/shippo/openapi-typescript-code-samples
+                blocking: false

.speakeasy/workflow.lock

@@ -15,5 +15,5 @@ targets:
                 token: $npm_token
         codeSamples:
             registry:
-                location: registry.speakeasyapi.dev/shippo/shippo/openapi-code-samples
+                location: registry.speakeasyapi.dev/shippo/shippo/openapi-typescript-code-samples
             blocking: false

.speakeasy/workflow.yaml

@@ -31,7 +31,7 @@ const shippo = new ShippoCore({
 });
 
 async function run() {
-  const res = await addressesList(shippo);
+  const res = await addressesList(shippo, 1, 5);
 
   switch (true) {
     case res.ok:
@@ -53,7 +53,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

FUNCTIONS.md

@@ -20,18 +20,22 @@ Shippo external API.: Use this API to integrate with the Shippo service
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [<img src="https://docs.goshippo.com/images/Logo.png" width="30" alt="Shippo logo"> Shippo JavaScript SDK](#img-srchttpsdocsgoshippocomimageslogopng-width30-altshippo-logo-shippo-javascript-sdk)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Standalone functions](#standalone-functions)
+  * [Retries](#retries)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+  * [Documentation](#documentation)
+  * [Available Resources and Operations](#available-resources-and-operations)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+  * [About Shippo](#about-shippo)
 
-* [SDK Installation](#sdk-installation)
-* [Requirements](#requirements)
-* [SDK Example Usage](#sdk-example-usage)
-* [Available Resources and Operations](#available-resources-and-operations)
-* [Standalone functions](#standalone-functions)
-* [Retries](#retries)
-* [Error Handling](#error-handling)
-* [Server Selection](#server-selection)
-* [Custom HTTP Client](#custom-http-client)
-* [Authentication](#authentication)
-* [Debugging](#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -117,77 +121,76 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [addressesCreate](docs/sdks/addresses/README.md#create)
-- [addressesGet](docs/sdks/addresses/README.md#get)
-- [addressesList](docs/sdks/addresses/README.md#list)
-- [addressesValidate](docs/sdks/addresses/README.md#validate)
-- [batchesAddShipments](docs/sdks/batches/README.md#addshipments)
-- [batchesCreate](docs/sdks/batches/README.md#create)
-- [batchesGet](docs/sdks/batches/README.md#get)
-- [batchesPurchase](docs/sdks/batches/README.md#purchase)
-- [batchesRemoveShipments](docs/sdks/batches/README.md#removeshipments)
-- [carrierAccountsCreate](docs/sdks/carrieraccounts/README.md#create)
-- [carrierAccountsGetRegistrationStatus](docs/sdks/carrieraccounts/README.md#getregistrationstatus)
-- [carrierAccountsGet](docs/sdks/carrieraccounts/README.md#get)
-- [carrierAccountsInitiateOauth2Signin](docs/sdks/carrieraccounts/README.md#initiateoauth2signin)
-- [carrierAccountsList](docs/sdks/carrieraccounts/README.md#list)
-- [carrierAccountsRegister](docs/sdks/carrieraccounts/README.md#register)
-- [carrierAccountsUpdate](docs/sdks/carrieraccounts/README.md#update)
-- [carrierParcelTemplatesGet](docs/sdks/carrierparceltemplates/README.md#get)
-- [carrierParcelTemplatesList](docs/sdks/carrierparceltemplates/README.md#list)
-- [customsDeclarationsCreate](docs/sdks/customsdeclarations/README.md#create)
-- [customsDeclarationsGet](docs/sdks/customsdeclarations/README.md#get)
-- [customsDeclarationsList](docs/sdks/customsdeclarations/README.md#list)
-- [customsItemsCreate](docs/sdks/customsitems/README.md#create)
-- [customsItemsGet](docs/sdks/customsitems/README.md#get)
-- [customsItemsList](docs/sdks/customsitems/README.md#list)
-- [manifestsCreate](docs/sdks/manifests/README.md#create)
-- [manifestsGet](docs/sdks/manifests/README.md#get)
-- [manifestsList](docs/sdks/manifests/README.md#list)
-- [ordersCreate](docs/sdks/orders/README.md#create)
-- [ordersGet](docs/sdks/orders/README.md#get)
-- [ordersList](docs/sdks/orders/README.md#list)
-- [parcelsCreate](docs/sdks/parcels/README.md#create)
-- [parcelsGet](docs/sdks/parcels/README.md#get)
-- [parcelsList](docs/sdks/parcels/README.md#list)
-- [pickupsCreate](docs/sdks/pickups/README.md#create)
-- [ratesAtCheckoutCreate](docs/sdks/ratesatcheckout/README.md#create)
-- [ratesAtCheckoutDeleteDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#deletedefaultparceltemplate)
-- [ratesAtCheckoutGetDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#getdefaultparceltemplate)
-- [ratesAtCheckoutUpdateDefaultParcelTemplate](docs/sdks/ratesatcheckout/README.md#updatedefaultparceltemplate)
-- [ratesGet](docs/sdks/rates/README.md#get)
-- [ratesListShipmentRatesByCurrencyCode](docs/sdks/rates/README.md#listshipmentratesbycurrencycode)
-- [ratesListShipmentRates](docs/sdks/rates/README.md#listshipmentrates)
-- [refundsCreate](docs/sdks/refunds/README.md#create)
-- [refundsGet](docs/sdks/refunds/README.md#get)
-- [refundsList](docs/sdks/refunds/README.md#list)
-- [serviceGroupsCreate](docs/sdks/servicegroups/README.md#create)
-- [serviceGroupsDelete](docs/sdks/servicegroups/README.md#delete)
-- [serviceGroupsList](docs/sdks/servicegroups/README.md#list)
-- [serviceGroupsUpdate](docs/sdks/servicegroups/README.md#update)
-- [shipmentsCreate](docs/sdks/shipments/README.md#create)
-- [shipmentsGet](docs/sdks/shipments/README.md#get)
-- [shipmentsList](docs/sdks/shipments/README.md#list)
-- [shippoAccountsCreate](docs/sdks/shippoaccounts/README.md#create)
-- [shippoAccountsGet](docs/sdks/shippoaccounts/README.md#get)
-- [shippoAccountsList](docs/sdks/shippoaccounts/README.md#list)
-- [shippoAccountsUpdate](docs/sdks/shippoaccounts/README.md#update)
-- [trackingStatusCreate](docs/sdks/trackingstatus/README.md#create)
-- [trackingStatusGet](docs/sdks/trackingstatus/README.md#get)
-- [transactionsCreate](docs/sdks/transactions/README.md#create)
-- [transactionsGet](docs/sdks/transactions/README.md#get)
-- [transactionsList](docs/sdks/transactions/README.md#list)
-- [userParcelTemplatesCreate](docs/sdks/userparceltemplates/README.md#create)
-- [userParcelTemplatesDelete](docs/sdks/userparceltemplates/README.md#delete)
-- [userParcelTemplatesGet](docs/sdks/userparceltemplates/README.md#get)
-- [userParcelTemplatesList](docs/sdks/userparceltemplates/README.md#list)
-- [userParcelTemplatesUpdate](docs/sdks/userparceltemplates/README.md#update)
-- [webhooksCreateWebhook](docs/sdks/webhooks/README.md#createwebhook)
-- [webhooksDeleteWebhook](docs/sdks/webhooks/README.md#deletewebhook)
-- [webhooksGetWebhook](docs/sdks/webhooks/README.md#getwebhook)
-- [webhooksListWebhooks](docs/sdks/webhooks/README.md#listwebhooks)
-- [webhooksUpdateWebhook](docs/sdks/webhooks/README.md#updatewebhook)
-
+- [`addressesCreate`](docs/sdks/addresses/README.md#create) - Create a new address
+- [`addressesGet`](docs/sdks/addresses/README.md#get) - Retrieve an address
+- [`addressesList`](docs/sdks/addresses/README.md#list) - List all addresses
+- [`addressesValidate`](docs/sdks/addresses/README.md#validate) - Validate an address
+- [`batchesAddShipments`](docs/sdks/batches/README.md#addshipments) - Add shipments to a batch
+- [`batchesCreate`](docs/sdks/batches/README.md#create) - Create a batch
+- [`batchesGet`](docs/sdks/batches/README.md#get) - Retrieve a batch
+- [`batchesPurchase`](docs/sdks/batches/README.md#purchase) - Purchase a batch
+- [`batchesRemoveShipments`](docs/sdks/batches/README.md#removeshipments) - Remove shipments from a batch
+- [`carrierAccountsCreate`](docs/sdks/carrieraccounts/README.md#create) - Create a new carrier account
+- [`carrierAccountsGet`](docs/sdks/carrieraccounts/README.md#get) - Retrieve a carrier account
+- [`carrierAccountsGetRegistrationStatus`](docs/sdks/carrieraccounts/README.md#getregistrationstatus) - Get Carrier Registration status
+- [`carrierAccountsInitiateOauth2Signin`](docs/sdks/carrieraccounts/README.md#initiateoauth2signin) - Connect an existing carrier account using OAuth 2.0
+- [`carrierAccountsList`](docs/sdks/carrieraccounts/README.md#list) - List all carrier accounts
+- [`carrierAccountsRegister`](docs/sdks/carrieraccounts/README.md#register) - Add a Shippo carrier account
+- [`carrierAccountsUpdate`](docs/sdks/carrieraccounts/README.md#update) - Update a carrier account
+- [`carrierParcelTemplatesGet`](docs/sdks/carrierparceltemplates/README.md#get) - Retrieve a carrier parcel templates
+- [`carrierParcelTemplatesList`](docs/sdks/carrierparceltemplates/README.md#list) - List all carrier parcel templates
+- [`customsDeclarationsCreate`](docs/sdks/customsdeclarations/README.md#create) - Create a new customs declaration
+- [`customsDeclarationsGet`](docs/sdks/customsdeclarations/README.md#get) - Retrieve a customs declaration
+- [`customsDeclarationsList`](docs/sdks/customsdeclarations/README.md#list) - List all customs declarations
+- [`customsItemsCreate`](docs/sdks/customsitems/README.md#create) - Create a new customs item
+- [`customsItemsGet`](docs/sdks/customsitems/README.md#get) - Retrieve a customs item
+- [`customsItemsList`](docs/sdks/customsitems/README.md#list) - List all customs items
+- [`manifestsCreate`](docs/sdks/manifests/README.md#create) - Create a new manifest
+- [`manifestsGet`](docs/sdks/manifests/README.md#get) - Retrieve a manifest
+- [`manifestsList`](docs/sdks/manifests/README.md#list) - List all manifests
+- [`ordersCreate`](docs/sdks/orders/README.md#create) - Create a new order
+- [`ordersGet`](docs/sdks/orders/README.md#get) - Retrieve an order
+- [`ordersList`](docs/sdks/orders/README.md#list) - List all orders
+- [`parcelsCreate`](docs/sdks/parcels/README.md#create) - Create a new parcel
+- [`parcelsGet`](docs/sdks/parcels/README.md#get) - Retrieve an existing parcel
+- [`parcelsList`](docs/sdks/parcels/README.md#list) - List all parcels
+- [`pickupsCreate`](docs/sdks/pickups/README.md#create) - Create a pickup
+- [`ratesAtCheckoutCreate`](docs/sdks/ratesatcheckout/README.md#create) - Generate a live rates request
+- [`ratesAtCheckoutDeleteDefaultParcelTemplate`](docs/sdks/ratesatcheckout/README.md#deletedefaultparceltemplate) - Clear current default parcel template
+- [`ratesAtCheckoutGetDefaultParcelTemplate`](docs/sdks/ratesatcheckout/README.md#getdefaultparceltemplate) - Show current default parcel template
+- [`ratesAtCheckoutUpdateDefaultParcelTemplate`](docs/sdks/ratesatcheckout/README.md#updatedefaultparceltemplate) - Update default parcel template
+- [`ratesGet`](docs/sdks/rates/README.md#get) - Retrieve a rate
+- [`ratesListShipmentRates`](docs/sdks/rates/README.md#listshipmentrates) - Retrieve shipment rates
+- [`ratesListShipmentRatesByCurrencyCode`](docs/sdks/rates/README.md#listshipmentratesbycurrencycode) - Retrieve shipment rates in currency
+- [`refundsCreate`](docs/sdks/refunds/README.md#create) - Create a refund
+- [`refundsGet`](docs/sdks/refunds/README.md#get) - Retrieve a refund
+- [`refundsList`](docs/sdks/refunds/README.md#list) - List all refunds
+- [`serviceGroupsCreate`](docs/sdks/servicegroups/README.md#create) - Create a new service group
+- [`serviceGroupsDelete`](docs/sdks/servicegroups/README.md#delete) - Delete a service group
+- [`serviceGroupsList`](docs/sdks/servicegroups/README.md#list) - List all service groups
+- [`serviceGroupsUpdate`](docs/sdks/servicegroups/README.md#update) - Update an existing service group
+- [`shipmentsCreate`](docs/sdks/shipments/README.md#create) - Create a new shipment
+- [`shipmentsGet`](docs/sdks/shipments/README.md#get) - Retrieve a shipment
+- [`shipmentsList`](docs/sdks/shipments/README.md#list) - List all shipments
+- [`shippoAccountsCreate`](docs/sdks/shippoaccounts/README.md#create) - Create a Shippo Account
+- [`shippoAccountsGet`](docs/sdks/shippoaccounts/README.md#get) - Retrieve a Shippo Account
+- [`shippoAccountsList`](docs/sdks/shippoaccounts/README.md#list) - List all Shippo Accounts
+- [`shippoAccountsUpdate`](docs/sdks/shippoaccounts/README.md#update) - Update a Shippo Account
+- [`trackingStatusCreate`](docs/sdks/trackingstatus/README.md#create) - Register a tracking webhook
+- [`trackingStatusGet`](docs/sdks/trackingstatus/README.md#get) - Get a tracking status
+- [`transactionsCreate`](docs/sdks/transactions/README.md#create) - Create a shipping label
+- [`transactionsGet`](docs/sdks/transactions/README.md#get) - Retrieve a shipping label
+- [`transactionsList`](docs/sdks/transactions/README.md#list) - List all shipping labels
+- [`userParcelTemplatesCreate`](docs/sdks/userparceltemplates/README.md#create) - Create a new user parcel template
+- [`userParcelTemplatesDelete`](docs/sdks/userparceltemplates/README.md#delete) - Delete a user parcel template
+- [`userParcelTemplatesGet`](docs/sdks/userparceltemplates/README.md#get) - Retrieves a user parcel template
+- [`userParcelTemplatesList`](docs/sdks/userparceltemplates/README.md#list) - List all user parcel templates
+- [`userParcelTemplatesUpdate`](docs/sdks/userparceltemplates/README.md#update) - Update an existing user parcel template
+- [`webhooksCreateWebhook`](docs/sdks/webhooks/README.md#createwebhook) - Create a new webhook
+- [`webhooksDeleteWebhook`](docs/sdks/webhooks/README.md#deletewebhook) - Delete a specific webhook
+- [`webhooksGetWebhook`](docs/sdks/webhooks/README.md#getwebhook) - Retrieve a specific webhook
+- [`webhooksListWebhooks`](docs/sdks/webhooks/README.md#listwebhooks) - List all webhooks
+- [`webhooksUpdateWebhook`](docs/sdks/webhooks/README.md#updatewebhook) - Update an existing webhook
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -207,7 +210,7 @@ const shippo = new Shippo({
 });
 
 async function run() {
-  const result = await shippo.addresses.list({
+  const result = await shippo.addresses.list(1, 5, {
     retries: {
       strategy: "backoff",
       backoff: {
@@ -248,7 +251,7 @@ const shippo = new Shippo({
 });
 
 async function run() {
-  const result = await shippo.addresses.list();
+  const result = await shippo.addresses.list(1, 5);
 
   // Handle the result
   console.log(result);

README.md

@@ -336,4 +336,14 @@ Based on:
 ### Generated
 - [typescript v2.14.1] .
 ### Releases
-- [NPM v2.14.1] https://www.npmjs.com/package/shippo/v/2.14.1 - .
+- [NPM v2.14.1] https://www.npmjs.com/package/shippo/v/2.14.1 - .
+
+## 2025-01-27 21:48:20
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.476.2 (2.495.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v2.15.0] .
+### Releases
+- [NPM v2.15.0] https://www.npmjs.com/package/shippo/v/2.15.0 - .

RELEASES.md

@@ -1,6 +1,6 @@
 # Supported JavaScript runtimes
 
-This SDK is intended to be used in JavaScript runtimes that support the following features:
+This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
 
 * [Web Fetch API][web-fetch]
 * [Web Streams API][web-streams] and in particular `ReadableStream`
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
   - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
 
 [deno-file-streaming]: https://github.com/denoland/deno/issues/11018
+
+## Recommended TypeScript compiler options
+
+The following `tsconfig.json` options are recommended for projects using this
+SDK in order to get static type support for features like async iterables,
+streams and `fetch`-related APIs ([`for await...of`][for-await-of], 
+[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
+so on):
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
+[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
+
+```jsonc
+{
+  "compilerOptions": {
+    "target": "es2020", // or higher
+    "lib": ["es2020", "dom", "dom.iterable"],
+  }
+}
+```
+
+While `target` can be set to older ECMAScript versions, it may result in extra,
+unnecessary compatibility code being generated if you are not targeting old
+runtimes.

RUNTIMES.md

@@ -8,7 +8,7 @@ const shippo = new Shippo({
 });
 
 async function run() {
-  const result = await shippo.addresses.list();
+  const result = await shippo.addresses.list(1, 5);
 
   // Handle the result
   console.log(result);