ci: regenerated with OpenAPI Doc 0.4.0 ., Speakeasy CLI 1.296.1

speakeasybot · speakeasybot · commit 62abc249e4b0 · 2024-05-25T00:11:56.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: c1d828d0e8ecf8fac6bec9e95f0ca086
+  docChecksum: 8a861fbcf601580459816dcab1973d85
   docVersion: 0.4.0 .
-  speakeasyVersion: 1.295.2
-  generationVersion: 2.335.5
-  releaseVersion: 3.3.3
-  configChecksum: cbbb7f5c89a3b545efe7057a5f101858
+  speakeasyVersion: 1.296.1
+  generationVersion: 2.338.1
+  releaseVersion: 3.3.4
+  configChecksum: f9b752d021d3a6a8f21c9fe9beb11516
   repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript.git
   repoSubDirectory: .
   installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript
@@ -34,6 +34,7 @@ generatedFiles:
   - src/sdk/github.ts
   - src/sdk/organizations.ts
   - src/sdk/reports.ts
+  - src/sdk/suggest.ts
   - src/sdk/embeds.ts
   - src/sdk/events.ts
   - src/sdk/sdk.ts
@@ -104,6 +105,7 @@ generatedFiles:
   - src/sdk/models/operations/getchangesreportsignedurl.ts
   - src/sdk/models/operations/getlintingreportsignedurl.ts
   - src/sdk/models/operations/uploadreport.ts
+  - src/sdk/models/operations/suggestoperationids.ts
   - src/sdk/models/operations/getembedaccesstoken.ts
   - src/sdk/models/operations/getvalidembedaccesstokens.ts
   - src/sdk/models/operations/revokeembedaccesstoken.ts
@@ -253,6 +255,13 @@ generatedFiles:
   - docs/sdk/models/operations/uploadreportrequestbody.md
   - docs/sdk/models/operations/uploadreportuploadedreport.md
   - docs/sdk/models/operations/uploadreportresponse.md
+  - docs/sdk/models/operations/depthstyle.md
+  - docs/sdk/models/operations/style.md
+  - docs/sdk/models/operations/opts.md
+  - docs/sdk/models/operations/schema.md
+  - docs/sdk/models/operations/suggestoperationidsrequestbody.md
+  - docs/sdk/models/operations/suggestoperationidssuggestion.md
+  - docs/sdk/models/operations/suggestoperationidsresponse.md
   - docs/sdk/models/operations/getembedaccesstokenrequest.md
   - docs/sdk/models/operations/getembedaccesstokenresponse.md
   - docs/sdk/models/operations/getvalidembedaccesstokensresponse.md
@@ -333,6 +342,7 @@ generatedFiles:
   - docs/sdks/github/README.md
   - docs/sdks/organizations/README.md
   - docs/sdks/reports/README.md
+  - docs/sdks/suggest/README.md
   - docs/sdks/embeds/README.md
   - docs/sdks/events/README.md
   - USAGE.md
