ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.176.0

speakeasybot · speakeasybot · commit fc535927a8e9 · 2024-02-09T00:11:17.000Z
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 89968bf0-a755-4d50-9acb-d47410010f05
 management:
-  docChecksum: dff663dce4f21ddf3fc2332b7d7be92b
+  docChecksum: 557634d4bb5964b949ae70f79f40d856
   docVersion: 0.4.0
   speakeasyVersion: internal
-  generationVersion: 2.250.16
-  releaseVersion: 3.0.1
-  configChecksum: 99b8e5f3cd48d97507fa9ab6fd6e05cc
+  generationVersion: 2.250.22
+  releaseVersion: 3.1.0
+  configChecksum: 54549759930fcd5f880c2ea492dac967
   repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript.git
   repoSubDirectory: .
   installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript
@@ -20,6 +20,7 @@ features:
     globalServerURLs: 2.82.1
     globals: 2.81.1
     inputOutputModels: 2.83.0
+    retries: 2.82.1
     serverIDs: 2.81.2
 generatedFiles:
   - src/sdk/apis.ts
@@ -205,6 +206,7 @@ generatedFiles:
   - docs/sdks/auth/README.md
   - docs/sdks/requests/README.md
   - docs/sdks/embeds/README.md
+  - docs/internal/utils/retryconfig.md
   - docs/sdks/events/README.md
   - USAGE.md
   - .gitattributes
