Merge pull request #16 from panoratech/speakeasy-sdk-regen-1722906018

chore: 🐝 Update SDK - Generate 0.6.0
panoratech · Aug 6, 2024 · 223f8e1 · 223f8e1
2 parents d191365 + cca0b37
commit 223f8e1
Show file tree

Hide file tree

Showing 191 changed files with 2,905 additions and 2,436 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: caaaa8c3-6dd7-43a5-841e-c3193e68cc73
 management:
-  docChecksum: 73ce3778a891c9bdb1d0d00c8a42490f
+  docChecksum: 6285cb7ccee4454432a81b1d7aaf3a30
   docVersion: "1.0"
   speakeasyVersion: 1.352.2
   generationVersion: 2.385.2
-  releaseVersion: 0.5.1
-  configChecksum: 36082a99a0f6afb5f706af6e12de6dbe
+  releaseVersion: 0.6.0
+  configChecksum: b367c72f5dc7f7633c5f0b19b3a43714
   repoURL: https://github.com/panoratech/typescript-sdk.git
   installationURL: https://github.com/panoratech/typescript-sdk
   published: true
@@ -23,6 +23,7 @@ features:
     groups: 2.81.2
     nameOverrides: 2.81.2
     nullables: 0.1.0
+    pagination: 2.82.6
     responseFormat: 0.2.3
     retries: 2.83.0
     sdkHooks: 0.1.0
@@ -52,13 +53,8 @@ generatedFiles:
   - src/sdk/tasks.ts
   - src/sdk/panorausers.ts
   - src/sdk/crm.ts
-  - src/sdk/batch.ts
-  - src/sdk/id.ts
-  - src/sdk/fromremoteid.ts
   - src/sdk/linkedusers.ts
   - src/sdk/projects.ts
-  - src/sdk/define.ts
-  - src/sdk/map.ts
   - src/sdk/fieldmappings.ts
   - src/sdk/events.ts
   - src/sdk/passthrough.ts
@@ -203,8 +199,8 @@ generatedFiles:
   - src/models/components/projectresponse.ts
   - src/models/components/createprojectdto.ts
   - src/models/components/customfieldresponse.ts
-  - src/models/components/customfieldcreatedto.ts
   - src/models/components/definetargetfielddto.ts
+  - src/models/components/customfieldcreatedto.ts
   - src/models/components/mapfieldtoproviderdto.ts
   - src/models/components/eventresponse.ts
   - src/models/components/passthroughresponse.ts
@@ -577,12 +573,12 @@ generatedFiles:
   - docs/models/components/createprojectdto.md
   - docs/models/components/customfieldresponsedatatype.md
   - docs/models/components/customfieldresponse.md
-  - docs/models/components/customfieldcreatedtoobjecttypeowner.md
-  - docs/models/components/customfieldcreatedtodatatype.md
-  - docs/models/components/customfieldcreatedto.md
   - docs/models/components/objecttypeowner.md
   - docs/models/components/datatype.md
   - docs/models/components/definetargetfielddto.md
+  - docs/models/components/customfieldcreatedtoobjecttypeowner.md
+  - docs/models/components/customfieldcreatedtodatatype.md
+  - docs/models/components/customfieldcreatedto.md
   - docs/models/components/mapfieldtoproviderdto.md
   - docs/models/components/eventresponsetype.md
   - docs/models/components/eventresponsestatus.md
@@ -706,6 +702,7 @@ generatedFiles:
   - docs/models/operations/verifyeventresponsebody.md
   - docs/models/operations/listticketingticketrequest.md
   - docs/models/operations/listticketingticketresponsebody.md
+  - docs/models/operations/listticketingticketresponse.md
   - docs/models/operations/createticketingticketrequest.md
   - docs/models/operations/retrieveticketingticketrequest.md
   - docs/models/operations/listticketingusersrequest.md
@@ -1014,13 +1011,8 @@ generatedFiles:
   - docs/sdks/tasks/README.md
   - docs/sdks/panorausers/README.md
   - docs/sdks/linkedusers/README.md
-  - docs/sdks/batch/README.md
-  - docs/sdks/id/README.md
-  - docs/sdks/fromremoteid/README.md
   - docs/sdks/projects/README.md
   - docs/sdks/fieldmappings/README.md
-  - docs/sdks/define/README.md
-  - docs/sdks/map/README.md
   - docs/sdks/events/README.md
   - docs/sdks/passthrough/README.md
   - docs/sdks/hris/README.md

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 typescript:
-  version: 0.5.1
+  version: 0.6.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,19 +2,19 @@ speakeasyVersion: 1.352.2
 sources:
     panora-open-api-swagger:
         sourceNamespace: panora-open-api-swagger
