Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.421.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@speakeasybot
speakeasybot committed Oct 25, 2024
1 parent 311ce13 commit 7045e04
Show file tree
Hide file tree
Showing 51 changed files with 214 additions and 161 deletions.
8 changes: 4 additions & 4 deletions .speakeasy/gen.lock
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: db1bb4da-054f-485f-8c6e-d42db3f1da90
management:
docChecksum: 0de17f0e213d140341433691065dc210
docChecksum: 0516c1ad132f5c25f4436defc305a71b
docVersion: 0.4.0
speakeasyVersion: 1.419.2
speakeasyVersion: 1.421.2
generationVersion: 2.438.15
releaseVersion: 0.44.4
configChecksum: 6bef500076370480b58f5f0e26291192
releaseVersion: 0.44.5
configChecksum: 528e0fe5092b22f21e8bae6d7b9dd47a
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-php.git
repoSubDirectory: .
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-php
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
php:
version: 0.44.4
version: 0.44.5
clientServerStatusCodesAsErrors: true
flattenGlobalSecurity: true
imports:
Expand Down
10 changes: 5 additions & 5 deletions .speakeasy/workflow.lock
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
speakeasyVersion: 1.419.2
speakeasyVersion: 1.421.2
sources:
my-source:
sourceNamespace: my-source
sourceRevisionDigest: sha256:96096a005338bebdae27ae25661275aadd00d2b8c2d3bafcbafb862d3f6436d3
sourceBlobDigest: sha256:5c9772941b84f3517d5ce969ef358b10daece2df8afa823eb2abde28a85e9f4b
sourceRevisionDigest: sha256:9bdcb4e5dfa7e9189cbae1726008aff19c9917f396add1659aaa3713ee75c409
sourceBlobDigest: sha256:4bdb54f96c3450278550d0948f44121da0514c097977bc08215d4131bb122ed6
tags:
- latest
- main
targets:
php-target:
source: my-source
sourceNamespace: my-source
sourceRevisionDigest: sha256:96096a005338bebdae27ae25661275aadd00d2b8c2d3bafcbafb862d3f6436d3
sourceBlobDigest: sha256:5c9772941b84f3517d5ce969ef358b10daece2df8afa823eb2abde28a85e9f4b
sourceRevisionDigest: sha256:9bdcb4e5dfa7e9189cbae1726008aff19c9917f396add1659aaa3713ee75c409
sourceBlobDigest: sha256:4bdb54f96c3450278550d0948f44121da0514c097977bc08215d4131bb122ed6
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
44 changes: 44 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,49 @@ if ($response->apis !== null) {



<!-- Start Global Parameters [global-parameters] -->
## Global Parameters

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set `workspace_id` to `'<id>'` at SDK initialization and then you do not have to pass the same value on calls to operations like `getAccessToken`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.


### Available Globals

The following global parameter is available.

| Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- |
| workspaceId | string | | The workspaceId parameter. |


### Example

```php
declare(strict_types=1);

require 'vendor/autoload.php';

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

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

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

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

if ($response->accessToken !== null) {
// handle response
}
```
<!-- End Global Parameters [global-parameters] -->

<!-- Start Error Handling [errors] -->
## Error Handling

Expand Down Expand Up @@ -285,6 +328,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)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
<!-- End Table of Contents [toc] -->
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1354,4 +1354,14 @@ Based on:
### Generated
- [php v0.44.4] .
### Releases
- [Composer v0.44.4] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.44.4 - .
- [Composer v0.44.4] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.44.4 - .

## 2024-10-25 00:15:57
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.421.2 (2.438.15) https://github.com/speakeasy-api/speakeasy
### Generated
- [php v0.44.5] .
### Releases
- [Composer v0.44.5] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.44.5 - .
2 changes: 1 addition & 1 deletion docs/Models/Operations/CreateSubscriptionRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
| Field | Type | Required | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `registrySubscription` | [Shared\RegistrySubscription](../../Models/Shared/RegistrySubscription.md) | :heavy_check_mark: | The subscription to create |
| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID |
| `workspaceId` | *?string* | :heavy_minus_sign: | The workspace ID |
2 changes: 1 addition & 1 deletion docs/Models/Operations/CreateWorkspaceTokenRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `workspaceToken` | [Shared\WorkspaceToken](../../Models/Shared/WorkspaceToken.md) | :heavy_check_mark: | N/A |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
2 changes: 1 addition & 1 deletion docs/Models/Operations/DeleteWorkspaceTokenRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `tokenID` | *string* | :heavy_check_mark: | Unique identifier of the token. |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
4 changes: 2 additions & 2 deletions docs/Models/Operations/GetWorkspaceEventsByTargetRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `targetId` | *string* | :heavy_check_mark: | Filter to only return events corresponding to a particular gen_lock_id (gen_lock_id uniquely identifies a target) |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `afterCreatedAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | Filter to only return events created after this timestamp |
| `afterCreatedAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | Filter to only return events created after this timestamp |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
2 changes: 1 addition & 1 deletion docs/Models/Operations/GetWorkspaceFeatureFlagsRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
2 changes: 1 addition & 1 deletion docs/Models/Operations/GetWorkspaceRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
2 changes: 1 addition & 1 deletion docs/Models/Operations/GetWorkspaceSettingsRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
4 changes: 2 additions & 2 deletions docs/Models/Operations/GetWorkspaceTargetsDeprecatedRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `afterLastEventCreatedAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | Filter to only return targets with events created after this timestamp |
| `afterLastEventCreatedAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | Filter to only return targets with events created after this timestamp |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
2 changes: 1 addition & 1 deletion docs/Models/Operations/GetWorkspaceTeamRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
2 changes: 1 addition & 1 deletion docs/Models/Operations/GetWorkspaceTokensRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

| Field | Type | Required | Description |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
2 changes: 1 addition & 1 deletion docs/Models/Operations/GrantUserAccessToWorkspaceRequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
| Field | Type | Required | Description |
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| `email` | *string* | :heavy_check_mark: | Email of the user to grant access to. |
| `workspaceId` | *string* | :heavy_check_mark: | Unique identifier of the workspace. |
| `workspaceId` | *?string* | :heavy_minus_sign: | Unique identifier of the workspace. |
Loading

0 comments on commit 7045e04

Please sign in to comment.