diff --git a/README.md b/README.md
@@ -356,6 +356,116 @@ run();
 ```
 <!-- End Global Parameters [global-parameters] -->
 
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
+import {
+    GenerateBumpType,
+    InteractionType,
+} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/shared";
+
+async function run() {
+    const sdk = new Speakeasy({
+        security: {
+            apiKey: "<YOUR_API_KEY_HERE>",
+        },
+        workspaceID: "string",
+    });
+
+    const res = await sdk.events.postWorkspaceEvents(
+        {
+            requestBody: [
+                {
+                    createdAt: new Date("2024-11-21T06:58:42.120Z"),
+                    executionId: "string",
+                    id: "<ID>",
+                    interactionType: InteractionType.CliExec,
+                    localStartedAt: new Date("2024-05-07T12:35:47.182Z"),
+                    speakeasyApiKeyName: "string",
+                    speakeasyVersion: "string",
+                    success: false,
+                    workspaceId: "string",
+                },
+            ],
+        },
+        {
+            strategy: "backoff",
+            backoff: {
+                initialInterval: 1,
+                maxInterval: 50,
+                exponent: 1.1,
+                maxElapsedTime: 100,
+            },
+            retryConnectionErrors: false,
+        }
+    );
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
+import {
+    GenerateBumpType,
+    InteractionType,
+} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/shared";
+
+async function run() {
+    const sdk = new Speakeasy({
+        retry_config: {
+            strategy: "backoff",
+            backoff: {
+                initialInterval: 1,
+                maxInterval: 50,
+                exponent: 1.1,
+                maxElapsedTime: 100,
+            },
+            retryConnectionErrors: false,
+        },
+        security: {
+            apiKey: "<YOUR_API_KEY_HERE>",
+        },
+        workspaceID: "string",
+    });
+
+    const res = await sdk.events.postWorkspaceEvents({
+        requestBody: [
+            {
+                createdAt: new Date("2024-11-21T06:58:42.120Z"),
+                executionId: "string",
+                id: "<ID>",
+                interactionType: InteractionType.CliExec,
+                localStartedAt: new Date("2024-05-07T12:35:47.182Z"),
+                speakeasyApiKeyName: "string",
+                speakeasyVersion: "string",
+                success: false,
+                workspaceId: "string",
+            },
+        ],
+    });
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 
diff --git a/RELEASES.md b/RELEASES.md
@@ -1116,4 +1116,14 @@ Based on:
 ### Generated
 - [typescript v3.0.1] .
 ### Releases
-- [NPM v3.0.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.0.1 - .
+- [NPM v3.0.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.0.1 - .
+
+## 2024-02-09 00:10:59
+### Changes
+Based on:
+- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.176.0 (2.250.22) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v3.1.0] .
+### Releases
+- [NPM v3.1.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.1.0 - .
diff --git a/docs/internal/utils/retryconfig.md b/docs/internal/utils/retryconfig.md
@@ -0,0 +1,24 @@
+# RetryConfig
+
+Allows customizing the default retry configuration. Only usable with methods that mention they support retries.
+
+## Fields
+
+| Name                      | Type                                | Description                             | Example   |
+| ------------------------- | ----------------------------------- | --------------------------------------- | --------- |
+| `strategy`                | `*string*`                             | The retry strategy to use.              | `backoff` |
+| `backoff`                 | [BackoffStrategy](#backoffstrategy) | Configuration for the backoff strategy. |           |
+| `retryConnectionErrors` | `*boolean*`                            | Whether to retry on connection errors.  | `true`    |
+
+## BackoffStrategy
+
+The backoff strategy allows retrying a request with an exponential backoff between each retry.
+
+### Fields
+
+| Name               | Type      | Description                               | Example  |
+| ------------------ | --------- | ----------------------------------------- | -------- |
+| `initialInterval` | `*number*`   | The initial interval in milliseconds.     | `500`    |
+| `maxInterval`     | `*number*`   | The maximum interval in milliseconds.     | `60000`  |
+| `exponent`         | `*number*` | The exponent to use for the backoff.      | `1.5`    |
+| `maxElapsedTime` | `*number*`   | The maximum elapsed time in milliseconds. | `300000` |
diff --git a/docs/sdk/models/operations/postworkspaceeventsresponse.md b/docs/sdk/models/operations/postworkspaceeventsresponse.md
@@ -6,5 +6,6 @@
 | Field                                                   | Type                                                    | Required                                                | Description                                             |
 | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
 | `contentType`                                           | *string*                                                | :heavy_check_mark:                                      | HTTP response content type for this operation           |
+| `error`                                                 | [shared.ErrorT](../../../sdk/models/shared/errort.md)   | :heavy_minus_sign:                                      | N/A                                                     |
 | `statusCode`                                            | *number*                                                | :heavy_check_mark:                                      | HTTP response status code for this operation            |
 | `rawResponse`                                           | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark:                                      | Raw HTTP response; suitable for custom response parsing |
diff --git a/docs/sdks/events/README.md b/docs/sdks/events/README.md
@@ -56,6 +56,7 @@ run();
 | Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
 | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
 | `request`                                                                                          | [operations.PostWorkspaceEventsRequest](../../sdk/models/operations/postworkspaceeventsrequest.md) | :heavy_check_mark:                                                                                 | The request object to use for the request.                                                         |
+| `retries`                                                                                          | [utils.RetryConfig](../../internal/utils/retryconfig.md)                                           | :heavy_minus_sign:                                                                                 | Configuration to override the default retry behavior of the client.                                |
 | `config`                                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                       | :heavy_minus_sign:                                                                                 | Available config options for making requests.                                                      |
 
 
diff --git a/gen.yaml b/gen.yaml
@@ -8,7 +8,7 @@ generation:
     parameterOrderingFeb2024: false
     requestResponseComponentNamesFeb2024: false
 typescript:
-  version: 3.0.1
+  version: 3.1.0
   author: Speakeasy
   clientServerStatusCodesAsErrors: false
   flattenGlobalSecurity: false
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@speakeasy-api/speakeasy-client-sdk-typescript",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "author": "Speakeasy",
   "scripts": {
     "prepare": "tsc --build",
diff --git a/src/sdk/events.ts b/src/sdk/events.ts
@@ -3,6 +3,7 @@
  */
 
 import * as utils from "../internal/utils";
+import * as errors from "../sdk/models/errors";
 import * as operations from "../sdk/models/operations";
 import * as shared from "../sdk/models/shared";
 import { SDKConfiguration } from "./sdk";
@@ -27,6 +28,7 @@ export class Events {
      */
     async postWorkspaceEvents(
         req: operations.PostWorkspaceEventsRequest,
+        retries?: utils.RetryConfig,
         config?: AxiosRequestConfig
     ): Promise<operations.PostWorkspaceEventsResponse> {
         if (!(req instanceof utils.SpeakeasyBase)) {
@@ -68,19 +70,34 @@ export class Events {
             ...properties.headers,
         };
         if (reqBody == null) throw new Error("request body is required");
-        headers["Accept"] = "*/*";
+        headers["Accept"] = "application/json";
 
         headers["user-agent"] = this.sdkConfiguration.userAgent;
 
-        const httpRes: AxiosResponse = await client.request({
-            validateStatus: () => true,
-            url: operationUrl,
-            method: "post",
-            headers: headers,
-            responseType: "arraybuffer",
-            data: reqBody,
-            ...config,
-        });
+        const globalRetryConfig = this.sdkConfiguration.retryConfig;
+        let retryConfig: utils.RetryConfig | undefined = retries;
+        if (!retryConfig) {
+            if (globalRetryConfig) {
+                retryConfig = globalRetryConfig;
+            } else {
+                retryConfig = new utils.RetryConfig(
+                    "backoff",
+                    new utils.BackoffStrategy(100, 2000, 1.5, 30000),
+                    true
+                );
+            }
+        }
+        const httpRes: AxiosResponse = await utils.Retry(() => {
+            return client.request({
+                validateStatus: () => true,
+                url: operationUrl,
+                method: "post",
+                headers: headers,
+                responseType: "arraybuffer",
+                data: reqBody,
+                ...config,
+            });
+        }, new utils.Retries(retryConfig, ["408", "500", "502", "503"]));
 
         const responseContentType: string = httpRes?.headers?.["content-type"] ?? "";
 
@@ -94,8 +111,21 @@ export class Events {
                 contentType: responseContentType,
                 rawResponse: httpRes,
             });
+        const decodedRes = new TextDecoder().decode(httpRes?.data);
         switch (true) {
-            default:
+            case httpRes?.status >= 200 && httpRes?.status < 300:
+                break;
+            case httpRes?.status >= 500 && httpRes?.status < 600:
+                if (utils.matchContentType(responseContentType, `application/json`)) {
+                    res.error = utils.objectToClass(JSON.parse(decodedRes), shared.ErrorT);
+                } else {
+                    throw new errors.SDKError(
+                        "unknown content-type received: " + responseContentType,
+                        httpRes.status,
+                        decodedRes,
+                        httpRes
+                    );
+                }
                 break;
         }
 
diff --git a/src/sdk/models/operations/postworkspaceevents.ts b/src/sdk/models/operations/postworkspaceevents.ts
@@ -24,6 +24,9 @@ export class PostWorkspaceEventsResponse extends SpeakeasyBase {
     @SpeakeasyMetadata()
     contentType: string;
 
+    @SpeakeasyMetadata()
+    error?: shared.ErrorT;
+
     /**
      * HTTP response status code for this operation
      */
diff --git a/src/sdk/sdk.ts b/src/sdk/sdk.ts
@@ -64,10 +64,10 @@ export class SDKConfiguration {
     serverDefaults: any;
     language = "typescript";
     openapiDocVersion = "0.4.0";
-    sdkVersion = "3.0.1";
-    genVersion = "2.250.16";
+    sdkVersion = "3.1.0";
+    genVersion = "2.250.22";
     userAgent =
-        "speakeasy-sdk/typescript 3.0.1 2.250.16 0.4.0 @speakeasy-api/speakeasy-client-sdk-typescript";
+        "speakeasy-sdk/typescript 3.1.0 2.250.22 0.4.0 @speakeasy-api/speakeasy-client-sdk-typescript";
     globals: any;
     retryConfig?: utils.RetryConfig;
     public constructor(init?: Partial<SDKConfiguration>) {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@speakeasy-api/speakeasy-client-sdk-typescript",`
`3`		`- "version": "3.0.1",`
	`3`	`+ "version": "3.1.0",`
`4`	`4`	`"author": "Speakeasy",`
`5`	`5`	`"scripts": {`
`6`	`6`	`"prepare": "tsc --build",`