ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.403.3

speakeasy-api · Sep 27, 2024 · 8296f3f · 8296f3f
1 parent d1ffc6d
commit 8296f3f
Show file tree

Hide file tree

Showing 236 changed files with 5,030 additions and 2,189 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -10,7 +10,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 php:
-  version: 0.41.16
+  version: 0.42.0
   clientServerStatusCodesAsErrors: true
   flattenGlobalSecurity: true
   imports:

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,18 +1,18 @@
-speakeasyVersion: 1.402.1
+speakeasyVersion: 1.403.3
 sources:
     my-source:
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:80c3c90005952697b9d5e1deca96cc73c475b4aafecb711ac22912430743ef2b
-        sourceBlobDigest: sha256:c631a3d49dc602f7258899ba657fffa1c794ebe2c1f3211a3c728186c7577f54
+        sourceRevisionDigest: sha256:48f9a0b94f30dfaea17712ec077ca3071e29ac93f2db8663938d17eaa011a800
+        sourceBlobDigest: sha256:818f8ae440499921534f8a99ba574fb42c935ca8e70152292414b8866a845036
         tags:
             - latest
             - main
 targets:
     php-target:
         source: my-source
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:80c3c90005952697b9d5e1deca96cc73c475b4aafecb711ac22912430743ef2b
-        sourceBlobDigest: sha256:c631a3d49dc602f7258899ba657fffa1c794ebe2c1f3211a3c728186c7577f54
+        sourceRevisionDigest: sha256:48f9a0b94f30dfaea17712ec077ca3071e29ac93f2db8663938d17eaa011a800
+        sourceBlobDigest: sha256:818f8ae440499921534f8a99ba574fb42c935ca8e70152292414b8866a845036
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -26,14 +26,15 @@ use Speakeasy\SpeakeasyClientSDK\Models\Operations;
 use Speakeasy\SpeakeasyClientSDK\Models\Shared;
 
 $security = new Shared\Security(
-    apiKey: "<YOUR_API_KEY_HERE>",
+    apiKey: '<YOUR_API_KEY_HERE>',
 );
 
 $sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
