chore: 🐝 Update SDK - Generate 2.14.1 (#94)

* ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.401.2 * write tests to verify shipments paging --------- Co-authored-by: speakeasybot <[email protected]> Co-authored-by: Randall Keur <[email protected]>
goshippo · Nov 26, 2024 · d653350 · d653350
1 parent 9b2685a
commit d653350
Show file tree

Hide file tree

Showing 12 changed files with 84 additions and 16 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 4f7e8ab5-4c00-496a-9710-e7c707e4ee78
 management:
-  docChecksum: bda7f4add5fb510fe4737e3adbe45aea
+  docChecksum: 256e7d68eaf807fc9ef86f8311e8a13f
   docVersion: "2018-02-08"
   speakeasyVersion: 1.401.2
   generationVersion: 2.421.3
-  releaseVersion: 2.13.0
-  configChecksum: d4256e5ea6287869f60153cb7c8c4927
+  releaseVersion: 2.14.1
+  configChecksum: bcfebe2c39e567249ac9def567cd98fe
   repoURL: https://github.com/goshippo/shippo-javascript-sdk.git
   installationURL: https://github.com/goshippo/shippo-javascript-sdk
   published: true
@@ -1525,3 +1525,4 @@ examples:
       parameters:
         path:
           webhookId: "<value>"
+generatedTests: {}
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: true
 typescript:
-  version: 2.13.0
+  version: 2.14.1
   additionalDependencies:
     dependencies: {}
     devDependencies:
@@ -27,6 +27,7 @@ typescript:
   author: Shippo
   clientServerStatusCodesAsErrors: true
   defaultErrorName: SDKError
+  enableReactQuery: false
   enumFormat: union
   flattenGlobalSecurity: true
   flatteningOrder: body-first

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,19 +2,19 @@ speakeasyVersion: 1.401.2
 sources:
     openapi:
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:6a8ece3e0152d024847477a897bf45f36db26ce973667fe87361980077ef713f
-        sourceBlobDigest: sha256:9ed21afb1191003cf67f0c0e5735d08eb0d8b07ae141d7479d5c84ef9f221fb4
+        sourceRevisionDigest: sha256:67380a5740d2ebf50c6b5d4ecd48d398c184e281c8302c0d0306220da7535048
+        sourceBlobDigest: sha256:d1d1d6dbb27ba9c1d86549fa879da10167c9890d2d3443c087c7b8555971a12c
         tags:
             - latest
             - main
 targets:
     first-target:
         source: openapi
         sourceNamespace: openapi
-        sourceRevisionDigest: sha256:6a8ece3e0152d024847477a897bf45f36db26ce973667fe87361980077ef713f
-        sourceBlobDigest: sha256:9ed21afb1191003cf67f0c0e5735d08eb0d8b07ae141d7479d5c84ef9f221fb4
+        sourceRevisionDigest: sha256:67380a5740d2ebf50c6b5d4ecd48d398c184e281c8302c0d0306220da7535048
+        sourceBlobDigest: sha256:d1d1d6dbb27ba9c1d86549fa879da10167c9890d2d3443c087c7b8555971a12c
         codeSamplesNamespace: openapi-code-samples
-        codeSamplesRevisionDigest: sha256:5ffb891db6f12ae97b0d2a11181e5615a72e70854e5de83469968ae8e02ba333
+        codeSamplesRevisionDigest: sha256:df1a9ca170bc417e1e111efbc10b1f07765943764cb1cbd046d9b6efc18cfc43
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/RELEASES.md b/RELEASES.md
@@ -326,4 +326,14 @@ Based on:
 ### Generated
 - [typescript v2.13.0] .
 ### Releases
-- [NPM v2.13.0] https://www.npmjs.com/package/shippo/v/2.13.0 - .
+- [NPM v2.13.0] https://www.npmjs.com/package/shippo/v/2.13.0 - .
+
+## 2024-11-26 16:00:17
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v2.14.1] .
+### Releases
+- [NPM v2.14.1] https://www.npmjs.com/package/shippo/v/2.14.1 - .
diff --git a/docs/models/operations/listshipmentsrequest.md b/docs/models/operations/listshipmentsrequest.md
@@ -12,6 +12,7 @@ let value: ListShipmentsRequest = {};
 
 | Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
 | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `pageToken`                                                          | *string*                                                             | :heavy_minus_sign:                                                   | The page token for paginated results                                 |
 | `page`                                                               | *number*                                                             | :heavy_minus_sign:                                                   | The page number you want to select                                   |
 | `results`                                                            | *number*                                                             | :heavy_minus_sign:                                                   | The number of results to return per page (max 100)                   |
 | `objectCreatedGt`                                                    | *string*                                                             | :heavy_minus_sign:                                                   | Object(s) created greater than a provided date and time.             |

