Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.455.7
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot committed Dec 17, 2024
1 parent a6b786b commit 23bddf4
Show file tree
Hide file tree
Showing 73 changed files with 1,231 additions and 1,209 deletions.
12 changes: 6 additions & 6 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
lockVersion: 2.0.0
id: db1bb4da-054f-485f-8c6e-d42db3f1da90
management:
docChecksum: a776550f34009612df62ba6268f834e3
docChecksum: 3dbd165cb83aaf90203b78ec02c2a141
docVersion: 0.4.0
speakeasyVersion: 1.454.0
generationVersion: 2.477.0
releaseVersion: 0.46.1
configChecksum: 83433c2ee243a1850a58bc8610a106be
speakeasyVersion: 1.455.7
generationVersion: 2.480.1
releaseVersion: 0.46.2
configChecksum: a9969eb26a984169e7439787f686ca63
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-php.git
repoSubDirectory: .
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-php
published: true
features:
php:
core: 3.7.4
core: 3.7.7
deprecations: 2.81.1
globalSecurity: 2.81.7
globalServerURLs: 2.82.1
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ generation:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
php:
version: 0.46.1
version: 0.46.2
additionalDependencies:
autoload: {}
autoload-dev: {}
Expand Down
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
speakeasyVersion: 1.454.0
speakeasyVersion: 1.455.7
sources:
my-source:
sourceNamespace: my-source
sourceRevisionDigest: sha256:310b96e972b58732a907958ea7cb8cdbcbd4a945a1fc70f653d903afa982ab4f
sourceBlobDigest: sha256:57b066b6505966df2aab772bec5bd33880a1a448bb68083b0a10cb6a5113edd5
sourceRevisionDigest: sha256:497d1e1a343d81bb8d79bfde63c51946cbac1a0c5861d9275f136e383ede4823
sourceBlobDigest: sha256:ee4e1c74ebb80bf3690713051d38bee7fa0793818cd6fd2840b4b2dc9a082d0c
tags:
- latest
- speakeasy-sdk-regen-1733962630
- speakeasy-sdk-regen-1734394630
- 0.4.0
targets:
php-target:
source: my-source
sourceNamespace: my-source
sourceRevisionDigest: sha256:310b96e972b58732a907958ea7cb8cdbcbd4a945a1fc70f653d903afa982ab4f
sourceBlobDigest: sha256:57b066b6505966df2aab772bec5bd33880a1a448bb68083b0a10cb6a5113edd5
sourceRevisionDigest: sha256:497d1e1a343d81bb8d79bfde63c51946cbac1a0c5861d9275f136e383ede4823
sourceBlobDigest: sha256:ee4e1c74ebb80bf3690713051d38bee7fa0793818cd6fd2840b4b2dc9a082d0c
codeSamplesNamespace: my-source-php-code-samples
codeSamplesRevisionDigest: sha256:7eddbb66641d6df0c824feb0fbd940c40085422a375ad429c5e01fd71560b1fd
codeSamplesRevisionDigest: sha256:674842b3533ff6fec0123e18139d427d6f692f90235269cf3df84a6b6b41c0a7
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ if ($response->twoHundredApplicationJsonBytes !== null) {

### [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.
* [getAccess](docs/sdks/auth/README.md#getaccess) - Get access allowances for a particular workspace
* [validateApiKey](docs/sdks/auth/README.md#validateapikey) - Validate the current api key.

### [events](docs/sdks/events/README.md)
Expand All @@ -87,24 +87,24 @@ if ($response->twoHundredApplicationJsonBytes !== null) {
### [github](docs/sdks/github/README.md)

* [checkAccess](docs/sdks/github/README.md#checkaccess)
* [getAction](docs/sdks/github/README.md#getaction)
* [getSetup](docs/sdks/github/README.md#getsetup)
* [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)
* [getAction](docs/sdks/github/README.md#getaction)
* [getSetup](docs/sdks/github/README.md#getsetup)
* [linkGithub](docs/sdks/github/README.md#linkgithub)
* [storePublishingSecrets](docs/sdks/github/README.md#storepublishingsecrets)
* [triggerAction](docs/sdks/github/README.md#triggeraction)
* [linkGithub](docs/sdks/github/README.md#linkgithub)

### [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
* [create](docs/sdks/organizations/README.md#create) - Create an organization
* [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
* [getAll](docs/sdks/organizations/README.md#getall) - Get organizations for a user

### [reports](docs/sdks/reports/README.md)

Expand Down Expand Up @@ -139,13 +139,13 @@ if ($response->twoHundredApplicationJsonBytes !== null) {
* [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
* [get](docs/sdks/workspaces/README.md#get) - Get workspace by context
* [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
* [getAll](docs/sdks/workspaces/README.md#getall) - Get workspaces for a user
* [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
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -1524,4 +1524,14 @@ Based on:
### Generated
- [php v0.46.1] .
### Releases
- [Composer v0.46.1] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.46.1 - .
- [Composer v0.46.1] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.46.1 - .

## 2024-12-17 00:17:06
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.455.7 (2.480.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [php v0.46.2] .
### Releases
- [Composer v0.46.2] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.46.2 - .
3 changes: 2 additions & 1 deletion docs/Models/Shared/RemoteSourceSubscriptionSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@
| -------------------- | -------------------- | -------------------- | -------------------- |
| `baseSpecNamespaces` | array<*string*> | :heavy_check_mark: | N/A |
| `outputNamespace` | *string* | :heavy_check_mark: | N/A |
| `overlayNamespaces` | array<*string*> | :heavy_check_mark: | N/A |
| `overlayNamespaces` | array<*string*> | :heavy_check_mark: | N/A |
| `ignoredNamespaces` | array<*string*> | :heavy_minus_sign: | N/A |
86 changes: 43 additions & 43 deletions docs/sdks/auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ REST APIs for managing Authentication

### Available Operations

* [getAccess](#getaccess) - Get access allowances for a particular workspace
* [getAccessToken](#getaccesstoken) - Get or refresh an access token for the current workspace.
* [getUser](#getuser) - Get information about the current user.
* [getAccess](#getaccess) - Get access allowances for a particular workspace
* [validateApiKey](#validateapikey) - Validate the current api key.

## getAccess
## getAccessToken

Checks if generation is permitted for a particular run of the CLI
Get or refresh an access token for the current workspace.

### Example Usage

Expand All @@ -25,44 +25,42 @@ 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();
$sdk = SpeakeasyClientSDK\SDK::builder()->build();

$request = new Operations\GetWorkspaceAccessRequest();
$request = new Operations\GetAccessTokenRequest(
workspaceId: '<id>',
);

$response = $sdk->auth->getAccess(
$response = $sdk->auth->getAccessToken(
request: $request
);

if ($response->accessDetails !== null) {
if ($response->accessToken !== null) {
// handle response
}
```

### Parameters

| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `$request` | [Operations\GetWorkspaceAccessRequest](../../Models/Operations/GetWorkspaceAccessRequest.md) | :heavy_check_mark: | The request object to use for the request. |
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `$request` | [Operations\GetAccessTokenRequest](../../Models/Operations/GetAccessTokenRequest.md) | :heavy_check_mark: | The request object to use for the request. |

### Response

**[?Operations\GetWorkspaceAccessResponse](../../Models/Operations/GetWorkspaceAccessResponse.md)**
**[?Operations\GetAccessTokenResponse](../../Models/Operations/GetAccessTokenResponse.md)**

### Errors

| Error Type | Status Code | Content Type |
| --------------------- | --------------------- | --------------------- |
| Errorors\SDKException | 4XX, 5XX | \*/\* |
| Errorors\Error | 4XX | application/json |
| Errorors\SDKException | 5XX | \*/\* |

## getAccessToken
## getUser

Get or refresh an access token for the current workspace.
Get information about the current user.

### Example Usage

Expand All @@ -72,32 +70,28 @@ declare(strict_types=1);
require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;

$sdk = SpeakeasyClientSDK\SDK::builder()->build();
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$request = new Operations\GetAccessTokenRequest(
workspaceId: '<id>',
$security = new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
);

$response = $sdk->auth->getAccessToken(
request: $request
$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();



$response = $sdk->auth->getUser(

);

if ($response->accessToken !== null) {
if ($response->user !== null) {
// handle response
}
```

### Parameters

| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `$request` | [Operations\GetAccessTokenRequest](../../Models/Operations/GetAccessTokenRequest.md) | :heavy_check_mark: | The request object to use for the request. |

### Response

**[?Operations\GetAccessTokenResponse](../../Models/Operations/GetAccessTokenResponse.md)**
**[?Operations\GetUserResponse](../../Models/Operations/GetUserResponse.md)**

### Errors

Expand All @@ -106,9 +100,9 @@ if ($response->accessToken !== null) {
| Errorors\Error | 4XX | application/json |
| Errorors\SDKException | 5XX | \*/\* |

## getUser
## getAccess

Get information about the current user.
Checks if generation is permitted for a particular run of the CLI

### Example Usage

Expand All @@ -118,6 +112,7 @@ 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(
Expand All @@ -126,27 +121,32 @@ $security = new Shared\Security(

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetWorkspaceAccessRequest();


$response = $sdk->auth->getUser(

$response = $sdk->auth->getAccess(
request: $request
);

if ($response->user !== null) {
if ($response->accessDetails !== null) {
// handle response
}
```

### Parameters

| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `$request` | [Operations\GetWorkspaceAccessRequest](../../Models/Operations/GetWorkspaceAccessRequest.md) | :heavy_check_mark: | The request object to use for the request. |

### Response

**[?Operations\GetUserResponse](../../Models/Operations/GetUserResponse.md)**
**[?Operations\GetWorkspaceAccessResponse](../../Models/Operations/GetWorkspaceAccessResponse.md)**

### Errors

| Error Type | Status Code | Content Type |
| --------------------- | --------------------- | --------------------- |
| Errorors\Error | 4XX | application/json |
| Errorors\SDKException | 5XX | \*/\* |
| Errorors\SDKException | 4XX, 5XX | \*/\* |

## validateApiKey

Expand Down
Loading

0 comments on commit 23bddf4

Please sign in to comment.