feat: customize sdk method names

Argus-Labs · Aug 2, 2024 · 8d40293 · 8d40293
1 parent 2a6ea68
commit 8d40293
Show file tree

Hide file tree

Showing 28 changed files with 898 additions and 971 deletions.
diff --git a/.github/workflows/sdk_generation.yaml b/.github/workflows/sdk_generation.yaml
@@ -27,7 +27,6 @@ jobs:
       mode: pr
       set_version: ${{ github.event.inputs.set_version }}
       speakeasy_version: latest
-      working_directory: cardinal/sdk/typescript
     secrets:
       github_access_token: ${{ secrets.GITHUB_TOKEN }}
       speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: true
 typescript:
-  version: 0.0.1
+  version: 0.2.2
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,17 +1,17 @@
-speakeasyVersion: 1.351.0
+speakeasyVersion: 1.352.0
 sources:
     cardinal:
         sourceNamespace: cardinal
-        sourceRevisionDigest: sha256:bacc6ce74a7a215de483bc5bb59e8b673b157ff8f8a7ccf7f14d45487a4826d1
-        sourceBlobDigest: sha256:1da8f0bf0677aa13c17ea695edf9d54154114521f0cd10320e6e5c0e8d99e338
+        sourceRevisionDigest: sha256:4cc32242239a8a1d711fafed51ea35a0ac5047e15877ab6fd2e7d3bf41a61716
+        sourceBlobDigest: sha256:0c2627da1d3124fd952e346bc3c92c28138b31c60eaac80735332a7a90ad9af3
         tags:
             - latest
 targets:
     cardinal-ts:
         source: cardinal
         sourceNamespace: cardinal
-        sourceRevisionDigest: sha256:bacc6ce74a7a215de483bc5bb59e8b673b157ff8f8a7ccf7f14d45487a4826d1
-        sourceBlobDigest: sha256:1da8f0bf0677aa13c17ea695edf9d54154114521f0cd10320e6e5c0e8d99e338
+        sourceRevisionDigest: sha256:4cc32242239a8a1d711fafed51ea35a0ac5047e15877ab6fd2e7d3bf41a61716
+        sourceBlobDigest: sha256:0c2627da1d3124fd952e346bc3c92c28138b31c60eaac80735332a7a90ad9af3
         outLocation: cardinal/sdk/typescript
 workflow:
     workflowVersion: 1.0.0

diff --git a/cardinal/sdk/typescript/.speakeasy/gen.lock b/cardinal/sdk/typescript/.speakeasy/gen.lock
@@ -1,20 +1,22 @@
 lockVersion: 2.0.0
 id: fc6bc2ef-bea2-433a-a006-bbd7c75eb7e5
 management:
-  docChecksum: d11e4c607c38b470780d0598f8624aec
+  docChecksum: bca4de5ed616447f5a60b1d34a234055
   docVersion: 0.0.1
-  speakeasyVersion: 1.351.0
-  generationVersion: 2.384.1
-  releaseVersion: 0.0.1
-  configChecksum: 48b480cf853884a3cf0893af8e50dbfa
+  speakeasyVersion: 1.352.0
+  generationVersion: 2.384.4
+  releaseVersion: 0.2.2
+  configChecksum: e54b7a7f6ee784433e085cd30e3d2e69
 features:
   typescript:
     additionalDependencies: 0.1.0
-    core: 3.11.11
+    core: 3.11.12
     defaultEnabledRetries: 0.1.0
     envVarSecurityUsage: 0.1.0
     globalSecurityCallbacks: 0.1.0
     globalServerURLs: 2.82.4
+    ignores: 2.81.1
+    nameOverrides: 2.81.2
     responseFormat: 0.2.3
     retries: 2.83.0
     sdkHooks: 0.1.0
@@ -59,9 +61,8 @@ generatedFiles:
   - src/models/components/cardinalserverhandlertransaction.ts
   - src/models/components/cardinalserverhandlergetworldresponse.ts
   - src/models/components/pkgworlddevworldenginecardinaltypesfielddetail.ts
-  - src/models/operations/postqueryquerygroupqueryname.ts
+  - src/models/operations/postquerygamequeryname.ts
   - src/models/operations/posttxgametxname.ts
-  - src/models/operations/posttxtxgrouptxname.ts
   - src/models/errors/index.ts
   - src/models/components/index.ts
   - src/models/operations/index.ts
@@ -82,11 +83,10 @@ generatedFiles:
   - docs/models/components/cardinalserverhandlergetworldresponse.md
   - docs/models/components/fields.md
   - docs/models/components/pkgworlddevworldenginecardinaltypesfielddetail.md
-  - docs/models/operations/postqueryquerygroupquerynamerequestbody.md
-  - docs/models/operations/postqueryquerygroupquerynamerequest.md
-  - docs/models/operations/postqueryquerygroupquerynameresponsebody.md
+  - docs/models/operations/postquerygamequerynamerequestbody.md
+  - docs/models/operations/postquerygamequerynamerequest.md
+  - docs/models/operations/postquerygamequerynameresponsebody.md
   - docs/models/operations/posttxgametxnamerequest.md
-  - docs/models/operations/posttxtxgrouptxnamerequest.md
   - docs/lib/utils/retryconfig.md
   - docs/sdks/cardinal/README.md
   - USAGE.md