-
 try {
     $request = new Operations\GetApisRequest();
-    $response = $sdk->apis->getApis($request);
+    $response = $sdk.apis->getApis(
+        request: $request
+    );
 
     if ($response->apis !== null) {
         // handle response
@@ -50,7 +51,7 @@ try {
 <details open>
 <summary>Available methods</summary>
 
-### [ApiEndpoints](docs/sdks/apiendpoints/README.md)
+### [apiEndpoints](docs/sdks/apiendpoints/README.md)
 
 * [deleteApiEndpoint](docs/sdks/apiendpoints/README.md#deleteapiendpoint) - Delete an ApiEndpoint.
 * [findApiEndpoint](docs/sdks/apiendpoints/README.md#findapiendpoint) - Find an ApiEndpoint via its displayName.
@@ -61,7 +62,7 @@ try {
 * [getApiEndpoint](docs/sdks/apiendpoints/README.md#getapiendpoint) - Get an ApiEndpoint.
 * [upsertApiEndpoint](docs/sdks/apiendpoints/README.md#upsertapiendpoint) - Upsert an ApiEndpoint.
 
-### [Apis](docs/sdks/apis/README.md)
+### [apis](docs/sdks/apis/README.md)
 
 * [deleteApi](docs/sdks/apis/README.md#deleteapi) - Delete an Api.
 * [generateOpenApiSpec](docs/sdks/apis/README.md#generateopenapispec) - Generate an OpenAPI specification for a particular Api.
@@ -70,7 +71,7 @@ try {
 * [getApis](docs/sdks/apis/README.md#getapis) - Get a list of Apis for a given workspace
 * [upsertApi](docs/sdks/apis/README.md#upsertapi) - Upsert an Api
 
-### [Artifacts](docs/sdks/artifacts/README.md)
+### [artifacts](docs/sdks/artifacts/README.md)
 
 * [getBlob](docs/sdks/artifacts/README.md#getblob) - Get blob for a particular digest
 * [getManifest](docs/sdks/artifacts/README.md#getmanifest) - Get manifest for a particular reference
@@ -80,64 +81,66 @@ try {
 * [postTags](docs/sdks/artifacts/README.md#posttags) - Add tags to an existing revision
 * [preflight](docs/sdks/artifacts/README.md#preflight) - Get access token for communicating with OCI distribution endpoints
 
-### [Auth](docs/sdks/auth/README.md)
+### [auth](docs/sdks/auth/README.md)
 
+* [getAccess](docs/sdks/auth/README.md#getaccess) - Get access allowances for a particular workspace
 * [getAccessToken](docs/sdks/auth/README.md#getaccesstoken) - Get or refresh an access token for the current workspace.
 * [getUser](docs/sdks/auth/README.md#getuser) - Get information about the current user.
-* [getWorkspaceAccess](docs/sdks/auth/README.md#getworkspaceaccess) - Get access allowances for a particular workspace
 * [validateApiKey](docs/sdks/auth/README.md#validateapikey) - Validate the current api key.
 
-### [Embeds](docs/sdks/embeds/README.md)
+### [embeds](docs/sdks/embeds/README.md)
 
 * [getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
 * [getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
 * [revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.
 
-### [Events](docs/sdks/events/README.md)
+### [events](docs/sdks/events/README.md)
 
-* [getWorkspaceEventsByTarget](docs/sdks/events/README.md#getworkspaceeventsbytarget) - Load recent events for a particular workspace
-* [getWorkspaceTargets](docs/sdks/events/README.md#getworkspacetargets) - Load targets for a particular workspace
-* [postWorkspaceEvents](docs/sdks/events/README.md#postworkspaceevents) - Post events for a specific workspace
-* [searchWorkspaceEvents](docs/sdks/events/README.md#searchworkspaceevents) - Search events for a particular workspace by any field
+* [getEventsByTarget](docs/sdks/events/README.md#geteventsbytarget) - Load recent events for a particular workspace
+* [getTargets](docs/sdks/events/README.md#gettargets) - Load targets for a particular workspace
+* [getTargetsDeprecated](docs/sdks/events/README.md#gettargetsdeprecated) - Load targets for a particular workspace
+* [post](docs/sdks/events/README.md#post) - Post events for a specific workspace
+* [search](docs/sdks/events/README.md#search) - Search events for a particular workspace by any field
 
-### [Github](docs/sdks/github/README.md)
+### [github](docs/sdks/github/README.md)
 
 * [checkAccess](docs/sdks/github/README.md#checkaccess)
+* [checkPublishingPRs](docs/sdks/github/README.md#checkpublishingprs)
+* [checkPublishingSecrets](docs/sdks/github/README.md#checkpublishingsecrets)
 * [configureCodeSamples](docs/sdks/github/README.md#configurecodesamples)
 * [configureMintlifyRepo](docs/sdks/github/README.md#configuremintlifyrepo)
 * [configureTarget](docs/sdks/github/README.md#configuretarget)
-* [fetchPublishingPRs](docs/sdks/github/README.md#fetchpublishingprs)
 * [getAction](docs/sdks/github/README.md#getaction)
-* [githubCheckPublishingSecrets](docs/sdks/github/README.md#githubcheckpublishingsecrets)
-* [githubStorePublishingSecrets](docs/sdks/github/README.md#githubstorepublishingsecrets)
+* [storePublishingSecrets](docs/sdks/github/README.md#storepublishingsecrets)
 * [triggerAction](docs/sdks/github/README.md#triggeraction)
 
-### [Metadata](docs/sdks/metadata/README.md)
+### [metadata](docs/sdks/metadata/README.md)
 
 * [deleteVersionMetadata](docs/sdks/metadata/README.md#deleteversionmetadata) - Delete metadata for a particular apiID and versionID.
 * [getVersionMetadata](docs/sdks/metadata/README.md#getversionmetadata) - Get all metadata for a particular apiID and versionID.
 * [insertVersionMetadata](docs/sdks/metadata/README.md#insertversionmetadata) - Insert metadata for a particular apiID and versionID.
 
-### [Organizations](docs/sdks/organizations/README.md)
+### [organizations](docs/sdks/organizations/README.md)
 
+* [create](docs/sdks/organizations/README.md#create) - Create an organization
 * [createFreeTrial](docs/sdks/organizations/README.md#createfreetrial) - Create a free trial for an organization
-* [getOrganization](docs/sdks/organizations/README.md#getorganization) - Get organization
-* [getOrganizationUsage](docs/sdks/organizations/README.md#getorganizationusage) - Get billing usage summary for a particular organization
-* [getOrganizations](docs/sdks/organizations/README.md#getorganizations) - Get organizations for a user
+* [get](docs/sdks/organizations/README.md#get) - Get organization
+* [getAll](docs/sdks/organizations/README.md#getall) - Get organizations for a user
+* [getUsage](docs/sdks/organizations/README.md#getusage) - Get billing usage summary for a particular organization
 
-### [Reports](docs/sdks/reports/README.md)
+### [reports](docs/sdks/reports/README.md)
 
 * [getChangesReportSignedUrl](docs/sdks/reports/README.md#getchangesreportsignedurl) - Get the signed access url for the change reports for a particular document.
 * [getLintingReportSignedUrl](docs/sdks/reports/README.md#getlintingreportsignedurl) - Get the signed access url for the linting reports for a particular document.
 * [uploadReport](docs/sdks/reports/README.md#uploadreport) - Upload a report.
 
-### [Requests](docs/sdks/requests/README.md)
+### [requests](docs/sdks/requests/README.md)
 
 * [generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
 * [getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
 * [queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.
 
-### [Schemas](docs/sdks/schemas/README.md)
+### [schemas](docs/sdks/schemas/README.md)
 
 * [deleteSchema](docs/sdks/schemas/README.md#deleteschema) - Delete a particular schema revision for an Api.
 * [downloadSchema](docs/sdks/schemas/README.md#downloadschema) - Download the latest schema for a particular apiID.
@@ -149,21 +152,32 @@ try {
 * [registerSchema](docs/sdks/schemas/README.md#registerschema) - Register a schema.
 
 
-### [ShortURLs](docs/sdks/shorturls/README.md)
+### [shortURLs](docs/sdks/shorturls/README.md)
 
 * [create](docs/sdks/shorturls/README.md#create) - Shorten a URL.
 
-### [Suggest](docs/sdks/suggest/README.md)
+### [suggest](docs/sdks/suggest/README.md)
 
 * [suggest](docs/sdks/suggest/README.md#suggest) - Generate suggestions for improving an OpenAPI document.
 * [suggestOpenAPI](docs/sdks/suggest/README.md#suggestopenapi) - (DEPRECATED) Generate suggestions for improving an OpenAPI document.
 * [suggestOpenAPIRegistry](docs/sdks/suggest/README.md#suggestopenapiregistry) - Generate suggestions for improving an OpenAPI document stored in the registry.
 
-### [Workspaces](docs/sdks/workspaces/README.md)
-
-* [getWorkspace](docs/sdks/workspaces/README.md#getworkspace) - Get workspace
-* [getWorkspaceByContext](docs/sdks/workspaces/README.md#getworkspacebycontext) - Get workspace by context
-* [getWorkspaceFeatureFlags](docs/sdks/workspaces/README.md#getworkspacefeatureflags) - Get workspace feature flags
+### [workspaces](docs/sdks/workspaces/README.md)
+
+* [create](docs/sdks/workspaces/README.md#create) - Create a workspace
+* [createToken](docs/sdks/workspaces/README.md#createtoken) - Create a token for a particular workspace
+* [deleteToken](docs/sdks/workspaces/README.md#deletetoken) - Delete a token for a particular workspace
+* [get](docs/sdks/workspaces/README.md#get) - Get workspace by context
+* [getAll](docs/sdks/workspaces/README.md#getall) - Get workspaces for a user
+* [getByID](docs/sdks/workspaces/README.md#getbyid) - Get workspace
+* [getFeatureFlags](docs/sdks/workspaces/README.md#getfeatureflags) - Get workspace feature flags
+* [getSettings](docs/sdks/workspaces/README.md#getsettings) - Get workspace settings
+* [getTeam](docs/sdks/workspaces/README.md#getteam) - Get team members for a particular workspace
+* [getTokens](docs/sdks/workspaces/README.md#gettokens) - Get tokens for a particular workspace
+* [grantAccess](docs/sdks/workspaces/README.md#grantaccess) - Grant a user access to a particular workspace
+* [revokeAccess](docs/sdks/workspaces/README.md#revokeaccess) - Revoke a user's access to a particular workspace
+* [update](docs/sdks/workspaces/README.md#update) - Update workspace details
+* [updateSettings](docs/sdks/workspaces/README.md#updatesettings) - Update workspace settings
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -190,53 +204,6 @@ You can override the default server globally by passing a server name to the `se
 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:
 <!-- End Server Selection [server] -->
 
-<!-- Start Global Parameters [global-parameters] -->
-## Global Parameters
-
-A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
-
-For example, you can set `workspaceID` to `'<value>'` at SDK initialization and then you do not have to pass the same value on calls to operations like `getWorkspace`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
-
-
-### Available Globals
-
-The following global parameter is available.
-
-| Name | Type | Required | Description |
-| ---- | ---- |:--------:| ----------- |
-| workspaceID | string |  | The workspaceID parameter. |
-
-
-### Example
-
-```php
-declare(strict_types=1);
-
-require 'vendor/autoload.php';
-
-use Speakeasy\SpeakeasyClientSDK;
-use Speakeasy\SpeakeasyClientSDK\Models\Operations;
-use Speakeasy\SpeakeasyClientSDK\Models\Shared;
-
-$security = new Shared\Security(
-    apiKey: "<YOUR_API_KEY_HERE>",
-);
-
-$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
-
-try {
-    $request = new Operations\GetWorkspaceRequest();
-    $response = $sdk->workspaces->getWorkspace($request);
-
-    if ($response->workspace !== null) {
-        // handle response
-    }
-} catch (Throwable $e) {
-    // handle exception
-}
-```
-<!-- End Global Parameters [global-parameters] -->
-
 <!-- Start Summary [summary] -->
 ## Summary
 
@@ -251,7 +218,6 @@ 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)
 <!-- End Table of Contents [toc] -->
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -1274,4 +1274,14 @@ Based on:
 ### Generated
 - [php v0.41.16] .
 ### Releases
-- [Composer v0.41.16] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.41.16 - .
+- [Composer v0.41.16] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.41.16 - .
+
+## 2024-09-27 00:15:36
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.403.3 (2.424.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [php v0.42.0] .
+### Releases
+- [Composer v0.42.0] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.42.0 - .
diff --git a/USAGE.md b/USAGE.md
@@ -9,14 +9,15 @@ use Speakeasy\SpeakeasyClientSDK\Models\Operations;
 use Speakeasy\SpeakeasyClientSDK\Models\Shared;
 
 $security = new Shared\Security(
-    apiKey: "<YOUR_API_KEY_HERE>",
+    apiKey: '<YOUR_API_KEY_HERE>',
 );
 
 $sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
-
 try {
     $request = new Operations\GetApisRequest();
-    $response = $sdk->apis->getApis($request);
+    $response = $sdk.apis->getApis(
+        request: $request
+    );
 
     if ($response->apis !== null) {
         // handle response

diff --git a/composer.json b/composer.json
@@ -15,7 +15,7 @@
     "phpdocumentor/type-resolver": "^1.8"
   },
   "require-dev": {
-    "laravel/pint": "^1.15",
+    "laravel/pint": "^1.18.1",
     "phpstan/phpstan": "^1.9",
     "phpunit/phpunit": "^10",
     "rector/rector": "^0.18.13",

diff --git a/docs/Models/Operations/CheckAccessRequest.md → ...ls/Operations/CheckGithubAccessRequest.md b/docs/Models/Operations/CheckAccessRequest.md → ...ls/Operations/CheckGithubAccessRequest.md
@@ -1,4 +1,4 @@
-# CheckAccessRequest
+# CheckGithubAccessRequest
 
 
 ## Fields

diff --git a/docs/Models/Operations/CheckGithubAccessResponse.md b/docs/Models/Operations/CheckGithubAccessResponse.md
@@ -0,0 +1,10 @@
+# CheckGithubAccessResponse
+
+
+## Fields
+
+| Field                                                                                                        | Type                                                                                                         | Required                                                                                                     | Description                                                                                                  |
+| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| `contentType`                                                                                                | *string*                                                                                                     | :heavy_check_mark:                                                                                           | HTTP response content type for this operation                                                                |
+| `statusCode`                                                                                                 | *int*                                                                                                        | :heavy_check_mark:                                                                                           | HTTP response status code for this operation                                                                 |
+| `rawResponse`                                                                                                | [\Psr\Http\Message\ResponseInterface](https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface) | :heavy_check_mark:                                                                                           | Raw HTTP response; suitable for custom response parsing                                                      |