diff --git a/README.md b/README.md
@@ -131,6 +131,10 @@ run();
 * [getLintingReportSignedUrl](docs/sdks/reports/README.md#getlintingreportsignedurl) - Get the signed access url for the linting reports for a particular document.
 * [uploadReport](docs/sdks/reports/README.md#uploadreport) - Upload a report.
 
+### [suggest](docs/sdks/suggest/README.md)
+
+* [suggestOperationIDs](docs/sdks/suggest/README.md#suggestoperationids) - Generate operation ID suggestions.
+
 ### [embeds](docs/sdks/embeds/README.md)
 
 * [getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
diff --git a/RELEASES.md b/RELEASES.md
@@ -1496,4 +1496,14 @@ Based on:
 ### Generated
 - [typescript v3.3.3] .
 ### Releases
-- [NPM v3.3.3] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.3 - .
+- [NPM v3.3.3] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.3 - .
+
+## 2024-05-25 00:11:28
+### Changes
+Based on:
+- OpenAPI Doc 0.4.0 . https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v3.3.4] .
+### Releases
+- [NPM v3.3.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.4 - .
diff --git a/docs/sdk/models/operations/depthstyle.md b/docs/sdk/models/operations/depthstyle.md
@@ -0,0 +1,11 @@
+# DepthStyle
+
+
+## Values
+
+| Name       | Value      |
+| ---------- | ---------- |
+| `Original` | original   |
+| `Flat`     | flat       |
+| `Nested`   | nested     |
+| `Deep`     | deep       |
diff --git a/docs/sdk/models/operations/opts.md b/docs/sdk/models/operations/opts.md
@@ -0,0 +1,9 @@
+# Opts
+
+
+## Fields
+
+| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `depthStyle`                                                          | [operations.DepthStyle](../../../sdk/models/operations/depthstyle.md) | :heavy_minus_sign:                                                    | N/A                                                                   |
+| `style`                                                               | [operations.Style](../../../sdk/models/operations/style.md)           | :heavy_minus_sign:                                                    | N/A                                                                   |
diff --git a/docs/sdk/models/operations/schema.md b/docs/sdk/models/operations/schema.md
@@ -0,0 +1,9 @@
+# Schema
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `content`          | *Uint8Array*       | :heavy_check_mark: | N/A                |
+| `fileName`         | *string*           | :heavy_check_mark: | N/A                |
diff --git a/docs/sdk/models/operations/style.md b/docs/sdk/models/operations/style.md
@@ -0,0 +1,9 @@
+# Style
+
+
+## Values
+
+| Name          | Value         |
+| ------------- | ------------- |
+| `Standardize` | standardize   |
+| `Resource`    | resource      |
diff --git a/docs/sdk/models/operations/suggestoperationidsrequestbody.md b/docs/sdk/models/operations/suggestoperationidsrequestbody.md
@@ -0,0 +1,11 @@
+# SuggestOperationIDsRequestBody
+
+The schema file to upload provided as a multipart/form-data file segment.
+
+
+## Fields
+
+| Field                                                         | Type                                                          | Required                                                      | Description                                                   |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `opts`                                                        | [operations.Opts](../../../sdk/models/operations/opts.md)     | :heavy_minus_sign:                                            | N/A                                                           |
+| `schema`                                                      | [operations.Schema](../../../sdk/models/operations/schema.md) | :heavy_check_mark:                                            | N/A                                                           |
diff --git a/docs/sdk/models/operations/suggestoperationidsresponse.md b/docs/sdk/models/operations/suggestoperationidsresponse.md
@@ -0,0 +1,11 @@
+# SuggestOperationIDsResponse
+
+
+## Fields
+
+| Field                                                                                                       | Type                                                                                                        | Required                                                                                                    | Description                                                                                                 |
+| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| `contentType`                                                                                               | *string*                                                                                                    | :heavy_check_mark:                                                                                          | HTTP response content type for this operation                                                               |
+| `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                                                     |
+| `suggestion`                                                                                                | [operations.SuggestOperationIDsSuggestion](../../../sdk/models/operations/suggestoperationidssuggestion.md) | :heavy_minus_sign:                                                                                          | OK                                                                                                          |
diff --git a/docs/sdk/models/operations/suggestoperationidssuggestion.md b/docs/sdk/models/operations/suggestoperationidssuggestion.md
@@ -0,0 +1,10 @@
+# SuggestOperationIDsSuggestion
+
+OK
+
+
+## Fields
+
+| Field                      | Type                       | Required                   | Description                |
+| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
+| `operationIds`             | Record<string, *string*[]> | :heavy_check_mark:         | N/A                        |
diff --git a/docs/sdks/reports/README.md b/docs/sdks/reports/README.md
@@ -122,7 +122,7 @@ async function run() {
     data: {},
     file: {
       content: new TextEncoder().encode("0xA329C0ad85"),
-      fileName: "sausages.m3a",
+      fileName: "your_file_here",
     },
   });
 
diff --git a/docs/sdks/schemas/README.md b/docs/sdks/schemas/README.md
@@ -367,7 +367,7 @@ async function run() {
     requestBody: {
       file: {
         content: new TextEncoder().encode("0xCAFCA03e0e"),
-        fileName: "bronze_table_blues.m2a",
+        fileName: "your_file_here",
       },
     },
     apiID: "<value>",
diff --git a/docs/sdks/suggest/README.md b/docs/sdks/suggest/README.md
@@ -0,0 +1,60 @@
+# Suggest
+(*suggest*)
+
+## Overview
+
+REST APIs for managing LLM OAS suggestions
+
+### Available Operations
+
+* [suggestOperationIDs](#suggestoperationids) - Generate operation ID suggestions.
+
+## suggestOperationIDs
+
+Get suggestions from an LLM model for improving the operationIDs in the provided schema.
+
+### Example Usage
+
+```typescript
+import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
+import { DepthStyle, Style } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
+
+async function run() {
+  const sdk = new Speakeasy({
+    security: {
+      apiKey: "<YOUR_API_KEY_HERE>",
+    },
+  });
+
+  const res = await sdk.suggest.suggestOperationIDs({
+    opts: {},
+    schema: {
+      content: new TextEncoder().encode("0xb2de88c98a"),
+      fileName: "your_file_here",
+    },
+  });
+
+  if (res.statusCode == 200) {
+    // handle response
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                  | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `request`                                                                                                  | [operations.SuggestOperationIDsRequestBody](../../sdk/models/operations/suggestoperationidsrequestbody.md) | :heavy_check_mark:                                                                                         | The request object to use for the request.                                                                 |
+| `config`                                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                               | :heavy_minus_sign:                                                                                         | Available config options for making requests.                                                              |
+
+
+### Response
+
+**Promise<[operations.SuggestOperationIDsResponse](../../sdk/models/operations/suggestoperationidsresponse.md)>**
+### Errors
+
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4xx-5xx         | */*             |
diff --git a/gen.yaml b/gen.yaml
@@ -10,7 +10,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 typescript:
-  version: 3.3.3
+  version: 3.3.4
   author: Speakeasy
   clientServerStatusCodesAsErrors: false
   flattenGlobalSecurity: false
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/src/sdk/models/operations/index.ts b/src/sdk/models/operations/index.ts
diff --git a/src/sdk/models/operations/suggestoperationids.ts b/src/sdk/models/operations/suggestoperationids.ts
diff --git a/src/sdk/sdk.ts b/src/sdk/sdk.ts
diff --git a/src/sdk/suggest.ts b/src/sdk/suggest.ts
