ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.434.0

speakeasy-api · Nov 7, 2024 · 5357ab9 · 5357ab9
1 parent ece7db9
commit 5357ab9
Show file tree

Hide file tree

Showing 289 changed files with 4,909 additions and 976 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,18 +1,20 @@
-speakeasyVersion: 1.414.1
+speakeasyVersion: 1.434.0
 sources:
     my-source:
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:1028a5681cdb95a67b15df8dbdc317bb263a1a3777b8f0a01adfa4cf681d5ac4
-        sourceBlobDigest: sha256:09998bda13d2cfb8f8b4358ed65c6a132bd8a5f7fc1825bf153dec19b1c89744
+        sourceRevisionDigest: sha256:9824359ae320945242d59513389993f8e37819141b76143acca4ba2ca3f65e46
+        sourceBlobDigest: sha256:626d2551e4a9e62c3e36b71f3896d953746f43790e69b8e2475591aa049940ed
         tags:
             - latest
             - main
 targets:
     speakeasy-client-sdk-typescript:
         source: my-source
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:1028a5681cdb95a67b15df8dbdc317bb263a1a3777b8f0a01adfa4cf681d5ac4
-        sourceBlobDigest: sha256:09998bda13d2cfb8f8b4358ed65c6a132bd8a5f7fc1825bf153dec19b1c89744
+        sourceRevisionDigest: sha256:9824359ae320945242d59513389993f8e37819141b76143acca4ba2ca3f65e46
+        sourceBlobDigest: sha256:626d2551e4a9e62c3e36b71f3896d953746f43790e69b8e2475591aa049940ed
+        codeSamplesNamespace: my-source-code-samples
+        codeSamplesRevisionDigest: sha256:e3e606507befb4533fa2a41314a1ac4ee54b5abe69e376d173e1d78ce0ac13c2
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -29,3 +31,7 @@ workflow:
             publish:
                 npm:
                     token: $npm_token
+            codeSamples:
+                registry:
+                    location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/my-source-code-samples
+                blocking: false
diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml
@@ -13,3 +13,7 @@ targets:
         publish:
             npm:
                 token: $npm_token
+        codeSamples:
+            registry:
+                location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/my-source-code-samples
+            blocking: false
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <!-- Start Summary [summary] -->
 ## Summary
 
-Speakeasy API: The Speakeasy API allows teams to manage common operations with their APIs
+Speakeasy API: The Subscriptions API manages subscriptions for CLI and registry events
 
 For more information about the API: [The Speakeasy Platform Documentation](/docs)
 <!-- End Summary [summary] -->