diff --git a/cardinal/sdk/typescript/README.md b/cardinal/sdk/typescript/README.md
@@ -64,7 +64,7 @@ import { Cardinal } from "cardinal";
 const cardinal = new Cardinal();
 
 async function run() {
-    const result = await cardinal.postCql({});
+    const result = await cardinal.queryCql({});
 
     // Handle the result
     console.log(result);
@@ -80,15 +80,13 @@ run();
 
 ### [Cardinal SDK](docs/sdks/cardinal/README.md)
 
-* [postCql](docs/sdks/cardinal/README.md#postcql) - Executes a CQL (Cardinal Query Language) query
-* [postDebugState](docs/sdks/cardinal/README.md#postdebugstate) - Retrieves a list of all entities in the game state
-* [getEvents](docs/sdks/cardinal/README.md#getevents) - Establishes a new websocket connection to retrieve system events
+* [queryCql](docs/sdks/cardinal/README.md#querycql) - Executes a CQL (Cardinal Query Language) query
+* [getDebugState](docs/sdks/cardinal/README.md#getdebugstate) - Retrieves a list of all entities in the game state
 * [getHealth](docs/sdks/cardinal/README.md#gethealth) - Retrieves the status of the server and game loop
-* [postQueryReceiptsList](docs/sdks/cardinal/README.md#postqueryreceiptslist) - Retrieves all transaction receipts
-* [postQueryQueryGroupQueryName](docs/sdks/cardinal/README.md#postqueryquerygroupqueryname) - Executes a query
-* [postTxGameTxName](docs/sdks/cardinal/README.md#posttxgametxname) - Submits a transaction
-* [postTxPersonaCreatePersona](docs/sdks/cardinal/README.md#posttxpersonacreatepersona) - Creates a persona
-* [postTxTxGroupTxName](docs/sdks/cardinal/README.md#posttxtxgrouptxname) - Submits a transaction
+* [query](docs/sdks/cardinal/README.md#query) - Executes a query
+* [getReceipts](docs/sdks/cardinal/README.md#getreceipts) - Retrieves all transaction receipts
+* [transact](docs/sdks/cardinal/README.md#transact) - Submits a transaction
+* [createPersona](docs/sdks/cardinal/README.md#createpersona) - Creates a persona
 * [getWorld](docs/sdks/cardinal/README.md#getworld) - Retrieves details of the game world
 <!-- End Available Resources and Operations [operations] -->
 
@@ -104,7 +102,7 @@ import { Cardinal } from "cardinal";
 const cardinal = new Cardinal();
 
 async function run() {
-    const result = await cardinal.postCql(
+    const result = await cardinal.queryCql(
         {},
         {
             retries: {
@@ -146,7 +144,7 @@ const cardinal = new Cardinal({
 });
 
 async function run() {
-    const result = await cardinal.postCql({});
+    const result = await cardinal.queryCql({});
 
     // Handle the result
     console.log(result);
@@ -178,7 +176,7 @@ const cardinal = new Cardinal();
 async function run() {
     let result;
     try {
-        result = await cardinal.postCql({});
+        result = await cardinal.queryCql({});
     } catch (err) {
         switch (true) {
             case err instanceof SDKValidationError: {
@@ -222,7 +220,7 @@ const cardinal = new Cardinal({
 });
 
 async function run() {
-    const result = await cardinal.postCql({});
+    const result = await cardinal.queryCql({});
 
     // Handle the result
     console.log(result);
@@ -245,7 +243,7 @@ const cardinal = new Cardinal({
 });
 
 async function run() {
-    const result = await cardinal.postCql({});
+    const result = await cardinal.queryCql({});
 
     // Handle the result
     console.log(result);

diff --git a/cardinal/sdk/typescript/USAGE.md b/cardinal/sdk/typescript/USAGE.md
@@ -5,7 +5,7 @@ import { Cardinal } from "cardinal";
 const cardinal = new Cardinal();
 
 async function run() {
-    const result = await cardinal.postCql({});
+    const result = await cardinal.queryCql({});
 
     // Handle the result
     console.log(result);

diff --git a/cardinal/sdk/typescript/docs/models/operations/postquerygamequerynamerequest.md b/cardinal/sdk/typescript/docs/models/operations/postquerygamequerynamerequest.md
@@ -0,0 +1,9 @@
+# PostQueryGameQueryNameRequest
+
+
+## Fields
+
+| Field                                                                                                        | Type                                                                                                         | Required                                                                                                     | Description                                                                                                  |
+| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| `queryName`                                                                                                  | *string*                                                                                                     | :heavy_check_mark:                                                                                           | Name of a registered query                                                                                   |
+| `requestBody`                                                                                                | [operations.PostQueryGameQueryNameRequestBody](../../models/operations/postquerygamequerynamerequestbody.md) | :heavy_check_mark:                                                                                           | Query to be executed                                                                                         |
diff --git a/...ostqueryquerygroupquerynamerequestbody.md → ...ions/postquerygamequerynamerequestbody.md b/...ostqueryquerygroupquerynamerequestbody.md → ...ions/postquerygamequerynamerequestbody.md
@@ -1,4 +1,4 @@
-# PostQueryQueryGroupQueryNameRequestBody
+# PostQueryGameQueryNameRequestBody
 
 Query to be executed
 

diff --git a/...stqueryquerygroupquerynameresponsebody.md → ...ons/postquerygamequerynameresponsebody.md b/...stqueryquerygroupquerynameresponsebody.md → ...ons/postquerygamequerynameresponsebody.md
@@ -1,4 +1,4 @@
-# PostQueryQueryGroupQueryNameResponseBody
+# PostQueryGameQueryNameResponseBody
 
 Results of the executed query
 

diff --git a/...al/sdk/typescript/docs/models/operations/postqueryquerygroupquerynamerequest.md b/...al/sdk/typescript/docs/models/operations/postqueryquerygroupquerynamerequest.md
diff --git a/cardinal/sdk/typescript/docs/models/operations/posttxtxgrouptxnamerequest.md b/cardinal/sdk/typescript/docs/models/operations/posttxtxgrouptxnamerequest.md