-        sourceRevisionDigest: sha256:c2c6829443735d39ca07b71f8c269c09be36206f348f4607daffe3bc2071df24
-        sourceBlobDigest: sha256:00c5d274f2ad4ceebaaf0cc9f3efa30f4e7005931d28203635e0b1f593157336
+        sourceRevisionDigest: sha256:4ffa359f331f43e3e75ab59b81e40983030d3e1d77aead527f51665a08484a61
+        sourceBlobDigest: sha256:342c552d930e33efaa3246ae82cfeda95537b63ceef0bda067bb2bfbf5d0278b
         tags:
             - latest
             - main
 targets:
     my-first-target:
         source: panora-open-api-swagger
         sourceNamespace: panora-open-api-swagger
-        sourceRevisionDigest: sha256:c2c6829443735d39ca07b71f8c269c09be36206f348f4607daffe3bc2071df24
-        sourceBlobDigest: sha256:00c5d274f2ad4ceebaaf0cc9f3efa30f4e7005931d28203635e0b1f593157336
+        sourceRevisionDigest: sha256:4ffa359f331f43e3e75ab59b81e40983030d3e1d77aead527f51665a08484a61
+        sourceBlobDigest: sha256:342c552d930e33efaa3246ae82cfeda95537b63ceef0bda067bb2bfbf5d0278b
         codeSamplesNamespace: code-samples-typescript-my-first-target
-        codeSamplesRevisionDigest: sha256:53d6ca387a5e6b481c642e6f1f8a532cf1ba5ac5fe80f57d917f0e2c2b8eebcc
+        codeSamplesRevisionDigest: sha256:1b062b14013988d8449345ca4fb430d07a582c943372443727b1deded72eb838
         outLocation: /github/workspace/repo
 workflow:
     workflowVersion: 1.0.0

diff --git a/README.md b/README.md
@@ -207,18 +207,9 @@ run();
 
 * [create](docs/sdks/linkedusers/README.md#create) - Create Linked Users
 * [list](docs/sdks/linkedusers/README.md#list) - List Linked Users
-
-### [linkedUsers.batch](docs/sdks/batch/README.md)
-
-* [importBatch](docs/sdks/batch/README.md#importbatch) - Add Batch Linked Users
-
-### [linkedUsers.id](docs/sdks/id/README.md)
-
-* [retrieve](docs/sdks/id/README.md#retrieve) - Retrieve Linked Users
-
-### [linkedUsers.fromremoteid](docs/sdks/fromremoteid/README.md)
-
-* [remoteId](docs/sdks/fromremoteid/README.md#remoteid) - Retrieve a Linked User From A Remote Id
+* [importBatch](docs/sdks/linkedusers/README.md#importbatch) - Add Batch Linked Users
+* [retrieve](docs/sdks/linkedusers/README.md#retrieve) - Retrieve Linked Users
+* [remoteId](docs/sdks/linkedusers/README.md#remoteid) - Retrieve a Linked User From A Remote Id
 
 ### [projects](docs/sdks/projects/README.md)
 
@@ -227,15 +218,9 @@ run();
 
 ### [fieldMappings](docs/sdks/fieldmappings/README.md)
 
+* [definitions](docs/sdks/fieldmappings/README.md#definitions) - Define target Field
 * [defineCustomField](docs/sdks/fieldmappings/README.md#definecustomfield) - Create Custom Field
-
-### [fieldMappings.define](docs/sdks/define/README.md)
-
-* [definitions](docs/sdks/define/README.md#definitions) - Define target Field
-
-### [fieldMappings.map](docs/sdks/map/README.md)
-
-* [map](docs/sdks/map/README.md#map) - Map Custom Field
+* [map](docs/sdks/fieldmappings/README.md#map) - Map Custom Field
 
 ### [events](docs/sdks/events/README.md)
 
@@ -844,6 +829,43 @@ run();
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Pagination [pagination] -->
+## Pagination
+
+Some of the endpoints in this SDK support pagination. To use pagination, you
+make your SDK calls as usual, but the returned response object will also be an
+async iterable that can be consumed using the [`for await...of`][for-await-of]
+syntax.
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+
+Here's an example of one such pagination call:
+
+```typescript
+import { Panora } from "@panora/sdk";
+
+const panora = new Panora({
+    apiKey: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+    const result = await panora.ticketing.tickets.list({
+        xConnectionToken: "<value>",
+        remoteData: true,
+        limit: 10,
+        cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
+    });
+
+    for await (const page of result) {
+        // handle page
+    }
+}
+
+run();
+
+```
+<!-- End Pagination [pagination] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 # Development

diff --git a/RELEASES.md b/RELEASES.md
@@ -118,4 +118,14 @@ Based on:
 ### Generated
 - [typescript v0.5.1] .
 ### Releases
-- [NPM v0.5.1] https://www.npmjs.com/package/@panora/sdk/v/0.5.1 - .
+- [NPM v0.5.1] https://www.npmjs.com/package/@panora/sdk/v/0.5.1 - .
+
+## 2024-08-06 01:00:15
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.352.2 (2.385.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.6.0] .
+### Releases
+- [NPM v0.6.0] https://www.npmjs.com/package/@panora/sdk/v/0.6.0 - .