diff --git a/jsr.json b/jsr.json
@@ -2,7 +2,7 @@
 
 {
   "name": "shippo",
-  "version": "2.13.0",
+  "version": "2.14.1",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "shippo",
-  "version": "2.13.0",
+  "version": "2.14.1",
   "author": "Shippo",
   "license": "MIT",
   "main": "./index.js",

diff --git a/src/funcs/shipmentsList.ts b/src/funcs/shipmentsList.ts
@@ -82,6 +82,7 @@ export async function shipmentsList(
     "object_created_lt": payload.object_created_lt,
     "object_created_lte": payload.object_created_lte,
     "page": payload.page,
+    "page_token": payload.page_token,
     "results": payload.results,
   });
 

diff --git 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.13.0",
+  sdkVersion: "2.14.1",
   genVersion: "2.421.3",
-  userAgent: "speakeasy-sdk/typescript 2.13.0 2.421.3 2018-02-08 shippo",
+  userAgent: "speakeasy-sdk/typescript 2.14.1 2.421.3 2018-02-08 shippo",
 } as const;
diff --git a/src/models/operations/listshipments.ts b/src/models/operations/listshipments.ts
@@ -13,6 +13,10 @@ export type ListShipmentsGlobals = {
 };
 
 export type ListShipmentsRequest = {
+  /**
+   * The page token for paginated results
+   */
+  pageToken?: string | undefined;
   /**
    * The page number you want to select
    */
@@ -89,6 +93,7 @@ export const ListShipmentsRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  page_token: z.string().optional(),
   page: z.number().int().default(1),
   results: z.number().int().default(25),
   object_created_gt: z.string().optional(),
@@ -97,6 +102,7 @@ export const ListShipmentsRequest$inboundSchema: z.ZodType<
   object_created_lte: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
+    "page_token": "pageToken",
     "object_created_gt": "objectCreatedGt",
     "object_created_gte": "objectCreatedGte",
     "object_created_lt": "objectCreatedLt",
@@ -106,6 +112,7 @@ export const ListShipmentsRequest$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ListShipmentsRequest$Outbound = {
+  page_token?: string | undefined;
   page: number;
   results: number;
   object_created_gt?: string | undefined;
@@ -120,6 +127,7 @@ export const ListShipmentsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListShipmentsRequest
 > = z.object({
+  pageToken: z.string().optional(),
   page: z.number().int().default(1),
   results: z.number().int().default(25),
   objectCreatedGt: z.string().optional(),
@@ -128,6 +136,7 @@ export const ListShipmentsRequest$outboundSchema: z.ZodType<
   objectCreatedLte: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
+    pageToken: "page_token",
     objectCreatedGt: "object_created_gt",
     objectCreatedGte: "object_created_gte",
     objectCreatedLt: "object_created_lt",

diff --git a/test/shipment.test.ts b/test/shipment.test.ts
@@ -0,0 +1,45 @@
+import {shippoSdk} from "./helpers";
+import {expect} from "chai";
+
+describe('TestShipments', function () {
+    it('testListAllShipments', async() => {
+        const response = await shippoSdk.shipments.list({});
+
+        expect(response).to.not.be.null;
+        expect(response).to.be.an('object');
+
+        expect(response).to.have.property('results').that.is.an('array');
+        assertShipmentResults(response.results);
+    });
+
+    it('testListAllShipmentsPagination', async() => {
+        const response = await shippoSdk.shipments.list({ page: 1, results: 2 });
+
+        // Basic response assertions
+        expect(response).to.not.be.null;
+        expect(response).to.have.property('results').that.is.an('array');
+        assertShipmentResults(response.results);
+
+        if (response.next) {
+            const pageTokenMatch = response.next.match(/page_token=([^&]+)/);
+            if (pageTokenMatch) {
+                const pageToken = pageTokenMatch[1];
+                const secondResponse = await shippoSdk.shipments.list({ page_token: pageToken, page: 2, results: 2 });
+
+                expect(secondResponse).to.not.be.null;
+                expect(secondResponse).to.have.property('results').that.is.an('array');
+                assertShipmentResults(secondResponse.results);
+            }
+        }
+    });
+});
+
+function assertShipmentResults(results) {
+    if (results.length > 0) {
+        results.forEach(result => {
+            expect(result).to.have.property('objectId').that.is.a('string').and.is.not.empty;
+            expect(result).to.have.property('addressFrom').that.is.an('object');
+            expect(result).to.have.property('addressTo').that.is.an('object');
+        });
+    }
+}