@@ -16,6 +16,7 @@ For more information about the API: [The Speakeasy Platform Documentation](/docs
 * [SDK Example Usage](#sdk-example-usage)
 * [Available Resources and Operations](#available-resources-and-operations)
 * [Standalone functions](#standalone-functions)
+* [Global Parameters](#global-parameters)
 * [File uploads](#file-uploads)
 * [Retries](#retries)
 * [Error Handling](#error-handling)
@@ -112,11 +113,13 @@ run();
 
 ### [artifacts](docs/sdks/artifacts/README.md)
 
+* [createRemoteSource](docs/sdks/artifacts/README.md#createremotesource) - Configure a new remote source
 * [getBlob](docs/sdks/artifacts/README.md#getblob) - Get blob for a particular digest
 * [getManifest](docs/sdks/artifacts/README.md#getmanifest) - Get manifest for a particular reference
 * [getNamespaces](docs/sdks/artifacts/README.md#getnamespaces) - Each namespace contains many revisions.
 * [getRevisions](docs/sdks/artifacts/README.md#getrevisions)
 * [getTags](docs/sdks/artifacts/README.md#gettags)
+* [listRemoteSources](docs/sdks/artifacts/README.md#listremotesources) - Get remote sources attached to a particular namespace
 * [postTags](docs/sdks/artifacts/README.md#posttags) - Add tags to an existing revision
 * [preflight](docs/sdks/artifacts/README.md#preflight) - Get access token for communicating with OCI distribution endpoints
 
@@ -150,6 +153,7 @@ run();
 * [configureMintlifyRepo](docs/sdks/github/README.md#configuremintlifyrepo)
 * [configureTarget](docs/sdks/github/README.md#configuretarget)
 * [getAction](docs/sdks/github/README.md#getaction)
+* [linkGithub](docs/sdks/github/README.md#linkgithub)
 * [storePublishingSecrets](docs/sdks/github/README.md#storepublishingsecrets)
 * [triggerAction](docs/sdks/github/README.md#triggeraction)
 
@@ -195,9 +199,15 @@ run();
 * [create](docs/sdks/shorturls/README.md#create) - Shorten a URL.
 
 
+### [subscriptions](docs/sdks/subscriptions/README.md)
+
+* [createSubscription](docs/sdks/subscriptions/README.md#createsubscription) - Create Subscription
+* [listRegistrySubscriptions](docs/sdks/subscriptions/README.md#listregistrysubscriptions) - List Subscriptions
+
 ### [suggest](docs/sdks/suggest/README.md)
 
 * [suggest](docs/sdks/suggest/README.md#suggest) - Generate suggestions for improving an OpenAPI document.
+* [suggestItems](docs/sdks/suggest/README.md#suggestitems) - Generate generic suggestions for a list of items.
 * [suggestOpenAPI](docs/sdks/suggest/README.md#suggestopenapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
 * [suggestOpenAPIRegistry](docs/sdks/suggest/README.md#suggestopenapiregistry) - Generate suggestions for improving an OpenAPI document stored in the registry.
 
@@ -559,11 +569,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`apisGetAllApiVersions`](docs/sdks/apis/README.md#getallapiversions) - Get all Api versions for a particular ApiEndpoint.
 - [`apisGetApis`](docs/sdks/apis/README.md#getapis) - Get a list of Apis for a given workspace
 - [`apisUpsertApi`](docs/sdks/apis/README.md#upsertapi) - Upsert an Api
+- [`artifactsCreateRemoteSource`](docs/sdks/artifacts/README.md#createremotesource) - Configure a new remote source
 - [`artifactsGetBlob`](docs/sdks/artifacts/README.md#getblob) - Get blob for a particular digest
 - [`artifactsGetManifest`](docs/sdks/artifacts/README.md#getmanifest) - Get manifest for a particular reference
 - [`artifactsGetNamespaces`](docs/sdks/artifacts/README.md#getnamespaces) - Each namespace contains many revisions.
 - [`artifactsGetRevisions`](docs/sdks/artifacts/README.md#getrevisions)
 - [`artifactsGetTags`](docs/sdks/artifacts/README.md#gettags)
+- [`artifactsListRemoteSources`](docs/sdks/artifacts/README.md#listremotesources) - Get remote sources attached to a particular namespace
 - [`artifactsPostTags`](docs/sdks/artifacts/README.md#posttags) - Add tags to an existing revision
 - [`artifactsPreflight`](docs/sdks/artifacts/README.md#preflight) - Get access token for communicating with OCI distribution endpoints
 - [`authGetAccess`](docs/sdks/auth/README.md#getaccess) - Get access allowances for a particular workspace
@@ -585,6 +597,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`githubConfigureMintlifyRepo`](docs/sdks/github/README.md#configuremintlifyrepo)
 - [`githubConfigureTarget`](docs/sdks/github/README.md#configuretarget)
 - [`githubGetAction`](docs/sdks/github/README.md#getaction)
+- [`githubLinkGithub`](docs/sdks/github/README.md#linkgithub)
 - [`githubStorePublishingSecrets`](docs/sdks/github/README.md#storepublishingsecrets)
 - [`githubTriggerAction`](docs/sdks/github/README.md#triggeraction)
 - [`metadataDeleteVersionMetadata`](docs/sdks/metadata/README.md#deleteversionmetadata) - Delete metadata for a particular apiID and versionID.
@@ -610,7 +623,10 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`schemasGetSchemas`](docs/sdks/schemas/README.md#getschemas) - Get information about all schemas associated with a particular apiID.
 - [`schemasRegisterSchema`](docs/sdks/schemas/README.md#registerschema) - Register a schema.
 - [`shortURLsCreate`](docs/sdks/shorturls/README.md#create) - Shorten a URL.
+- [`subscriptionsCreateSubscription`](docs/sdks/subscriptions/README.md#createsubscription) - Create Subscription
+- [`subscriptionsListRegistrySubscriptions`](docs/sdks/subscriptions/README.md#listregistrysubscriptions) - List Subscriptions
 - [`suggestSuggest`](docs/sdks/suggest/README.md#suggest) - Generate suggestions for improving an OpenAPI document.
+- [`suggestSuggestItems`](docs/sdks/suggest/README.md#suggestitems) - Generate generic suggestions for a list of items.
 - [`suggestSuggestOpenAPI`](docs/sdks/suggest/README.md#suggestopenapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
 - [`suggestSuggestOpenAPIRegistry`](docs/sdks/suggest/README.md#suggestopenapiregistry) - Generate suggestions for improving an OpenAPI document stored in the registry.
 - [`workspacesCreate`](docs/sdks/workspaces/README.md#create) - Create a workspace
@@ -631,6 +647,44 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
 
+<!-- Start Global Parameters [global-parameters] -->
+## Global Parameters
+
+A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
+
+For example, you can set `workspace_id` to `"<id>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getAccessToken`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
+
+
+### Available Globals
+
+The following global parameter is available.
+
+| Name | Type | Required | Description |
+| ---- | ---- |:--------:| ----------- |
+| workspaceId | string |  | The workspaceId parameter. |
+
+
+### Example
+
+```typescript
+import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
+
+const speakeasy = new Speakeasy();
+
+async function run() {
+  const result = await speakeasy.auth.getAccessToken({
+    workspaceId: "<id>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Global Parameters [global-parameters] -->
+
 <!-- Start File uploads [file-upload] -->
 ## File uploads
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -1656,4 +1656,14 @@ Based on:
 ### Generated
 - [typescript v4.0.0-rc.2] .
 ### Releases
-- [NPM v4.0.0-rc.2] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/4.0.0-rc.2 - .
+- [NPM v4.0.0-rc.2] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/4.0.0-rc.2 - .
+
+## 2024-11-07 00:18:06
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.434.0 (2.452.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v4.0.0-rc.3] .
+### Releases
+- [NPM v4.0.0-rc.3] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/4.0.0-rc.3 - .
diff --git a/docs/sdk/models/operations/createorganizationresponse.md b/docs/sdk/models/operations/createorganizationresponse.md
@@ -8,21 +8,21 @@
 ```typescript
 const value: shared.ErrorT = {
   message: "<value>",
-  statusCode: 501,
+  statusCode: 426,
 };
 ```
 
 ### `shared.Organization`
 
 ```typescript
 const value: shared.Organization = {
-  accountType: "enterprise",
-  createdAt: new Date("2022-11-19T12:22:37.852Z"),
+  accountType: "free",
+  createdAt: new Date("2022-11-16T08:41:29.527Z"),
   id: "<id>",
   name: "<value>",
   slug: "<value>",
   telemetryDisabled: false,
-  updatedAt: new Date("2023-04-23T03:32:15.282Z"),
+  updatedAt: new Date("2022-02-11T16:43:38.291Z"),
 };
 ```
 
diff --git a/docs/sdk/models/operations/createrequestbody.md b/docs/sdk/models/operations/createrequestbody.md
@@ -6,7 +6,7 @@
 import { CreateRequestBody } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
 
 let value: CreateRequestBody = {
-  url: "https://fruitful-masterpiece.org",
+  url: "https://discrete-habit.name/",
 };
 ```
 

diff --git a/docs/sdk/models/operations/createsubscriptionglobals.md b/docs/sdk/models/operations/createsubscriptionglobals.md
@@ -0,0 +1,15 @@
+# CreateSubscriptionGlobals
+
+## Example Usage
+
+```typescript
+import { CreateSubscriptionGlobals } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
+
+let value: CreateSubscriptionGlobals = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `workspaceId`      | *string*           | :heavy_minus_sign: | N/A                |
diff --git a/docs/sdk/models/operations/createsubscriptionrequest.md b/docs/sdk/models/operations/createsubscriptionrequest.md
@@ -0,0 +1,27 @@
+# CreateSubscriptionRequest
+
+## Example Usage
+
+```typescript
+import { CreateSubscriptionRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
+
+let value: CreateSubscriptionRequest = {
+  registrySubscription: {
+    createdAt: new Date("2022-06-08T02:05:29.917Z"),
+    eventType: "update",
+    id: "<id>",
+    namespaceName: "<value>",
+    subscriptionSettings: "<value>",
+    subscriptionType: "cli",
+    updatedAt: new Date("2024-07-09T15:47:57.182Z"),
+    workspaceId: "<id>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                             | Type                                                                              | Required                                                                          | Description                                                                       |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `workspaceId`                                                                     | *string*                                                                          | :heavy_minus_sign:                                                                | The workspace ID                                                                  |
+| `registrySubscription`                                                            | [shared.RegistrySubscription](../../../sdk/models/shared/registrysubscription.md) | :heavy_check_mark:                                                                | The subscription to create                                                        |
diff --git a/docs/sdk/models/operations/createworkspaceresponse.md b/docs/sdk/models/operations/createworkspaceresponse.md
@@ -8,21 +8,20 @@
 ```typescript
 const value: shared.ErrorT = {
   message: "<value>",
-  statusCode: 408,
+  statusCode: 500,
 };
 ```
 
 ### `shared.Workspace`
 
 ```typescript
 const value: shared.Workspace = {
-  createdAt: new Date("2022-04-24T23:18:08.610Z"),
+  createdAt: new Date("2022-01-01T09:39:45.396Z"),
   id: "<id>",
   name: "<value>",
   organizationId: "<id>",
   slug: "<value>",
-  telemetryDisabled: false,
-  updatedAt: new Date("2024-09-22T01:21:39.695Z"),
+  updatedAt: new Date("2022-10-28T00:15:47.100Z"),
   verified: false,
 };
 ```

diff --git a/docs/sdk/models/operations/createworkspacetokenglobals.md b/docs/sdk/models/operations/createworkspacetokenglobals.md
@@ -0,0 +1,15 @@
+# CreateWorkspaceTokenGlobals
+
+## Example Usage
+
+```typescript
+import { CreateWorkspaceTokenGlobals } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
+
+let value: CreateWorkspaceTokenGlobals = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `workspaceId`      | *string*           | :heavy_minus_sign: | N/A                |
diff --git a/docs/sdk/models/operations/createworkspacetokenrequest.md b/docs/sdk/models/operations/createworkspacetokenrequest.md
@@ -6,13 +6,13 @@
 import { CreateWorkspaceTokenRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
 
 let value: CreateWorkspaceTokenRequest = {
-  workspaceId: "<id>",
   workspaceToken: {
     alg: "<value>",
-    createdAt: "<value>",
+    createdAt: new Date("2023-05-22T11:00:48.310Z"),
     id: "<id>",
     key: "<key>",
     name: "<value>",
+    workspaceId: "<id>",
   },
 };
 ```
@@ -21,5 +21,5 @@ let value: CreateWorkspaceTokenRequest = {
 
 | Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
 | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `workspaceId`                                                         | *string*                                                              | :heavy_check_mark:                                                    | Unique identifier of the workspace.                                   |
+| `workspaceId`                                                         | *string*                                                              | :heavy_minus_sign:                                                    | Unique identifier of the workspace.                                   |
 | `workspaceToken`                                                      | [shared.WorkspaceToken](../../../sdk/models/shared/workspacetoken.md) | :heavy_check_mark:                                                    | N/A                                                                   |
diff --git a/docs/sdk/models/operations/deleteworkspacetokenglobals.md b/docs/sdk/models/operations/deleteworkspacetokenglobals.md
@@ -0,0 +1,15 @@
+# DeleteWorkspaceTokenGlobals
+
+## Example Usage
+
+```typescript
+import { DeleteWorkspaceTokenGlobals } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
+
+let value: DeleteWorkspaceTokenGlobals = {};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `workspaceId`      | *string*           | :heavy_minus_sign: | N/A                |
diff --git a/docs/sdk/models/operations/deleteworkspacetokenrequest.md b/docs/sdk/models/operations/deleteworkspacetokenrequest.md
@@ -6,7 +6,6 @@
 import { DeleteWorkspaceTokenRequest } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/operations";
 
 let value: DeleteWorkspaceTokenRequest = {
-  workspaceId: "<id>",
   tokenID: "<id>",
 };
 ```
@@ -15,5 +14,5 @@ let value: DeleteWorkspaceTokenRequest = {
 
 | Field                               | Type                                | Required                            | Description                         |
 | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
-| `workspaceId`                       | *string*                            | :heavy_check_mark:                  | Unique identifier of the workspace. |
+| `workspaceId`                       | *string*                            | :heavy_minus_sign:                  | Unique identifier of the workspace. |
 | `tokenID`                           | *string*                            | :heavy_check_mark:                  | Unique identifier of the token.     |
diff --git a/docs/sdk/models/operations/downloadschemaresponse.md b/docs/sdk/models/operations/downloadschemaresponse.md
@@ -20,7 +20,7 @@ const value: ReadableStream<Uint8Array> = await openAsBlob("example.file");
 ```typescript
 const value: shared.ErrorT = {
   message: "<value>",
-  statusCode: 510,
+  statusCode: 305,
 };
 ```
 
diff --git a/docs/sdk/models/operations/downloadschemarevisionresponse.md b/docs/sdk/models/operations/downloadschemarevisionresponse.md
@@ -20,7 +20,7 @@ const value: ReadableStream<Uint8Array> = await openAsBlob("example.file");
 ```typescript
 const value: shared.ErrorT = {
   message: "<value>",
-  statusCode: 401,
+  statusCode: 308,
 };
 ```
 
diff --git a/docs/sdk/models/operations/findapiendpointrequest.md b/docs/sdk/models/operations/findapiendpointrequest.md
@@ -8,7 +8,7 @@ import { FindApiEndpointRequest } from "@speakeasy-api/speakeasy-client-sdk-type
 let value: FindApiEndpointRequest = {
   apiID: "<id>",
   versionID: "<id>",
-  displayName: "Myriam_Powlowski71",
+  displayName: "Cory_Terry",
 };
 ```