diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 7148b0e..bf89ab5 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,18 +1,18 @@ lockVersion: 2.0.0 id: ee307ad3-8dfc-4d06-9c04-86e7d437810d management: - docChecksum: cf89a4fde0fbc1524296a333f75ea848 - docVersion: 0.4.0 . - speakeasyVersion: 1.405.8 - generationVersion: 2.429.0 - releaseVersion: 4.2.24 - configChecksum: b44c4c6d10fc1cef416d8c5bd31c898a + docChecksum: 4eeb9ba3e43b84ddc6061ea69a073a47 + docVersion: 0.4.0 + speakeasyVersion: 1.441.0 + generationVersion: 2.460.1 + releaseVersion: 4.3.0 + configChecksum: 6536735459f6ffbd3790af4eb3aeee87 repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby.git installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-ruby published: true features: ruby: - core: 3.2.26 + core: 3.3.1 deprecations: 2.81.1 examples: 2.81.3 flattening: 2.81.1 @@ -35,8 +35,11 @@ generatedFiles: - docs/models/operations/checkgithubaccessresponse.md - docs/models/operations/createfreetrialresponse.md - docs/models/operations/createorganizationresponse.md + - docs/models/operations/createremotesourceresponse.md - docs/models/operations/createrequestbody.md - docs/models/operations/createresponse.md + - docs/models/operations/createsubscriptionrequest.md + - docs/models/operations/createsubscriptionresponse.md - docs/models/operations/createworkspaceresponse.md - docs/models/operations/createworkspacetokenrequest.md - docs/models/operations/createworkspacetokenresponse.md @@ -57,6 +60,9 @@ generatedFiles: - docs/models/operations/file.md - docs/models/operations/findapiendpointrequest.md - docs/models/operations/findapiendpointresponse.md + - docs/models/operations/generatecodesamplepreviewasyncresponse.md + - docs/models/operations/generatecodesamplepreviewasyncresponsebody.md + - docs/models/operations/generatecodesamplepreviewresponse.md - docs/models/operations/generateopenapispecforapiendpointrequest.md - docs/models/operations/generateopenapispecforapiendpointresponse.md - docs/models/operations/generateopenapispecrequest.md @@ -84,6 +90,9 @@ generatedFiles: - docs/models/operations/getchangesreportsignedurlrequest.md - docs/models/operations/getchangesreportsignedurlresponse.md - docs/models/operations/getchangesreportsignedurlsignedaccess.md + - docs/models/operations/getcodesamplepreviewasyncrequest.md + - docs/models/operations/getcodesamplepreviewasyncresponse.md + - docs/models/operations/getcodesamplepreviewasyncresponsebody.md - docs/models/operations/getembedaccesstokenrequest.md - docs/models/operations/getembedaccesstokenresponse.md - docs/models/operations/getgithubactionrequest.md @@ -149,6 +158,12 @@ generatedFiles: - docs/models/operations/grantuseraccesstoworkspaceresponse.md - docs/models/operations/insertversionmetadatarequest.md - docs/models/operations/insertversionmetadataresponse.md + - docs/models/operations/linkgithubaccessrequest.md + - docs/models/operations/linkgithubaccessresponse.md + - docs/models/operations/listregistrysubscriptionsrequest.md + - docs/models/operations/listregistrysubscriptionsresponse.md + - docs/models/operations/listremotesourcesrequest.md + - docs/models/operations/listremotesourcesresponse.md - docs/models/operations/op.md - docs/models/operations/posttagsrequest.md - docs/models/operations/posttagsresponse.md @@ -168,6 +183,7 @@ generatedFiles: - docs/models/operations/schema.md - docs/models/operations/searchworkspaceeventsrequest.md - docs/models/operations/searchworkspaceeventsresponse.md + - docs/models/operations/suggestitemsresponse.md - docs/models/operations/suggestopenapiregistryrequest.md - docs/models/operations/suggestopenapiregistryresponse.md - docs/models/operations/suggestopenapirequest.md @@ -203,10 +219,13 @@ generatedFiles: - docs/models/shared/boundedrequest.md - docs/models/shared/claims.md - docs/models/shared/clievent.md + - docs/models/shared/codesampleschemainput.md + - docs/models/shared/codesamplesjobstatus.md - docs/models/shared/diagnostic.md - docs/models/shared/embedaccesstokenresponse.md - docs/models/shared/embedtoken.md - docs/models/shared/error.md + - docs/models/shared/eventtype.md - docs/models/shared/featureflag.md - docs/models/shared/filter.md - docs/models/shared/filters.md @@ -238,16 +257,22 @@ generatedFiles: - docs/models/shared/organizationusageresponse.md - docs/models/shared/preflightrequest.md - docs/models/shared/preflighttoken.md + - docs/models/shared/registrysubscription.md - docs/models/shared/relationship.md + - docs/models/shared/remotedocument.md + - docs/models/shared/remotesource.md - docs/models/shared/report.md - docs/models/shared/requestmetadata.md - docs/models/shared/revision.md - docs/models/shared/schema.md - docs/models/shared/schemadiff.md + - docs/models/shared/schemafile.md - docs/models/shared/security.md - docs/models/shared/shorturl.md - docs/models/shared/ssometadata.md + - docs/models/shared/subscriptiontype.md - docs/models/shared/suggestiontype.md + - docs/models/shared/suggestitemsrequestbody.md - docs/models/shared/suggestoptsold.md - docs/models/shared/suggestrequestbody.md - docs/models/shared/suggestrequestbodysuggestiontype.md @@ -284,6 +309,7 @@ generatedFiles: - docs/sdks/shorturls/README.md - docs/sdks/speakeasyclientsdk/README.md - docs/sdks/speakeasyclientsdkapiendpoints/README.md + - docs/sdks/subscriptions/README.md - docs/sdks/suggest/README.md - docs/sdks/workspaces/README.md - lib/open_api_sdk/apiendpoints.rb @@ -301,6 +327,9 @@ generatedFiles: - lib/open_api_sdk/models/operations/create_response.rb - lib/open_api_sdk/models/operations/createfreetrial_response.rb - lib/open_api_sdk/models/operations/createorganization_response.rb + - lib/open_api_sdk/models/operations/createremotesource_response.rb + - lib/open_api_sdk/models/operations/createsubscription_request.rb + - lib/open_api_sdk/models/operations/createsubscription_response.rb - lib/open_api_sdk/models/operations/createworkspace_response.rb - lib/open_api_sdk/models/operations/createworkspacetoken_request.rb - lib/open_api_sdk/models/operations/createworkspacetoken_response.rb @@ -321,6 +350,9 @@ generatedFiles: - lib/open_api_sdk/models/operations/file.rb - lib/open_api_sdk/models/operations/findapiendpoint_request.rb - lib/open_api_sdk/models/operations/findapiendpoint_response.rb + - lib/open_api_sdk/models/operations/generatecodesamplepreview_response.rb + - lib/open_api_sdk/models/operations/generatecodesamplepreviewasync_response.rb + - lib/open_api_sdk/models/operations/generatecodesamplepreviewasync_responsebody.rb - lib/open_api_sdk/models/operations/generateopenapispec_request.rb - lib/open_api_sdk/models/operations/generateopenapispec_response.rb - lib/open_api_sdk/models/operations/generateopenapispecforapiendpoint_request.rb @@ -348,6 +380,9 @@ generatedFiles: - lib/open_api_sdk/models/operations/getchangesreportsignedurl_request.rb - lib/open_api_sdk/models/operations/getchangesreportsignedurl_response.rb - lib/open_api_sdk/models/operations/getchangesreportsignedurl_signedaccess.rb + - lib/open_api_sdk/models/operations/getcodesamplepreviewasync_request.rb + - lib/open_api_sdk/models/operations/getcodesamplepreviewasync_response.rb + - lib/open_api_sdk/models/operations/getcodesamplepreviewasync_responsebody.rb - lib/open_api_sdk/models/operations/getembedaccesstoken_request.rb - lib/open_api_sdk/models/operations/getembedaccesstoken_response.rb - lib/open_api_sdk/models/operations/getgithubaction_request.rb @@ -413,6 +448,12 @@ generatedFiles: - lib/open_api_sdk/models/operations/grantuseraccesstoworkspace_response.rb - lib/open_api_sdk/models/operations/insertversionmetadata_request.rb - lib/open_api_sdk/models/operations/insertversionmetadata_response.rb + - lib/open_api_sdk/models/operations/linkgithubaccess_request.rb + - lib/open_api_sdk/models/operations/linkgithubaccess_response.rb + - lib/open_api_sdk/models/operations/listregistrysubscriptions_request.rb + - lib/open_api_sdk/models/operations/listregistrysubscriptions_response.rb + - lib/open_api_sdk/models/operations/listremotesources_request.rb + - lib/open_api_sdk/models/operations/listremotesources_response.rb - lib/open_api_sdk/models/operations/op.rb - lib/open_api_sdk/models/operations/posttags_request.rb - lib/open_api_sdk/models/operations/posttags_response.rb @@ -434,6 +475,7 @@ generatedFiles: - lib/open_api_sdk/models/operations/searchworkspaceevents_response.rb - lib/open_api_sdk/models/operations/suggest_request.rb - lib/open_api_sdk/models/operations/suggest_response.rb + - lib/open_api_sdk/models/operations/suggestitems_response.rb - lib/open_api_sdk/models/operations/suggestopenapi_request.rb - lib/open_api_sdk/models/operations/suggestopenapi_requestbody.rb - lib/open_api_sdk/models/operations/suggestopenapi_response.rb @@ -468,10 +510,13 @@ generatedFiles: - lib/open_api_sdk/models/shared/boundedrequest.rb - lib/open_api_sdk/models/shared/claims.rb - lib/open_api_sdk/models/shared/clievent.rb + - lib/open_api_sdk/models/shared/codesampleschemainput.rb + - lib/open_api_sdk/models/shared/codesamplesjobstatus.rb - lib/open_api_sdk/models/shared/diagnostic.rb - lib/open_api_sdk/models/shared/embedaccesstokenresponse.rb - lib/open_api_sdk/models/shared/embedtoken.rb - lib/open_api_sdk/models/shared/error.rb + - lib/open_api_sdk/models/shared/eventtype.rb - lib/open_api_sdk/models/shared/featureflag.rb - lib/open_api_sdk/models/shared/filter.rb - lib/open_api_sdk/models/shared/filters.rb @@ -503,16 +548,22 @@ generatedFiles: - lib/open_api_sdk/models/shared/organizationusageresponse.rb - lib/open_api_sdk/models/shared/preflightrequest.rb - lib/open_api_sdk/models/shared/preflighttoken.rb + - lib/open_api_sdk/models/shared/registrysubscription.rb - lib/open_api_sdk/models/shared/relationship.rb + - lib/open_api_sdk/models/shared/remotedocument.rb + - lib/open_api_sdk/models/shared/remotesource.rb - lib/open_api_sdk/models/shared/report.rb - lib/open_api_sdk/models/shared/requestmetadata.rb - lib/open_api_sdk/models/shared/revision.rb - lib/open_api_sdk/models/shared/schema.rb + - lib/open_api_sdk/models/shared/schema_file.rb - lib/open_api_sdk/models/shared/schemadiff.rb - lib/open_api_sdk/models/shared/security.rb - lib/open_api_sdk/models/shared/shorturl.rb - lib/open_api_sdk/models/shared/ssometadata.rb + - lib/open_api_sdk/models/shared/subscriptiontype.rb - lib/open_api_sdk/models/shared/suggestion_type.rb + - lib/open_api_sdk/models/shared/suggestitemsrequestbody.rb - lib/open_api_sdk/models/shared/suggestoptsold.rb - lib/open_api_sdk/models/shared/suggestrequestbody.rb - lib/open_api_sdk/models/shared/suggestrequestbody_suggestion_type.rb @@ -542,6 +593,7 @@ generatedFiles: - lib/open_api_sdk/shorturls.rb - lib/open_api_sdk/speakeasyclientsdk.rb - lib/open_api_sdk/speakeasyclientsdk_apiendpoints.rb + - lib/open_api_sdk/subscriptions.rb - lib/open_api_sdk/suggest.rb - lib/open_api_sdk/utils/metadata_fields.rb - lib/open_api_sdk/utils/t.rb @@ -876,7 +928,7 @@ examples: speakeasy-default-validate-api-key: responses: 2XX: - application/json: {"workspace_id": "", "workspace_slug": "", "org_slug": "", "account_type_v2": "enterprise", "enabled_features": ["", "", ""], "telemetry_disabled": true} + application/json: {"workspace_id": "", "workspace_slug": "", "org_slug": "", "account_type_v2": "enterprise", "enabled_features": ["", "", ""], "telemetry_disabled": true, "workspace_created_at": "2024-04-24T00:30:38.626Z"} 4XX: application/json: {"message": "", "status_code": 365836} getUser: @@ -1114,7 +1166,7 @@ examples: workspace_id: "" responses: 2XX: - application/json: {"workspace_id": ""} + application/json: {"workspace_id": "", "webhook_url": "https://ideal-hospitalization.biz", "created_at": "2022-02-07T14:50:24.533Z", "updated_at": "2022-01-26T01:43:28.591Z"} 4XX: application/json: {"message": "", "status_code": 802866} updateWorkspaceSettings: @@ -1123,7 +1175,7 @@ examples: path: workspace_id: "" requestBody: - application/json: {"workspace_id": ""} + application/json: {"workspace_id": "", "webhook_url": "https://last-suspension.info/", "created_at": "2023-12-29T06:46:35.807Z", "updated_at": "2024-02-04T10:37:56.725Z"} responses: 4XX: application/json: {"message": "", "status_code": 169241} @@ -1164,7 +1216,7 @@ examples: workspace_id: "" responses: 2XX: - application/json: [{"id": "", "name": "", "alg": "", "key": "", "created_at": ""}, {"id": "", "name": "", "alg": "", "key": "", "created_at": ""}, {"id": "", "name": "", "alg": "", "key": "", "created_at": ""}] + application/json: [{"id": "", "name": "", "workspace_id": "", "alg": "", "key": "", "created_at": ""}, {"id": "", "name": "", "workspace_id": "", "alg": "", "key": "", "created_at": ""}, {"id": "", "name": "", "workspace_id": "", "alg": "", "key": "", "created_at": ""}] 4XX: application/json: {"message": "", "status_code": 498293} createWorkspaceToken: @@ -1173,7 +1225,7 @@ examples: path: workspace_id: "" requestBody: - application/json: {"id": "", "name": "", "alg": "", "key": "", "created_at": ""} + application/json: {"id": "", "name": "", "workspace_id": "", "alg": "", "key": "", "created_at": ""} responses: 4XX: application/json: {"message": "", "status_code": 207213} @@ -1375,3 +1427,74 @@ examples: responses: 2XX: application/json: {"short_url": "https://standard-utilization.com/", "full_url": "https://brisk-seafood.net/"} + generateCodeSamplePreview: + speakeasy-default-generate-code-sample-preview: + requestBody: + multipart/form-data: {"languages": ["", ""], "schema_file": {"": "0x3dD8BfBefE"}} + responses: + "200": + application/x-yaml: "0x28e0E3f5d1" + application/json: "0xfA011e0be4" + 4XX: + application/json: {"message": "", "status_code": 396101} + generateCodeSamplePreviewAsync: + speakeasy-default-generate-code-sample-preview-async: + requestBody: + multipart/form-data: {"languages": ["", "", ""], "schema_file": {"": "0xD5CDd177Ee"}} + responses: + "202": + application/json: {"job_id": "", "status": "pending"} + 4XX: + application/json: {"message": "", "status_code": 394086} + getCodeSamplePreviewAsync: + speakeasy-default-get-code-sample-preview-async: + parameters: + path: + jobID: "" + responses: + "200": + application/x-yaml: "0x2090d4E1A7" + application/json: "0x14456CbEbA" + "202": + application/json: {"status": "running"} + 4XX: + application/json: {"message": "", "status_code": 462062} + linkGithubAccess: + speakeasy-default-link-github-access: + responses: + 4XX: + application/json: {"message": "", "status_code": 774553} + suggestItems: + speakeasy-default-suggest-items: + requestBody: + application/json: {"prompt": "", "items": []} + responses: + 2XX: + application/json: ["", ""] + listRemoteSources: + speakeasy-default-list-remote-sources: + parameters: + query: + namespace_name: "" + responses: + 2XX: + application/json: {"inputs": [{"registry_url": "https://well-lit-cap.net"}, {"registry_url": "https://vibrant-labourer.net"}], "output": {"registry_url": "https://unfit-minor.biz"}} + 4XX: + application/json: {"message": "", "status_code": 754391} + createRemoteSource: + speakeasy-default-create-remote-source: + responses: + 4XX: + application/json: {"message": "", "status_code": 580557} + listRegistrySubscriptions: + speakeasy-default-list-registry-subscriptions: + responses: + "200": + application/json: [{"id": "", "workspace_id": "", "event_type": "update", "namespace_name": "", "subscription_type": "cli", "subscription_settings": "", "created_at": "2022-12-26T20:06:41.993Z", "updated_at": "2023-10-12T18:58:27.338Z"}, {"id": "", "workspace_id": "", "event_type": "update", "namespace_name": "", "subscription_type": "cli", "subscription_settings": "", "created_at": "2022-07-07T11:51:20.859Z", "updated_at": "2022-03-26T04:16:26.649Z"}] + createSubscription: + speakeasy-default-create-subscription: + requestBody: + application/json: {"id": "", "workspace_id": "", "event_type": "update", "namespace_name": "", "subscription_type": "cli", "subscription_settings": "", "created_at": "2022-06-08T17:58:57.702Z", "updated_at": "2022-07-20T08:51:35.776Z"} + responses: + "200": + application/json: {"id": "", "workspace_id": "", "event_type": "update", "namespace_name": "", "subscription_type": "cli", "subscription_settings": "", "created_at": "2022-03-27T15:41:56.125Z", "updated_at": "2023-07-24T03:56:06.003Z"} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 854d462..70a45e2 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -11,8 +11,9 @@ generation: requestResponseComponentNamesFeb2024: true auth: oAuth2ClientCredentialsEnabled: true + oAuth2PasswordEnabled: false ruby: - version: 4.2.24 + version: 4.3.0 author: Speakeasy description: Ruby Client SDK Generated by Speakeasy imports: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index e399960..dfdbaa7 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.405.8 +speakeasyVersion: 1.441.0 sources: {} targets: speakeasy-client-sdk: @@ -21,3 +21,7 @@ workflow: publish: rubygems: token: $rubygems_auth_token + codeSamples: + registry: + location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/-oas-code-samples + blocking: false diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml index e280bf7..63b8ff3 100644 --- a/.speakeasy/workflow.yaml +++ b/.speakeasy/workflow.yaml @@ -15,3 +15,7 @@ targets: publish: rubygems: token: $rubygems_auth_token + codeSamples: + registry: + location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-self/-oas-code-samples + blocking: false diff --git a/README.md b/README.md index 4d0e7a2..1fb35ec 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Developer-friendly & type-safe Ruby SDK specifically catered to leverage *speake ## 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) @@ -28,6 +28,7 @@ For more information about the API: [The Speakeasy Platform Documentation](/docs * [SDK Installation](#sdk-installation) * [SDK Example Usage](#sdk-example-usage) * [Available Resources and Operations](#available-resources-and-operations) +* [Global Parameters](#global-parameters) * [Server Selection](#server-selection) @@ -79,11 +80,21 @@ end
Available methods -### [Apiendpoints](docs/sdks/apiendpoints/README.md) +### [api_endpoints](docs/sdks/speakeasyclientsdkapiendpoints/README.md) + +* [get_all](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get_all) - Get all ApiEndpoints for a particular apiID and versionID. +* [find](docs/sdks/speakeasyclientsdkapiendpoints/README.md#find) - Find an ApiEndpoint via its displayName. +* [delete](docs/sdks/speakeasyclientsdkapiendpoints/README.md#delete) - Delete an ApiEndpoint. +* [get](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get) - Get an ApiEndpoint. +* [upsert](docs/sdks/speakeasyclientsdkapiendpoints/README.md#upsert) - Upsert an ApiEndpoint. +* [generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint. +* [generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint. + +### [apiendpoints](docs/sdks/apiendpoints/README.md) * [list](docs/sdks/apiendpoints/README.md#list) - Get all Api endpoints for a particular apiID. -### [Apis](docs/sdks/apis/README.md) +### [apis](docs/sdks/apis/README.md) * [get_all](docs/sdks/apis/README.md#get_all) - Get a list of Apis for a given workspace * [get_all_versions](docs/sdks/apis/README.md#get_all_versions) - Get all Api versions for a particular ApiEndpoint. @@ -92,30 +103,32 @@ end * [generate_open_api](docs/sdks/apis/README.md#generate_open_api) - Generate an OpenAPI specification for a particular Api. * [generate_postman](docs/sdks/apis/README.md#generate_postman) - Generate a Postman collection for a particular Api. -### [Artifacts](docs/sdks/artifacts/README.md) +### [artifacts](docs/sdks/artifacts/README.md) * [preflight](docs/sdks/artifacts/README.md#preflight) - Get access token for communicating with OCI distribution endpoints * [get_namespaces](docs/sdks/artifacts/README.md#get_namespaces) - Each namespace contains many revisions. * [get_revisions](docs/sdks/artifacts/README.md#get_revisions) * [get_tags](docs/sdks/artifacts/README.md#get_tags) * [post_tags](docs/sdks/artifacts/README.md#post_tags) - Add tags to an existing revision +* [list_remote_sources](docs/sdks/artifacts/README.md#list_remote_sources) - Get remote sources attached to a particular namespace +* [create_remote_source](docs/sdks/artifacts/README.md#create_remote_source) - Configure a new remote source * [get_manifest](docs/sdks/artifacts/README.md#get_manifest) - Get manifest for a particular reference * [get_blob](docs/sdks/artifacts/README.md#get_blob) - Get blob for a particular digest -### [Auth](docs/sdks/auth/README.md) +### [auth](docs/sdks/auth/README.md) * [validate_api_key](docs/sdks/auth/README.md#validate_api_key) - Validate the current api key. * [get_user](docs/sdks/auth/README.md#get_user) - Get information about the current user. * [get_access_token](docs/sdks/auth/README.md#get_access_token) - Get or refresh an access token for the current workspace. * [get_allowances](docs/sdks/auth/README.md#get_allowances) - Get access allowances for a particular workspace -### [Embeds](docs/sdks/embeds/README.md) +### [embeds](docs/sdks/embeds/README.md) * [get_access_token](docs/sdks/embeds/README.md#get_access_token) - Get an embed access token for the current workspace. * [get_valid](docs/sdks/embeds/README.md#get_valid) - Get all valid embed access tokens for the current workspace. * [delete](docs/sdks/embeds/README.md#delete) - Revoke an embed access EmbedToken. -### [Events](docs/sdks/events/README.md) +### [events](docs/sdks/events/README.md) * [search](docs/sdks/events/README.md#search) - Search events for a particular workspace by any field * [post](docs/sdks/events/README.md#post) - Post events for a specific workspace @@ -123,9 +136,10 @@ end * [get_targets](docs/sdks/events/README.md#get_targets) - Load targets for a particular workspace * [get_targets_deprecated](docs/sdks/events/README.md#get_targets_deprecated) - Load targets for a particular workspace -### [Github](docs/sdks/github/README.md) +### [github](docs/sdks/github/README.md) * [check_access](docs/sdks/github/README.md#check_access) +* [link_github](docs/sdks/github/README.md#link_github) * [check_publishing_p_rs](docs/sdks/github/README.md#check_publishing_p_rs) * [check_publishing_secrets](docs/sdks/github/README.md#check_publishing_secrets) * [store_publishing_secrets](docs/sdks/github/README.md#store_publishing_secrets) @@ -135,13 +149,13 @@ end * [trigger_action](docs/sdks/github/README.md#trigger_action) * [get_action](docs/sdks/github/README.md#get_action) -### [Metadata](docs/sdks/metadata/README.md) +### [metadata](docs/sdks/metadata/README.md) * [get](docs/sdks/metadata/README.md#get) - Get all metadata for a particular apiID and versionID. * [insert_version](docs/sdks/metadata/README.md#insert_version) - Insert metadata for a particular apiID and versionID. * [delete_version](docs/sdks/metadata/README.md#delete_version) - Delete metadata for a particular apiID and versionID. -### [Organizations](docs/sdks/organizations/README.md) +### [organizations](docs/sdks/organizations/README.md) * [get_all](docs/sdks/organizations/README.md#get_all) - Get organizations for a user * [create](docs/sdks/organizations/README.md#create) - Create an organization @@ -149,19 +163,19 @@ end * [create_free_trial](docs/sdks/organizations/README.md#create_free_trial) - Create a free trial for an organization * [get_usage](docs/sdks/organizations/README.md#get_usage) - Get billing usage summary for a particular organization -### [Reports](docs/sdks/reports/README.md) +### [reports](docs/sdks/reports/README.md) * [upload](docs/sdks/reports/README.md#upload) - Upload a report. * [get_signed_url](docs/sdks/reports/README.md#get_signed_url) - Get the signed access url for the linting reports for a particular document. * [get_changes_signed_url](docs/sdks/reports/README.md#get_changes_signed_url) - Get the signed access url for the change reports for a particular document. -### [Requests](docs/sdks/requests/README.md) +### [requests](docs/sdks/requests/README.md) * [query](docs/sdks/requests/README.md#query) - Query the event log to retrieve a list of requests. * [get](docs/sdks/requests/README.md#get) - Get information about a particular request. * [generate_postman_collection](docs/sdks/requests/README.md#generate_postman_collection) - Generate a Postman collection for a particular request. -### [Schemas](docs/sdks/schemas/README.md) +### [schemas](docs/sdks/schemas/README.md) * [get_latest](docs/sdks/schemas/README.md#get_latest) - Get information about the latest schema. * [post](docs/sdks/schemas/README.md#post) - Register a schema. @@ -172,28 +186,29 @@ end * [download_revision](docs/sdks/schemas/README.md#download_revision) - Download a particular schema revision for an Api. * [get](docs/sdks/schemas/README.md#get) - Get information about all schemas associated with a particular apiID. -### [ShortURLs](docs/sdks/shorturls/README.md) +### [short_ur_ls](docs/sdks/shorturls/README.md) * [create](docs/sdks/shorturls/README.md#create) - Shorten a URL. +### [SpeakeasyClientSDK](docs/sdks/speakeasyclientsdk/README.md) -### [SpeakeasyClientSDKApiEndpoints](docs/sdks/speakeasyclientsdkapiendpoints/README.md) +* [generate_code_sample_preview](docs/sdks/speakeasyclientsdk/README.md#generate_code_sample_preview) - Generate Code Sample previews from a file and configuration parameters. +* [generate_code_sample_preview_async](docs/sdks/speakeasyclientsdk/README.md#generate_code_sample_preview_async) - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling. +* [get_code_sample_preview_async](docs/sdks/speakeasyclientsdk/README.md#get_code_sample_preview_async) - Poll for the result of an asynchronous Code Sample preview generation. -* [get_all](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get_all) - Get all ApiEndpoints for a particular apiID and versionID. -* [find](docs/sdks/speakeasyclientsdkapiendpoints/README.md#find) - Find an ApiEndpoint via its displayName. -* [delete](docs/sdks/speakeasyclientsdkapiendpoints/README.md#delete) - Delete an ApiEndpoint. -* [get](docs/sdks/speakeasyclientsdkapiendpoints/README.md#get) - Get an ApiEndpoint. -* [upsert](docs/sdks/speakeasyclientsdkapiendpoints/README.md#upsert) - Upsert an ApiEndpoint. -* [generate_open_api_spec](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular ApiEndpoint. -* [generate_postman_collection](docs/sdks/speakeasyclientsdkapiendpoints/README.md#generate_postman_collection) - Generate a Postman collection for a particular ApiEndpoint. +### [subscriptions](docs/sdks/subscriptions/README.md) -### [Suggest](docs/sdks/suggest/README.md) +* [list_registry_subscriptions](docs/sdks/subscriptions/README.md#list_registry_subscriptions) - List Subscriptions +* [create_subscription](docs/sdks/subscriptions/README.md#create_subscription) - Create Subscription + +### [suggest](docs/sdks/suggest/README.md) * [openapi](docs/sdks/suggest/README.md#openapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document. * [generate](docs/sdks/suggest/README.md#generate) - Generate suggestions for improving an OpenAPI document. +* [suggest_items](docs/sdks/suggest/README.md#suggest_items) - Generate generic suggestions for a list of items. * [openapi_registry](docs/sdks/suggest/README.md#openapi_registry) - Generate suggestions for improving an OpenAPI document stored in the registry. -### [Workspaces](docs/sdks/workspaces/README.md) +### [workspaces](docs/sdks/workspaces/README.md) * [get_all](docs/sdks/workspaces/README.md#get_all) - Get workspaces for a user * [get](docs/sdks/workspaces/README.md#get) - Get workspace by context @@ -213,24 +228,119 @@ end
- -## Server Selection + +## 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 `""` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_access_token`. 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 | Description | +| ------------ | -------- | --------------------------- | +| workspace_id | ::String | The workspace_id parameter. | + +### Example + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new + + +res = s.auth.get_access_token(workspace_id="") + +if ! res.access_token.nil? + # handle response +end + +``` + + + ## Server Selection ### Select Server by Name -You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: +You can override the default server globally by passing a server name to the `server (Symbol)` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: -| Name | Server | Variables | -| ----- | ------ | --------- | -| `prod` | `https://api.prod.speakeasyapi.dev` | None | +| Name | Server | +| ------ | ----------------------------------- | +| `prod` | `https://api.prod.speakeasyapi.dev` | +#### Example +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new( + server: "prod", + ) +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new( + languages: [ + "", + ], + schema_file: ::OpenApiSDK::Shared::SchemaFile.new( + file_name: "example.file", + content: "0xc3dD8BfBef".encode(), + ), +) + +res = s.generate_code_sample_preview(req) + +if ! res.two_hundred_application_x_yaml_bytes.nil? + # handle response +end + +``` ### Override Server URL Per-Client -The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: +The default server can also be overridden globally by passing a URL to the `server_url (String)` optional parameter when initializing the SDK client instance. For example: +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new( + server_url: "https://api.prod.speakeasyapi.dev", + ) +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new( + languages: [ + "", + ], + schema_file: ::OpenApiSDK::Shared::SchemaFile.new( + file_name: "example.file", + content: "0xc3dD8BfBef".encode(), + ), +) + +res = s.generate_code_sample_preview(req) + +if ! res.two_hundred_application_x_yaml_bytes.nil? + # handle response +end + +``` diff --git a/RELEASES.md b/RELEASES.md index b16b943..5a1262b 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -34,4 +34,14 @@ Based on: ### Generated - [ruby v4.2.24] . ### Releases -- [Ruby Gems v4.2.24] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.24 - . \ No newline at end of file +- [Ruby Gems v4.2.24] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.2.24 - . + +## 2024-11-20 00:12:52 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.441.0 (2.460.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [ruby v4.3.0] . +### Releases +- [Ruby Gems v4.3.0] https://rubygems.org/gems/speakeasy_client_sdk_ruby/versions/4.3.0 - . \ No newline at end of file diff --git a/docs/models/operations/createremotesourceresponse.md b/docs/models/operations/createremotesourceresponse.md new file mode 100644 index 0000000..5225b0d --- /dev/null +++ b/docs/models/operations/createremotesourceresponse.md @@ -0,0 +1,11 @@ +# CreateRemoteSourceResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response | \ No newline at end of file diff --git a/docs/models/operations/createsubscriptionrequest.md b/docs/models/operations/createsubscriptionrequest.md new file mode 100644 index 0000000..5053e74 --- /dev/null +++ b/docs/models/operations/createsubscriptionrequest.md @@ -0,0 +1,9 @@ +# CreateSubscriptionRequest + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `registry_subscription` | [::OpenApiSDK::Shared::RegistrySubscription](../../models/shared/registrysubscription.md) | :heavy_check_mark: | The subscription to create | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | The workspace ID | \ No newline at end of file diff --git a/docs/models/operations/createsubscriptionresponse.md b/docs/models/operations/createsubscriptionresponse.md new file mode 100644 index 0000000..acecb19 --- /dev/null +++ b/docs/models/operations/createsubscriptionresponse.md @@ -0,0 +1,11 @@ +# CreateSubscriptionResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `registry_subscription` | [T.nilable(::OpenApiSDK::Shared::RegistrySubscription)](../../models/shared/registrysubscription.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/docs/models/operations/createworkspacetokenrequest.md b/docs/models/operations/createworkspacetokenrequest.md index 5521c7b..a346f50 100644 --- a/docs/models/operations/createworkspacetokenrequest.md +++ b/docs/models/operations/createworkspacetokenrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | -| `workspace_token` | [::OpenApiSDK::Shared::WorkspaceToken](../../models/shared/workspacetoken.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `workspace_token` | [::OpenApiSDK::Shared::WorkspaceToken](../../models/shared/workspacetoken.md) | :heavy_check_mark: | N/A | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacetokenrequest.md b/docs/models/operations/deleteworkspacetokenrequest.md index 788fa52..420987d 100644 --- a/docs/models/operations/deleteworkspacetokenrequest.md +++ b/docs/models/operations/deleteworkspacetokenrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | -| `token_id` | *::String* | :heavy_check_mark: | Unique identifier of the token. | \ No newline at end of file +| `token_id` | *::String* | :heavy_check_mark: | Unique identifier of the token. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/generatecodesamplepreviewasyncresponse.md b/docs/models/operations/generatecodesamplepreviewasyncresponse.md new file mode 100644 index 0000000..c8d09ee --- /dev/null +++ b/docs/models/operations/generatecodesamplepreviewasyncresponse.md @@ -0,0 +1,12 @@ +# GenerateCodeSamplePreviewAsyncResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [T.nilable(::OpenApiSDK::Operations::GenerateCodeSamplePreviewAsyncResponseBody)](../../models/operations/generatecodesamplepreviewasyncresponsebody.md) | :heavy_minus_sign: | Job accepted, returns a job ID to poll for status and result | +| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Error | \ No newline at end of file diff --git a/docs/models/operations/generatecodesamplepreviewasyncresponsebody.md b/docs/models/operations/generatecodesamplepreviewasyncresponsebody.md new file mode 100644 index 0000000..dfb4b5b --- /dev/null +++ b/docs/models/operations/generatecodesamplepreviewasyncresponsebody.md @@ -0,0 +1,11 @@ +# GenerateCodeSamplePreviewAsyncResponseBody + +Job accepted, returns a job ID to poll for status and result + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `job_id` | *::String* | :heavy_check_mark: | The job ID for polling | +| `status` | [::OpenApiSDK::Shared::CodeSamplesJobStatus](../../models/shared/codesamplesjobstatus.md) | :heavy_check_mark: | The current status of the job. Possible values are `pending` or `running`. | \ No newline at end of file diff --git a/docs/models/operations/generatecodesamplepreviewresponse.md b/docs/models/operations/generatecodesamplepreviewresponse.md new file mode 100644 index 0000000..e9750d0 --- /dev/null +++ b/docs/models/operations/generatecodesamplepreviewresponse.md @@ -0,0 +1,13 @@ +# GenerateCodeSamplePreviewResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `two_hundred_application_x_yaml_bytes` | *T.nilable(::String)* | :heavy_minus_sign: | Successfully returned codeSample overlay file | +| `two_hundred_application_json_bytes` | *T.nilable(::String)* | :heavy_minus_sign: | Successfully returned codeSample overlay file | +| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Error | \ No newline at end of file diff --git a/docs/models/operations/getcodesamplepreviewasyncrequest.md b/docs/models/operations/getcodesamplepreviewasyncrequest.md new file mode 100644 index 0000000..b278fc3 --- /dev/null +++ b/docs/models/operations/getcodesamplepreviewasyncrequest.md @@ -0,0 +1,8 @@ +# GetCodeSamplePreviewAsyncRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `job_id` | *::String* | :heavy_check_mark: | The ID of the job to check the status and retrieve results | \ No newline at end of file diff --git a/docs/models/operations/getcodesamplepreviewasyncresponse.md b/docs/models/operations/getcodesamplepreviewasyncresponse.md new file mode 100644 index 0000000..112d130 --- /dev/null +++ b/docs/models/operations/getcodesamplepreviewasyncresponse.md @@ -0,0 +1,14 @@ +# GetCodeSamplePreviewAsyncResponse + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `two_hundred_application_x_yaml_bytes` | *T.nilable(::String)* | :heavy_minus_sign: | Successfully returned codeSample overlay file | +| `two_hundred_application_json_bytes` | *T.nilable(::String)* | :heavy_minus_sign: | Successfully returned codeSample overlay file | +| `two_hundred_and_two_application_json_object` | [T.nilable(::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncResponseBody)](../../models/operations/getcodesamplepreviewasyncresponsebody.md) | :heavy_minus_sign: | Job is still in progress | +| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Error | \ No newline at end of file diff --git a/docs/models/operations/getcodesamplepreviewasyncresponsebody.md b/docs/models/operations/getcodesamplepreviewasyncresponsebody.md new file mode 100644 index 0000000..7c273d6 --- /dev/null +++ b/docs/models/operations/getcodesamplepreviewasyncresponsebody.md @@ -0,0 +1,10 @@ +# GetCodeSamplePreviewAsyncResponseBody + +Job is still in progress + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `status` | [::OpenApiSDK::Shared::CodeSamplesJobStatus](../../models/shared/codesamplesjobstatus.md) | :heavy_check_mark: | The current status of the job. Possible values are `pending` or `running`. | \ No newline at end of file diff --git a/docs/models/operations/getworkspaceeventsbytargetrequest.md b/docs/models/operations/getworkspaceeventsbytargetrequest.md index b0a90fc..35789b0 100644 --- a/docs/models/operations/getworkspaceeventsbytargetrequest.md +++ b/docs/models/operations/getworkspaceeventsbytargetrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `target_id` | *::String* | :heavy_check_mark: | Filter to only return events corresponding to a particular gen_lock_id (gen_lock_id uniquely identifies a target) | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | | `after_created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | Filter to only return events created after this timestamp | \ No newline at end of file diff --git a/docs/models/operations/getworkspacefeatureflagsrequest.md b/docs/models/operations/getworkspacefeatureflagsrequest.md index 4c390a7..b77bff7 100644 --- a/docs/models/operations/getworkspacefeatureflagsrequest.md +++ b/docs/models/operations/getworkspacefeatureflagsrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | \ No newline at end of file +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/getworkspacerequest.md b/docs/models/operations/getworkspacerequest.md index bd2dfab..a062757 100644 --- a/docs/models/operations/getworkspacerequest.md +++ b/docs/models/operations/getworkspacerequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | \ No newline at end of file +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/getworkspacesettingsrequest.md b/docs/models/operations/getworkspacesettingsrequest.md index 411e929..299ea4a 100644 --- a/docs/models/operations/getworkspacesettingsrequest.md +++ b/docs/models/operations/getworkspacesettingsrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | \ No newline at end of file +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/getworkspacetargetsdeprecatedrequest.md b/docs/models/operations/getworkspacetargetsdeprecatedrequest.md index b88ff4d..5724494 100644 --- a/docs/models/operations/getworkspacetargetsdeprecatedrequest.md +++ b/docs/models/operations/getworkspacetargetsdeprecatedrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | | `after_last_event_created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | Filter to only return targets with events created after this timestamp | \ No newline at end of file diff --git a/docs/models/operations/getworkspaceteamrequest.md b/docs/models/operations/getworkspaceteamrequest.md index a1bd684..2e35887 100644 --- a/docs/models/operations/getworkspaceteamrequest.md +++ b/docs/models/operations/getworkspaceteamrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | \ No newline at end of file +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/getworkspacetokensrequest.md b/docs/models/operations/getworkspacetokensrequest.md index 79b37c3..f77cf99 100644 --- a/docs/models/operations/getworkspacetokensrequest.md +++ b/docs/models/operations/getworkspacetokensrequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | \ No newline at end of file +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/grantuseraccesstoworkspacerequest.md b/docs/models/operations/grantuseraccesstoworkspacerequest.md index 04dcd5a..f8dac5a 100644 --- a/docs/models/operations/grantuseraccesstoworkspacerequest.md +++ b/docs/models/operations/grantuseraccesstoworkspacerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | -| `email` | *::String* | :heavy_check_mark: | Email of the user to grant access to. | \ No newline at end of file +| `email` | *::String* | :heavy_check_mark: | Email of the user to grant access to. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/linkgithubaccessrequest.md b/docs/models/operations/linkgithubaccessrequest.md new file mode 100644 index 0000000..1e20536 --- /dev/null +++ b/docs/models/operations/linkgithubaccessrequest.md @@ -0,0 +1,10 @@ +# LinkGithubAccessRequest + + +## Fields + +| Field | Type | Required | Description | +| --------------------- | --------------------- | --------------------- | --------------------- | +| `installation_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| `github_org` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| `github_oidc_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/linkgithubaccessresponse.md b/docs/models/operations/linkgithubaccessresponse.md new file mode 100644 index 0000000..bf2df63 --- /dev/null +++ b/docs/models/operations/linkgithubaccessresponse.md @@ -0,0 +1,11 @@ +# LinkGithubAccessResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response | \ No newline at end of file diff --git a/docs/models/operations/listregistrysubscriptionsrequest.md b/docs/models/operations/listregistrysubscriptionsrequest.md new file mode 100644 index 0000000..6244bf2 --- /dev/null +++ b/docs/models/operations/listregistrysubscriptionsrequest.md @@ -0,0 +1,12 @@ +# ListRegistrySubscriptionsRequest + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | The workspace ID | +| `event_type` | *T.nilable(::String)* | :heavy_minus_sign: | The event type | +| `namespace_name` | *T.nilable(::String)* | :heavy_minus_sign: | The namespace name | +| `subscription_type` | [T.nilable(::OpenApiSDK::Shared::SubscriptionType)](../../models/shared/subscriptiontype.md) | :heavy_minus_sign: | The subscription type | +| `tag` | *T.nilable(::String)* | :heavy_minus_sign: | The tag | \ No newline at end of file diff --git a/docs/models/operations/listregistrysubscriptionsresponse.md b/docs/models/operations/listregistrysubscriptionsresponse.md new file mode 100644 index 0000000..02ebda1 --- /dev/null +++ b/docs/models/operations/listregistrysubscriptionsresponse.md @@ -0,0 +1,11 @@ +# ListRegistrySubscriptionsResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `registry_subscriptions` | T::Array<[::OpenApiSDK::Shared::RegistrySubscription](../../models/shared/registrysubscription.md)> | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/docs/models/operations/listremotesourcesrequest.md b/docs/models/operations/listremotesourcesrequest.md new file mode 100644 index 0000000..7b7c0bf --- /dev/null +++ b/docs/models/operations/listremotesourcesrequest.md @@ -0,0 +1,8 @@ +# ListRemoteSourcesRequest + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `namespace_name` | *::String* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listremotesourcesresponse.md b/docs/models/operations/listremotesourcesresponse.md new file mode 100644 index 0000000..a407185 --- /dev/null +++ b/docs/models/operations/listremotesourcesresponse.md @@ -0,0 +1,12 @@ +# ListRemoteSourcesResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `remote_source` | [T.nilable(::OpenApiSDK::Shared::RemoteSource)](../../models/shared/remotesource.md) | :heavy_minus_sign: | OK | +| `error` | [T.nilable(::OpenApiSDK::Shared::Error)](../../models/shared/error.md) | :heavy_minus_sign: | Default error response | \ No newline at end of file diff --git a/docs/models/operations/postworkspaceeventsrequest.md b/docs/models/operations/postworkspaceeventsrequest.md index e7bd160..00079f6 100644 --- a/docs/models/operations/postworkspaceeventsrequest.md +++ b/docs/models/operations/postworkspaceeventsrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | -| `request_body` | T::Array<[::OpenApiSDK::Shared::CliEvent](../../models/shared/clievent.md)> | :heavy_check_mark: | N/A | \ No newline at end of file +| `request_body` | T::Array<[::OpenApiSDK::Shared::CliEvent](../../models/shared/clievent.md)> | :heavy_check_mark: | N/A | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/revokeuseraccesstoworkspacerequest.md b/docs/models/operations/revokeuseraccesstoworkspacerequest.md index 8b80249..c382d8e 100644 --- a/docs/models/operations/revokeuseraccesstoworkspacerequest.md +++ b/docs/models/operations/revokeuseraccesstoworkspacerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | -| `user_id` | *::String* | :heavy_check_mark: | Unique identifier of the user. | \ No newline at end of file +| `user_id` | *::String* | :heavy_check_mark: | Unique identifier of the user. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/searchworkspaceeventsrequest.md b/docs/models/operations/searchworkspaceeventsrequest.md index 984165b..2b7c67d 100644 --- a/docs/models/operations/searchworkspaceeventsrequest.md +++ b/docs/models/operations/searchworkspaceeventsrequest.md @@ -5,9 +5,10 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | | `source_revision_digest` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the source revision digest. | | `lint_report_digest` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the lint report digest. | | `openapi_diff_report_digest` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the openapi diff report digest. | | `interaction_type` | [T.nilable(::OpenApiSDK::Shared::InteractionType)](../../models/shared/interactiontype.md) | :heavy_minus_sign: | Specified interaction type for events. | -| `generate_gen_lock_id` | *T.nilable(::String)* | :heavy_minus_sign: | A specific gen lock ID for the events. | \ No newline at end of file +| `generate_gen_lock_id` | *T.nilable(::String)* | :heavy_minus_sign: | A specific gen lock ID for the events. | +| `execution_id` | *T.nilable(::String)* | :heavy_minus_sign: | Shared execution ID for cli events across a single action. | \ No newline at end of file diff --git a/docs/models/operations/suggestitemsresponse.md b/docs/models/operations/suggestitemsresponse.md new file mode 100644 index 0000000..6400897 --- /dev/null +++ b/docs/models/operations/suggestitemsresponse.md @@ -0,0 +1,11 @@ +# SuggestItemsResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `strings` | T::Array<*::String*> | :heavy_minus_sign: | One suggestion per item. Guaranteed to be the same length as the input items. | \ No newline at end of file diff --git a/docs/models/operations/updateworkspacedetailsrequest.md b/docs/models/operations/updateworkspacedetailsrequest.md index 46b5c00..000c1a5 100644 --- a/docs/models/operations/updateworkspacedetailsrequest.md +++ b/docs/models/operations/updateworkspacedetailsrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | -| `workspace` | [::OpenApiSDK::Shared::Workspace](../../models/shared/workspace.md) | :heavy_check_mark: | The workspace details to update. | \ No newline at end of file +| `workspace` | [::OpenApiSDK::Shared::Workspace](../../models/shared/workspace.md) | :heavy_check_mark: | The workspace details to update. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/operations/updateworkspacesettingsrequest.md b/docs/models/operations/updateworkspacesettingsrequest.md index e792b9d..262a9a8 100644 --- a/docs/models/operations/updateworkspacesettingsrequest.md +++ b/docs/models/operations/updateworkspacesettingsrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | -| `workspace_settings` | [::OpenApiSDK::Shared::WorkspaceSettings](../../models/shared/workspacesettings.md) | :heavy_check_mark: | The workspace settings to update. | \ No newline at end of file +| `workspace_settings` | [::OpenApiSDK::Shared::WorkspaceSettings](../../models/shared/workspacesettings.md) | :heavy_check_mark: | The workspace settings to update. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | \ No newline at end of file diff --git a/docs/models/shared/apikeydetails.md b/docs/models/shared/apikeydetails.md index 41680fc..2686390 100644 --- a/docs/models/shared/apikeydetails.md +++ b/docs/models/shared/apikeydetails.md @@ -12,4 +12,5 @@ | `account_type_v2` | [::OpenApiSDK::Shared::AccountType](../../models/shared/accounttype.md) | :heavy_check_mark: | N/A | | `enabled_features` | T::Array<*::String*> | :heavy_check_mark: | N/A | | ~~`feature_flags`~~ | T::Array<*::String*> | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | -| `telemetry_disabled` | *T::Boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `telemetry_disabled` | *T::Boolean* | :heavy_check_mark: | N/A | +| `workspace_created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | Workspace creation timestamp. | \ No newline at end of file diff --git a/docs/models/shared/clievent.md b/docs/models/shared/clievent.md index c948a09..e9f9f6b 100644 --- a/docs/models/shared/clievent.md +++ b/docs/models/shared/clievent.md @@ -21,6 +21,8 @@ | `gh_action_run_link` | *T.nilable(::String)* | :heavy_minus_sign: | Link to the GitHub action run. | | `gh_action_version` | *T.nilable(::String)* | :heavy_minus_sign: | Version of the GitHub action. | | `gh_action_organization` | *T.nilable(::String)* | :heavy_minus_sign: | GitHub organization of the action. | +| `gh_pull_request` | *T.nilable(::String)* | :heavy_minus_sign: | The reference to a created pull request URL. | +| `gh_changes_committed` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether or not changes were committed from generation in the Github Action. | | `gh_action_ref` | *T.nilable(::String)* | :heavy_minus_sign: | GitHub Action ref value. | | `gh_action_repository` | *T.nilable(::String)* | :heavy_minus_sign: | GitHub repository of the action. | | `repo_label` | *T.nilable(::String)* | :heavy_minus_sign: | Label of the git repository. | @@ -57,6 +59,7 @@ | `generate_bump_type` | [T.nilable(::OpenApiSDK::Shared::GenerateBumpType)](../../models/shared/generatebumptype.md) | :heavy_minus_sign: | Bump type of the lock file (calculated semver delta, custom change (manual release), or prerelease/graduate) | | `generate_number_of_operations_ignored` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of operations ignored in generation. | | `generate_number_of_operations_used` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of operations used in generation. | +| `generate_number_of_terraform_resources` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of terraform resources used in generation. | | `generate_published` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether the target was considered published. | | `generate_repo_url` | *T.nilable(::String)* | :heavy_minus_sign: | Expected Repo URL, for use in documentation generation. | | `publish_package_url` | *T.nilable(::String)* | :heavy_minus_sign: | URL of the published package. | diff --git a/docs/models/shared/codesampleschemainput.md b/docs/models/shared/codesampleschemainput.md new file mode 100644 index 0000000..27bcad5 --- /dev/null +++ b/docs/models/shared/codesampleschemainput.md @@ -0,0 +1,11 @@ +# CodeSampleSchemaInput + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `package_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the package | +| `sdk_class_name` | *T.nilable(::String)* | :heavy_minus_sign: | The SDK class name | +| `languages` | T::Array<*::String*> | :heavy_check_mark: | A list of languages to generate code samples for | +| `schema_file` | [::OpenApiSDK::Shared::SchemaFile](../../models/shared/schemafile.md) | :heavy_check_mark: | The OpenAPI file to be uploaded | \ No newline at end of file diff --git a/docs/models/shared/codesamplesjobstatus.md b/docs/models/shared/codesamplesjobstatus.md new file mode 100644 index 0000000..2dd86bc --- /dev/null +++ b/docs/models/shared/codesamplesjobstatus.md @@ -0,0 +1,11 @@ +# CodeSamplesJobStatus + +The current status of the job. Possible values are `pending` or `running`. + + +## Values + +| Name | Value | +| --------- | --------- | +| `PENDING` | pending | +| `RUNNING` | running | \ No newline at end of file diff --git a/docs/models/shared/eventtype.md b/docs/models/shared/eventtype.md new file mode 100644 index 0000000..f03994f --- /dev/null +++ b/docs/models/shared/eventtype.md @@ -0,0 +1,8 @@ +# EventType + + +## Values + +| Name | Value | +| -------- | -------- | +| `UPDATE` | update | \ No newline at end of file diff --git a/docs/models/shared/organization.md b/docs/models/shared/organization.md index ba46b39..af733f6 100644 --- a/docs/models/shared/organization.md +++ b/docs/models/shared/organization.md @@ -14,4 +14,5 @@ A speakeasy organization | `telemetry_disabled` | *T::Boolean* | :heavy_check_mark: | N/A | | `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | | `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | -| `free_trial_expiry` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `free_trial_expiry` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | +| `internal` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/organizationusage.md b/docs/models/shared/organizationusage.md index 7ce53fa..57a2187 100644 --- a/docs/models/shared/organizationusage.md +++ b/docs/models/shared/organizationusage.md @@ -3,12 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `number_of_operations` | *::Integer* | :heavy_check_mark: | Number of operations performed | -| `language` | *::String* | :heavy_check_mark: | The programming language used | -| `used_features` | T::Array<*::String*> | :heavy_check_mark: | Features that have been used | -| `accessible_features` | T::Array<*::String*> | :heavy_check_mark: | Features that are accessible | -| `accessible` | *T::Boolean* | :heavy_check_mark: | Indicates if the features are accessible | -| `workspaces` | T::Array<*::String*> | :heavy_check_mark: | List of workspace IDs | -| `gen_lock_ids` | T::Array<*::String*> | :heavy_check_mark: | List of generation lock IDs | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `number_of_operations` | *::Integer* | :heavy_check_mark: | Number of operations performed | +| `max_operations` | *::Integer* | :heavy_check_mark: | Maximum Number of operations per SDK specific in contract | +| `language` | *::String* | :heavy_check_mark: | The programming language used | +| `used_features` | T::Array<*::String*> | :heavy_check_mark: | Features that have been used | +| `accessible_features` | T::Array<*::String*> | :heavy_check_mark: | Features that are accessible | +| `accessible` | *T::Boolean* | :heavy_check_mark: | Indicates if the features are accessible | +| `workspaces` | T::Array<*::String*> | :heavy_check_mark: | List of workspace IDs | +| `gen_lock_ids` | T::Array<*::String*> | :heavy_check_mark: | List of generation lock IDs | \ No newline at end of file diff --git a/docs/models/shared/registrysubscription.md b/docs/models/shared/registrysubscription.md new file mode 100644 index 0000000..892e968 --- /dev/null +++ b/docs/models/shared/registrysubscription.md @@ -0,0 +1,19 @@ +# RegistrySubscription + +A subscription to a registry event + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `id` | *::String* | :heavy_check_mark: | N/A | +| `workspace_id` | *::String* | :heavy_check_mark: | N/A | +| `event_type` | [::OpenApiSDK::Shared::EventType](../../models/shared/eventtype.md) | :heavy_check_mark: | N/A | +| `namespace_name` | *::String* | :heavy_check_mark: | N/A | +| `tags` | T::Array<*::String*> | :heavy_minus_sign: | N/A | +| `subscription_type` | [::OpenApiSDK::Shared::SubscriptionType](../../models/shared/subscriptiontype.md) | :heavy_check_mark: | N/A | +| `subscription_settings` | *::String* | :heavy_check_mark: | N/A | +| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | +| `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | +| `deleted_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/remotedocument.md b/docs/models/shared/remotedocument.md new file mode 100644 index 0000000..c4406df --- /dev/null +++ b/docs/models/shared/remotedocument.md @@ -0,0 +1,10 @@ +# RemoteDocument + +A document hosted in the registry + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `registry_url` | *::String* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/remotesource.md b/docs/models/shared/remotesource.md new file mode 100644 index 0000000..7c95712 --- /dev/null +++ b/docs/models/shared/remotesource.md @@ -0,0 +1,12 @@ +# RemoteSource + +Remote source configuration + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `inputs` | T::Array<[::OpenApiSDK::Shared::RemoteDocument](../../models/shared/remotedocument.md)> | :heavy_check_mark: | N/A | +| `overlays` | T::Array<[::OpenApiSDK::Shared::RemoteDocument](../../models/shared/remotedocument.md)> | :heavy_minus_sign: | N/A | +| `output` | [::OpenApiSDK::Shared::RemoteDocument](../../models/shared/remotedocument.md) | :heavy_check_mark: | A document hosted in the registry | \ No newline at end of file diff --git a/docs/models/shared/schemafile.md b/docs/models/shared/schemafile.md new file mode 100644 index 0000000..7b1e9fc --- /dev/null +++ b/docs/models/shared/schemafile.md @@ -0,0 +1,9 @@ +# SchemaFile + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `file_name` | *::String* | :heavy_check_mark: | N/A | +| `content` | *::String* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/subscriptiontype.md b/docs/models/shared/subscriptiontype.md new file mode 100644 index 0000000..fff5a2b --- /dev/null +++ b/docs/models/shared/subscriptiontype.md @@ -0,0 +1,8 @@ +# SubscriptionType + + +## Values + +| Name | Value | +| ----- | ----- | +| `CLI` | cli | \ No newline at end of file diff --git a/docs/models/shared/suggestitemsrequestbody.md b/docs/models/shared/suggestitemsrequestbody.md new file mode 100644 index 0000000..d04d882 --- /dev/null +++ b/docs/models/shared/suggestitemsrequestbody.md @@ -0,0 +1,9 @@ +# SuggestItemsRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `prompt` | *::String* | :heavy_check_mark: | The prompt to use for the suggestion. Think of this as the "preamble". | +| `items` | T::Array<*::String*> | :heavy_check_mark: | The list of "things" to get suggestions for. One suggestion will be returned for each item in the list. | \ No newline at end of file diff --git a/docs/models/shared/targetsdk.md b/docs/models/shared/targetsdk.md index adf55ba..3a0a0b0 100644 --- a/docs/models/shared/targetsdk.md +++ b/docs/models/shared/targetsdk.md @@ -24,6 +24,7 @@ | `generate_eligible_features` | *T.nilable(::String)* | :heavy_minus_sign: | Eligible feature set during generation | | `generate_number_of_operations_ignored` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of operations ignored in generation. | | `generate_number_of_operations_used` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of operations used in generation. | +| `generate_number_of_terraform_resources` | *T.nilable(::Integer)* | :heavy_minus_sign: | The number of terraform resources used in generation. | | `generate_published` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether the target was considered published. | | `continuous_integration_environment` | *T.nilable(::String)* | :heavy_minus_sign: | Name of the CI environment. | | `gh_action_ref` | *T.nilable(::String)* | :heavy_minus_sign: | GitHub Action ref value. | @@ -41,6 +42,8 @@ | `error` | *T.nilable(::String)* | :heavy_minus_sign: | Error message if the last event was not successful. | | `workflow_pre_raw` | *T.nilable(::String)* | :heavy_minus_sign: | Workflow file (prior to execution) | | `workflow_post_raw` | *T.nilable(::String)* | :heavy_minus_sign: | Workflow file (post execution) | +| `workflow_lock_pre_raw` | *T.nilable(::String)* | :heavy_minus_sign: | Workflow lock file (prior to execution) | +| `workflow_lock_post_raw` | *T.nilable(::String)* | :heavy_minus_sign: | Workflow lock file (post execution) | | `publish_package_url` | *T.nilable(::String)* | :heavy_minus_sign: | URL of the published package. | | `publish_package_name` | *T.nilable(::String)* | :heavy_minus_sign: | Name of the published package. | | `publish_package_version` | *T.nilable(::String)* | :heavy_minus_sign: | Version of the published package. | diff --git a/docs/models/shared/user.md b/docs/models/shared/user.md index fdc17d3..0266319 100644 --- a/docs/models/shared/user.md +++ b/docs/models/shared/user.md @@ -17,4 +17,5 @@ | `last_login_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | Timestamp of the last login. | | `admin` | *T::Boolean* | :heavy_check_mark: | Indicates whether the user is an admin. | | `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | Timestamp of the user's creation. | -| `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | Timestamp of the user's last update. | \ No newline at end of file +| `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | Timestamp of the user's last update. | +| `internal` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates whether the user is internal. | \ No newline at end of file diff --git a/docs/models/shared/workspace.md b/docs/models/shared/workspace.md index f58dc7e..e978c89 100644 --- a/docs/models/shared/workspace.md +++ b/docs/models/shared/workspace.md @@ -5,15 +5,14 @@ A speakeasy workspace ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | -| `id` | *::String* | :heavy_check_mark: | N/A | -| `name` | *::String* | :heavy_check_mark: | N/A | -| `oci_repo` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | -| `oci_repo_created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | -| `organization_id` | *::String* | :heavy_check_mark: | N/A | -| `slug` | *::String* | :heavy_check_mark: | N/A | -| `telemetry_disabled` | *T::Boolean* | :heavy_check_mark: | N/A | -| `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | -| `verified` | *T::Boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | +| `id` | *::String* | :heavy_check_mark: | N/A | +| `name` | *::String* | :heavy_check_mark: | N/A | +| `organization_id` | *::String* | :heavy_check_mark: | N/A | +| `slug` | *::String* | :heavy_check_mark: | N/A | +| `inactive` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | N/A | +| ~~`telemetry_disabled`~~ | *T.nilable(T::Boolean)* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use organization.telemetry_disabled instead. | +| `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | +| `verified` | *T::Boolean* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/workspacesettings.md b/docs/models/shared/workspacesettings.md index ee6d754..2fc6d99 100644 --- a/docs/models/shared/workspacesettings.md +++ b/docs/models/shared/workspacesettings.md @@ -3,7 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | N/A | -| `webhook_url` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `workspace_id` | *::String* | :heavy_check_mark: | N/A | +| `webhook_url` | *::String* | :heavy_check_mark: | N/A | +| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | +| `updated_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/workspacetoken.md b/docs/models/shared/workspacetoken.md index e2aff63..8cb3c19 100644 --- a/docs/models/shared/workspacetoken.md +++ b/docs/models/shared/workspacetoken.md @@ -5,14 +5,14 @@ A workspace token ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `id` | *::String* | :heavy_check_mark: | N/A | -| `name` | *::String* | :heavy_check_mark: | N/A | -| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | -| `alg` | *::String* | :heavy_check_mark: | N/A | -| `key` | *::String* | :heavy_check_mark: | N/A | -| `last_used` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | -| `created_at` | *::String* | :heavy_check_mark: | N/A | -| `created_by` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | -| `email` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `id` | *::String* | :heavy_check_mark: | N/A | +| `name` | *::String* | :heavy_check_mark: | N/A | +| `workspace_id` | *::String* | :heavy_check_mark: | N/A | +| `alg` | *::String* | :heavy_check_mark: | N/A | +| `key` | *::String* | :heavy_check_mark: | N/A | +| `last_used` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | N/A | +| `created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_check_mark: | N/A | +| `created_by` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| `email` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdks/apiendpoints/README.md b/docs/sdks/apiendpoints/README.md index ec359ef..60e6bb7 100644 --- a/docs/sdks/apiendpoints/README.md +++ b/docs/sdks/apiendpoints/README.md @@ -1,4 +1,5 @@ # Apiendpoints +(*apiendpoints*) ## Overview diff --git a/docs/sdks/apis/README.md b/docs/sdks/apis/README.md index c7e291c..8a841c8 100644 --- a/docs/sdks/apis/README.md +++ b/docs/sdks/apis/README.md @@ -1,4 +1,5 @@ # Apis +(*apis*) ## Overview diff --git a/docs/sdks/artifacts/README.md b/docs/sdks/artifacts/README.md index a6c4bf7..f050143 100644 --- a/docs/sdks/artifacts/README.md +++ b/docs/sdks/artifacts/README.md @@ -1,4 +1,5 @@ # Artifacts +(*artifacts*) ## Overview @@ -11,6 +12,8 @@ REST APIs for working with Registry artifacts * [get_revisions](#get_revisions) * [get_tags](#get_tags) * [post_tags](#post_tags) - Add tags to an existing revision +* [list_remote_sources](#list_remote_sources) - Get remote sources attached to a particular namespace +* [create_remote_source](#create_remote_source) - Configure a new remote source * [get_manifest](#get_manifest) - Get manifest for a particular reference * [get_blob](#get_blob) - Get blob for a particular digest @@ -205,6 +208,93 @@ end +## list_remote_sources + +Get remote sources attached to a particular namespace + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +res = s.artifacts.list_remote_sources(namespace_name="") + +if ! res.remote_source.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `namespace_name` | *::String* | :heavy_check_mark: | N/A | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::ListRemoteSourcesResponse)](../../models/operations/listremotesourcesresponse.md)** + + + +## create_remote_source + +Configure a new remote source + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +req = ::OpenApiSDK::Shared::RemoteSource.new( + inputs: [ + ::OpenApiSDK::Shared::RemoteDocument.new( + registry_url: "https://productive-swine.net", + ), + ], + output: ::OpenApiSDK::Shared::RemoteDocument.new( + registry_url: "https://spiteful-apricot.info", + ), +) + +res = s.artifacts.create_remote_source(req) + +if res.status_code == 200 + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `request` | [::OpenApiSDK::Shared::RemoteSource](../../models/shared/remotesource.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::CreateRemoteSourceResponse)](../../models/operations/createremotesourceresponse.md)** + + + ## get_manifest Get manifest for a particular reference diff --git a/docs/sdks/auth/README.md b/docs/sdks/auth/README.md index 7f869b8..ba4140c 100644 --- a/docs/sdks/auth/README.md +++ b/docs/sdks/auth/README.md @@ -1,4 +1,5 @@ # Auth +(*auth*) ## Overview diff --git a/docs/sdks/embeds/README.md b/docs/sdks/embeds/README.md index ab4812b..847db72 100644 --- a/docs/sdks/embeds/README.md +++ b/docs/sdks/embeds/README.md @@ -1,4 +1,5 @@ # Embeds +(*embeds*) ## Overview diff --git a/docs/sdks/events/README.md b/docs/sdks/events/README.md index af88d2f..e492067 100644 --- a/docs/sdks/events/README.md +++ b/docs/sdks/events/README.md @@ -1,4 +1,5 @@ # Events +(*events*) ## Overview @@ -30,9 +31,7 @@ s.config_security( ) -req = ::OpenApiSDK::Operations::SearchWorkspaceEventsRequest.new( - workspace_id: "", -) +req = ::OpenApiSDK::Operations::SearchWorkspaceEventsRequest.new() res = s.events.search(req) @@ -72,7 +71,7 @@ s.config_security( ) -res = s.events.post(workspace_id="", request_body=[ +res = s.events.post(request_body=[ ::OpenApiSDK::Shared::CliEvent.new( id: "", execution_id: "", @@ -84,7 +83,7 @@ res = s.events.post(workspace_id="", request_body=[ speakeasy_version: "", success: false, ), -]) +], workspace_id="") if res.status_code == 200 # handle response @@ -96,8 +95,8 @@ end | Parameter | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `request_body` | T::Array<[::OpenApiSDK::Shared::CliEvent](../../models/shared/clievent.md)> | :heavy_check_mark: | N/A | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -123,7 +122,7 @@ s.config_security( ) -res = s.events.get_by_target(workspace_id="", target_id="", after_created_at=DateTime.iso8601('2024-03-28T13:02:13.730Z')) +res = s.events.get_by_target(target_id="", workspace_id="", after_created_at=DateTime.iso8601('2024-03-28T13:02:13.730Z')) if ! res.cli_event_batch.nil? # handle response @@ -135,8 +134,8 @@ end | Parameter | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `target_id` | *::String* | :heavy_check_mark: | Filter to only return events corresponding to a particular gen_lock_id (gen_lock_id uniquely identifies a target) | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | | `after_created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | Filter to only return events created after this timestamp | ### Response @@ -213,7 +212,7 @@ end | Parameter | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | | `after_last_event_created_at` | [Date](https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/Date.html) | :heavy_minus_sign: | Filter to only return targets with events created after this timestamp | ### Response diff --git a/docs/sdks/github/README.md b/docs/sdks/github/README.md index 632dd9a..03b363a 100644 --- a/docs/sdks/github/README.md +++ b/docs/sdks/github/README.md @@ -1,10 +1,12 @@ # Github +(*github*) ## Overview ### Available Operations * [check_access](#check_access) +* [link_github](#link_github) * [check_publishing_p_rs](#check_publishing_p_rs) * [check_publishing_secrets](#check_publishing_secrets) * [store_publishing_secrets](#store_publishing_secrets) @@ -51,6 +53,44 @@ end +## link_github + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +res = s.github.link_github(installation_id="", github_org="", github_oidc_token="") + +if res.status_code == 200 + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------- | --------------------- | --------------------- | --------------------- | +| `installation_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| `github_org` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| `github_oidc_token` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::LinkGithubAccessResponse)](../../models/operations/linkgithubaccessresponse.md)** + + + ## check_publishing_p_rs ### Example Usage diff --git a/docs/sdks/metadata/README.md b/docs/sdks/metadata/README.md index 0d07b43..fe1ae34 100644 --- a/docs/sdks/metadata/README.md +++ b/docs/sdks/metadata/README.md @@ -1,4 +1,5 @@ # Metadata +(*metadata*) ## Overview diff --git a/docs/sdks/organizations/README.md b/docs/sdks/organizations/README.md index b0b1e1b..c40006f 100644 --- a/docs/sdks/organizations/README.md +++ b/docs/sdks/organizations/README.md @@ -1,4 +1,5 @@ # Organizations +(*organizations*) ## Overview diff --git a/docs/sdks/reports/README.md b/docs/sdks/reports/README.md index 95398f8..9c3ab0d 100644 --- a/docs/sdks/reports/README.md +++ b/docs/sdks/reports/README.md @@ -1,4 +1,5 @@ # Reports +(*reports*) ## Overview diff --git a/docs/sdks/requests/README.md b/docs/sdks/requests/README.md index cd5acf7..7fd07e7 100644 --- a/docs/sdks/requests/README.md +++ b/docs/sdks/requests/README.md @@ -1,4 +1,5 @@ # Requests +(*requests*) ## Overview @@ -100,7 +101,7 @@ end ## generate_postman_collection -Generates a Postman collection for a particular request. +Generates a Postman collection for a particular request. Allowing it to be replayed with the same inputs that were captured by the SDK. ### Example Usage diff --git a/docs/sdks/schemas/README.md b/docs/sdks/schemas/README.md index 2207a05..2b10591 100644 --- a/docs/sdks/schemas/README.md +++ b/docs/sdks/schemas/README.md @@ -1,4 +1,5 @@ # Schemas +(*schemas*) ## Overview @@ -17,7 +18,7 @@ REST APIs for managing Schema entities ## get_latest -Returns information about the last uploaded schema for a particular API version. +Returns information about the last uploaded schema for a particular API version. This won't include the schema itself, that can be retrieved via the downloadSchema operation. ### Example Usage @@ -223,7 +224,7 @@ end ## get_revision -Returns information about the last uploaded schema for a particular schema revision. +Returns information about the last uploaded schema for a particular schema revision. This won't include the schema itself, that can be retrieved via the downloadSchema operation. ### Example Usage @@ -304,7 +305,7 @@ end ## get -Returns information the schemas associated with a particular apiID. +Returns information the schemas associated with a particular apiID. This won't include the schemas themselves, they can be retrieved via the downloadSchema operation. ### Example Usage diff --git a/docs/sdks/shorturls/README.md b/docs/sdks/shorturls/README.md index 13f2813..19dc8f2 100644 --- a/docs/sdks/shorturls/README.md +++ b/docs/sdks/shorturls/README.md @@ -1,4 +1,5 @@ # ShortURLs +(*short_ur_ls*) ## Overview diff --git a/docs/sdks/speakeasyclientsdk/README.md b/docs/sdks/speakeasyclientsdk/README.md index 9bd5994..f258b15 100644 --- a/docs/sdks/speakeasyclientsdk/README.md +++ b/docs/sdks/speakeasyclientsdk/README.md @@ -2,7 +2,146 @@ ## Overview -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 The Speakeasy Platform Documentation - \ No newline at end of file + + +### Available Operations + +* [generate_code_sample_preview](#generate_code_sample_preview) - Generate Code Sample previews from a file and configuration parameters. +* [generate_code_sample_preview_async](#generate_code_sample_preview_async) - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling. +* [get_code_sample_preview_async](#get_code_sample_preview_async) - Poll for the result of an asynchronous Code Sample preview generation. + +## generate_code_sample_preview + +This endpoint generates Code Sample previews from a file and configuration parameters. + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new( + languages: [ + "", + ], + schema_file: ::OpenApiSDK::Shared::SchemaFile.new( + file_name: "example.file", + content: "0xc3dD8BfBef".encode(), + ), +) + +res = s.generate_code_sample_preview(req) + +if ! res.two_hundred_application_x_yaml_bytes.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `request` | [::OpenApiSDK::Shared::CodeSampleSchemaInput](../../models/shared/codesampleschemainput.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::GenerateCodeSamplePreviewResponse)](../../models/operations/generatecodesamplepreviewresponse.md)** + + + +## generate_code_sample_preview_async + +This endpoint generates Code Sample previews from a file and configuration parameters, receiving an async JobID response for polling. + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +req = ::OpenApiSDK::Shared::CodeSampleSchemaInput.new( + languages: [ + "", + ], + schema_file: ::OpenApiSDK::Shared::SchemaFile.new( + file_name: "example.file", + content: "0xED5CDd177E".encode(), + ), +) + +res = s.generate_code_sample_preview_async(req) + +if ! res.object.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `request` | [::OpenApiSDK::Shared::CodeSampleSchemaInput](../../models/shared/codesampleschemainput.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::GenerateCodeSamplePreviewAsyncResponse)](../../models/operations/generatecodesamplepreviewasyncresponse.md)** + + + +## get_code_sample_preview_async + +Poll for the result of an asynchronous Code Sample preview generation. + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +res = s.get_code_sample_preview_async(job_id="") + +if ! res.two_hundred_application_x_yaml_bytes.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `job_id` | *::String* | :heavy_check_mark: | The ID of the job to check the status and retrieve results | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncResponse)](../../models/operations/getcodesamplepreviewasyncresponse.md)** + diff --git a/docs/sdks/speakeasyclientsdkapiendpoints/README.md b/docs/sdks/speakeasyclientsdkapiendpoints/README.md index 9f36bd4..9fc7560 100644 --- a/docs/sdks/speakeasyclientsdkapiendpoints/README.md +++ b/docs/sdks/speakeasyclientsdkapiendpoints/README.md @@ -1,4 +1,5 @@ # SpeakeasyClientSDKApiEndpoints +(*api_endpoints*) ## Overview diff --git a/docs/sdks/subscriptions/README.md b/docs/sdks/subscriptions/README.md new file mode 100644 index 0000000..5232051 --- /dev/null +++ b/docs/sdks/subscriptions/README.md @@ -0,0 +1,98 @@ +# Subscriptions +(*subscriptions*) + +## Overview + +REST APIs for managing subscriptions + +### Available Operations + +* [list_registry_subscriptions](#list_registry_subscriptions) - List Subscriptions +* [create_subscription](#create_subscription) - Create Subscription + +## list_registry_subscriptions + +List Subscriptions + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +req = ::OpenApiSDK::Operations::ListRegistrySubscriptionsRequest.new() + +res = s.subscriptions.list_registry_subscriptions(req) + +if ! res.registry_subscriptions.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `request` | [::OpenApiSDK::Operations::ListRegistrySubscriptionsRequest](../../models/operations/listregistrysubscriptionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::ListRegistrySubscriptionsResponse)](../../models/operations/listregistrysubscriptionsresponse.md)** + + + +## create_subscription + +Create Subscription + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +res = s.subscriptions.create_subscription(registry_subscription=::OpenApiSDK::Shared::RegistrySubscription.new( + id: "", + workspace_id: "", + event_type: ::OpenApiSDK::Shared::EventType::UPDATE, + namespace_name: "", + subscription_type: ::OpenApiSDK::Shared::SubscriptionType::CLI, + subscription_settings: "", + created_at: DateTime.iso8601('2022-06-08T17:58:57.702Z'), + updated_at: DateTime.iso8601('2022-07-20T08:51:35.776Z'), +), workspace_id="") + +if ! res.registry_subscription.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `registry_subscription` | [::OpenApiSDK::Shared::RegistrySubscription](../../models/shared/registrysubscription.md) | :heavy_check_mark: | The subscription to create | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | The workspace ID | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::CreateSubscriptionResponse)](../../models/operations/createsubscriptionresponse.md)** + diff --git a/docs/sdks/suggest/README.md b/docs/sdks/suggest/README.md index dcf00b2..fe4467d 100644 --- a/docs/sdks/suggest/README.md +++ b/docs/sdks/suggest/README.md @@ -1,4 +1,5 @@ # Suggest +(*suggest*) ## Overview @@ -8,6 +9,7 @@ REST APIs for managing LLM OAS suggestions * [openapi](#openapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document. * [generate](#generate) - Generate suggestions for improving an OpenAPI document. +* [suggest_items](#suggest_items) - Generate generic suggestions for a list of items. * [openapi_registry](#openapi_registry) - Generate suggestions for improving an OpenAPI document stored in the registry. ## openapi @@ -124,6 +126,51 @@ end +## suggest_items + +Generate generic suggestions for a list of items. + +### Example Usage + +```ruby +require 'speakeasy_client_sdk_ruby' + + +s = ::OpenApiSDK::SpeakeasyClientSDK.new +s.config_security( + ::OpenApiSDK::Shared::Security.new( + api_key: "", + ) +) + + +req = ::OpenApiSDK::Shared::SuggestItemsRequestBody.new( + prompt: "", + items: [ + "", + ], +) + +res = s.suggest.suggest_items(req) + +if ! res.strings.nil? + # handle response +end + +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `request` | [::OpenApiSDK::Shared::SuggestItemsRequestBody](../../models/shared/suggestitemsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[T.nilable(::OpenApiSDK::Operations::SuggestItemsResponse)](../../models/operations/suggestitemsresponse.md)** + + + ## openapi_registry Get suggestions from an LLM model for improving an OpenAPI document stored in the registry. diff --git a/docs/sdks/workspaces/README.md b/docs/sdks/workspaces/README.md index b25f1c0..c956d6c 100644 --- a/docs/sdks/workspaces/README.md +++ b/docs/sdks/workspaces/README.md @@ -1,4 +1,5 @@ # Workspaces +(*workspaces*) ## Overview @@ -107,7 +108,6 @@ req = ::OpenApiSDK::Shared::Workspace.new( name: "", organization_id: "", slug: "", - telemetry_disabled: false, updated_at: DateTime.iso8601('2023-12-01T17:06:07.804Z'), verified: false, ) @@ -162,7 +162,7 @@ end | Parameter | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -188,16 +188,15 @@ s.config_security( ) -res = s.workspaces.update_details(workspace_id="", workspace=::OpenApiSDK::Shared::Workspace.new( +res = s.workspaces.update_details(workspace=::OpenApiSDK::Shared::Workspace.new( created_at: DateTime.iso8601('2024-02-01T20:44:31.776Z'), id: "", name: "", organization_id: "", slug: "", - telemetry_disabled: false, updated_at: DateTime.iso8601('2023-08-04T18:26:06.739Z'), verified: false, -)) +), workspace_id="") if res.status_code == 200 # handle response @@ -209,8 +208,8 @@ end | Parameter | Type | Required | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `workspace` | [::OpenApiSDK::Shared::Workspace](../../models/shared/workspace.md) | :heavy_check_mark: | The workspace details to update. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -248,7 +247,7 @@ end | Parameter | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -274,9 +273,12 @@ s.config_security( ) -res = s.workspaces.update_settings(workspace_id="", workspace_settings=::OpenApiSDK::Shared::WorkspaceSettings.new( +res = s.workspaces.update_settings(workspace_settings=::OpenApiSDK::Shared::WorkspaceSettings.new( workspace_id: "", -)) + webhook_url: "https://last-suspension.info/", + created_at: DateTime.iso8601('2023-12-29T06:46:35.807Z'), + updated_at: DateTime.iso8601('2024-02-04T10:37:56.725Z'), +), workspace_id="") if res.status_code == 200 # handle response @@ -288,8 +290,8 @@ end | Parameter | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `workspace_settings` | [::OpenApiSDK::Shared::WorkspaceSettings](../../models/shared/workspacesettings.md) | :heavy_check_mark: | The workspace settings to update. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -327,7 +329,7 @@ end | Parameter | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -353,7 +355,7 @@ s.config_security( ) -res = s.workspaces.grant_access(workspace_id="", email="Lucinda.Batz8@hotmail.com") +res = s.workspaces.grant_access(email="Lucinda.Batz8@hotmail.com", workspace_id="") if ! res.workspace_invite_response.nil? # handle response @@ -365,8 +367,8 @@ end | Parameter | Type | Required | Description | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `email` | *::String* | :heavy_check_mark: | Email of the user to grant access to. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -392,7 +394,7 @@ s.config_security( ) -res = s.workspaces.revoke_access(workspace_id="", user_id="") +res = s.workspaces.revoke_access(user_id="", workspace_id="") if res.status_code == 200 # handle response @@ -404,8 +406,8 @@ end | Parameter | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `user_id` | *::String* | :heavy_check_mark: | Unique identifier of the user. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -443,7 +445,7 @@ end | Parameter | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -469,13 +471,14 @@ s.config_security( ) -res = s.workspaces.create_token(workspace_id="", workspace_token=::OpenApiSDK::Shared::WorkspaceToken.new( +res = s.workspaces.create_token(workspace_token=::OpenApiSDK::Shared::WorkspaceToken.new( id: "", name: "", + workspace_id: "", alg: "", key: "", - created_at: "", -)) + created_at: DateTime.iso8601('2022-08-16T02:33:00.784Z'), +), workspace_id="") if res.status_code == 200 # handle response @@ -487,8 +490,8 @@ end | Parameter | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `workspace_token` | [::OpenApiSDK::Shared::WorkspaceToken](../../models/shared/workspacetoken.md) | :heavy_check_mark: | N/A | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -514,7 +517,7 @@ s.config_security( ) -res = s.workspaces.delete_token(workspace_id="", token_id="") +res = s.workspaces.delete_token(token_id="", workspace_id="") if res.status_code == 200 # handle response @@ -526,8 +529,8 @@ end | Parameter | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | | `token_id` | *::String* | :heavy_check_mark: | Unique identifier of the token. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response @@ -565,7 +568,7 @@ end | Parameter | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `workspace_id` | *::String* | :heavy_check_mark: | Unique identifier of the workspace. | +| `workspace_id` | *T.nilable(::String)* | :heavy_minus_sign: | Unique identifier of the workspace. | ### Response diff --git a/lib/open_api_sdk/artifacts.rb b/lib/open_api_sdk/artifacts.rb index 0c5a47a..25b096d 100644 --- a/lib/open_api_sdk/artifacts.rb +++ b/lib/open_api_sdk/artifacts.rb @@ -242,6 +242,87 @@ def post_tags(namespace_name, add_tags = nil) end + sig { params(namespace_name: ::String).returns(::OpenApiSDK::Operations::ListRemoteSourcesResponse) } + def list_remote_sources(namespace_name) + # list_remote_sources - Get remote sources attached to a particular namespace + request = ::OpenApiSDK::Operations::ListRemoteSourcesRequest.new( + + namespace_name: namespace_name + ) + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/v1/artifacts/remote_sources" + headers = {} + query_params = Utils.get_query_params(::OpenApiSDK::Operations::ListRemoteSourcesRequest, request, @sdk_configuration.globals) + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.get(url) do |req| + req.headers = headers + req.params = query_params + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::ListRemoteSourcesResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status >= 200 && r.status < 300 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::RemoteSource) + res.remote_source = out + end + elsif r.status >= 400 && r.status < 500 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error) + res.error = out + end + end + res + end + + + sig { params(request: T.nilable(::OpenApiSDK::Shared::RemoteSource)).returns(::OpenApiSDK::Operations::CreateRemoteSourceResponse) } + def create_remote_source(request) + # create_remote_source - Configure a new remote source + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/v1/artifacts/remote_sources" + headers = {} + req_content_type, data, form = Utils.serialize_request_body(request, :request, :json) + headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.post(url) do |req| + req.headers = headers + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + if form + req.body = Utils.encode_form(form) + elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded') + req.body = URI.encode_www_form(data) + else + req.body = data + end + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::CreateRemoteSourceResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status >= 200 && r.status < 300 + elsif r.status >= 400 && r.status < 500 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error) + res.error = out + end + end + res + end + + sig { params(organization_slug: ::String, workspace_slug: ::String, namespace_name: ::String, revision_reference: ::String).returns(::OpenApiSDK::Operations::GetManifestResponse) } def get_manifest(organization_slug, workspace_slug, namespace_name, revision_reference) # get_manifest - Get manifest for a particular reference diff --git a/lib/open_api_sdk/events.rb b/lib/open_api_sdk/events.rb index a850f91..17c1511 100644 --- a/lib/open_api_sdk/events.rb +++ b/lib/open_api_sdk/events.rb @@ -62,14 +62,14 @@ def search(request) end - sig { params(workspace_id: ::String, request_body: T::Array[::OpenApiSDK::Shared::CliEvent]).returns(::OpenApiSDK::Operations::PostWorkspaceEventsResponse) } - def post(workspace_id, request_body) + sig { params(request_body: T::Array[::OpenApiSDK::Shared::CliEvent], workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::PostWorkspaceEventsResponse) } + def post(request_body, workspace_id = nil) # post - Post events for a specific workspace # Sends an array of events to be stored for a particular workspace. request = ::OpenApiSDK::Operations::PostWorkspaceEventsRequest.new( - workspace_id: workspace_id, - request_body: request_body + request_body: request_body, + workspace_id: workspace_id ) url, params = @sdk_configuration.get_server_details base_url = Utils.template_url(url, params) @@ -115,13 +115,13 @@ def post(workspace_id, request_body) end - sig { params(workspace_id: ::String, target_id: ::String, after_created_at: T.nilable(::DateTime)).returns(::OpenApiSDK::Operations::GetWorkspaceEventsByTargetResponse) } - def get_by_target(workspace_id, target_id, after_created_at = nil) + sig { params(target_id: ::String, workspace_id: T.nilable(::String), after_created_at: T.nilable(::DateTime)).returns(::OpenApiSDK::Operations::GetWorkspaceEventsByTargetResponse) } + def get_by_target(target_id, workspace_id = nil, after_created_at = nil) # get_by_target - Load recent events for a particular workspace request = ::OpenApiSDK::Operations::GetWorkspaceEventsByTargetRequest.new( - workspace_id: workspace_id, target_id: target_id, + workspace_id: workspace_id, after_created_at: after_created_at ) url, params = @sdk_configuration.get_server_details @@ -205,8 +205,8 @@ def get_targets(after_last_event_created_at = nil) end - sig { params(workspace_id: ::String, after_last_event_created_at: T.nilable(::DateTime)).returns(::OpenApiSDK::Operations::GetWorkspaceTargetsDeprecatedResponse) } - def get_targets_deprecated(workspace_id, after_last_event_created_at = nil) + sig { params(workspace_id: T.nilable(::String), after_last_event_created_at: T.nilable(::DateTime)).returns(::OpenApiSDK::Operations::GetWorkspaceTargetsDeprecatedResponse) } + def get_targets_deprecated(workspace_id = nil, after_last_event_created_at = nil) # get_targets_deprecated - Load targets for a particular workspace request = ::OpenApiSDK::Operations::GetWorkspaceTargetsDeprecatedRequest.new( diff --git a/lib/open_api_sdk/github.rb b/lib/open_api_sdk/github.rb index 76e0848..1a9b205 100644 --- a/lib/open_api_sdk/github.rb +++ b/lib/open_api_sdk/github.rb @@ -57,6 +57,45 @@ def check_access(org, repo) end + sig { params(installation_id: T.nilable(::String), github_org: T.nilable(::String), github_oidc_token: T.nilable(::String)).returns(::OpenApiSDK::Operations::LinkGithubAccessResponse) } + def link_github(installation_id = nil, github_org = nil, github_oidc_token = nil) + + request = ::OpenApiSDK::Operations::LinkGithubAccessRequest.new( + + installation_id: installation_id, + github_org: github_org, + github_oidc_token: github_oidc_token + ) + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/v1/github/link" + headers = {} + query_params = Utils.get_query_params(::OpenApiSDK::Operations::LinkGithubAccessRequest, request, @sdk_configuration.globals) + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.post(url) do |req| + req.headers = headers + req.params = query_params + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::LinkGithubAccessResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status >= 200 && r.status < 300 + elsif r.status >= 400 && r.status < 500 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error) + res.error = out + end + end + res + end + + sig { params(generate_gen_lock_id: ::String, org: ::String, repo: ::String).returns(::OpenApiSDK::Operations::GithubCheckPublishingPRsResponse) } def check_publishing_p_rs(generate_gen_lock_id, org, repo) diff --git a/lib/open_api_sdk/models/operations.rb b/lib/open_api_sdk/models/operations.rb index 18ddba7..b3383eb 100644 --- a/lib/open_api_sdk/models/operations.rb +++ b/lib/open_api_sdk/models/operations.rb @@ -5,6 +5,12 @@ module OpenApiSDK module Operations + autoload :GenerateCodeSamplePreviewResponse, 'open_api_sdk/models/operations/generatecodesamplepreview_response.rb' + autoload :GenerateCodeSamplePreviewAsyncResponseBody, 'open_api_sdk/models/operations/generatecodesamplepreviewasync_responsebody.rb' + autoload :GenerateCodeSamplePreviewAsyncResponse, 'open_api_sdk/models/operations/generatecodesamplepreviewasync_response.rb' + autoload :GetCodeSamplePreviewAsyncRequest, 'open_api_sdk/models/operations/getcodesamplepreviewasync_request.rb' + autoload :GetCodeSamplePreviewAsyncResponseBody, 'open_api_sdk/models/operations/getcodesamplepreviewasync_responsebody.rb' + autoload :GetCodeSamplePreviewAsyncResponse, 'open_api_sdk/models/operations/getcodesamplepreviewasync_response.rb' autoload :Op, 'open_api_sdk/models/operations/op.rb' autoload :GetApisRequest, 'open_api_sdk/models/operations/getapis_request.rb' autoload :GetApisResponse, 'open_api_sdk/models/operations/getapis_response.rb' @@ -73,6 +79,8 @@ module Operations autoload :GenerateRequestPostmanCollectionResponse, 'open_api_sdk/models/operations/generaterequestpostmancollection_response.rb' autoload :CheckGithubAccessRequest, 'open_api_sdk/models/operations/checkgithubaccess_request.rb' autoload :CheckGithubAccessResponse, 'open_api_sdk/models/operations/checkgithubaccess_response.rb' + autoload :LinkGithubAccessRequest, 'open_api_sdk/models/operations/linkgithubaccess_request.rb' + autoload :LinkGithubAccessResponse, 'open_api_sdk/models/operations/linkgithubaccess_response.rb' autoload :GithubCheckPublishingPRsRequest, 'open_api_sdk/models/operations/githubcheckpublishingprs_request.rb' autoload :GithubCheckPublishingPRsResponse, 'open_api_sdk/models/operations/githubcheckpublishingprs_response.rb' autoload :GithubCheckPublishingSecretsRequest, 'open_api_sdk/models/operations/githubcheckpublishingsecrets_request.rb' @@ -130,18 +138,6 @@ module Operations autoload :GetWorkspaceTargetsResponse, 'open_api_sdk/models/operations/getworkspacetargets_response.rb' autoload :GetWorkspaceTargetsDeprecatedRequest, 'open_api_sdk/models/operations/getworkspacetargetsdeprecated_request.rb' autoload :GetWorkspaceTargetsDeprecatedResponse, 'open_api_sdk/models/operations/getworkspacetargetsdeprecated_response.rb' - autoload :PreflightResponse, 'open_api_sdk/models/operations/preflight_response.rb' - autoload :GetNamespacesResponse, 'open_api_sdk/models/operations/getnamespaces_response.rb' - autoload :GetRevisionsRequest, 'open_api_sdk/models/operations/getrevisions_request.rb' - autoload :GetRevisionsResponse, 'open_api_sdk/models/operations/getrevisions_response.rb' - autoload :GetTagsRequest, 'open_api_sdk/models/operations/gettags_request.rb' - autoload :GetTagsResponse, 'open_api_sdk/models/operations/gettags_response.rb' - autoload :PostTagsRequest, 'open_api_sdk/models/operations/posttags_request.rb' - autoload :PostTagsResponse, 'open_api_sdk/models/operations/posttags_response.rb' - autoload :GetManifestRequest, 'open_api_sdk/models/operations/getmanifest_request.rb' - autoload :GetManifestResponse, 'open_api_sdk/models/operations/getmanifest_response.rb' - autoload :GetBlobRequest, 'open_api_sdk/models/operations/getblob_request.rb' - autoload :GetBlobResponse, 'open_api_sdk/models/operations/getblob_response.rb' autoload :UploadReportFile, 'open_api_sdk/models/operations/uploadreport_file.rb' autoload :UploadReportRequestBody, 'open_api_sdk/models/operations/uploadreport_requestbody.rb' autoload :UploadReportUploadedReport, 'open_api_sdk/models/operations/uploadreport_uploadedreport.rb' @@ -158,9 +154,29 @@ module Operations autoload :SuggestOpenAPIResponse, 'open_api_sdk/models/operations/suggestopenapi_response.rb' autoload :SuggestRequest, 'open_api_sdk/models/operations/suggest_request.rb' autoload :SuggestResponse, 'open_api_sdk/models/operations/suggest_response.rb' + autoload :SuggestItemsResponse, 'open_api_sdk/models/operations/suggestitems_response.rb' autoload :SuggestOpenAPIRegistryRequest, 'open_api_sdk/models/operations/suggestopenapiregistry_request.rb' autoload :SuggestOpenAPIRegistryResponse, 'open_api_sdk/models/operations/suggestopenapiregistry_response.rb' autoload :CreateRequestBody, 'open_api_sdk/models/operations/create_requestbody.rb' autoload :CreateResponse, 'open_api_sdk/models/operations/create_response.rb' + autoload :PreflightResponse, 'open_api_sdk/models/operations/preflight_response.rb' + autoload :GetNamespacesResponse, 'open_api_sdk/models/operations/getnamespaces_response.rb' + autoload :GetRevisionsRequest, 'open_api_sdk/models/operations/getrevisions_request.rb' + autoload :GetRevisionsResponse, 'open_api_sdk/models/operations/getrevisions_response.rb' + autoload :GetTagsRequest, 'open_api_sdk/models/operations/gettags_request.rb' + autoload :GetTagsResponse, 'open_api_sdk/models/operations/gettags_response.rb' + autoload :PostTagsRequest, 'open_api_sdk/models/operations/posttags_request.rb' + autoload :PostTagsResponse, 'open_api_sdk/models/operations/posttags_response.rb' + autoload :ListRemoteSourcesRequest, 'open_api_sdk/models/operations/listremotesources_request.rb' + autoload :ListRemoteSourcesResponse, 'open_api_sdk/models/operations/listremotesources_response.rb' + autoload :CreateRemoteSourceResponse, 'open_api_sdk/models/operations/createremotesource_response.rb' + autoload :GetManifestRequest, 'open_api_sdk/models/operations/getmanifest_request.rb' + autoload :GetManifestResponse, 'open_api_sdk/models/operations/getmanifest_response.rb' + autoload :GetBlobRequest, 'open_api_sdk/models/operations/getblob_request.rb' + autoload :GetBlobResponse, 'open_api_sdk/models/operations/getblob_response.rb' + autoload :ListRegistrySubscriptionsRequest, 'open_api_sdk/models/operations/listregistrysubscriptions_request.rb' + autoload :ListRegistrySubscriptionsResponse, 'open_api_sdk/models/operations/listregistrysubscriptions_response.rb' + autoload :CreateSubscriptionRequest, 'open_api_sdk/models/operations/createsubscription_request.rb' + autoload :CreateSubscriptionResponse, 'open_api_sdk/models/operations/createsubscription_response.rb' end end diff --git a/lib/open_api_sdk/models/operations/createremotesource_response.rb b/lib/open_api_sdk/models/operations/createremotesource_response.rb new file mode 100644 index 0000000..33edbf3 --- /dev/null +++ b/lib/open_api_sdk/models/operations/createremotesource_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class CreateRemoteSourceResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # Default error response + field :error, T.nilable(::OpenApiSDK::Shared::Error) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, error: T.nilable(::OpenApiSDK::Shared::Error)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, error: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @error = error + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/createsubscription_request.rb b/lib/open_api_sdk/models/operations/createsubscription_request.rb new file mode 100644 index 0000000..21b7ecf --- /dev/null +++ b/lib/open_api_sdk/models/operations/createsubscription_request.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class CreateSubscriptionRequest < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # The subscription to create + field :registry_subscription, ::OpenApiSDK::Shared::RegistrySubscription, { 'request': { 'media_type': 'application/json' } } + # The workspace ID + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + + + sig { params(registry_subscription: ::OpenApiSDK::Shared::RegistrySubscription, workspace_id: T.nilable(::String)).void } + def initialize(registry_subscription: nil, workspace_id: nil) + @registry_subscription = registry_subscription + @workspace_id = workspace_id + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/createsubscription_response.rb b/lib/open_api_sdk/models/operations/createsubscription_response.rb new file mode 100644 index 0000000..38736d4 --- /dev/null +++ b/lib/open_api_sdk/models/operations/createsubscription_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class CreateSubscriptionResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # OK + field :registry_subscription, T.nilable(::OpenApiSDK::Shared::RegistrySubscription) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, registry_subscription: T.nilable(::OpenApiSDK::Shared::RegistrySubscription)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, registry_subscription: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @registry_subscription = registry_subscription + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/createworkspacetoken_request.rb b/lib/open_api_sdk/models/operations/createworkspacetoken_request.rb index 27220cf..0a06ab0 100644 --- a/lib/open_api_sdk/models/operations/createworkspacetoken_request.rb +++ b/lib/open_api_sdk/models/operations/createworkspacetoken_request.rb @@ -11,16 +11,16 @@ module Operations class CreateWorkspaceTokenRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig - # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } field :workspace_token, ::OpenApiSDK::Shared::WorkspaceToken, { 'request': { 'media_type': 'application/json' } } + # Unique identifier of the workspace. + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String, workspace_token: ::OpenApiSDK::Shared::WorkspaceToken).void } - def initialize(workspace_id: nil, workspace_token: nil) - @workspace_id = workspace_id + sig { params(workspace_token: ::OpenApiSDK::Shared::WorkspaceToken, workspace_id: T.nilable(::String)).void } + def initialize(workspace_token: nil, workspace_id: nil) @workspace_token = workspace_token + @workspace_id = workspace_id end end end diff --git a/lib/open_api_sdk/models/operations/deleteworkspacetoken_request.rb b/lib/open_api_sdk/models/operations/deleteworkspacetoken_request.rb index 2599661..ab17532 100644 --- a/lib/open_api_sdk/models/operations/deleteworkspacetoken_request.rb +++ b/lib/open_api_sdk/models/operations/deleteworkspacetoken_request.rb @@ -14,10 +14,10 @@ class DeleteWorkspaceTokenRequest < ::OpenApiSDK::Utils::FieldAugmented # Unique identifier of the token. field :token_id, ::String, { 'path_param': { 'field_name': 'tokenID', 'style': 'simple', 'explode': false } } # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(token_id: ::String, workspace_id: ::String).void } + sig { params(token_id: ::String, workspace_id: T.nilable(::String)).void } def initialize(token_id: nil, workspace_id: nil) @token_id = token_id @workspace_id = workspace_id diff --git a/lib/open_api_sdk/models/operations/generatecodesamplepreview_response.rb b/lib/open_api_sdk/models/operations/generatecodesamplepreview_response.rb new file mode 100644 index 0000000..91c866a --- /dev/null +++ b/lib/open_api_sdk/models/operations/generatecodesamplepreview_response.rb @@ -0,0 +1,39 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class GenerateCodeSamplePreviewResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # Successfully returned codeSample overlay file + field :two_hundred_application_json_bytes, T.nilable(::String) + # Successfully returned codeSample overlay file + field :two_hundred_application_x_yaml_bytes, T.nilable(::String) + # Error + field :error, T.nilable(::OpenApiSDK::Shared::Error) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, two_hundred_application_json_bytes: T.nilable(::String), two_hundred_application_x_yaml_bytes: T.nilable(::String), error: T.nilable(::OpenApiSDK::Shared::Error)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, two_hundred_application_json_bytes: nil, two_hundred_application_x_yaml_bytes: nil, error: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @two_hundred_application_json_bytes = two_hundred_application_json_bytes + @two_hundred_application_x_yaml_bytes = two_hundred_application_x_yaml_bytes + @error = error + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/generatecodesamplepreviewasync_response.rb b/lib/open_api_sdk/models/operations/generatecodesamplepreviewasync_response.rb new file mode 100644 index 0000000..6d441f9 --- /dev/null +++ b/lib/open_api_sdk/models/operations/generatecodesamplepreviewasync_response.rb @@ -0,0 +1,36 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class GenerateCodeSamplePreviewAsyncResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # Error + field :error, T.nilable(::OpenApiSDK::Shared::Error) + # Job accepted, returns a job ID to poll for status and result + field :object, T.nilable(::OpenApiSDK::Operations::GenerateCodeSamplePreviewAsyncResponseBody) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, error: T.nilable(::OpenApiSDK::Shared::Error), object: T.nilable(::OpenApiSDK::Operations::GenerateCodeSamplePreviewAsyncResponseBody)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, error: nil, object: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @error = error + @object = object + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/generatecodesamplepreviewasync_responsebody.rb b/lib/open_api_sdk/models/operations/generatecodesamplepreviewasync_responsebody.rb new file mode 100644 index 0000000..c826457 --- /dev/null +++ b/lib/open_api_sdk/models/operations/generatecodesamplepreviewasync_responsebody.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + # Job accepted, returns a job ID to poll for status and result + class GenerateCodeSamplePreviewAsyncResponseBody < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # The job ID for polling + field :job_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('job_id') } } + # The current status of the job. Possible values are `pending` or `running`. + field :status, ::OpenApiSDK::Shared::CodeSamplesJobStatus, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Shared::CodeSamplesJobStatus, false) } } + + + sig { params(job_id: ::String, status: ::OpenApiSDK::Shared::CodeSamplesJobStatus).void } + def initialize(job_id: nil, status: nil) + @job_id = job_id + @status = status + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_request.rb b/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_request.rb new file mode 100644 index 0000000..032b9cd --- /dev/null +++ b/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_request.rb @@ -0,0 +1,24 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class GetCodeSamplePreviewAsyncRequest < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # The ID of the job to check the status and retrieve results + field :job_id, ::String, { 'path_param': { 'field_name': 'jobID', 'style': 'simple', 'explode': false } } + + + sig { params(job_id: ::String).void } + def initialize(job_id: nil) + @job_id = job_id + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_response.rb b/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_response.rb new file mode 100644 index 0000000..9b8a277 --- /dev/null +++ b/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_response.rb @@ -0,0 +1,42 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class GetCodeSamplePreviewAsyncResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # Successfully returned codeSample overlay file + field :two_hundred_application_json_bytes, T.nilable(::String) + # Successfully returned codeSample overlay file + field :two_hundred_application_x_yaml_bytes, T.nilable(::String) + # Job is still in progress + field :two_hundred_and_two_application_json_object, T.nilable(::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncResponseBody) + # Error + field :error, T.nilable(::OpenApiSDK::Shared::Error) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, two_hundred_application_json_bytes: T.nilable(::String), two_hundred_application_x_yaml_bytes: T.nilable(::String), two_hundred_and_two_application_json_object: T.nilable(::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncResponseBody), error: T.nilable(::OpenApiSDK::Shared::Error)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, two_hundred_application_json_bytes: nil, two_hundred_application_x_yaml_bytes: nil, two_hundred_and_two_application_json_object: nil, error: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @two_hundred_application_json_bytes = two_hundred_application_json_bytes + @two_hundred_application_x_yaml_bytes = two_hundred_application_x_yaml_bytes + @two_hundred_and_two_application_json_object = two_hundred_and_two_application_json_object + @error = error + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_responsebody.rb b/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_responsebody.rb new file mode 100644 index 0000000..a52547e --- /dev/null +++ b/lib/open_api_sdk/models/operations/getcodesamplepreviewasync_responsebody.rb @@ -0,0 +1,24 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + # Job is still in progress + class GetCodeSamplePreviewAsyncResponseBody < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # The current status of the job. Possible values are `pending` or `running`. + field :status, ::OpenApiSDK::Shared::CodeSamplesJobStatus, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Shared::CodeSamplesJobStatus, false) } } + + + sig { params(status: ::OpenApiSDK::Shared::CodeSamplesJobStatus).void } + def initialize(status: nil) + @status = status + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/getworkspace_request.rb b/lib/open_api_sdk/models/operations/getworkspace_request.rb index c6516f4..148316d 100644 --- a/lib/open_api_sdk/models/operations/getworkspace_request.rb +++ b/lib/open_api_sdk/models/operations/getworkspace_request.rb @@ -12,10 +12,10 @@ class GetWorkspaceRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String).void } + sig { params(workspace_id: T.nilable(::String)).void } def initialize(workspace_id: nil) @workspace_id = workspace_id end diff --git a/lib/open_api_sdk/models/operations/getworkspaceeventsbytarget_request.rb b/lib/open_api_sdk/models/operations/getworkspaceeventsbytarget_request.rb index 9b9ca79..c3003b5 100644 --- a/lib/open_api_sdk/models/operations/getworkspaceeventsbytarget_request.rb +++ b/lib/open_api_sdk/models/operations/getworkspaceeventsbytarget_request.rb @@ -13,17 +13,17 @@ class GetWorkspaceEventsByTargetRequest < ::OpenApiSDK::Utils::FieldAugmented # Filter to only return events corresponding to a particular gen_lock_id (gen_lock_id uniquely identifies a target) field :target_id, ::String, { 'path_param': { 'field_name': 'target_id', 'style': 'simple', 'explode': false } } - # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } # Filter to only return events created after this timestamp field :after_created_at, T.nilable(::DateTime), { 'query_param': { 'field_name': 'after_created_at', 'style': 'form', 'explode': true } } + # Unique identifier of the workspace. + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(target_id: ::String, workspace_id: ::String, after_created_at: T.nilable(::DateTime)).void } - def initialize(target_id: nil, workspace_id: nil, after_created_at: nil) + sig { params(target_id: ::String, after_created_at: T.nilable(::DateTime), workspace_id: T.nilable(::String)).void } + def initialize(target_id: nil, after_created_at: nil, workspace_id: nil) @target_id = target_id - @workspace_id = workspace_id @after_created_at = after_created_at + @workspace_id = workspace_id end end end diff --git a/lib/open_api_sdk/models/operations/getworkspacefeatureflags_request.rb b/lib/open_api_sdk/models/operations/getworkspacefeatureflags_request.rb index 75ce99f..007eb42 100644 --- a/lib/open_api_sdk/models/operations/getworkspacefeatureflags_request.rb +++ b/lib/open_api_sdk/models/operations/getworkspacefeatureflags_request.rb @@ -12,10 +12,10 @@ class GetWorkspaceFeatureFlagsRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String).void } + sig { params(workspace_id: T.nilable(::String)).void } def initialize(workspace_id: nil) @workspace_id = workspace_id end diff --git a/lib/open_api_sdk/models/operations/getworkspacesettings_request.rb b/lib/open_api_sdk/models/operations/getworkspacesettings_request.rb index d02917e..7d6fbbe 100644 --- a/lib/open_api_sdk/models/operations/getworkspacesettings_request.rb +++ b/lib/open_api_sdk/models/operations/getworkspacesettings_request.rb @@ -12,10 +12,10 @@ class GetWorkspaceSettingsRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String).void } + sig { params(workspace_id: T.nilable(::String)).void } def initialize(workspace_id: nil) @workspace_id = workspace_id end diff --git a/lib/open_api_sdk/models/operations/getworkspacetargetsdeprecated_request.rb b/lib/open_api_sdk/models/operations/getworkspacetargetsdeprecated_request.rb index fe1c96a..dd5dae1 100644 --- a/lib/open_api_sdk/models/operations/getworkspacetargetsdeprecated_request.rb +++ b/lib/open_api_sdk/models/operations/getworkspacetargetsdeprecated_request.rb @@ -11,16 +11,16 @@ module Operations class GetWorkspaceTargetsDeprecatedRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig - # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } # Filter to only return targets with events created after this timestamp field :after_last_event_created_at, T.nilable(::DateTime), { 'query_param': { 'field_name': 'after_last_event_created_at', 'style': 'form', 'explode': true } } + # Unique identifier of the workspace. + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String, after_last_event_created_at: T.nilable(::DateTime)).void } - def initialize(workspace_id: nil, after_last_event_created_at: nil) - @workspace_id = workspace_id + sig { params(after_last_event_created_at: T.nilable(::DateTime), workspace_id: T.nilable(::String)).void } + def initialize(after_last_event_created_at: nil, workspace_id: nil) @after_last_event_created_at = after_last_event_created_at + @workspace_id = workspace_id end end end diff --git a/lib/open_api_sdk/models/operations/getworkspaceteam_request.rb b/lib/open_api_sdk/models/operations/getworkspaceteam_request.rb index 8371a5d..9099e98 100644 --- a/lib/open_api_sdk/models/operations/getworkspaceteam_request.rb +++ b/lib/open_api_sdk/models/operations/getworkspaceteam_request.rb @@ -12,10 +12,10 @@ class GetWorkspaceTeamRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String).void } + sig { params(workspace_id: T.nilable(::String)).void } def initialize(workspace_id: nil) @workspace_id = workspace_id end diff --git a/lib/open_api_sdk/models/operations/getworkspacetokens_request.rb b/lib/open_api_sdk/models/operations/getworkspacetokens_request.rb index 332ae0e..971dc91 100644 --- a/lib/open_api_sdk/models/operations/getworkspacetokens_request.rb +++ b/lib/open_api_sdk/models/operations/getworkspacetokens_request.rb @@ -12,10 +12,10 @@ class GetWorkspaceTokensRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String).void } + sig { params(workspace_id: T.nilable(::String)).void } def initialize(workspace_id: nil) @workspace_id = workspace_id end diff --git a/lib/open_api_sdk/models/operations/grantuseraccesstoworkspace_request.rb b/lib/open_api_sdk/models/operations/grantuseraccesstoworkspace_request.rb index b72765b..de21880 100644 --- a/lib/open_api_sdk/models/operations/grantuseraccesstoworkspace_request.rb +++ b/lib/open_api_sdk/models/operations/grantuseraccesstoworkspace_request.rb @@ -14,10 +14,10 @@ class GrantUserAccessToWorkspaceRequest < ::OpenApiSDK::Utils::FieldAugmented # Email of the user to grant access to. field :email, ::String, { 'path_param': { 'field_name': 'email', 'style': 'simple', 'explode': false } } # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(email: ::String, workspace_id: ::String).void } + sig { params(email: ::String, workspace_id: T.nilable(::String)).void } def initialize(email: nil, workspace_id: nil) @email = email @workspace_id = workspace_id diff --git a/lib/open_api_sdk/models/operations/linkgithubaccess_request.rb b/lib/open_api_sdk/models/operations/linkgithubaccess_request.rb new file mode 100644 index 0000000..e021631 --- /dev/null +++ b/lib/open_api_sdk/models/operations/linkgithubaccess_request.rb @@ -0,0 +1,30 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class LinkGithubAccessRequest < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + + field :github_oidc_token, T.nilable(::String), { 'query_param': { 'field_name': 'github_oidc_token', 'style': 'form', 'explode': true } } + + field :github_org, T.nilable(::String), { 'query_param': { 'field_name': 'github_org', 'style': 'form', 'explode': true } } + + field :installation_id, T.nilable(::String), { 'query_param': { 'field_name': 'installation_id', 'style': 'form', 'explode': true } } + + + sig { params(github_oidc_token: T.nilable(::String), github_org: T.nilable(::String), installation_id: T.nilable(::String)).void } + def initialize(github_oidc_token: nil, github_org: nil, installation_id: nil) + @github_oidc_token = github_oidc_token + @github_org = github_org + @installation_id = installation_id + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/linkgithubaccess_response.rb b/lib/open_api_sdk/models/operations/linkgithubaccess_response.rb new file mode 100644 index 0000000..01f63a5 --- /dev/null +++ b/lib/open_api_sdk/models/operations/linkgithubaccess_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class LinkGithubAccessResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # Default error response + field :error, T.nilable(::OpenApiSDK::Shared::Error) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, error: T.nilable(::OpenApiSDK::Shared::Error)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, error: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @error = error + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/listregistrysubscriptions_request.rb b/lib/open_api_sdk/models/operations/listregistrysubscriptions_request.rb new file mode 100644 index 0000000..9f24f6e --- /dev/null +++ b/lib/open_api_sdk/models/operations/listregistrysubscriptions_request.rb @@ -0,0 +1,36 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class ListRegistrySubscriptionsRequest < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # The event type + field :event_type, T.nilable(::String), { 'query_param': { 'field_name': 'event_type', 'style': 'form', 'explode': true } } + # The namespace name + field :namespace_name, T.nilable(::String), { 'query_param': { 'field_name': 'namespace_name', 'style': 'form', 'explode': true } } + # The subscription type + field :subscription_type, T.nilable(::OpenApiSDK::Shared::SubscriptionType), { 'query_param': { 'field_name': 'subscription_type', 'style': 'form', 'explode': true } } + # The tag + field :tag, T.nilable(::String), { 'query_param': { 'field_name': 'tag', 'style': 'form', 'explode': true } } + # The workspace ID + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + + + sig { params(event_type: T.nilable(::String), namespace_name: T.nilable(::String), subscription_type: T.nilable(::OpenApiSDK::Shared::SubscriptionType), tag: T.nilable(::String), workspace_id: T.nilable(::String)).void } + def initialize(event_type: nil, namespace_name: nil, subscription_type: nil, tag: nil, workspace_id: nil) + @event_type = event_type + @namespace_name = namespace_name + @subscription_type = subscription_type + @tag = tag + @workspace_id = workspace_id + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/listregistrysubscriptions_response.rb b/lib/open_api_sdk/models/operations/listregistrysubscriptions_response.rb new file mode 100644 index 0000000..664cbc5 --- /dev/null +++ b/lib/open_api_sdk/models/operations/listregistrysubscriptions_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class ListRegistrySubscriptionsResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # OK + field :registry_subscriptions, T.nilable(T::Array[::OpenApiSDK::Shared::RegistrySubscription]) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, registry_subscriptions: T.nilable(T::Array[::OpenApiSDK::Shared::RegistrySubscription])).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, registry_subscriptions: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @registry_subscriptions = registry_subscriptions + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/listremotesources_request.rb b/lib/open_api_sdk/models/operations/listremotesources_request.rb new file mode 100644 index 0000000..519a02c --- /dev/null +++ b/lib/open_api_sdk/models/operations/listremotesources_request.rb @@ -0,0 +1,24 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class ListRemoteSourcesRequest < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + + field :namespace_name, ::String, { 'query_param': { 'field_name': 'namespace_name', 'style': 'form', 'explode': true } } + + + sig { params(namespace_name: ::String).void } + def initialize(namespace_name: nil) + @namespace_name = namespace_name + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/listremotesources_response.rb b/lib/open_api_sdk/models/operations/listremotesources_response.rb new file mode 100644 index 0000000..8e737c2 --- /dev/null +++ b/lib/open_api_sdk/models/operations/listremotesources_response.rb @@ -0,0 +1,36 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class ListRemoteSourcesResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # Default error response + field :error, T.nilable(::OpenApiSDK::Shared::Error) + # OK + field :remote_source, T.nilable(::OpenApiSDK::Shared::RemoteSource) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, error: T.nilable(::OpenApiSDK::Shared::Error), remote_source: T.nilable(::OpenApiSDK::Shared::RemoteSource)).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, error: nil, remote_source: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @error = error + @remote_source = remote_source + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/postworkspaceevents_request.rb b/lib/open_api_sdk/models/operations/postworkspaceevents_request.rb index 42f71ff..c971f64 100644 --- a/lib/open_api_sdk/models/operations/postworkspaceevents_request.rb +++ b/lib/open_api_sdk/models/operations/postworkspaceevents_request.rb @@ -14,10 +14,10 @@ class PostWorkspaceEventsRequest < ::OpenApiSDK::Utils::FieldAugmented field :request_body, T::Array[::OpenApiSDK::Shared::CliEvent], { 'request': { 'media_type': 'application/json' } } # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(request_body: T::Array[::OpenApiSDK::Shared::CliEvent], workspace_id: ::String).void } + sig { params(request_body: T::Array[::OpenApiSDK::Shared::CliEvent], workspace_id: T.nilable(::String)).void } def initialize(request_body: nil, workspace_id: nil) @request_body = request_body @workspace_id = workspace_id diff --git a/lib/open_api_sdk/models/operations/revokeuseraccesstoworkspace_request.rb b/lib/open_api_sdk/models/operations/revokeuseraccesstoworkspace_request.rb index 86fa098..653cfc5 100644 --- a/lib/open_api_sdk/models/operations/revokeuseraccesstoworkspace_request.rb +++ b/lib/open_api_sdk/models/operations/revokeuseraccesstoworkspace_request.rb @@ -14,10 +14,10 @@ class RevokeUserAccessToWorkspaceRequest < ::OpenApiSDK::Utils::FieldAugmented # Unique identifier of the user. field :user_id, ::String, { 'path_param': { 'field_name': 'userId', 'style': 'simple', 'explode': false } } # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(user_id: ::String, workspace_id: ::String).void } + sig { params(user_id: ::String, workspace_id: T.nilable(::String)).void } def initialize(user_id: nil, workspace_id: nil) @user_id = user_id @workspace_id = workspace_id diff --git a/lib/open_api_sdk/models/operations/searchworkspaceevents_request.rb b/lib/open_api_sdk/models/operations/searchworkspaceevents_request.rb index d0327f5..42d7c0a 100644 --- a/lib/open_api_sdk/models/operations/searchworkspaceevents_request.rb +++ b/lib/open_api_sdk/models/operations/searchworkspaceevents_request.rb @@ -11,8 +11,8 @@ module Operations class SearchWorkspaceEventsRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig - # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + # Shared execution ID for cli events across a single action. + field :execution_id, T.nilable(::String), { 'query_param': { 'field_name': 'execution_id', 'style': 'form', 'explode': true } } # A specific gen lock ID for the events. field :generate_gen_lock_id, T.nilable(::String), { 'query_param': { 'field_name': 'generate_gen_lock_id', 'style': 'form', 'explode': true } } # Specified interaction type for events. @@ -23,16 +23,19 @@ class SearchWorkspaceEventsRequest < ::OpenApiSDK::Utils::FieldAugmented field :openapi_diff_report_digest, T.nilable(::String), { 'query_param': { 'field_name': 'openapi_diff_report_digest', 'style': 'form', 'explode': true } } # Unique identifier of the source revision digest. field :source_revision_digest, T.nilable(::String), { 'query_param': { 'field_name': 'source_revision_digest', 'style': 'form', 'explode': true } } + # Unique identifier of the workspace. + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String, generate_gen_lock_id: T.nilable(::String), interaction_type: T.nilable(::OpenApiSDK::Shared::InteractionType), lint_report_digest: T.nilable(::String), openapi_diff_report_digest: T.nilable(::String), source_revision_digest: T.nilable(::String)).void } - def initialize(workspace_id: nil, generate_gen_lock_id: nil, interaction_type: nil, lint_report_digest: nil, openapi_diff_report_digest: nil, source_revision_digest: nil) - @workspace_id = workspace_id + sig { params(execution_id: T.nilable(::String), generate_gen_lock_id: T.nilable(::String), interaction_type: T.nilable(::OpenApiSDK::Shared::InteractionType), lint_report_digest: T.nilable(::String), openapi_diff_report_digest: T.nilable(::String), source_revision_digest: T.nilable(::String), workspace_id: T.nilable(::String)).void } + def initialize(execution_id: nil, generate_gen_lock_id: nil, interaction_type: nil, lint_report_digest: nil, openapi_diff_report_digest: nil, source_revision_digest: nil, workspace_id: nil) + @execution_id = execution_id @generate_gen_lock_id = generate_gen_lock_id @interaction_type = interaction_type @lint_report_digest = lint_report_digest @openapi_diff_report_digest = openapi_diff_report_digest @source_revision_digest = source_revision_digest + @workspace_id = workspace_id end end end diff --git a/lib/open_api_sdk/models/operations/suggestitems_response.rb b/lib/open_api_sdk/models/operations/suggestitems_response.rb new file mode 100644 index 0000000..03260e2 --- /dev/null +++ b/lib/open_api_sdk/models/operations/suggestitems_response.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class SuggestItemsResponse < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # HTTP response content type for this operation + field :content_type, ::String + # Raw HTTP response; suitable for custom response parsing + field :raw_response, ::Faraday::Response + # HTTP response status code for this operation + field :status_code, ::Integer + # One suggestion per item. Guaranteed to be the same length as the input items. + field :strings, T.nilable(T::Array[::String]) + + + sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, strings: T.nilable(T::Array[::String])).void } + def initialize(content_type: nil, raw_response: nil, status_code: nil, strings: nil) + @content_type = content_type + @raw_response = raw_response + @status_code = status_code + @strings = strings + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/updateworkspacedetails_request.rb b/lib/open_api_sdk/models/operations/updateworkspacedetails_request.rb index f9b3fd1..51c0a28 100644 --- a/lib/open_api_sdk/models/operations/updateworkspacedetails_request.rb +++ b/lib/open_api_sdk/models/operations/updateworkspacedetails_request.rb @@ -14,10 +14,10 @@ class UpdateWorkspaceDetailsRequest < ::OpenApiSDK::Utils::FieldAugmented # The workspace details to update. field :workspace, ::OpenApiSDK::Shared::Workspace, { 'request': { 'media_type': 'application/json' } } # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace: ::OpenApiSDK::Shared::Workspace, workspace_id: ::String).void } + sig { params(workspace: ::OpenApiSDK::Shared::Workspace, workspace_id: T.nilable(::String)).void } def initialize(workspace: nil, workspace_id: nil) @workspace = workspace @workspace_id = workspace_id diff --git a/lib/open_api_sdk/models/operations/updateworkspacesettings_request.rb b/lib/open_api_sdk/models/operations/updateworkspacesettings_request.rb index 6b1129c..49d66db 100644 --- a/lib/open_api_sdk/models/operations/updateworkspacesettings_request.rb +++ b/lib/open_api_sdk/models/operations/updateworkspacesettings_request.rb @@ -11,16 +11,16 @@ module Operations class UpdateWorkspaceSettingsRequest < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig - # Unique identifier of the workspace. - field :workspace_id, ::String, { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } # The workspace settings to update. field :workspace_settings, ::OpenApiSDK::Shared::WorkspaceSettings, { 'request': { 'media_type': 'application/json' } } + # Unique identifier of the workspace. + field :workspace_id, T.nilable(::String), { 'path_param': { 'field_name': 'workspace_id', 'style': 'simple', 'explode': false } } - sig { params(workspace_id: ::String, workspace_settings: ::OpenApiSDK::Shared::WorkspaceSettings).void } - def initialize(workspace_id: nil, workspace_settings: nil) - @workspace_id = workspace_id + sig { params(workspace_settings: ::OpenApiSDK::Shared::WorkspaceSettings, workspace_id: T.nilable(::String)).void } + def initialize(workspace_settings: nil, workspace_id: nil) @workspace_settings = workspace_settings + @workspace_id = workspace_id end end end diff --git a/lib/open_api_sdk/models/shared.rb b/lib/open_api_sdk/models/shared.rb index c4e8c88..2f6d63e 100644 --- a/lib/open_api_sdk/models/shared.rb +++ b/lib/open_api_sdk/models/shared.rb @@ -6,6 +6,9 @@ module OpenApiSDK module Shared autoload :Error, 'open_api_sdk/models/shared/error.rb' + autoload :SchemaFile, 'open_api_sdk/models/shared/schema_file.rb' + autoload :CodeSampleSchemaInput, 'open_api_sdk/models/shared/codesampleschemainput.rb' + autoload :CodeSamplesJobStatus, 'open_api_sdk/models/shared/codesamplesjobstatus.rb' autoload :Api, 'open_api_sdk/models/shared/api.rb' autoload :ApiInput, 'open_api_sdk/models/shared/api_input.rb' autoload :GenerateOpenApiSpecDiff, 'open_api_sdk/models/shared/generateopenapispecdiff.rb' @@ -61,18 +64,6 @@ module Shared autoload :CliEvent, 'open_api_sdk/models/shared/clievent.rb' autoload :InteractionType, 'open_api_sdk/models/shared/interactiontype.rb' autoload :TargetSDK, 'open_api_sdk/models/shared/targetsdk.rb' - autoload :PreflightToken, 'open_api_sdk/models/shared/preflighttoken.rb' - autoload :PreflightRequest, 'open_api_sdk/models/shared/preflightrequest.rb' - autoload :GetNamespacesResponse, 'open_api_sdk/models/shared/getnamespacesresponse.rb' - autoload :Namespace, 'open_api_sdk/models/shared/namespace.rb' - autoload :GetRevisionsResponse, 'open_api_sdk/models/shared/getrevisionsresponse.rb' - autoload :Revision, 'open_api_sdk/models/shared/revision.rb' - autoload :GetTagsResponse, 'open_api_sdk/models/shared/gettagsresponse.rb' - autoload :Tag, 'open_api_sdk/models/shared/tag.rb' - autoload :AddTags, 'open_api_sdk/models/shared/addtags.rb' - autoload :Manifest, 'open_api_sdk/models/shared/manifest.rb' - autoload :V2Descriptor, 'open_api_sdk/models/shared/v2descriptor.rb' - autoload :Annotations, 'open_api_sdk/models/shared/annotations.rb' autoload :Type, 'open_api_sdk/models/shared/type.rb' autoload :Report, 'open_api_sdk/models/shared/report.rb' autoload :SuggestionType, 'open_api_sdk/models/shared/suggestion_type.rb' @@ -84,7 +75,25 @@ module Shared autoload :OASOperation, 'open_api_sdk/models/shared/oasoperation.rb' autoload :License, 'open_api_sdk/models/shared/license.rb' autoload :OASInfo, 'open_api_sdk/models/shared/oasinfo.rb' + autoload :SuggestItemsRequestBody, 'open_api_sdk/models/shared/suggestitemsrequestbody.rb' autoload :ShortURL, 'open_api_sdk/models/shared/shorturl.rb' + autoload :PreflightToken, 'open_api_sdk/models/shared/preflighttoken.rb' + autoload :PreflightRequest, 'open_api_sdk/models/shared/preflightrequest.rb' + autoload :GetNamespacesResponse, 'open_api_sdk/models/shared/getnamespacesresponse.rb' + autoload :Namespace, 'open_api_sdk/models/shared/namespace.rb' + autoload :GetRevisionsResponse, 'open_api_sdk/models/shared/getrevisionsresponse.rb' + autoload :Revision, 'open_api_sdk/models/shared/revision.rb' + autoload :GetTagsResponse, 'open_api_sdk/models/shared/gettagsresponse.rb' + autoload :Tag, 'open_api_sdk/models/shared/tag.rb' + autoload :AddTags, 'open_api_sdk/models/shared/addtags.rb' + autoload :RemoteSource, 'open_api_sdk/models/shared/remotesource.rb' + autoload :RemoteDocument, 'open_api_sdk/models/shared/remotedocument.rb' + autoload :Manifest, 'open_api_sdk/models/shared/manifest.rb' + autoload :V2Descriptor, 'open_api_sdk/models/shared/v2descriptor.rb' + autoload :Annotations, 'open_api_sdk/models/shared/annotations.rb' + autoload :RegistrySubscription, 'open_api_sdk/models/shared/registrysubscription.rb' + autoload :SubscriptionType, 'open_api_sdk/models/shared/subscriptiontype.rb' + autoload :EventType, 'open_api_sdk/models/shared/eventtype.rb' autoload :Security, 'open_api_sdk/models/shared/security.rb' end end diff --git a/lib/open_api_sdk/models/shared/apikeydetails.rb b/lib/open_api_sdk/models/shared/apikeydetails.rb index f7d0df0..64d35b3 100644 --- a/lib/open_api_sdk/models/shared/apikeydetails.rb +++ b/lib/open_api_sdk/models/shared/apikeydetails.rb @@ -19,6 +19,8 @@ class ApiKeyDetails < ::OpenApiSDK::Utils::FieldAugmented field :org_slug, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('org_slug') } } field :telemetry_disabled, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('telemetry_disabled') } } + # Workspace creation timestamp. + field :workspace_created_at, ::DateTime, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspace_created_at'), 'decoder': Utils.datetime_from_iso_format(false) } } field :workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspace_id') } } @@ -29,12 +31,13 @@ class ApiKeyDetails < ::OpenApiSDK::Utils::FieldAugmented field :generation_access_unlimited, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generation_access_unlimited') } } - sig { params(account_type_v2: ::OpenApiSDK::Shared::AccountType, enabled_features: T::Array[::String], org_slug: ::String, telemetry_disabled: T::Boolean, workspace_id: ::String, workspace_slug: ::String, feature_flags: T.nilable(T::Array[::String]), generation_access_unlimited: T.nilable(T::Boolean)).void } - def initialize(account_type_v2: nil, enabled_features: nil, org_slug: nil, telemetry_disabled: nil, workspace_id: nil, workspace_slug: nil, feature_flags: nil, generation_access_unlimited: nil) + sig { params(account_type_v2: ::OpenApiSDK::Shared::AccountType, enabled_features: T::Array[::String], org_slug: ::String, telemetry_disabled: T::Boolean, workspace_created_at: ::DateTime, workspace_id: ::String, workspace_slug: ::String, feature_flags: T.nilable(T::Array[::String]), generation_access_unlimited: T.nilable(T::Boolean)).void } + def initialize(account_type_v2: nil, enabled_features: nil, org_slug: nil, telemetry_disabled: nil, workspace_created_at: nil, workspace_id: nil, workspace_slug: nil, feature_flags: nil, generation_access_unlimited: nil) @account_type_v2 = account_type_v2 @enabled_features = enabled_features @org_slug = org_slug @telemetry_disabled = telemetry_disabled + @workspace_created_at = workspace_created_at @workspace_id = workspace_id @workspace_slug = workspace_slug @feature_flags = feature_flags diff --git a/lib/open_api_sdk/models/shared/clievent.rb b/lib/open_api_sdk/models/shared/clievent.rb index e811741..81e2c65 100644 --- a/lib/open_api_sdk/models/shared/clievent.rb +++ b/lib/open_api_sdk/models/shared/clievent.rb @@ -75,6 +75,8 @@ class CliEvent < ::OpenApiSDK::Utils::FieldAugmented field :generate_number_of_operations_ignored, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generate_number_of_operations_ignored') } } # The number of operations used in generation. field :generate_number_of_operations_used, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generate_number_of_operations_used') } } + # The number of terraform resources used in generation. + field :generate_number_of_terraform_resources, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generate_number_of_terraform_resources') } } # Indicates whether tests were output. field :generate_output_tests, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generate_output_tests') } } # Indicates whether the target was considered published. @@ -99,6 +101,10 @@ class CliEvent < ::OpenApiSDK::Utils::FieldAugmented field :gh_action_run_link, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('gh_action_run_link') } } # Version of the GitHub action. field :gh_action_version, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('gh_action_version') } } + # Whether or not changes were committed from generation in the Github Action. + field :gh_changes_committed, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('gh_changes_committed') } } + # The reference to a created pull request URL. + field :gh_pull_request, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('gh_pull_request') } } # Current working directory relative to the git root. field :git_relative_cwd, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('git_relative_cwd') } } # Default owner for git remote. @@ -169,8 +175,8 @@ class CliEvent < ::OpenApiSDK::Utils::FieldAugmented field :workflow_pre_raw, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workflow_pre_raw') } } - sig { params(created_at: ::DateTime, execution_id: ::String, id: ::String, interaction_type: ::OpenApiSDK::Shared::InteractionType, local_started_at: ::DateTime, speakeasy_api_key_name: ::String, speakeasy_version: ::String, success: T::Boolean, workspace_id: ::String, commit_head: T.nilable(::String), continuous_integration_environment: T.nilable(::String), duration_ms: T.nilable(::Integer), error: T.nilable(::String), generate_bump_type: T.nilable(::OpenApiSDK::Shared::GenerateBumpType), generate_config_post_checksum: T.nilable(::String), generate_config_post_raw: T.nilable(::String), generate_config_post_version: T.nilable(::String), generate_config_pre_checksum: T.nilable(::String), generate_config_pre_raw: T.nilable(::String), generate_config_pre_version: T.nilable(::String), generate_eligible_features: T.nilable(::String), generate_gen_lock_id: T.nilable(::String), generate_gen_lock_post_features: T.nilable(::String), generate_gen_lock_pre_blob_digest: T.nilable(::String), generate_gen_lock_pre_doc_checksum: T.nilable(::String), generate_gen_lock_pre_doc_version: T.nilable(::String), generate_gen_lock_pre_features: T.nilable(::String), generate_gen_lock_pre_namespace_name: T.nilable(::String), generate_gen_lock_pre_revision_digest: T.nilable(::String), generate_gen_lock_pre_version: T.nilable(::String), generate_number_of_operations_ignored: T.nilable(::Integer), generate_number_of_operations_used: T.nilable(::Integer), generate_output_tests: T.nilable(T::Boolean), generate_published: T.nilable(T::Boolean), generate_repo_url: T.nilable(::String), generate_target: T.nilable(::String), generate_target_name: T.nilable(::String), generate_target_version: T.nilable(::String), generate_version: T.nilable(::String), gh_action_organization: T.nilable(::String), gh_action_ref: T.nilable(::String), gh_action_repository: T.nilable(::String), gh_action_run_link: T.nilable(::String), gh_action_version: T.nilable(::String), git_relative_cwd: T.nilable(::String), git_remote_default_owner: T.nilable(::String), git_remote_default_repo: T.nilable(::String), git_user_email: T.nilable(::String), git_user_name: T.nilable(::String), hostname: T.nilable(::String), last_step: T.nilable(::String), lint_report_digest: T.nilable(::String), lint_report_error_count: T.nilable(::Integer), lint_report_info_count: T.nilable(::Integer), lint_report_warning_count: T.nilable(::Integer), local_completed_at: T.nilable(::DateTime), management_doc_checksum: T.nilable(::String), management_doc_version: T.nilable(::String), mermaid_diagram: T.nilable(::String), openapi_diff_base_source_blob_digest: T.nilable(::String), openapi_diff_base_source_namespace_name: T.nilable(::String), openapi_diff_base_source_revision_digest: T.nilable(::String), openapi_diff_breaking_changes_count: T.nilable(::Integer), openapi_diff_bump_type: T.nilable(::OpenApiSDK::Shared::OpenapiDiffBumpType), openapi_diff_report_digest: T.nilable(::String), publish_package_name: T.nilable(::String), publish_package_registry_name: T.nilable(::String), publish_package_url: T.nilable(::String), publish_package_version: T.nilable(::String), raw_command: T.nilable(::String), repo_label: T.nilable(::String), source_blob_digest: T.nilable(::String), source_namespace_name: T.nilable(::String), source_revision_digest: T.nilable(::String), workflow_lock_post_raw: T.nilable(::String), workflow_lock_pre_raw: T.nilable(::String), workflow_post_raw: T.nilable(::String), workflow_pre_raw: T.nilable(::String)).void } - def initialize(created_at: nil, execution_id: nil, id: nil, interaction_type: nil, local_started_at: nil, speakeasy_api_key_name: nil, speakeasy_version: nil, success: nil, workspace_id: nil, commit_head: nil, continuous_integration_environment: nil, duration_ms: nil, error: nil, generate_bump_type: nil, generate_config_post_checksum: nil, generate_config_post_raw: nil, generate_config_post_version: nil, generate_config_pre_checksum: nil, generate_config_pre_raw: nil, generate_config_pre_version: nil, generate_eligible_features: nil, generate_gen_lock_id: nil, generate_gen_lock_post_features: nil, generate_gen_lock_pre_blob_digest: nil, generate_gen_lock_pre_doc_checksum: nil, generate_gen_lock_pre_doc_version: nil, generate_gen_lock_pre_features: nil, generate_gen_lock_pre_namespace_name: nil, generate_gen_lock_pre_revision_digest: nil, generate_gen_lock_pre_version: nil, generate_number_of_operations_ignored: nil, generate_number_of_operations_used: nil, generate_output_tests: nil, generate_published: nil, generate_repo_url: nil, generate_target: nil, generate_target_name: nil, generate_target_version: nil, generate_version: nil, gh_action_organization: nil, gh_action_ref: nil, gh_action_repository: nil, gh_action_run_link: nil, gh_action_version: nil, git_relative_cwd: nil, git_remote_default_owner: nil, git_remote_default_repo: nil, git_user_email: nil, git_user_name: nil, hostname: nil, last_step: nil, lint_report_digest: nil, lint_report_error_count: nil, lint_report_info_count: nil, lint_report_warning_count: nil, local_completed_at: nil, management_doc_checksum: nil, management_doc_version: nil, mermaid_diagram: nil, openapi_diff_base_source_blob_digest: nil, openapi_diff_base_source_namespace_name: nil, openapi_diff_base_source_revision_digest: nil, openapi_diff_breaking_changes_count: nil, openapi_diff_bump_type: nil, openapi_diff_report_digest: nil, publish_package_name: nil, publish_package_registry_name: nil, publish_package_url: nil, publish_package_version: nil, raw_command: nil, repo_label: nil, source_blob_digest: nil, source_namespace_name: nil, source_revision_digest: nil, workflow_lock_post_raw: nil, workflow_lock_pre_raw: nil, workflow_post_raw: nil, workflow_pre_raw: nil) + sig { params(created_at: ::DateTime, execution_id: ::String, id: ::String, interaction_type: ::OpenApiSDK::Shared::InteractionType, local_started_at: ::DateTime, speakeasy_api_key_name: ::String, speakeasy_version: ::String, success: T::Boolean, workspace_id: ::String, commit_head: T.nilable(::String), continuous_integration_environment: T.nilable(::String), duration_ms: T.nilable(::Integer), error: T.nilable(::String), generate_bump_type: T.nilable(::OpenApiSDK::Shared::GenerateBumpType), generate_config_post_checksum: T.nilable(::String), generate_config_post_raw: T.nilable(::String), generate_config_post_version: T.nilable(::String), generate_config_pre_checksum: T.nilable(::String), generate_config_pre_raw: T.nilable(::String), generate_config_pre_version: T.nilable(::String), generate_eligible_features: T.nilable(::String), generate_gen_lock_id: T.nilable(::String), generate_gen_lock_post_features: T.nilable(::String), generate_gen_lock_pre_blob_digest: T.nilable(::String), generate_gen_lock_pre_doc_checksum: T.nilable(::String), generate_gen_lock_pre_doc_version: T.nilable(::String), generate_gen_lock_pre_features: T.nilable(::String), generate_gen_lock_pre_namespace_name: T.nilable(::String), generate_gen_lock_pre_revision_digest: T.nilable(::String), generate_gen_lock_pre_version: T.nilable(::String), generate_number_of_operations_ignored: T.nilable(::Integer), generate_number_of_operations_used: T.nilable(::Integer), generate_number_of_terraform_resources: T.nilable(::Integer), generate_output_tests: T.nilable(T::Boolean), generate_published: T.nilable(T::Boolean), generate_repo_url: T.nilable(::String), generate_target: T.nilable(::String), generate_target_name: T.nilable(::String), generate_target_version: T.nilable(::String), generate_version: T.nilable(::String), gh_action_organization: T.nilable(::String), gh_action_ref: T.nilable(::String), gh_action_repository: T.nilable(::String), gh_action_run_link: T.nilable(::String), gh_action_version: T.nilable(::String), gh_changes_committed: T.nilable(T::Boolean), gh_pull_request: T.nilable(::String), git_relative_cwd: T.nilable(::String), git_remote_default_owner: T.nilable(::String), git_remote_default_repo: T.nilable(::String), git_user_email: T.nilable(::String), git_user_name: T.nilable(::String), hostname: T.nilable(::String), last_step: T.nilable(::String), lint_report_digest: T.nilable(::String), lint_report_error_count: T.nilable(::Integer), lint_report_info_count: T.nilable(::Integer), lint_report_warning_count: T.nilable(::Integer), local_completed_at: T.nilable(::DateTime), management_doc_checksum: T.nilable(::String), management_doc_version: T.nilable(::String), mermaid_diagram: T.nilable(::String), openapi_diff_base_source_blob_digest: T.nilable(::String), openapi_diff_base_source_namespace_name: T.nilable(::String), openapi_diff_base_source_revision_digest: T.nilable(::String), openapi_diff_breaking_changes_count: T.nilable(::Integer), openapi_diff_bump_type: T.nilable(::OpenApiSDK::Shared::OpenapiDiffBumpType), openapi_diff_report_digest: T.nilable(::String), publish_package_name: T.nilable(::String), publish_package_registry_name: T.nilable(::String), publish_package_url: T.nilable(::String), publish_package_version: T.nilable(::String), raw_command: T.nilable(::String), repo_label: T.nilable(::String), source_blob_digest: T.nilable(::String), source_namespace_name: T.nilable(::String), source_revision_digest: T.nilable(::String), workflow_lock_post_raw: T.nilable(::String), workflow_lock_pre_raw: T.nilable(::String), workflow_post_raw: T.nilable(::String), workflow_pre_raw: T.nilable(::String)).void } + def initialize(created_at: nil, execution_id: nil, id: nil, interaction_type: nil, local_started_at: nil, speakeasy_api_key_name: nil, speakeasy_version: nil, success: nil, workspace_id: nil, commit_head: nil, continuous_integration_environment: nil, duration_ms: nil, error: nil, generate_bump_type: nil, generate_config_post_checksum: nil, generate_config_post_raw: nil, generate_config_post_version: nil, generate_config_pre_checksum: nil, generate_config_pre_raw: nil, generate_config_pre_version: nil, generate_eligible_features: nil, generate_gen_lock_id: nil, generate_gen_lock_post_features: nil, generate_gen_lock_pre_blob_digest: nil, generate_gen_lock_pre_doc_checksum: nil, generate_gen_lock_pre_doc_version: nil, generate_gen_lock_pre_features: nil, generate_gen_lock_pre_namespace_name: nil, generate_gen_lock_pre_revision_digest: nil, generate_gen_lock_pre_version: nil, generate_number_of_operations_ignored: nil, generate_number_of_operations_used: nil, generate_number_of_terraform_resources: nil, generate_output_tests: nil, generate_published: nil, generate_repo_url: nil, generate_target: nil, generate_target_name: nil, generate_target_version: nil, generate_version: nil, gh_action_organization: nil, gh_action_ref: nil, gh_action_repository: nil, gh_action_run_link: nil, gh_action_version: nil, gh_changes_committed: nil, gh_pull_request: nil, git_relative_cwd: nil, git_remote_default_owner: nil, git_remote_default_repo: nil, git_user_email: nil, git_user_name: nil, hostname: nil, last_step: nil, lint_report_digest: nil, lint_report_error_count: nil, lint_report_info_count: nil, lint_report_warning_count: nil, local_completed_at: nil, management_doc_checksum: nil, management_doc_version: nil, mermaid_diagram: nil, openapi_diff_base_source_blob_digest: nil, openapi_diff_base_source_namespace_name: nil, openapi_diff_base_source_revision_digest: nil, openapi_diff_breaking_changes_count: nil, openapi_diff_bump_type: nil, openapi_diff_report_digest: nil, publish_package_name: nil, publish_package_registry_name: nil, publish_package_url: nil, publish_package_version: nil, raw_command: nil, repo_label: nil, source_blob_digest: nil, source_namespace_name: nil, source_revision_digest: nil, workflow_lock_post_raw: nil, workflow_lock_pre_raw: nil, workflow_post_raw: nil, workflow_pre_raw: nil) @created_at = created_at @execution_id = execution_id @id = id @@ -203,6 +209,7 @@ def initialize(created_at: nil, execution_id: nil, id: nil, interaction_type: ni @generate_gen_lock_pre_version = generate_gen_lock_pre_version @generate_number_of_operations_ignored = generate_number_of_operations_ignored @generate_number_of_operations_used = generate_number_of_operations_used + @generate_number_of_terraform_resources = generate_number_of_terraform_resources @generate_output_tests = generate_output_tests @generate_published = generate_published @generate_repo_url = generate_repo_url @@ -215,6 +222,8 @@ def initialize(created_at: nil, execution_id: nil, id: nil, interaction_type: ni @gh_action_repository = gh_action_repository @gh_action_run_link = gh_action_run_link @gh_action_version = gh_action_version + @gh_changes_committed = gh_changes_committed + @gh_pull_request = gh_pull_request @git_relative_cwd = git_relative_cwd @git_remote_default_owner = git_remote_default_owner @git_remote_default_repo = git_remote_default_repo diff --git a/lib/open_api_sdk/models/shared/codesampleschemainput.rb b/lib/open_api_sdk/models/shared/codesampleschemainput.rb new file mode 100644 index 0000000..209fc9f --- /dev/null +++ b/lib/open_api_sdk/models/shared/codesampleschemainput.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + + class CodeSampleSchemaInput < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # A list of languages to generate code samples for + field :languages, T::Array[::String], { 'multipart_form': { 'field_name': 'languages' } } + # The OpenAPI file to be uploaded + field :schema_file, ::OpenApiSDK::Shared::SchemaFile, { 'multipart_form': { 'file': true } } + # The name of the package + field :package_name, T.nilable(::String), { 'multipart_form': { 'field_name': 'package_name' } } + # The SDK class name + field :sdk_class_name, T.nilable(::String), { 'multipart_form': { 'field_name': 'sdk_class_name' } } + + + sig { params(languages: T::Array[::String], schema_file: ::OpenApiSDK::Shared::SchemaFile, package_name: T.nilable(::String), sdk_class_name: T.nilable(::String)).void } + def initialize(languages: nil, schema_file: nil, package_name: nil, sdk_class_name: nil) + @languages = languages + @schema_file = schema_file + @package_name = package_name + @sdk_class_name = sdk_class_name + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/codesamplesjobstatus.rb b/lib/open_api_sdk/models/shared/codesamplesjobstatus.rb new file mode 100644 index 0000000..01e6de9 --- /dev/null +++ b/lib/open_api_sdk/models/shared/codesamplesjobstatus.rb @@ -0,0 +1,18 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + # CodeSamplesJobStatus - The current status of the job. Possible values are `pending` or `running`. + class CodeSamplesJobStatus < T::Enum + enums do + PENDING = new('pending') + RUNNING = new('running') + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/eventtype.rb b/lib/open_api_sdk/models/shared/eventtype.rb new file mode 100644 index 0000000..7248cc4 --- /dev/null +++ b/lib/open_api_sdk/models/shared/eventtype.rb @@ -0,0 +1,17 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + + class EventType < T::Enum + enums do + UPDATE = new('update') + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/organization.rb b/lib/open_api_sdk/models/shared/organization.rb index 0f6b2e3..d8902fa 100644 --- a/lib/open_api_sdk/models/shared/organization.rb +++ b/lib/open_api_sdk/models/shared/organization.rb @@ -28,9 +28,11 @@ class Organization < ::OpenApiSDK::Utils::FieldAugmented field :free_trial_expiry, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('free_trial_expiry'), 'decoder': Utils.datetime_from_iso_format(true) } } + field :internal, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('internal') } } - sig { params(account_type: ::OpenApiSDK::Shared::AccountType, created_at: ::DateTime, id: ::String, name: ::String, slug: ::String, telemetry_disabled: T::Boolean, updated_at: ::DateTime, free_trial_expiry: T.nilable(::DateTime)).void } - def initialize(account_type: nil, created_at: nil, id: nil, name: nil, slug: nil, telemetry_disabled: nil, updated_at: nil, free_trial_expiry: nil) + + sig { params(account_type: ::OpenApiSDK::Shared::AccountType, created_at: ::DateTime, id: ::String, name: ::String, slug: ::String, telemetry_disabled: T::Boolean, updated_at: ::DateTime, free_trial_expiry: T.nilable(::DateTime), internal: T.nilable(T::Boolean)).void } + def initialize(account_type: nil, created_at: nil, id: nil, name: nil, slug: nil, telemetry_disabled: nil, updated_at: nil, free_trial_expiry: nil, internal: nil) @account_type = account_type @created_at = created_at @id = id @@ -39,6 +41,7 @@ def initialize(account_type: nil, created_at: nil, id: nil, name: nil, slug: nil @telemetry_disabled = telemetry_disabled @updated_at = updated_at @free_trial_expiry = free_trial_expiry + @internal = internal end end end diff --git a/lib/open_api_sdk/models/shared/organizationusage.rb b/lib/open_api_sdk/models/shared/organizationusage.rb index 5210a46..b19d5c0 100644 --- a/lib/open_api_sdk/models/shared/organizationusage.rb +++ b/lib/open_api_sdk/models/shared/organizationusage.rb @@ -19,6 +19,8 @@ class OrganizationUsage < ::OpenApiSDK::Utils::FieldAugmented field :gen_lock_ids, T::Array[::String], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('gen_lock_ids') } } # The programming language used field :language, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('language') } } + # Maximum Number of operations per SDK specific in contract + field :max_operations, ::Integer, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('max_operations') } } # Number of operations performed field :number_of_operations, ::Integer, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('number_of_operations') } } # Features that have been used @@ -27,12 +29,13 @@ class OrganizationUsage < ::OpenApiSDK::Utils::FieldAugmented field :workspaces, T::Array[::String], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspaces') } } - sig { params(accessible: T::Boolean, accessible_features: T::Array[::String], gen_lock_ids: T::Array[::String], language: ::String, number_of_operations: ::Integer, used_features: T::Array[::String], workspaces: T::Array[::String]).void } - def initialize(accessible: nil, accessible_features: nil, gen_lock_ids: nil, language: nil, number_of_operations: nil, used_features: nil, workspaces: nil) + sig { params(accessible: T::Boolean, accessible_features: T::Array[::String], gen_lock_ids: T::Array[::String], language: ::String, max_operations: ::Integer, number_of_operations: ::Integer, used_features: T::Array[::String], workspaces: T::Array[::String]).void } + def initialize(accessible: nil, accessible_features: nil, gen_lock_ids: nil, language: nil, max_operations: nil, number_of_operations: nil, used_features: nil, workspaces: nil) @accessible = accessible @accessible_features = accessible_features @gen_lock_ids = gen_lock_ids @language = language + @max_operations = max_operations @number_of_operations = number_of_operations @used_features = used_features @workspaces = workspaces diff --git a/lib/open_api_sdk/models/shared/registrysubscription.rb b/lib/open_api_sdk/models/shared/registrysubscription.rb new file mode 100644 index 0000000..64776ce --- /dev/null +++ b/lib/open_api_sdk/models/shared/registrysubscription.rb @@ -0,0 +1,51 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + # A subscription to a registry event + class RegistrySubscription < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + + field :created_at, ::DateTime, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(false) } } + + field :event_type, ::OpenApiSDK::Shared::EventType, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('event_type'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Shared::EventType, false) } } + + field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } } + + field :namespace_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('namespace_name') } } + + field :subscription_settings, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('subscription_settings') } } + + field :subscription_type, ::OpenApiSDK::Shared::SubscriptionType, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('subscription_type'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Shared::SubscriptionType, false) } } + + field :updated_at, ::DateTime, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('updated_at'), 'decoder': Utils.datetime_from_iso_format(false) } } + + field :workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspace_id') } } + + field :deleted_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('deleted_at'), 'decoder': Utils.datetime_from_iso_format(true) } } + + field :tags, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tags') } } + + + sig { params(created_at: ::DateTime, event_type: ::OpenApiSDK::Shared::EventType, id: ::String, namespace_name: ::String, subscription_settings: ::String, subscription_type: ::OpenApiSDK::Shared::SubscriptionType, updated_at: ::DateTime, workspace_id: ::String, deleted_at: T.nilable(::DateTime), tags: T.nilable(T::Array[::String])).void } + def initialize(created_at: nil, event_type: nil, id: nil, namespace_name: nil, subscription_settings: nil, subscription_type: nil, updated_at: nil, workspace_id: nil, deleted_at: nil, tags: nil) + @created_at = created_at + @event_type = event_type + @id = id + @namespace_name = namespace_name + @subscription_settings = subscription_settings + @subscription_type = subscription_type + @updated_at = updated_at + @workspace_id = workspace_id + @deleted_at = deleted_at + @tags = tags + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/remotedocument.rb b/lib/open_api_sdk/models/shared/remotedocument.rb new file mode 100644 index 0000000..efd791f --- /dev/null +++ b/lib/open_api_sdk/models/shared/remotedocument.rb @@ -0,0 +1,24 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + # A document hosted in the registry + class RemoteDocument < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + + field :registry_url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('registry_url') } } + + + sig { params(registry_url: ::String).void } + def initialize(registry_url: nil) + @registry_url = registry_url + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/remotesource.rb b/lib/open_api_sdk/models/shared/remotesource.rb new file mode 100644 index 0000000..345f95b --- /dev/null +++ b/lib/open_api_sdk/models/shared/remotesource.rb @@ -0,0 +1,30 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + # Remote source configuration + class RemoteSource < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + + field :inputs, T::Array[::OpenApiSDK::Shared::RemoteDocument], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('inputs') } } + # A document hosted in the registry + field :output, ::OpenApiSDK::Shared::RemoteDocument, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('output') } } + + field :overlays, T.nilable(T::Array[::OpenApiSDK::Shared::RemoteDocument]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('overlays') } } + + + sig { params(inputs: T::Array[::OpenApiSDK::Shared::RemoteDocument], output: ::OpenApiSDK::Shared::RemoteDocument, overlays: T.nilable(T::Array[::OpenApiSDK::Shared::RemoteDocument])).void } + def initialize(inputs: nil, output: nil, overlays: nil) + @inputs = inputs + @output = output + @overlays = overlays + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/schema_file.rb b/lib/open_api_sdk/models/shared/schema_file.rb new file mode 100644 index 0000000..5eec3b0 --- /dev/null +++ b/lib/open_api_sdk/models/shared/schema_file.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + + class SchemaFile < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + + field :content, ::String, { 'multipart_form': { 'content': true } } + + field :file_name, ::String, { 'multipart_form': { 'field_name': 'schema_file' } } + + + sig { params(content: ::String, file_name: ::String).void } + def initialize(content: nil, file_name: nil) + @content = content + @file_name = file_name + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/subscriptiontype.rb b/lib/open_api_sdk/models/shared/subscriptiontype.rb new file mode 100644 index 0000000..814f9e7 --- /dev/null +++ b/lib/open_api_sdk/models/shared/subscriptiontype.rb @@ -0,0 +1,17 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + + class SubscriptionType < T::Enum + enums do + CLI = new('cli') + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/suggestitemsrequestbody.rb b/lib/open_api_sdk/models/shared/suggestitemsrequestbody.rb new file mode 100644 index 0000000..577272a --- /dev/null +++ b/lib/open_api_sdk/models/shared/suggestitemsrequestbody.rb @@ -0,0 +1,27 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Shared + + + class SuggestItemsRequestBody < ::OpenApiSDK::Utils::FieldAugmented + extend T::Sig + + # The list of "things" to get suggestions for. One suggestion will be returned for each item in the list. + field :items, T::Array[::String], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('items') } } + # The prompt to use for the suggestion. Think of this as the "preamble". + field :prompt, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prompt') } } + + + sig { params(items: T::Array[::String], prompt: ::String).void } + def initialize(items: nil, prompt: nil) + @items = items + @prompt = prompt + end + end + end +end diff --git a/lib/open_api_sdk/models/shared/targetsdk.rb b/lib/open_api_sdk/models/shared/targetsdk.rb index 37f38d8..b12f87e 100644 --- a/lib/open_api_sdk/models/shared/targetsdk.rb +++ b/lib/open_api_sdk/models/shared/targetsdk.rb @@ -41,6 +41,8 @@ class TargetSDK < ::OpenApiSDK::Utils::FieldAugmented field :generate_number_of_operations_ignored, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generate_number_of_operations_ignored') } } # The number of operations used in generation. field :generate_number_of_operations_used, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generate_number_of_operations_used') } } + # The number of terraform resources used in generation. + field :generate_number_of_terraform_resources, T.nilable(::Integer), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generate_number_of_terraform_resources') } } # Indicates whether the target was considered published. field :generate_published, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('generate_published') } } # The workflow name of the target. @@ -87,14 +89,18 @@ class TargetSDK < ::OpenApiSDK::Utils::FieldAugmented field :source_revision_digest, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('source_revision_digest') } } # Indicates whether the event was successful. field :success, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('success') } } + # Workflow lock file (post execution) + field :workflow_lock_post_raw, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workflow_lock_post_raw') } } + # Workflow lock file (prior to execution) + field :workflow_lock_pre_raw, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workflow_lock_pre_raw') } } # Workflow file (post execution) field :workflow_post_raw, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workflow_post_raw') } } # Workflow file (prior to execution) field :workflow_pre_raw, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workflow_pre_raw') } } - sig { params(generate_gen_lock_id: ::String, generate_target: ::String, id: ::String, last_event_created_at: ::DateTime, last_event_id: ::String, last_event_interaction_type: ::OpenApiSDK::Shared::InteractionType, commit_head: T.nilable(::String), continuous_integration_environment: T.nilable(::String), error: T.nilable(::String), generate_config_post_version: T.nilable(::String), generate_eligible_features: T.nilable(::String), generate_gen_lock_pre_features: T.nilable(::String), generate_gen_lock_pre_version: T.nilable(::String), generate_number_of_operations_ignored: T.nilable(::Integer), generate_number_of_operations_used: T.nilable(::Integer), generate_published: T.nilable(T::Boolean), generate_target_name: T.nilable(::String), generate_target_version: T.nilable(::String), gh_action_organization: T.nilable(::String), gh_action_ref: T.nilable(::String), gh_action_repository: T.nilable(::String), gh_action_run_link: T.nilable(::String), gh_action_version: T.nilable(::String), git_relative_cwd: T.nilable(::String), git_remote_default_owner: T.nilable(::String), git_remote_default_repo: T.nilable(::String), git_user_email: T.nilable(::String), git_user_name: T.nilable(::String), hostname: T.nilable(::String), publish_package_name: T.nilable(::String), publish_package_registry_name: T.nilable(::String), publish_package_url: T.nilable(::String), publish_package_version: T.nilable(::String), repo_label: T.nilable(::String), source_blob_digest: T.nilable(::String), source_namespace_name: T.nilable(::String), source_revision_digest: T.nilable(::String), success: T.nilable(T::Boolean), workflow_post_raw: T.nilable(::String), workflow_pre_raw: T.nilable(::String)).void } - def initialize(generate_gen_lock_id: nil, generate_target: nil, id: nil, last_event_created_at: nil, last_event_id: nil, last_event_interaction_type: nil, commit_head: nil, continuous_integration_environment: nil, error: nil, generate_config_post_version: nil, generate_eligible_features: nil, generate_gen_lock_pre_features: nil, generate_gen_lock_pre_version: nil, generate_number_of_operations_ignored: nil, generate_number_of_operations_used: nil, generate_published: nil, generate_target_name: nil, generate_target_version: nil, gh_action_organization: nil, gh_action_ref: nil, gh_action_repository: nil, gh_action_run_link: nil, gh_action_version: nil, git_relative_cwd: nil, git_remote_default_owner: nil, git_remote_default_repo: nil, git_user_email: nil, git_user_name: nil, hostname: nil, publish_package_name: nil, publish_package_registry_name: nil, publish_package_url: nil, publish_package_version: nil, repo_label: nil, source_blob_digest: nil, source_namespace_name: nil, source_revision_digest: nil, success: nil, workflow_post_raw: nil, workflow_pre_raw: nil) + sig { params(generate_gen_lock_id: ::String, generate_target: ::String, id: ::String, last_event_created_at: ::DateTime, last_event_id: ::String, last_event_interaction_type: ::OpenApiSDK::Shared::InteractionType, commit_head: T.nilable(::String), continuous_integration_environment: T.nilable(::String), error: T.nilable(::String), generate_config_post_version: T.nilable(::String), generate_eligible_features: T.nilable(::String), generate_gen_lock_pre_features: T.nilable(::String), generate_gen_lock_pre_version: T.nilable(::String), generate_number_of_operations_ignored: T.nilable(::Integer), generate_number_of_operations_used: T.nilable(::Integer), generate_number_of_terraform_resources: T.nilable(::Integer), generate_published: T.nilable(T::Boolean), generate_target_name: T.nilable(::String), generate_target_version: T.nilable(::String), gh_action_organization: T.nilable(::String), gh_action_ref: T.nilable(::String), gh_action_repository: T.nilable(::String), gh_action_run_link: T.nilable(::String), gh_action_version: T.nilable(::String), git_relative_cwd: T.nilable(::String), git_remote_default_owner: T.nilable(::String), git_remote_default_repo: T.nilable(::String), git_user_email: T.nilable(::String), git_user_name: T.nilable(::String), hostname: T.nilable(::String), publish_package_name: T.nilable(::String), publish_package_registry_name: T.nilable(::String), publish_package_url: T.nilable(::String), publish_package_version: T.nilable(::String), repo_label: T.nilable(::String), source_blob_digest: T.nilable(::String), source_namespace_name: T.nilable(::String), source_revision_digest: T.nilable(::String), success: T.nilable(T::Boolean), workflow_lock_post_raw: T.nilable(::String), workflow_lock_pre_raw: T.nilable(::String), workflow_post_raw: T.nilable(::String), workflow_pre_raw: T.nilable(::String)).void } + def initialize(generate_gen_lock_id: nil, generate_target: nil, id: nil, last_event_created_at: nil, last_event_id: nil, last_event_interaction_type: nil, commit_head: nil, continuous_integration_environment: nil, error: nil, generate_config_post_version: nil, generate_eligible_features: nil, generate_gen_lock_pre_features: nil, generate_gen_lock_pre_version: nil, generate_number_of_operations_ignored: nil, generate_number_of_operations_used: nil, generate_number_of_terraform_resources: nil, generate_published: nil, generate_target_name: nil, generate_target_version: nil, gh_action_organization: nil, gh_action_ref: nil, gh_action_repository: nil, gh_action_run_link: nil, gh_action_version: nil, git_relative_cwd: nil, git_remote_default_owner: nil, git_remote_default_repo: nil, git_user_email: nil, git_user_name: nil, hostname: nil, publish_package_name: nil, publish_package_registry_name: nil, publish_package_url: nil, publish_package_version: nil, repo_label: nil, source_blob_digest: nil, source_namespace_name: nil, source_revision_digest: nil, success: nil, workflow_lock_post_raw: nil, workflow_lock_pre_raw: nil, workflow_post_raw: nil, workflow_pre_raw: nil) @generate_gen_lock_id = generate_gen_lock_id @generate_target = generate_target @id = id @@ -110,6 +116,7 @@ def initialize(generate_gen_lock_id: nil, generate_target: nil, id: nil, last_ev @generate_gen_lock_pre_version = generate_gen_lock_pre_version @generate_number_of_operations_ignored = generate_number_of_operations_ignored @generate_number_of_operations_used = generate_number_of_operations_used + @generate_number_of_terraform_resources = generate_number_of_terraform_resources @generate_published = generate_published @generate_target_name = generate_target_name @generate_target_version = generate_target_version @@ -133,6 +140,8 @@ def initialize(generate_gen_lock_id: nil, generate_target: nil, id: nil, last_ev @source_namespace_name = source_namespace_name @source_revision_digest = source_revision_digest @success = success + @workflow_lock_post_raw = workflow_lock_post_raw + @workflow_lock_pre_raw = workflow_lock_pre_raw @workflow_post_raw = workflow_post_raw @workflow_pre_raw = workflow_pre_raw end diff --git a/lib/open_api_sdk/models/shared/user.rb b/lib/open_api_sdk/models/shared/user.rb index 4a8a0da..b0927f4 100644 --- a/lib/open_api_sdk/models/shared/user.rb +++ b/lib/open_api_sdk/models/shared/user.rb @@ -33,14 +33,16 @@ class User < ::OpenApiSDK::Utils::FieldAugmented field :default_workspace_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('default_workspace_id') } } # GitHub handle of the user. field :github_handle, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('github_handle') } } + # Indicates whether the user is internal. + field :internal, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('internal') } } # Timestamp of the last login. field :last_login_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('last_login_at'), 'decoder': Utils.datetime_from_iso_format(true) } } # URL of the user's photo. field :photo_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('photo_url') } } - sig { params(admin: T::Boolean, confirmed: T::Boolean, created_at: ::DateTime, display_name: ::String, email: ::String, email_verified: T::Boolean, id: ::String, updated_at: ::DateTime, whitelisted: T::Boolean, default_workspace_id: T.nilable(::String), github_handle: T.nilable(::String), last_login_at: T.nilable(::DateTime), photo_url: T.nilable(::String)).void } - def initialize(admin: nil, confirmed: nil, created_at: nil, display_name: nil, email: nil, email_verified: nil, id: nil, updated_at: nil, whitelisted: nil, default_workspace_id: nil, github_handle: nil, last_login_at: nil, photo_url: nil) + sig { params(admin: T::Boolean, confirmed: T::Boolean, created_at: ::DateTime, display_name: ::String, email: ::String, email_verified: T::Boolean, id: ::String, updated_at: ::DateTime, whitelisted: T::Boolean, default_workspace_id: T.nilable(::String), github_handle: T.nilable(::String), internal: T.nilable(T::Boolean), last_login_at: T.nilable(::DateTime), photo_url: T.nilable(::String)).void } + def initialize(admin: nil, confirmed: nil, created_at: nil, display_name: nil, email: nil, email_verified: nil, id: nil, updated_at: nil, whitelisted: nil, default_workspace_id: nil, github_handle: nil, internal: nil, last_login_at: nil, photo_url: nil) @admin = admin @confirmed = confirmed @created_at = created_at @@ -52,6 +54,7 @@ def initialize(admin: nil, confirmed: nil, created_at: nil, display_name: nil, e @whitelisted = whitelisted @default_workspace_id = default_workspace_id @github_handle = github_handle + @internal = internal @last_login_at = last_login_at @photo_url = photo_url end diff --git a/lib/open_api_sdk/models/shared/workspace.rb b/lib/open_api_sdk/models/shared/workspace.rb index 0346535..b515300 100644 --- a/lib/open_api_sdk/models/shared/workspace.rb +++ b/lib/open_api_sdk/models/shared/workspace.rb @@ -22,29 +22,28 @@ class Workspace < ::OpenApiSDK::Utils::FieldAugmented field :slug, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('slug') } } - field :telemetry_disabled, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('telemetry_disabled') } } - field :updated_at, ::DateTime, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('updated_at'), 'decoder': Utils.datetime_from_iso_format(false) } } field :verified, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('verified') } } - field :oci_repo, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('oci_repo') } } - - field :oci_repo_created_at, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('oci_repo_created_at'), 'decoder': Utils.datetime_from_iso_format(true) } } + field :inactive, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('inactive') } } + # Deprecated. Use organization.telemetry_disabled instead. + # + # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible. + field :telemetry_disabled, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('telemetry_disabled') } } - sig { params(created_at: ::DateTime, id: ::String, name: ::String, organization_id: ::String, slug: ::String, telemetry_disabled: T::Boolean, updated_at: ::DateTime, verified: T::Boolean, oci_repo: T.nilable(::String), oci_repo_created_at: T.nilable(::DateTime)).void } - def initialize(created_at: nil, id: nil, name: nil, organization_id: nil, slug: nil, telemetry_disabled: nil, updated_at: nil, verified: nil, oci_repo: nil, oci_repo_created_at: nil) + sig { params(created_at: ::DateTime, id: ::String, name: ::String, organization_id: ::String, slug: ::String, updated_at: ::DateTime, verified: T::Boolean, inactive: T.nilable(T::Boolean), telemetry_disabled: T.nilable(T::Boolean)).void } + def initialize(created_at: nil, id: nil, name: nil, organization_id: nil, slug: nil, updated_at: nil, verified: nil, inactive: nil, telemetry_disabled: nil) @created_at = created_at @id = id @name = name @organization_id = organization_id @slug = slug - @telemetry_disabled = telemetry_disabled @updated_at = updated_at @verified = verified - @oci_repo = oci_repo - @oci_repo_created_at = oci_repo_created_at + @inactive = inactive + @telemetry_disabled = telemetry_disabled end end end diff --git a/lib/open_api_sdk/models/shared/workspacesettings.rb b/lib/open_api_sdk/models/shared/workspacesettings.rb index 041e505..99ae0ca 100644 --- a/lib/open_api_sdk/models/shared/workspacesettings.rb +++ b/lib/open_api_sdk/models/shared/workspacesettings.rb @@ -12,15 +12,21 @@ class WorkspaceSettings < ::OpenApiSDK::Utils::FieldAugmented extend T::Sig - field :workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspace_id') } } + field :created_at, ::DateTime, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(false) } } - field :webhook_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhook_url') } } + field :updated_at, ::DateTime, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('updated_at'), 'decoder': Utils.datetime_from_iso_format(false) } } + field :webhook_url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhook_url') } } - sig { params(workspace_id: ::String, webhook_url: T.nilable(::String)).void } - def initialize(workspace_id: nil, webhook_url: nil) - @workspace_id = workspace_id + field :workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspace_id') } } + + + sig { params(created_at: ::DateTime, updated_at: ::DateTime, webhook_url: ::String, workspace_id: ::String).void } + def initialize(created_at: nil, updated_at: nil, webhook_url: nil, workspace_id: nil) + @created_at = created_at + @updated_at = updated_at @webhook_url = webhook_url + @workspace_id = workspace_id end end end diff --git a/lib/open_api_sdk/models/shared/workspacetoken.rb b/lib/open_api_sdk/models/shared/workspacetoken.rb index f30763b..c5031bb 100644 --- a/lib/open_api_sdk/models/shared/workspacetoken.rb +++ b/lib/open_api_sdk/models/shared/workspacetoken.rb @@ -14,7 +14,7 @@ class WorkspaceToken < ::OpenApiSDK::Utils::FieldAugmented field :alg, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('alg') } } - field :created_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('created_at') } } + field :created_at, ::DateTime, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('created_at'), 'decoder': Utils.datetime_from_iso_format(false) } } field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } } @@ -22,26 +22,26 @@ class WorkspaceToken < ::OpenApiSDK::Utils::FieldAugmented field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } } + field :workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspace_id') } } + field :created_by, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('created_by') } } field :email, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } } - field :last_used, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('last_used') } } - - field :workspace_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspace_id') } } + field :last_used, T.nilable(::DateTime), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('last_used'), 'decoder': Utils.datetime_from_iso_format(true) } } - sig { params(alg: ::String, created_at: ::String, id: ::String, key: ::String, name: ::String, created_by: T.nilable(::String), email: T.nilable(::String), last_used: T.nilable(::String), workspace_id: T.nilable(::String)).void } - def initialize(alg: nil, created_at: nil, id: nil, key: nil, name: nil, created_by: nil, email: nil, last_used: nil, workspace_id: nil) + sig { params(alg: ::String, created_at: ::DateTime, id: ::String, key: ::String, name: ::String, workspace_id: ::String, created_by: T.nilable(::String), email: T.nilable(::String), last_used: T.nilable(::DateTime)).void } + def initialize(alg: nil, created_at: nil, id: nil, key: nil, name: nil, workspace_id: nil, created_by: nil, email: nil, last_used: nil) @alg = alg @created_at = created_at @id = id @key = key @name = name + @workspace_id = workspace_id @created_by = created_by @email = email @last_used = last_used - @workspace_id = workspace_id end end end diff --git a/lib/open_api_sdk/requests.rb b/lib/open_api_sdk/requests.rb index 6aea78e..518b4cf 100644 --- a/lib/open_api_sdk/requests.rb +++ b/lib/open_api_sdk/requests.rb @@ -110,7 +110,7 @@ def get(request_id) sig { params(request_id: ::String).returns(::OpenApiSDK::Operations::GenerateRequestPostmanCollectionResponse) } def generate_postman_collection(request_id) # generate_postman_collection - Generate a Postman collection for a particular request. - # Generates a Postman collection for a particular request. + # Generates a Postman collection for a particular request. # Allowing it to be replayed with the same inputs that were captured by the SDK. request = ::OpenApiSDK::Operations::GenerateRequestPostmanCollectionRequest.new( diff --git a/lib/open_api_sdk/schemas.rb b/lib/open_api_sdk/schemas.rb index 4862efb..e9af34a 100644 --- a/lib/open_api_sdk/schemas.rb +++ b/lib/open_api_sdk/schemas.rb @@ -22,7 +22,7 @@ def initialize(sdk_config) sig { params(api_id: ::String, version_id: ::String).returns(::OpenApiSDK::Operations::GetSchemaResponse) } def get_latest(api_id, version_id) # get_latest - Get information about the latest schema. - # Returns information about the last uploaded schema for a particular API version. + # Returns information about the last uploaded schema for a particular API version. # This won't include the schema itself, that can be retrieved via the downloadSchema operation. request = ::OpenApiSDK::Operations::GetSchemaRequest.new( @@ -262,7 +262,7 @@ def delete(api_id, version_id, revision_id) sig { params(api_id: ::String, version_id: ::String, revision_id: ::String).returns(::OpenApiSDK::Operations::GetSchemaRevisionResponse) } def get_revision(api_id, version_id, revision_id) # get_revision - Get information about a particular schema revision for an Api. - # Returns information about the last uploaded schema for a particular schema revision. + # Returns information about the last uploaded schema for a particular schema revision. # This won't include the schema itself, that can be retrieved via the downloadSchema operation. request = ::OpenApiSDK::Operations::GetSchemaRevisionRequest.new( @@ -358,7 +358,7 @@ def download_revision(api_id, version_id, revision_id) sig { params(api_id: ::String, version_id: ::String).returns(::OpenApiSDK::Operations::GetSchemasResponse) } def get(api_id, version_id) # get - Get information about all schemas associated with a particular apiID. - # Returns information the schemas associated with a particular apiID. + # Returns information the schemas associated with a particular apiID. # This won't include the schemas themselves, they can be retrieved via the downloadSchema operation. request = ::OpenApiSDK::Operations::GetSchemasRequest.new( diff --git a/lib/open_api_sdk/sdkconfiguration.rb b/lib/open_api_sdk/sdkconfiguration.rb index ca2cca0..aac95ee 100644 --- a/lib/open_api_sdk/sdkconfiguration.rb +++ b/lib/open_api_sdk/sdkconfiguration.rb @@ -40,10 +40,10 @@ def initialize(client, security, server_url, server, globals) @security = security @globals = globals.nil? ? {} : globals @language = 'ruby' - @openapi_doc_version = '0.4.0 .' - @sdk_version = '4.2.24' - @gen_version = '2.429.0' - @user_agent = 'speakeasy-sdk/ruby 4.2.24 2.429.0 0.4.0 . speakeasy_client_sdk_ruby' + @openapi_doc_version = '0.4.0' + @sdk_version = '4.3.0' + @gen_version = '2.460.1' + @user_agent = 'speakeasy-sdk/ruby 4.3.0 2.460.1 0.4.0 speakeasy_client_sdk_ruby' end sig { returns([String, T::Hash[Symbol, String]]) } diff --git a/lib/open_api_sdk/speakeasyclientsdk.rb b/lib/open_api_sdk/speakeasyclientsdk.rb index 630081a..e82cf83 100644 --- a/lib/open_api_sdk/speakeasyclientsdk.rb +++ b/lib/open_api_sdk/speakeasyclientsdk.rb @@ -13,7 +13,7 @@ module OpenApiSDK class SpeakeasyClientSDK extend T::Sig - attr_accessor :apis, :apiendpoints, :speakeasy_client_sdk_api_endpoints, :metadata, :schemas, :auth, :requests, :github, :organizations, :embeds, :workspaces, :events, :artifacts, :reports, :suggest, :short_ur_ls + attr_accessor :apis, :apiendpoints, :speakeasy_client_sdk_api_endpoints, :metadata, :schemas, :auth, :requests, :github, :organizations, :embeds, :workspaces, :events, :reports, :suggest, :short_ur_ls, :artifacts, :subscriptions sig do params(client: Faraday::Request, @@ -101,10 +101,154 @@ def init_sdks @embeds = Embeds.new(@sdk_configuration) @workspaces = Workspaces.new(@sdk_configuration) @events = Events.new(@sdk_configuration) - @artifacts = Artifacts.new(@sdk_configuration) @reports = Reports.new(@sdk_configuration) @suggest = Suggest.new(@sdk_configuration) @short_ur_ls = ShortURLs.new(@sdk_configuration) + @artifacts = Artifacts.new(@sdk_configuration) + @subscriptions = Subscriptions.new(@sdk_configuration) + end + + + sig { params(request: ::OpenApiSDK::Shared::CodeSampleSchemaInput).returns(::OpenApiSDK::Operations::GenerateCodeSamplePreviewResponse) } + def generate_code_sample_preview(request) + # generate_code_sample_preview - Generate Code Sample previews from a file and configuration parameters. + # This endpoint generates Code Sample previews from a file and configuration parameters. + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/v1/code_sample/preview" + headers = {} + req_content_type, data, form = Utils.serialize_request_body(request, :request, :multipart) + headers['content-type'] = req_content_type + raise StandardError, 'request body is required' if data.nil? && form.nil? + headers['Accept'] = 'application/json;q=1, application/x-yaml;q=0' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.post(url) do |req| + req.headers = headers + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + if form + req.body = Utils.encode_form(form) + elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded') + req.body = URI.encode_www_form(data) + else + req.body = data + end + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::GenerateCodeSamplePreviewResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + res.two_hundred_application_x_yaml_bytes = r.env.response_body if Utils.match_content_type(content_type, 'application/x-yaml') + + res.two_hundred_application_json_bytes = r.env.response_body if Utils.match_content_type(content_type, 'application/json') + + elsif r.status >= 400 && r.status < 500 || r.status >= 500 && r.status < 600 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error) + res.error = out + end + end + res + end + + + sig { params(request: ::OpenApiSDK::Shared::CodeSampleSchemaInput).returns(::OpenApiSDK::Operations::GenerateCodeSamplePreviewAsyncResponse) } + def generate_code_sample_preview_async(request) + # generate_code_sample_preview_async - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling. + # This endpoint generates Code Sample previews from a file and configuration parameters, receiving an async JobID response for polling. + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/v1/code_sample/preview/async" + headers = {} + req_content_type, data, form = Utils.serialize_request_body(request, :request, :multipart) + headers['content-type'] = req_content_type + raise StandardError, 'request body is required' if data.nil? && form.nil? + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.post(url) do |req| + req.headers = headers + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + if form + req.body = Utils.encode_form(form) + elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded') + req.body = URI.encode_www_form(data) + else + req.body = data + end + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::GenerateCodeSamplePreviewAsyncResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 202 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::GenerateCodeSamplePreviewAsyncResponseBody) + res.object = out + end + elsif r.status >= 400 && r.status < 500 || r.status >= 500 && r.status < 600 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error) + res.error = out + end + end + res + end + + + sig { params(job_id: ::String).returns(::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncResponse) } + def get_code_sample_preview_async(job_id) + # get_code_sample_preview_async - Poll for the result of an asynchronous Code Sample preview generation. + # Poll for the result of an asynchronous Code Sample preview generation. + request = ::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncRequest.new( + + job_id: job_id + ) + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = Utils.generate_url( + ::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncRequest, + base_url, + '/v1/code_sample/preview/async/{jobID}', + request, + @sdk_configuration.globals + ) + headers = {} + headers['Accept'] = 'application/json;q=1, application/x-yaml;q=0' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.get(url) do |req| + req.headers = headers + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + res.two_hundred_application_x_yaml_bytes = r.env.response_body if Utils.match_content_type(content_type, 'application/x-yaml') + + res.two_hundred_application_json_bytes = r.env.response_body if Utils.match_content_type(content_type, 'application/json') + + elsif r.status == 202 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::GetCodeSamplePreviewAsyncResponseBody) + res.two_hundred_and_two_application_json_object = out + end + elsif r.status >= 400 && r.status < 500 || r.status >= 500 && r.status < 600 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::Error) + res.error = out + end + end + res end end end diff --git a/lib/open_api_sdk/subscriptions.rb b/lib/open_api_sdk/subscriptions.rb new file mode 100644 index 0000000..ea4da4a --- /dev/null +++ b/lib/open_api_sdk/subscriptions.rb @@ -0,0 +1,110 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + +require 'faraday' +require 'faraday/multipart' +require 'sorbet-runtime' + +module OpenApiSDK + extend T::Sig + class Subscriptions + extend T::Sig + # REST APIs for managing subscriptions + + sig { params(sdk_config: SDKConfiguration).void } + def initialize(sdk_config) + @sdk_configuration = sdk_config + end + + + sig { params(request: T.nilable(::OpenApiSDK::Operations::ListRegistrySubscriptionsRequest)).returns(::OpenApiSDK::Operations::ListRegistrySubscriptionsResponse) } + def list_registry_subscriptions(request) + # list_registry_subscriptions - List Subscriptions + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = Utils.generate_url( + ::OpenApiSDK::Operations::ListRegistrySubscriptionsRequest, + base_url, + '/v1/workspace/{workspace_id}/registry_subscriptions', + request, + @sdk_configuration.globals + ) + headers = {} + query_params = Utils.get_query_params(::OpenApiSDK::Operations::ListRegistrySubscriptionsRequest, request, @sdk_configuration.globals) + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.get(url) do |req| + req.headers = headers + req.params = query_params + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::ListRegistrySubscriptionsResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, T::Array[::OpenApiSDK::Shared::RegistrySubscription]) + res.registry_subscriptions = out + end + end + res + end + + + sig { params(registry_subscription: ::OpenApiSDK::Shared::RegistrySubscription, workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::CreateSubscriptionResponse) } + def create_subscription(registry_subscription, workspace_id = nil) + # create_subscription - Create Subscription + request = ::OpenApiSDK::Operations::CreateSubscriptionRequest.new( + + registry_subscription: registry_subscription, + workspace_id: workspace_id + ) + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = Utils.generate_url( + ::OpenApiSDK::Operations::CreateSubscriptionRequest, + base_url, + '/v1/workspace/{workspace_id}/registry_subscriptions', + request, + @sdk_configuration.globals + ) + headers = {} + req_content_type, data, form = Utils.serialize_request_body(request, :registry_subscription, :json) + headers['content-type'] = req_content_type + raise StandardError, 'request body is required' if data.nil? && form.nil? + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.post(url) do |req| + req.headers = headers + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + if form + req.body = Utils.encode_form(form) + elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded') + req.body = URI.encode_www_form(data) + else + req.body = data + end + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::CreateSubscriptionResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status == 200 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::RegistrySubscription) + res.registry_subscription = out + end + end + res + end + end +end diff --git a/lib/open_api_sdk/suggest.rb b/lib/open_api_sdk/suggest.rb index 06c3389..1b2fae5 100644 --- a/lib/open_api_sdk/suggest.rb +++ b/lib/open_api_sdk/suggest.rb @@ -107,6 +107,46 @@ def generate(x_session_id, suggest_request_body) end + sig { params(request: ::OpenApiSDK::Shared::SuggestItemsRequestBody).returns(::OpenApiSDK::Operations::SuggestItemsResponse) } + def suggest_items(request) + # suggest_items - Generate generic suggestions for a list of items. + url, params = @sdk_configuration.get_server_details + base_url = Utils.template_url(url, params) + url = "#{base_url}/v1/suggest/items" + headers = {} + req_content_type, data, form = Utils.serialize_request_body(request, :request, :json) + headers['content-type'] = req_content_type + raise StandardError, 'request body is required' if data.nil? && form.nil? + headers['Accept'] = 'application/json' + headers['user-agent'] = @sdk_configuration.user_agent + + r = @sdk_configuration.client.post(url) do |req| + req.headers = headers + Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil? + if form + req.body = Utils.encode_form(form) + elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded') + req.body = URI.encode_www_form(data) + else + req.body = data + end + end + + content_type = r.headers.fetch('Content-Type', 'application/octet-stream') + + res = ::OpenApiSDK::Operations::SuggestItemsResponse.new( + status_code: r.status, content_type: content_type, raw_response: r + ) + if r.status >= 200 && r.status < 300 + if Utils.match_content_type(content_type, 'application/json') + out = Utils.unmarshal_complex(r.env.response_body, T::Array[::String]) + res.strings = out + end + end + res + end + + sig { params(x_session_id: ::String, namespace_name: ::String, revision_reference: ::String, suggest_request_body: T.nilable(::OpenApiSDK::Shared::SuggestRequestBody)).returns(::OpenApiSDK::Operations::SuggestOpenAPIRegistryResponse) } def openapi_registry(x_session_id, namespace_name, revision_reference, suggest_request_body = nil) # openapi_registry - Generate suggestions for improving an OpenAPI document stored in the registry. diff --git a/lib/open_api_sdk/workspaces.rb b/lib/open_api_sdk/workspaces.rb index 0458754..aec87fc 100644 --- a/lib/open_api_sdk/workspaces.rb +++ b/lib/open_api_sdk/workspaces.rb @@ -137,8 +137,8 @@ def create(request) end - sig { params(workspace_id: ::String).returns(::OpenApiSDK::Operations::GetWorkspaceResponse) } - def get_by_id(workspace_id) + sig { params(workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::GetWorkspaceResponse) } + def get_by_id(workspace_id = nil) # get_by_id - Get workspace # Get information about a particular workspace. request = ::OpenApiSDK::Operations::GetWorkspaceRequest.new( @@ -183,14 +183,14 @@ def get_by_id(workspace_id) end - sig { params(workspace_id: ::String, workspace: ::OpenApiSDK::Shared::Workspace).returns(::OpenApiSDK::Operations::UpdateWorkspaceDetailsResponse) } - def update_details(workspace_id, workspace) + sig { params(workspace: ::OpenApiSDK::Shared::Workspace, workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::UpdateWorkspaceDetailsResponse) } + def update_details(workspace, workspace_id = nil) # update_details - Update workspace details # Update information about a particular workspace. request = ::OpenApiSDK::Operations::UpdateWorkspaceDetailsRequest.new( - workspace_id: workspace_id, - workspace: workspace + workspace: workspace, + workspace_id: workspace_id ) url, params = @sdk_configuration.get_server_details base_url = Utils.template_url(url, params) @@ -236,8 +236,8 @@ def update_details(workspace_id, workspace) end - sig { params(workspace_id: ::String).returns(::OpenApiSDK::Operations::GetWorkspaceSettingsResponse) } - def get_settings(workspace_id) + sig { params(workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::GetWorkspaceSettingsResponse) } + def get_settings(workspace_id = nil) # get_settings - Get workspace settings # Get settings about a particular workspace. request = ::OpenApiSDK::Operations::GetWorkspaceSettingsRequest.new( @@ -282,14 +282,14 @@ def get_settings(workspace_id) end - sig { params(workspace_id: ::String, workspace_settings: ::OpenApiSDK::Shared::WorkspaceSettings).returns(::OpenApiSDK::Operations::UpdateWorkspaceSettingsResponse) } - def update_settings(workspace_id, workspace_settings) + sig { params(workspace_settings: ::OpenApiSDK::Shared::WorkspaceSettings, workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::UpdateWorkspaceSettingsResponse) } + def update_settings(workspace_settings, workspace_id = nil) # update_settings - Update workspace settings # Update settings about a particular workspace. request = ::OpenApiSDK::Operations::UpdateWorkspaceSettingsRequest.new( - workspace_id: workspace_id, - workspace_settings: workspace_settings + workspace_settings: workspace_settings, + workspace_id: workspace_id ) url, params = @sdk_configuration.get_server_details base_url = Utils.template_url(url, params) @@ -335,8 +335,8 @@ def update_settings(workspace_id, workspace_settings) end - sig { params(workspace_id: ::String).returns(::OpenApiSDK::Operations::GetWorkspaceTeamResponse) } - def get_team(workspace_id) + sig { params(workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::GetWorkspaceTeamResponse) } + def get_team(workspace_id = nil) # get_team - Get team members for a particular workspace request = ::OpenApiSDK::Operations::GetWorkspaceTeamRequest.new( @@ -380,13 +380,13 @@ def get_team(workspace_id) end - sig { params(workspace_id: ::String, email: ::String).returns(::OpenApiSDK::Operations::GrantUserAccessToWorkspaceResponse) } - def grant_access(workspace_id, email) + sig { params(email: ::String, workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::GrantUserAccessToWorkspaceResponse) } + def grant_access(email, workspace_id = nil) # grant_access - Grant a user access to a particular workspace request = ::OpenApiSDK::Operations::GrantUserAccessToWorkspaceRequest.new( - workspace_id: workspace_id, - email: email + email: email, + workspace_id: workspace_id ) url, params = @sdk_configuration.get_server_details base_url = Utils.template_url(url, params) @@ -426,13 +426,13 @@ def grant_access(workspace_id, email) end - sig { params(workspace_id: ::String, user_id: ::String).returns(::OpenApiSDK::Operations::RevokeUserAccessToWorkspaceResponse) } - def revoke_access(workspace_id, user_id) + sig { params(user_id: ::String, workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::RevokeUserAccessToWorkspaceResponse) } + def revoke_access(user_id, workspace_id = nil) # revoke_access - Revoke a user's access to a particular workspace request = ::OpenApiSDK::Operations::RevokeUserAccessToWorkspaceRequest.new( - workspace_id: workspace_id, - user_id: user_id + user_id: user_id, + workspace_id: workspace_id ) url, params = @sdk_configuration.get_server_details base_url = Utils.template_url(url, params) @@ -468,8 +468,8 @@ def revoke_access(workspace_id, user_id) end - sig { params(workspace_id: ::String).returns(::OpenApiSDK::Operations::GetWorkspaceTokensResponse) } - def get_tokens(workspace_id) + sig { params(workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::GetWorkspaceTokensResponse) } + def get_tokens(workspace_id = nil) # get_tokens - Get tokens for a particular workspace request = ::OpenApiSDK::Operations::GetWorkspaceTokensRequest.new( @@ -513,13 +513,13 @@ def get_tokens(workspace_id) end - sig { params(workspace_id: ::String, workspace_token: ::OpenApiSDK::Shared::WorkspaceToken).returns(::OpenApiSDK::Operations::CreateWorkspaceTokenResponse) } - def create_token(workspace_id, workspace_token) + sig { params(workspace_token: ::OpenApiSDK::Shared::WorkspaceToken, workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::CreateWorkspaceTokenResponse) } + def create_token(workspace_token, workspace_id = nil) # create_token - Create a token for a particular workspace request = ::OpenApiSDK::Operations::CreateWorkspaceTokenRequest.new( - workspace_id: workspace_id, - workspace_token: workspace_token + workspace_token: workspace_token, + workspace_id: workspace_id ) url, params = @sdk_configuration.get_server_details base_url = Utils.template_url(url, params) @@ -565,13 +565,13 @@ def create_token(workspace_id, workspace_token) end - sig { params(workspace_id: ::String, token_id: ::String).returns(::OpenApiSDK::Operations::DeleteWorkspaceTokenResponse) } - def delete_token(workspace_id, token_id) + sig { params(token_id: ::String, workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::DeleteWorkspaceTokenResponse) } + def delete_token(token_id, workspace_id = nil) # delete_token - Delete a token for a particular workspace request = ::OpenApiSDK::Operations::DeleteWorkspaceTokenRequest.new( - workspace_id: workspace_id, - token_id: token_id + token_id: token_id, + workspace_id: workspace_id ) url, params = @sdk_configuration.get_server_details base_url = Utils.template_url(url, params) @@ -607,8 +607,8 @@ def delete_token(workspace_id, token_id) end - sig { params(workspace_id: ::String).returns(::OpenApiSDK::Operations::GetWorkspaceFeatureFlagsResponse) } - def get_feature_flags(workspace_id) + sig { params(workspace_id: T.nilable(::String)).returns(::OpenApiSDK::Operations::GetWorkspaceFeatureFlagsResponse) } + def get_feature_flags(workspace_id = nil) # get_feature_flags - Get workspace feature flags request = ::OpenApiSDK::Operations::GetWorkspaceFeatureFlagsRequest.new( diff --git a/lib/speakeasy_client_sdk_ruby.rb b/lib/speakeasy_client_sdk_ruby.rb index 58e5fa5..3473114 100644 --- a/lib/speakeasy_client_sdk_ruby.rb +++ b/lib/speakeasy_client_sdk_ruby.rb @@ -19,10 +19,11 @@ module OpenApiSDK autoload :Embeds, 'open_api_sdk/embeds' autoload :Workspaces, 'open_api_sdk/workspaces' autoload :Events, 'open_api_sdk/events' - autoload :Artifacts, 'open_api_sdk/artifacts' autoload :Reports, 'open_api_sdk/reports' autoload :Suggest, 'open_api_sdk/suggest' autoload :ShortURLs, 'open_api_sdk/shorturls' + autoload :Artifacts, 'open_api_sdk/artifacts' + autoload :Subscriptions, 'open_api_sdk/subscriptions' end require_relative 'open_api_sdk/utils/t' diff --git a/speakeasy_client_sdk_ruby.gemspec b/speakeasy_client_sdk_ruby.gemspec index d07fc15..7b0e35a 100644 --- a/speakeasy_client_sdk_ruby.gemspec +++ b/speakeasy_client_sdk_ruby.gemspec @@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__) Gem::Specification.new do |s| s.name = 'speakeasy_client_sdk_ruby' - s.version = '4.2.24' + s.version = '4.3.0' s.platform = Gem::Platform::RUBY s.licenses = ['Apache-2.0'] s.summary = '' @@ -29,7 +29,7 @@ Gem::Specification.new do |s| s.add_development_dependency('minitest') - s.add_development_dependency('rubocop') + s.add_development_dependency('rubocop', '~> 1.60.2') s.add_development_dependency('sorbet-runtime') s.add_development_dependency('tapioca') end