Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.467.0
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot committed Jan 10, 2025
1 parent 7ffd4e1 commit 94a131f
Show file tree
Hide file tree
Showing 43 changed files with 1,143 additions and 766 deletions.
29 changes: 23 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: bb7b102d1334d2d3e66e7cd8d8b866d8
docChecksum: 52df6f1f34dfe76968f8ed009cc2bfd3
docVersion: 0.4.0
speakeasyVersion: 1.462.2
generationVersion: 2.486.1
releaseVersion: 0.47.0
configChecksum: 026d2eb83427eeb452300de5c320637d
speakeasyVersion: 1.467.0
generationVersion: 2.492.3
releaseVersion: 0.47.1
configChecksum: fc3e2a4f688162e907c0aed73a152b12
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.7
core: 3.7.8
deprecations: 2.81.1
globalSecurity: 2.81.7
globalServerURLs: 2.82.1
Expand Down Expand Up @@ -129,6 +129,7 @@ generatedFiles:
- docs/Models/Operations/SetVisibilityRequest.md
- docs/Models/Operations/SetVisibilityRequestBody.md
- docs/Models/Operations/SetVisibilityResponse.md
- docs/Models/Operations/SetWorkspaceFeatureFlagsResponse.md
- docs/Models/Operations/SuggestItemsResponse.md
- docs/Models/Operations/SuggestOpenAPIRegistryRequest.md
- docs/Models/Operations/SuggestOpenAPIRegistryResponse.md
Expand Down Expand Up @@ -189,6 +190,7 @@ generatedFiles:
- docs/Models/Shared/OrganizationUsageResponse.md
- docs/Models/Shared/PreflightRequest.md
- docs/Models/Shared/PreflightToken.md
- docs/Models/Shared/PullRequestMetadata.md
- docs/Models/Shared/Relationship.md
- docs/Models/Shared/RemoteDocument.md
- docs/Models/Shared/RemoteSource.md
Expand All @@ -215,6 +217,8 @@ generatedFiles:
- docs/Models/Shared/WorkflowDocument.md
- docs/Models/Shared/Workspace.md
- docs/Models/Shared/WorkspaceAndOrganization.md
- docs/Models/Shared/WorkspaceFeatureFlag.md
- docs/Models/Shared/WorkspaceFeatureFlagRequest.md
- docs/Models/Shared/WorkspaceFeatureFlagResponse.md
- docs/Models/Shared/WorkspaceInviteResponse.md
- docs/Models/Shared/WorkspaceSettings.md
Expand Down Expand Up @@ -360,6 +364,7 @@ generatedFiles:
- src/Models/Operations/SetVisibilityRequest.php
- src/Models/Operations/SetVisibilityRequestBody.php
- src/Models/Operations/SetVisibilityResponse.php
- src/Models/Operations/SetWorkspaceFeatureFlagsResponse.php
- src/Models/Operations/SuggestItemsResponse.php
- src/Models/Operations/SuggestOpenAPIRegistryRequest.php
- src/Models/Operations/SuggestOpenAPIRegistryResponse.php
Expand Down Expand Up @@ -420,6 +425,7 @@ generatedFiles:
- src/Models/Shared/OrganizationUsageResponse.php
- src/Models/Shared/PreflightRequest.php
- src/Models/Shared/PreflightToken.php
- src/Models/Shared/PullRequestMetadata.php
- src/Models/Shared/Relationship.php
- src/Models/Shared/RemoteDocument.php
- src/Models/Shared/RemoteSource.php
Expand All @@ -446,6 +452,8 @@ generatedFiles:
- src/Models/Shared/WorkflowDocument.php
- src/Models/Shared/Workspace.php
- src/Models/Shared/WorkspaceAndOrganization.php
- src/Models/Shared/WorkspaceFeatureFlag.php
- src/Models/Shared/WorkspaceFeatureFlagRequest.php
- src/Models/Shared/WorkspaceFeatureFlagResponse.php
- src/Models/Shared/WorkspaceInviteResponse.php
- src/Models/Shared/WorkspaceSettings.php
Expand Down Expand Up @@ -1699,4 +1707,13 @@ examples:
application/json: {"snippets": [{"code": "<value>", "language": "<value>", "operationId": "<id>"}, {"code": "<value>", "language": "<value>", "operationId": "<id>"}, {"code": "<value>", "language": "<value>", "operationId": "<id>"}]}
4XX:
application/json: {"message": "<value>", "status_code": 458049}
setWorkspaceFeatureFlags:
speakeasy-default-set-workspace-feature-flags:
requestBody:
application/json: {"feature_flags": ["skip_schema_registry", "webhooks"]}
responses:
"200":
application/json: {}
5XX:
application/json: {"message": "<value>", "status_code": 264889}
generatedTests: {}
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.47.0
version: 0.47.1
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.462.2
speakeasyVersion: 1.467.0
sources:
my-source:
sourceNamespace: my-source
sourceRevisionDigest: sha256:7b9fb099237d1f7df25f0e38cafedf3088749c59a436195b614812771bcfc4a5
sourceBlobDigest: sha256:e7aec57fcab24b90b71218efd6d6ddec717e6187121af68b9910031461f3d529
sourceRevisionDigest: sha256:b5af2ed48f211d3e3697888ebd8f0ef71934aa86bb45165e660960c07554ce07
sourceBlobDigest: sha256:952a58da1511e3191ea8e470c7f01a4e3785d11d9152f490a3e5a7173c8542e7
tags:
- latest
- speakeasy-sdk-regen-1735949733
- speakeasy-sdk-regen-1736468190
- 0.4.0
targets:
php-target:
source: my-source
sourceNamespace: my-source
sourceRevisionDigest: sha256:7b9fb099237d1f7df25f0e38cafedf3088749c59a436195b614812771bcfc4a5
sourceBlobDigest: sha256:e7aec57fcab24b90b71218efd6d6ddec717e6187121af68b9910031461f3d529
sourceRevisionDigest: sha256:b5af2ed48f211d3e3697888ebd8f0ef71934aa86bb45165e660960c07554ce07
sourceBlobDigest: sha256:952a58da1511e3191ea8e470c7f01a4e3785d11d9152f490a3e5a7173c8542e7
codeSamplesNamespace: my-source-php-code-samples
codeSamplesRevisionDigest: sha256:49ec0f280d745c12c334dda94a0f77f6a3f8c3aa7d0bd4a5f178b5edc0899fd7
codeSamplesRevisionDigest: sha256:397048d739633fe9fb487ef719337a73337410da205a46bea58d85d8a1a22f64
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
120 changes: 91 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,64 @@ require 'vendor/autoload.php';
use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
$sdk = SpeakeasyClientSDK\SDK::builder()
->setSecurity(
new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
)
)
->build();

