Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.24.0
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot committed Apr 26, 2023
1 parent 8577e0f commit de8a37a
Show file tree
Hide file tree
Showing 4 changed files with 150 additions and 6 deletions.
136 changes: 136 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
# speakeasy-api/speakeasy-client-sdk-php

<!-- Start SDK Installation -->
## SDK Installation

### Composer

```bash
composer require "speakeasy-api/speakeasy-client-sdk-php"
```
<!-- End SDK Installation -->

## SDK Example Usage
<!-- Start SDK Example Usage -->
```php
<?php

declare(strict_types=1);
require_once 'vendor/autoload.php';

use \Speakeasy\SpeakeasyClientSDK\SDK;
use \Speakeasy\SpeakeasyClientSDK\Models\Shared\Security;
use \Speakeasy\SpeakeasyClientSDK\Models\Operations\GetApisRequest;
use \Speakeasy\SpeakeasyClientSDK\Models\Operations\GetApisOp;

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

try {
$request = new GetApisRequest();
$request->metadata = [
'provident' => [
'quibusdam',
'unde',
'nulla',
],
'corrupti' => [
'vel',
'error',
'deserunt',
'suscipit',
],
'iure' => [
'debitis',
'ipsa',
],
];
$request->op = new GetApisOp();
$request->op->and = false;

$response = $sdk->apis->getApis($request);

if ($response->apis !== null) {
// handle response
}
} catch (Exception $e) {
// handle exception
}
```
<!-- End SDK Example Usage -->

<!-- Start SDK Available Operations -->
## Available Resources and Operations

### [SDK](docs/sdk/README.md)

* [validateApiKey](docs/sdk/README.md#validateapikey) - Validate the current api key.

### [apiEndpoints](docs/apiendpoints/README.md)

* [deleteApiEndpoint](docs/apiendpoints/README.md#deleteapiendpoint) - Delete an ApiEndpoint.
* [findApiEndpoint](docs/apiendpoints/README.md#findapiendpoint) - Find an ApiEndpoint via its displayName.
* [generateOpenApiSpecForApiEndpoint](docs/apiendpoints/README.md#generateopenapispecforapiendpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
* [generatePostmanCollectionForApiEndpoint](docs/apiendpoints/README.md#generatepostmancollectionforapiendpoint) - Generate a Postman collection for a particular ApiEndpoint.
* [getAllApiEndpoints](docs/apiendpoints/README.md#getallapiendpoints) - Get all Api endpoints for a particular apiID.
* [getAllForVersionApiEndpoints](docs/apiendpoints/README.md#getallforversionapiendpoints) - Get all ApiEndpoints for a particular apiID and versionID.
* [getApiEndpoint](docs/apiendpoints/README.md#getapiendpoint) - Get an ApiEndpoint.
* [upsertApiEndpoint](docs/apiendpoints/README.md#upsertapiendpoint) - Upsert an ApiEndpoint.

### [apis](docs/apis/README.md)

* [deleteApi](docs/apis/README.md#deleteapi) - Delete an Api.
* [generateOpenApiSpec](docs/apis/README.md#generateopenapispec) - Generate an OpenAPI specification for a particular Api.
* [generatePostmanCollection](docs/apis/README.md#generatepostmancollection) - Generate a Postman collection for a particular Api.
* [getAllApiVersions](docs/apis/README.md#getallapiversions) - Get all Api versions for a particular ApiEndpoint.
* [getApis](docs/apis/README.md#getapis) - Get a list of Apis for a given workspace
* [upsertApi](docs/apis/README.md#upsertapi) - Upsert an Api

### [embeds](docs/embeds/README.md)

* [getEmbedAccessToken](docs/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
* [getValidEmbedAccessTokens](docs/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
* [revokeEmbedAccessToken](docs/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.

### [metadata](docs/metadata/README.md)

* [deleteVersionMetadata](docs/metadata/README.md#deleteversionmetadata) - Delete metadata for a particular apiID and versionID.
* [getVersionMetadata](docs/metadata/README.md#getversionmetadata) - Get all metadata for a particular apiID and versionID.
* [insertVersionMetadata](docs/metadata/README.md#insertversionmetadata) - Insert metadata for a particular apiID and versionID.

### [plugins](docs/plugins/README.md)

* [getPlugins](docs/plugins/README.md#getplugins) - Get all plugins for the current workspace.
* [runPlugin](docs/plugins/README.md#runplugin) - Run a plugin
* [upsertPlugin](docs/plugins/README.md#upsertplugin) - Upsert a plugin

### [requests](docs/requests/README.md)

* [generateRequestPostmanCollection](docs/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
* [getRequestFromEventLog](docs/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
* [queryEventLog](docs/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.

### [schemas](docs/schemas/README.md)

* [deleteSchema](docs/schemas/README.md#deleteschema) - Delete a particular schema revision for an Api.
* [downloadSchema](docs/schemas/README.md#downloadschema) - Download the latest schema for a particular apiID.
* [downloadSchemaRevision](docs/schemas/README.md#downloadschemarevision) - Download a particular schema revision for an Api.
* [getSchema](docs/schemas/README.md#getschema) - Get information about the latest schema.
* [getSchemaDiff](docs/schemas/README.md#getschemadiff) - Get a diff of two schema revisions for an Api.
* [getSchemaRevision](docs/schemas/README.md#getschemarevision) - Get information about a particular schema revision for an Api.
* [getSchemas](docs/schemas/README.md#getschemas) - Get information about all schemas associated with a particular apiID.
* [registerSchema](docs/schemas/README.md#registerschema) - Register a schema.
<!-- End SDK Available Operations -->

### Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.

### Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
10 changes: 9 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,4 +302,12 @@ Based on:
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
- Speakeasy CLI 1.23.1 (2.21.1) https://github.com/speakeasy-api/speakeasy
### Releases
- [Composer v0.15.1] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.15.1 - .
- [Composer v0.15.1] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.15.1 - .

## 2023-04-26 09:35:18
### Changes
Based on:
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
- Speakeasy CLI 1.24.0 (2.21.2) https://github.com/speakeasy-api/speakeasy
### Releases
- [Composer v0.15.2] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.15.2 - .
6 changes: 3 additions & 3 deletions gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ configVersion: 1.0.0
management:
docChecksum: 2bba3b8f9d211b02569b3f9aff0d34b4
docVersion: 0.3.0
speakeasyVersion: 1.23.1
generationVersion: 2.21.1
speakeasyVersion: 1.24.0
generationVersion: 2.21.2
generation:
telemetryEnabled: true
sdkClassName: SDK
singleTagPerOp: false
php:
version: 0.15.1
version: 0.15.2
namespace: Speakeasy\SpeakeasyClientSDK
packageName: speakeasy-api/speakeasy-client-sdk-php
4 changes: 2 additions & 2 deletions src/SDK.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ class SDK
private ?Models\Shared\Security $_security;
private string $_serverUrl;
private string $_language = 'php';
private string $_sdkVersion = '0.15.1';
private string $_genVersion = '2.21.1';
private string $_sdkVersion = '0.15.2';
private string $_genVersion = '2.21.2';

/**
* Returns a new instance of the SDK builder used to configure and create the SDK instance.
Expand Down

0 comments on commit de8a37a

Please sign in to comment.