$request = new Shared\RemoteSource(
inputs: [
new Shared\RemoteDocument(
registryUrl: 'https://productive-swine.net',
),
],
output: new Shared\RemoteDocument(
registryUrl: 'https://spiteful-apricot.info',
),
);

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

if ($response->statusCode === 200) {
// handle response
}
```
<!-- End SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme |
| --------------------- | ------ | ----------- |
| `apiKey` | apiKey | API key |
| `bearer` | http | HTTP Bearer |
| `workspaceIdentifier` | apiKey | API key |

You can set the security parameters through the `setSecurity` function on the `SDKBuilder` when initializing the SDK. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```php
declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$sdk = SpeakeasyClientSDK\SDK::builder()
->setSecurity(
new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
)
)
->build();

$request = new Shared\RemoteSource(
inputs: [
Expand All @@ -49,7 +102,7 @@ if ($response->statusCode === 200) {
// handle response
}
```
<!-- End SDK Example Usage [usage] -->
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
Expand Down Expand Up @@ -151,6 +204,7 @@ if ($response->statusCode === 200) {
* [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
* [setFeatureFlags](docs/sdks/workspaces/README.md#setfeatureflags) - Set workspace feature flags
* [update](docs/sdks/workspaces/README.md#update) - Update workspace details
* [updateSettings](docs/sdks/workspaces/README.md#updatesettings) - Update workspace settings

Expand Down Expand Up @@ -217,11 +271,13 @@ use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;
use Speakeasy\SpeakeasyClientSDK\Utils\Retry;

$security = new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
$sdk = SpeakeasyClientSDK\SDK::builder()
->setSecurity(
new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
)
)
->build();

$request = new Operations\GetWorkspaceAccessRequest();

Expand Down Expand Up @@ -253,10 +309,6 @@ use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;
use Speakeasy\SpeakeasyClientSDK\Utils\Retry;

$security = new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()
->setRetryConfig(
new Retry\RetryConfigBackoff(
Expand All @@ -267,7 +319,12 @@ $sdk = SpeakeasyClientSDK\SDK::builder()
retryConnectionErrors: false,
)
)
->setSecurity($security)->build();
->setSecurity(
new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
)
)
->build();

$request = new Operations\GetWorkspaceAccessRequest();

Expand Down Expand Up @@ -312,11 +369,13 @@ require 'vendor/autoload.php';
use Speakeasy\SpeakeasyClientSDK;
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()
->setSecurity(
new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
)
)
->build();

try {
$request = new Shared\RemoteSource(
Expand Down Expand Up @@ -368,13 +427,14 @@ require 'vendor/autoload.php';
use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()
->setServer("prod")
->setSecurity($security)->build();
->setSecurity(
new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
)
)
->build();

$request = new Shared\RemoteSource(
inputs: [
Expand Down Expand Up @@ -407,13 +467,14 @@ require 'vendor/autoload.php';
use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()
->setServerURL('https://api.prod.speakeasyapi.dev')
->setSecurity($security)->build();
->setSecurity(
new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
)
)
->build();

$request = new Shared\RemoteSource(
inputs: [
Expand Down Expand Up @@ -450,6 +511,7 @@ For more information about the API: [The Speakeasy Platform Documentation](/docs
* [speakeasy-api/speakeasy-client-sdk-php](#speakeasy-apispeakeasy-client-sdk-php)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
* [Global Parameters](#global-parameters)
* [Retries](#retries)
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -1554,4 +1554,14 @@ Based on:
### Generated
- [php v0.47.0] .
### Releases
- [Composer v0.47.0] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.47.0 - .
- [Composer v0.47.0] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.47.0 - .

## 2025-01-10 00:16:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.467.0 (2.492.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [php v0.47.1] .
### Releases
- [Composer v0.47.1] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.47.1 - .
12 changes: 7 additions & 5 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ require 'vendor/autoload.php';
use Speakeasy\SpeakeasyClientSDK;
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()
->setSecurity(
new Shared\Security(
apiKey: '<YOUR_API_KEY_HERE>',
)
)
->build();

$request = new Shared\RemoteSource(
inputs: [
Expand Down
3 changes: 1 addition & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@
},
"require-dev": {
"laravel/pint": "^1.18.1",
"phpstan/phpstan": "^1.12",
"phpstan/phpstan": "^2.1.0",
"phpunit/phpunit": "^10",
"rector/rector": "^0.19",
"roave/security-advisories": "dev-latest"
},
"minimum-stability": "stable",
Expand Down
11 changes: 11 additions & 0 deletions docs/Models/Operations/SetWorkspaceFeatureFlagsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SetWorkspaceFeatureFlagsResponse


## 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 |
| `workspaceFeatureFlagResponse` | [?Shared\WorkspaceFeatureFlagResponse](../../Models/Shared/WorkspaceFeatureFlagResponse.md) | :heavy_minus_sign: | Success |
8 changes: 4 additions & 4 deletions docs/Models/Shared/FeatureFlag.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A feature flag is a key-value pair that can be used to enable or disable feature

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `featureFlag` | *string* | :heavy_check_mark: | N/A |
| `trialEndsAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| `featureFlag` | [Shared\WorkspaceFeatureFlag](../../Models/Shared/WorkspaceFeatureFlag.md) | :heavy_check_mark: | enum value workspace feature flag |
| `trialEndsAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A |
Loading

0 comments on commit 94a131f

Please sign in to comment.