From ece9cfe475b9a5f803d55f4a7b819e592d8b4435 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 25 Apr 2023 14:45:40 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.23.1 --- README.md | 114 +++++-- RELEASES.md | 10 +- docs/apiendpoints/README.md | 306 +++++++++++++++++- docs/apiendpoints/deleteapiendpoint.md | 34 -- docs/apiendpoints/findapiendpoint.md | 35 -- .../generateopenapispecforapiendpoint.md | 35 -- ...generatepostmancollectionforapiendpoint.md | 34 -- docs/apiendpoints/getallapiendpoints.md | 32 -- .../getallforversionapiendpoints.md | 33 -- docs/apiendpoints/getapiendpoint.md | 34 -- docs/apiendpoints/upsertapiendpoint.md | 42 --- docs/apis/README.md | 269 ++++++++++++++- docs/apis/deleteapi.md | 33 -- docs/apis/generateopenapispec.md | 34 -- docs/apis/generatepostmancollection.md | 33 -- docs/apis/getallapiversions.md | 50 --- docs/apis/getapis.md | 46 --- docs/apis/upsertapi.md | 52 --- docs/embeds/README.md | 115 ++++++- docs/embeds/getembedaccesstoken.md | 43 --- docs/embeds/getvalidembedaccesstokens.md | 28 -- docs/embeds/revokeembedaccesstoken.md | 32 -- docs/metadata/README.md | 117 ++++++- docs/metadata/deleteversionmetadata.md | 35 -- docs/metadata/getversionmetadata.md | 33 -- docs/metadata/insertversionmetadata.md | 37 --- docs/plugins/README.md | 121 ++++++- docs/plugins/getplugins.md | 28 -- docs/plugins/runplugin.md | 43 --- docs/plugins/upsertplugin.md | 38 --- docs/requests/README.md | 120 ++++++- .../generaterequestpostmancollection.md | 33 -- docs/requests/getrequestfromeventlog.md | 32 -- docs/requests/queryeventlog.md | 43 --- docs/schemas/README.md | 306 +++++++++++++++++- docs/schemas/deleteschema.md | 34 -- docs/schemas/downloadschema.md | 33 -- docs/schemas/downloadschemarevision.md | 34 -- docs/schemas/getschema.md | 34 -- docs/schemas/getschemadiff.md | 35 -- docs/schemas/getschemarevision.md | 35 -- docs/schemas/getschemas.md | 34 -- docs/schemas/registerschema.md | 40 --- docs/sdk/README.md | 34 +- docs/sdk/validateapikey.md | 28 -- files.gen | 35 -- gen.yaml | 6 +- src/SDK.php | 4 +- 48 files changed, 1446 insertions(+), 1370 deletions(-) delete mode 100755 docs/apiendpoints/deleteapiendpoint.md delete mode 100755 docs/apiendpoints/findapiendpoint.md delete mode 100755 docs/apiendpoints/generateopenapispecforapiendpoint.md delete mode 100755 docs/apiendpoints/generatepostmancollectionforapiendpoint.md delete mode 100755 docs/apiendpoints/getallapiendpoints.md delete mode 100755 docs/apiendpoints/getallforversionapiendpoints.md delete mode 100755 docs/apiendpoints/getapiendpoint.md delete mode 100755 docs/apiendpoints/upsertapiendpoint.md delete mode 100755 docs/apis/deleteapi.md delete mode 100755 docs/apis/generateopenapispec.md delete mode 100755 docs/apis/generatepostmancollection.md delete mode 100755 docs/apis/getallapiversions.md delete mode 100755 docs/apis/getapis.md delete mode 100755 docs/apis/upsertapi.md delete mode 100755 docs/embeds/getembedaccesstoken.md delete mode 100755 docs/embeds/getvalidembedaccesstokens.md delete mode 100755 docs/embeds/revokeembedaccesstoken.md delete mode 100755 docs/metadata/deleteversionmetadata.md delete mode 100755 docs/metadata/getversionmetadata.md delete mode 100755 docs/metadata/insertversionmetadata.md delete mode 100755 docs/plugins/getplugins.md delete mode 100755 docs/plugins/runplugin.md delete mode 100755 docs/plugins/upsertplugin.md delete mode 100755 docs/requests/generaterequestpostmancollection.md delete mode 100755 docs/requests/getrequestfromeventlog.md delete mode 100755 docs/requests/queryeventlog.md delete mode 100755 docs/schemas/deleteschema.md delete mode 100755 docs/schemas/downloadschema.md delete mode 100755 docs/schemas/downloadschemarevision.md delete mode 100755 docs/schemas/getschema.md delete mode 100755 docs/schemas/getschemadiff.md delete mode 100755 docs/schemas/getschemarevision.md delete mode 100755 docs/schemas/getschemas.md delete mode 100755 docs/schemas/registerschema.md delete mode 100755 docs/sdk/validateapikey.md diff --git a/README.md b/README.md index 4adb4cf..56db884 100755 --- a/README.md +++ b/README.md @@ -304,6 +304,50 @@ 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 +} +``````php +build(); @@ -346,62 +390,62 @@ try { ### [SDK](docs/sdk/README.md) -* [validateApiKey](docs/sdk/validateapikey.md) - Validate the current api key. +* [validateApiKey](docs/sdk/README.md#validateapikey) - Validate the current api key. ### [apiEndpoints](docs/apiendpoints/README.md) -* [deleteApiEndpoint](docs/apiendpoints/deleteapiendpoint.md) - Delete an ApiEndpoint. -* [findApiEndpoint](docs/apiendpoints/findapiendpoint.md) - Find an ApiEndpoint via its displayName. -* [generateOpenApiSpecForApiEndpoint](docs/apiendpoints/generateopenapispecforapiendpoint.md) - Generate an OpenAPI specification for a particular ApiEndpoint. -* [generatePostmanCollectionForApiEndpoint](docs/apiendpoints/generatepostmancollectionforapiendpoint.md) - Generate a Postman collection for a particular ApiEndpoint. -* [getAllApiEndpoints](docs/apiendpoints/getallapiendpoints.md) - Get all Api endpoints for a particular apiID. -* [getAllForVersionApiEndpoints](docs/apiendpoints/getallforversionapiendpoints.md) - Get all ApiEndpoints for a particular apiID and versionID. -* [getApiEndpoint](docs/apiendpoints/getapiendpoint.md) - Get an ApiEndpoint. -* [upsertApiEndpoint](docs/apiendpoints/upsertapiendpoint.md) - Upsert an ApiEndpoint. +* [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/deleteapi.md) - Delete an Api. -* [generateOpenApiSpec](docs/apis/generateopenapispec.md) - Generate an OpenAPI specification for a particular Api. -* [generatePostmanCollection](docs/apis/generatepostmancollection.md) - Generate a Postman collection for a particular Api. -* [getAllApiVersions](docs/apis/getallapiversions.md) - Get all Api versions for a particular ApiEndpoint. -* [getApis](docs/apis/getapis.md) - Get a list of Apis for a given workspace -* [upsertApi](docs/apis/upsertapi.md) - Upsert an Api +* [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/getembedaccesstoken.md) - Get an embed access token for the current workspace. -* [getValidEmbedAccessTokens](docs/embeds/getvalidembedaccesstokens.md) - Get all valid embed access tokens for the current workspace. -* [revokeEmbedAccessToken](docs/embeds/revokeembedaccesstoken.md) - Revoke an embed access EmbedToken. +* [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/deleteversionmetadata.md) - Delete metadata for a particular apiID and versionID. -* [getVersionMetadata](docs/metadata/getversionmetadata.md) - Get all metadata for a particular apiID and versionID. -* [insertVersionMetadata](docs/metadata/insertversionmetadata.md) - Insert metadata for a particular apiID and versionID. +* [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/getplugins.md) - Get all plugins for the current workspace. -* [runPlugin](docs/plugins/runplugin.md) - Run a plugin -* [upsertPlugin](docs/plugins/upsertplugin.md) - Upsert a plugin +* [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/generaterequestpostmancollection.md) - Generate a Postman collection for a particular request. -* [getRequestFromEventLog](docs/requests/getrequestfromeventlog.md) - Get information about a particular request. -* [queryEventLog](docs/requests/queryeventlog.md) - Query the event log to retrieve a list of requests. +* [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/deleteschema.md) - Delete a particular schema revision for an Api. -* [downloadSchema](docs/schemas/downloadschema.md) - Download the latest schema for a particular apiID. -* [downloadSchemaRevision](docs/schemas/downloadschemarevision.md) - Download a particular schema revision for an Api. -* [getSchema](docs/schemas/getschema.md) - Get information about the latest schema. -* [getSchemaDiff](docs/schemas/getschemadiff.md) - Get a diff of two schema revisions for an Api. -* [getSchemaRevision](docs/schemas/getschemarevision.md) - Get information about a particular schema revision for an Api. -* [getSchemas](docs/schemas/getschemas.md) - Get information about all schemas associated with a particular apiID. -* [registerSchema](docs/schemas/registerschema.md) - Register a schema. +* [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. ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) diff --git a/RELEASES.md b/RELEASES.md index 72340a4..6c3b17f 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -294,4 +294,12 @@ Based on: - OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml - Speakeasy CLI 1.23.0 (2.21.0) https://github.com/speakeasy-api/speakeasy ### Releases -- [Composer v0.15.0] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.15.0 - . \ No newline at end of file +- [Composer v0.15.0] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.15.0 - . + +## 2023-04-25 14:45:30 +### Changes +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 - . \ No newline at end of file diff --git a/docs/apiendpoints/README.md b/docs/apiendpoints/README.md index e3794b9..ba72696 100755 --- a/docs/apiendpoints/README.md +++ b/docs/apiendpoints/README.md @@ -1,13 +1,303 @@ # apiEndpoints +## Overview + REST APIs for managing ApiEndpoint entities +### Available Operations + +* [deleteApiEndpoint](#deleteapiendpoint) - Delete an ApiEndpoint. +* [findApiEndpoint](#findapiendpoint) - Find an ApiEndpoint via its displayName. +* [generateOpenApiSpecForApiEndpoint](#generateopenapispecforapiendpoint) - Generate an OpenAPI specification for a particular ApiEndpoint. +* [generatePostmanCollectionForApiEndpoint](#generatepostmancollectionforapiendpoint) - Generate a Postman collection for a particular ApiEndpoint. +* [getAllApiEndpoints](#getallapiendpoints) - Get all Api endpoints for a particular apiID. +* [getAllForVersionApiEndpoints](#getallforversionapiendpoints) - Get all ApiEndpoints for a particular apiID and versionID. +* [getApiEndpoint](#getapiendpoint) - Get an ApiEndpoint. +* [upsertApiEndpoint](#upsertapiendpoint) - Upsert an ApiEndpoint. + +## deleteApiEndpoint + +Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore). + +### Example Usage + +```php +build(); + +try { + $request = new DeleteApiEndpointRequest(); + $request->apiEndpointID = 'delectus'; + $request->apiID = 'tempora'; + $request->versionID = 'suscipit'; + + $response = $sdk->apiEndpoints->deleteApiEndpoint($request); + + if ($response->statusCode === 200) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## findApiEndpoint + +Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema). +This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints. + +### Example Usage + +```php +build(); + +try { + $request = new FindApiEndpointRequest(); + $request->apiID = 'molestiae'; + $request->displayName = 'minus'; + $request->versionID = 'placeat'; + + $response = $sdk->apiEndpoints->findApiEndpoint($request); + + if ($response->apiEndpoint !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## generateOpenApiSpecForApiEndpoint + +This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document. +Returns the original document and the newly generated document allowing a diff to be performed to see what has changed. + +### Example Usage + +```php +build(); + +try { + $request = new GenerateOpenApiSpecForApiEndpointRequest(); + $request->apiEndpointID = 'voluptatum'; + $request->apiID = 'iusto'; + $request->versionID = 'excepturi'; + + $response = $sdk->apiEndpoints->generateOpenApiSpecForApiEndpoint($request); + + if ($response->generateOpenApiSpecDiff !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## generatePostmanCollectionForApiEndpoint + +Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document. + +### Example Usage + +```php +build(); + +try { + $request = new GeneratePostmanCollectionForApiEndpointRequest(); + $request->apiEndpointID = 'nisi'; + $request->apiID = 'recusandae'; + $request->versionID = 'temporibus'; + + $response = $sdk->apiEndpoints->generatePostmanCollectionForApiEndpoint($request); + + if ($response->postmanCollection !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getAllApiEndpoints + +Get all Api endpoints for a particular apiID. + +### Example Usage + +```php +build(); + +try { + $request = new GetAllApiEndpointsRequest(); + $request->apiID = 'ab'; + + $response = $sdk->apiEndpoints->getAllApiEndpoints($request); + + if ($response->apiEndpoints !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getAllForVersionApiEndpoints + +Get all ApiEndpoints for a particular apiID and versionID. + +### Example Usage + +```php +build(); + +try { + $request = new GetAllForVersionApiEndpointsRequest(); + $request->apiID = 'quis'; + $request->versionID = 'veritatis'; + + $response = $sdk->apiEndpoints->getAllForVersionApiEndpoints($request); + + if ($response->apiEndpoints !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getApiEndpoint + +Get an ApiEndpoint. + +### Example Usage + +```php +build(); + +try { + $request = new GetApiEndpointRequest(); + $request->apiEndpointID = 'deserunt'; + $request->apiID = 'perferendis'; + $request->versionID = 'ipsam'; + + $response = $sdk->apiEndpoints->getApiEndpoint($request); + + if ($response->apiEndpoint !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## upsertApiEndpoint + +Upsert an ApiEndpoint. If the ApiEndpoint does not exist it will be created, otherwise it will be updated. + +### Example Usage + +```php +build(); + +try { + $request = new UpsertApiEndpointRequest(); + $request->apiEndpointInput = new ApiEndpointInput(); + $request->apiEndpointInput->apiEndpointId = 'repellendus'; + $request->apiEndpointInput->description = 'sapiente'; + $request->apiEndpointInput->displayName = 'quo'; + $request->apiEndpointInput->method = 'odit'; + $request->apiEndpointInput->path = 'at'; + $request->apiEndpointInput->versionId = 'at'; + $request->apiEndpointID = 'maiores'; + $request->apiID = 'molestiae'; + $request->versionID = 'quod'; + + $response = $sdk->apiEndpoints->upsertApiEndpoint($request); -* [deleteApiEndpoint](deleteapiendpoint.md) - Delete an ApiEndpoint. -* [findApiEndpoint](findapiendpoint.md) - Find an ApiEndpoint via its displayName. -* [generateOpenApiSpecForApiEndpoint](generateopenapispecforapiendpoint.md) - Generate an OpenAPI specification for a particular ApiEndpoint. -* [generatePostmanCollectionForApiEndpoint](generatepostmancollectionforapiendpoint.md) - Generate a Postman collection for a particular ApiEndpoint. -* [getAllApiEndpoints](getallapiendpoints.md) - Get all Api endpoints for a particular apiID. -* [getAllForVersionApiEndpoints](getallforversionapiendpoints.md) - Get all ApiEndpoints for a particular apiID and versionID. -* [getApiEndpoint](getapiendpoint.md) - Get an ApiEndpoint. -* [upsertApiEndpoint](upsertapiendpoint.md) - Upsert an ApiEndpoint. \ No newline at end of file + if ($response->apiEndpoint !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` diff --git a/docs/apiendpoints/deleteapiendpoint.md b/docs/apiendpoints/deleteapiendpoint.md deleted file mode 100755 index 3e6de83..0000000 --- a/docs/apiendpoints/deleteapiendpoint.md +++ /dev/null @@ -1,34 +0,0 @@ -# deleteApiEndpoint -Available in: `apiEndpoints` - -Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore). - -## Example Usage -```php -build(); - -try { - $request = new DeleteApiEndpointRequest(); - $request->apiEndpointID = 'delectus'; - $request->apiID = 'tempora'; - $request->versionID = 'suscipit'; - - $response = $sdk->apiEndpoints->deleteApiEndpoint($request); - - if ($response->statusCode === 200) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apiendpoints/findapiendpoint.md b/docs/apiendpoints/findapiendpoint.md deleted file mode 100755 index 452ac52..0000000 --- a/docs/apiendpoints/findapiendpoint.md +++ /dev/null @@ -1,35 +0,0 @@ -# findApiEndpoint -Available in: `apiEndpoints` - -Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema). -This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints. - -## Example Usage -```php -build(); - -try { - $request = new FindApiEndpointRequest(); - $request->apiID = 'molestiae'; - $request->displayName = 'minus'; - $request->versionID = 'placeat'; - - $response = $sdk->apiEndpoints->findApiEndpoint($request); - - if ($response->apiEndpoint !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apiendpoints/generateopenapispecforapiendpoint.md b/docs/apiendpoints/generateopenapispecforapiendpoint.md deleted file mode 100755 index bef621f..0000000 --- a/docs/apiendpoints/generateopenapispecforapiendpoint.md +++ /dev/null @@ -1,35 +0,0 @@ -# generateOpenApiSpecForApiEndpoint -Available in: `apiEndpoints` - -This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document. -Returns the original document and the newly generated document allowing a diff to be performed to see what has changed. - -## Example Usage -```php -build(); - -try { - $request = new GenerateOpenApiSpecForApiEndpointRequest(); - $request->apiEndpointID = 'voluptatum'; - $request->apiID = 'iusto'; - $request->versionID = 'excepturi'; - - $response = $sdk->apiEndpoints->generateOpenApiSpecForApiEndpoint($request); - - if ($response->generateOpenApiSpecDiff !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apiendpoints/generatepostmancollectionforapiendpoint.md b/docs/apiendpoints/generatepostmancollectionforapiendpoint.md deleted file mode 100755 index 709f9ad..0000000 --- a/docs/apiendpoints/generatepostmancollectionforapiendpoint.md +++ /dev/null @@ -1,34 +0,0 @@ -# generatePostmanCollectionForApiEndpoint -Available in: `apiEndpoints` - -Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document. - -## Example Usage -```php -build(); - -try { - $request = new GeneratePostmanCollectionForApiEndpointRequest(); - $request->apiEndpointID = 'nisi'; - $request->apiID = 'recusandae'; - $request->versionID = 'temporibus'; - - $response = $sdk->apiEndpoints->generatePostmanCollectionForApiEndpoint($request); - - if ($response->postmanCollection !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apiendpoints/getallapiendpoints.md b/docs/apiendpoints/getallapiendpoints.md deleted file mode 100755 index 563e5e1..0000000 --- a/docs/apiendpoints/getallapiendpoints.md +++ /dev/null @@ -1,32 +0,0 @@ -# getAllApiEndpoints -Available in: `apiEndpoints` - -Get all Api endpoints for a particular apiID. - -## Example Usage -```php -build(); - -try { - $request = new GetAllApiEndpointsRequest(); - $request->apiID = 'ab'; - - $response = $sdk->apiEndpoints->getAllApiEndpoints($request); - - if ($response->apiEndpoints !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apiendpoints/getallforversionapiendpoints.md b/docs/apiendpoints/getallforversionapiendpoints.md deleted file mode 100755 index 324cf79..0000000 --- a/docs/apiendpoints/getallforversionapiendpoints.md +++ /dev/null @@ -1,33 +0,0 @@ -# getAllForVersionApiEndpoints -Available in: `apiEndpoints` - -Get all ApiEndpoints for a particular apiID and versionID. - -## Example Usage -```php -build(); - -try { - $request = new GetAllForVersionApiEndpointsRequest(); - $request->apiID = 'quis'; - $request->versionID = 'veritatis'; - - $response = $sdk->apiEndpoints->getAllForVersionApiEndpoints($request); - - if ($response->apiEndpoints !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apiendpoints/getapiendpoint.md b/docs/apiendpoints/getapiendpoint.md deleted file mode 100755 index 62b17f8..0000000 --- a/docs/apiendpoints/getapiendpoint.md +++ /dev/null @@ -1,34 +0,0 @@ -# getApiEndpoint -Available in: `apiEndpoints` - -Get an ApiEndpoint. - -## Example Usage -```php -build(); - -try { - $request = new GetApiEndpointRequest(); - $request->apiEndpointID = 'deserunt'; - $request->apiID = 'perferendis'; - $request->versionID = 'ipsam'; - - $response = $sdk->apiEndpoints->getApiEndpoint($request); - - if ($response->apiEndpoint !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apiendpoints/upsertapiendpoint.md b/docs/apiendpoints/upsertapiendpoint.md deleted file mode 100755 index 542c76a..0000000 --- a/docs/apiendpoints/upsertapiendpoint.md +++ /dev/null @@ -1,42 +0,0 @@ -# upsertApiEndpoint -Available in: `apiEndpoints` - -Upsert an ApiEndpoint. If the ApiEndpoint does not exist it will be created, otherwise it will be updated. - -## Example Usage -```php -build(); - -try { - $request = new UpsertApiEndpointRequest(); - $request->apiEndpointInput = new ApiEndpointInput(); - $request->apiEndpointInput->apiEndpointId = 'repellendus'; - $request->apiEndpointInput->description = 'sapiente'; - $request->apiEndpointInput->displayName = 'quo'; - $request->apiEndpointInput->method = 'odit'; - $request->apiEndpointInput->path = 'at'; - $request->apiEndpointInput->versionId = 'at'; - $request->apiEndpointID = 'maiores'; - $request->apiID = 'molestiae'; - $request->versionID = 'quod'; - - $response = $sdk->apiEndpoints->upsertApiEndpoint($request); - - if ($response->apiEndpoint !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apis/README.md b/docs/apis/README.md index f41c05e..163c0d0 100755 --- a/docs/apis/README.md +++ b/docs/apis/README.md @@ -1,11 +1,268 @@ # apis +## Overview + REST APIs for managing Api entities +### Available Operations + +* [deleteApi](#deleteapi) - Delete an Api. +* [generateOpenApiSpec](#generateopenapispec) - Generate an OpenAPI specification for a particular Api. +* [generatePostmanCollection](#generatepostmancollection) - Generate a Postman collection for a particular Api. +* [getAllApiVersions](#getallapiversions) - Get all Api versions for a particular ApiEndpoint. +* [getApis](#getapis) - Get a list of Apis for a given workspace +* [upsertApi](#upsertapi) - Upsert an Api + +## deleteApi + +Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore). + +### Example Usage + +```php +build(); + +try { + $request = new DeleteApiRequest(); + $request->apiID = 'quod'; + $request->versionID = 'esse'; + + $response = $sdk->apis->deleteApi($request); + + if ($response->statusCode === 200) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## generateOpenApiSpec + +This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document. +Returns the original document and the newly generated document allowing a diff to be performed to see what has changed. + +### Example Usage + +```php +build(); + +try { + $request = new GenerateOpenApiSpecRequest(); + $request->apiID = 'totam'; + $request->versionID = 'porro'; + + $response = $sdk->apis->generateOpenApiSpec($request); + + if ($response->generateOpenApiSpecDiff !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## generatePostmanCollection + +Generates a postman collection containing all endpoints for a particular API. Includes variables produced for any path/query/header parameters included in the OpenAPI document. + +### Example Usage + +```php +build(); + +try { + $request = new GeneratePostmanCollectionRequest(); + $request->apiID = 'dolorum'; + $request->versionID = 'dicta'; + + $response = $sdk->apis->generatePostmanCollection($request); + + if ($response->postmanCollection !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getAllApiVersions + +Get all Api versions for a particular ApiEndpoint. +Supports filtering the versions based on metadata attributes. + +### Example Usage + +```php +build(); + +try { + $request = new GetAllApiVersionsRequest(); + $request->apiID = 'nam'; + $request->metadata = [ + 'occaecati' => [ + 'deleniti', + ], + 'hic' => [ + 'totam', + 'beatae', + 'commodi', + 'molestiae', + ], + 'modi' => [ + 'impedit', + ], + ]; + $request->op = new GetAllApiVersionsOp(); + $request->op->and = false; + + $response = $sdk->apis->getAllApiVersions($request); + + if ($response->apis !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getApis + +Get a list of all Apis and their versions for a given workspace. +Supports filtering the APIs based on metadata attributes. + +### Example Usage + +```php +build(); + +try { + $request = new GetApisRequest(); + $request->metadata = [ + 'esse' => [ + 'excepturi', + ], + 'aspernatur' => [ + 'ad', + ], + 'natus' => [ + 'iste', + ], + ]; + $request->op = new GetApisOp(); + $request->op->and = false; + + $response = $sdk->apis->getApis($request); + + if ($response->apis !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## upsertApi + +Upsert an Api. If the Api does not exist, it will be created. +If the Api exists, it will be updated. + +### Example Usage + +```php +build(); + +try { + $request = new UpsertApiRequest(); + $request->apiInput = new ApiInput(); + $request->apiInput->apiId = 'dolor'; + $request->apiInput->description = 'natus'; + $request->apiInput->metaData = [ + 'hic' => [ + 'fuga', + 'in', + 'corporis', + 'iste', + ], + 'iure' => [ + 'quidem', + 'architecto', + 'ipsa', + 'reiciendis', + ], + ]; + $request->apiInput->versionId = 'est'; + $request->apiID = 'mollitia'; + + $response = $sdk->apis->upsertApi($request); -* [deleteApi](deleteapi.md) - Delete an Api. -* [generateOpenApiSpec](generateopenapispec.md) - Generate an OpenAPI specification for a particular Api. -* [generatePostmanCollection](generatepostmancollection.md) - Generate a Postman collection for a particular Api. -* [getAllApiVersions](getallapiversions.md) - Get all Api versions for a particular ApiEndpoint. -* [getApis](getapis.md) - Get a list of Apis for a given workspace -* [upsertApi](upsertapi.md) - Upsert an Api \ No newline at end of file + if ($response->api !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` diff --git a/docs/apis/deleteapi.md b/docs/apis/deleteapi.md deleted file mode 100755 index f3685cb..0000000 --- a/docs/apis/deleteapi.md +++ /dev/null @@ -1,33 +0,0 @@ -# deleteApi -Available in: `apis` - -Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore). - -## Example Usage -```php -build(); - -try { - $request = new DeleteApiRequest(); - $request->apiID = 'quod'; - $request->versionID = 'esse'; - - $response = $sdk->apis->deleteApi($request); - - if ($response->statusCode === 200) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apis/generateopenapispec.md b/docs/apis/generateopenapispec.md deleted file mode 100755 index ee11fbb..0000000 --- a/docs/apis/generateopenapispec.md +++ /dev/null @@ -1,34 +0,0 @@ -# generateOpenApiSpec -Available in: `apis` - -This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document. -Returns the original document and the newly generated document allowing a diff to be performed to see what has changed. - -## Example Usage -```php -build(); - -try { - $request = new GenerateOpenApiSpecRequest(); - $request->apiID = 'totam'; - $request->versionID = 'porro'; - - $response = $sdk->apis->generateOpenApiSpec($request); - - if ($response->generateOpenApiSpecDiff !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apis/generatepostmancollection.md b/docs/apis/generatepostmancollection.md deleted file mode 100755 index 80f7908..0000000 --- a/docs/apis/generatepostmancollection.md +++ /dev/null @@ -1,33 +0,0 @@ -# generatePostmanCollection -Available in: `apis` - -Generates a postman collection containing all endpoints for a particular API. Includes variables produced for any path/query/header parameters included in the OpenAPI document. - -## Example Usage -```php -build(); - -try { - $request = new GeneratePostmanCollectionRequest(); - $request->apiID = 'dolorum'; - $request->versionID = 'dicta'; - - $response = $sdk->apis->generatePostmanCollection($request); - - if ($response->postmanCollection !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apis/getallapiversions.md b/docs/apis/getallapiversions.md deleted file mode 100755 index 826a29a..0000000 --- a/docs/apis/getallapiversions.md +++ /dev/null @@ -1,50 +0,0 @@ -# getAllApiVersions -Available in: `apis` - -Get all Api versions for a particular ApiEndpoint. -Supports filtering the versions based on metadata attributes. - -## Example Usage -```php -build(); - -try { - $request = new GetAllApiVersionsRequest(); - $request->apiID = 'nam'; - $request->metadata = [ - 'occaecati' => [ - 'deleniti', - ], - 'hic' => [ - 'totam', - 'beatae', - 'commodi', - 'molestiae', - ], - 'modi' => [ - 'impedit', - ], - ]; - $request->op = new GetAllApiVersionsOp(); - $request->op->and = false; - - $response = $sdk->apis->getAllApiVersions($request); - - if ($response->apis !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apis/getapis.md b/docs/apis/getapis.md deleted file mode 100755 index a42aec5..0000000 --- a/docs/apis/getapis.md +++ /dev/null @@ -1,46 +0,0 @@ -# getApis -Available in: `apis` - -Get a list of all Apis and their versions for a given workspace. -Supports filtering the APIs based on metadata attributes. - -## Example Usage -```php -build(); - -try { - $request = new GetApisRequest(); - $request->metadata = [ - 'esse' => [ - 'excepturi', - ], - 'aspernatur' => [ - 'ad', - ], - 'natus' => [ - 'iste', - ], - ]; - $request->op = new GetApisOp(); - $request->op->and = false; - - $response = $sdk->apis->getApis($request); - - if ($response->apis !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/apis/upsertapi.md b/docs/apis/upsertapi.md deleted file mode 100755 index cfb29b1..0000000 --- a/docs/apis/upsertapi.md +++ /dev/null @@ -1,52 +0,0 @@ -# upsertApi -Available in: `apis` - -Upsert an Api. If the Api does not exist, it will be created. -If the Api exists, it will be updated. - -## Example Usage -```php -build(); - -try { - $request = new UpsertApiRequest(); - $request->apiInput = new ApiInput(); - $request->apiInput->apiId = 'dolor'; - $request->apiInput->description = 'natus'; - $request->apiInput->metaData = [ - 'hic' => [ - 'fuga', - 'in', - 'corporis', - 'iste', - ], - 'iure' => [ - 'quidem', - 'architecto', - 'ipsa', - 'reiciendis', - ], - ]; - $request->apiInput->versionId = 'est'; - $request->apiID = 'mollitia'; - - $response = $sdk->apis->upsertApi($request); - - if ($response->api !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/embeds/README.md b/docs/embeds/README.md index 6fd9a44..d57bf47 100755 --- a/docs/embeds/README.md +++ b/docs/embeds/README.md @@ -1,8 +1,117 @@ # embeds +## Overview + REST APIs for managing embeds +### Available Operations + +* [getEmbedAccessToken](#getembedaccesstoken) - Get an embed access token for the current workspace. +* [getValidEmbedAccessTokens](#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace. +* [revokeEmbedAccessToken](#revokeembedaccesstoken) - Revoke an embed access EmbedToken. + +## getEmbedAccessToken + +Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content. +Filters can be applied allowing views to be filtered to things like particular customerIds. + +### Example Usage + +```php +build(); + +try { + $request = new GetEmbedAccessTokenRequest(); + $request->description = 'laborum'; + $request->duration = 170909; + $request->filters = new Filters(); + $request->filters->filters = [ + new Filter(), + ]; + $request->filters->limit = 358152; + $request->filters->offset = 128926; + $request->filters->operator = 'nobis'; + + $response = $sdk->embeds->getEmbedAccessToken($request); + + if ($response->embedAccessTokenResponse !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getValidEmbedAccessTokens + +Get all valid embed access tokens for the current workspace. + +### Example Usage + +```php +build(); + +try { + $response = $sdk->embeds->getValidEmbedAccessTokens(); + + if ($response->embedTokens !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## revokeEmbedAccessToken + +Revoke an embed access EmbedToken. + +### Example Usage + +```php +build(); + +try { + $request = new RevokeEmbedAccessTokenRequest(); + $request->tokenID = 'enim'; + + $response = $sdk->embeds->revokeEmbedAccessToken($request); -* [getEmbedAccessToken](getembedaccesstoken.md) - Get an embed access token for the current workspace. -* [getValidEmbedAccessTokens](getvalidembedaccesstokens.md) - Get all valid embed access tokens for the current workspace. -* [revokeEmbedAccessToken](revokeembedaccesstoken.md) - Revoke an embed access EmbedToken. \ No newline at end of file + if ($response->statusCode === 200) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` diff --git a/docs/embeds/getembedaccesstoken.md b/docs/embeds/getembedaccesstoken.md deleted file mode 100755 index ee81064..0000000 --- a/docs/embeds/getembedaccesstoken.md +++ /dev/null @@ -1,43 +0,0 @@ -# getEmbedAccessToken -Available in: `embeds` - -Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content. -Filters can be applied allowing views to be filtered to things like particular customerIds. - -## Example Usage -```php -build(); - -try { - $request = new GetEmbedAccessTokenRequest(); - $request->description = 'laborum'; - $request->duration = 170909; - $request->filters = new Filters(); - $request->filters->filters = [ - new Filter(), - ]; - $request->filters->limit = 358152; - $request->filters->offset = 128926; - $request->filters->operator = 'nobis'; - - $response = $sdk->embeds->getEmbedAccessToken($request); - - if ($response->embedAccessTokenResponse !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/embeds/getvalidembedaccesstokens.md b/docs/embeds/getvalidembedaccesstokens.md deleted file mode 100755 index 0b52c9b..0000000 --- a/docs/embeds/getvalidembedaccesstokens.md +++ /dev/null @@ -1,28 +0,0 @@ -# getValidEmbedAccessTokens -Available in: `embeds` - -Get all valid embed access tokens for the current workspace. - -## Example Usage -```php -build(); - -try { - $response = $sdk->embeds->getValidEmbedAccessTokens(); - - if ($response->embedTokens !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/embeds/revokeembedaccesstoken.md b/docs/embeds/revokeembedaccesstoken.md deleted file mode 100755 index 427050c..0000000 --- a/docs/embeds/revokeembedaccesstoken.md +++ /dev/null @@ -1,32 +0,0 @@ -# revokeEmbedAccessToken -Available in: `embeds` - -Revoke an embed access EmbedToken. - -## Example Usage -```php -build(); - -try { - $request = new RevokeEmbedAccessTokenRequest(); - $request->tokenID = 'enim'; - - $response = $sdk->embeds->revokeEmbedAccessToken($request); - - if ($response->statusCode === 200) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/metadata/README.md b/docs/metadata/README.md index 1a89c52..4443763 100755 --- a/docs/metadata/README.md +++ b/docs/metadata/README.md @@ -1,8 +1,119 @@ # metadata +## Overview + REST APIs for managing Version Metadata entities +### Available Operations + +* [deleteVersionMetadata](#deleteversionmetadata) - Delete metadata for a particular apiID and versionID. +* [getVersionMetadata](#getversionmetadata) - Get all metadata for a particular apiID and versionID. +* [insertVersionMetadata](#insertversionmetadata) - Insert metadata for a particular apiID and versionID. + +## deleteVersionMetadata + +Delete metadata for a particular apiID and versionID. + +### Example Usage + +```php +build(); + +try { + $request = new DeleteVersionMetadataRequest(); + $request->apiID = 'omnis'; + $request->metaKey = 'nemo'; + $request->metaValue = 'minima'; + $request->versionID = 'excepturi'; + + $response = $sdk->metadata->deleteVersionMetadata($request); + + if ($response->statusCode === 200) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getVersionMetadata + +Get all metadata for a particular apiID and versionID. + +### Example Usage + +```php +build(); + +try { + $request = new GetVersionMetadataRequest(); + $request->apiID = 'accusantium'; + $request->versionID = 'iure'; + + $response = $sdk->metadata->getVersionMetadata($request); + + if ($response->versionMetadata !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## insertVersionMetadata + +Insert metadata for a particular apiID and versionID. + +### Example Usage + +```php +build(); + +try { + $request = new InsertVersionMetadataRequest(); + $request->versionMetadataInput = new VersionMetadataInput(); + $request->versionMetadataInput->metaKey = 'culpa'; + $request->versionMetadataInput->metaValue = 'doloribus'; + $request->apiID = 'sapiente'; + $request->versionID = 'architecto'; + + $response = $sdk->metadata->insertVersionMetadata($request); -* [deleteVersionMetadata](deleteversionmetadata.md) - Delete metadata for a particular apiID and versionID. -* [getVersionMetadata](getversionmetadata.md) - Get all metadata for a particular apiID and versionID. -* [insertVersionMetadata](insertversionmetadata.md) - Insert metadata for a particular apiID and versionID. \ No newline at end of file + if ($response->versionMetadata !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` diff --git a/docs/metadata/deleteversionmetadata.md b/docs/metadata/deleteversionmetadata.md deleted file mode 100755 index 8679668..0000000 --- a/docs/metadata/deleteversionmetadata.md +++ /dev/null @@ -1,35 +0,0 @@ -# deleteVersionMetadata -Available in: `metadata` - -Delete metadata for a particular apiID and versionID. - -## Example Usage -```php -build(); - -try { - $request = new DeleteVersionMetadataRequest(); - $request->apiID = 'omnis'; - $request->metaKey = 'nemo'; - $request->metaValue = 'minima'; - $request->versionID = 'excepturi'; - - $response = $sdk->metadata->deleteVersionMetadata($request); - - if ($response->statusCode === 200) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/metadata/getversionmetadata.md b/docs/metadata/getversionmetadata.md deleted file mode 100755 index 4619188..0000000 --- a/docs/metadata/getversionmetadata.md +++ /dev/null @@ -1,33 +0,0 @@ -# getVersionMetadata -Available in: `metadata` - -Get all metadata for a particular apiID and versionID. - -## Example Usage -```php -build(); - -try { - $request = new GetVersionMetadataRequest(); - $request->apiID = 'accusantium'; - $request->versionID = 'iure'; - - $response = $sdk->metadata->getVersionMetadata($request); - - if ($response->versionMetadata !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/metadata/insertversionmetadata.md b/docs/metadata/insertversionmetadata.md deleted file mode 100755 index 810616b..0000000 --- a/docs/metadata/insertversionmetadata.md +++ /dev/null @@ -1,37 +0,0 @@ -# insertVersionMetadata -Available in: `metadata` - -Insert metadata for a particular apiID and versionID. - -## Example Usage -```php -build(); - -try { - $request = new InsertVersionMetadataRequest(); - $request->versionMetadataInput = new VersionMetadataInput(); - $request->versionMetadataInput->metaKey = 'culpa'; - $request->versionMetadataInput->metaValue = 'doloribus'; - $request->apiID = 'sapiente'; - $request->versionID = 'architecto'; - - $response = $sdk->metadata->insertVersionMetadata($request); - - if ($response->versionMetadata !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/plugins/README.md b/docs/plugins/README.md index 53d7f08..9829c99 100755 --- a/docs/plugins/README.md +++ b/docs/plugins/README.md @@ -1,8 +1,123 @@ # plugins +## Overview + REST APIs for managing and running plugins +### Available Operations + +* [getPlugins](#getplugins) - Get all plugins for the current workspace. +* [runPlugin](#runplugin) - Run a plugin +* [upsertPlugin](#upsertplugin) - Upsert a plugin + +## getPlugins + +Get all plugins for the current workspace. + +### Example Usage + +```php +build(); + +try { + $response = $sdk->plugins->getPlugins(); + + if ($response->plugins !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## runPlugin + +Run a plugin + +### Example Usage + +```php +build(); + +try { + $request = new RunPluginRequest(); + $request->filters = new Filters(); + $request->filters->filters = [ + new Filter(), + new Filter(), + new Filter(), + ]; + $request->filters->limit = 208876; + $request->filters->offset = 635059; + $request->filters->operator = 'consequuntur'; + $request->pluginID = 'repellat'; + + $response = $sdk->plugins->runPlugin($request); + + if ($response->boundedRequests !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## upsertPlugin + +Upsert a plugin + +### Example Usage + +```php +build(); + +try { + $request = new Plugin(); + $request->code = 'mollitia'; + $request->createdAt = DateTime::createFromFormat('Y-m-d\TH:i:sP', '2022-06-30T02:19:51.375Z'); + $request->evalHash = 'commodi'; + $request->pluginId = 'quam'; + $request->title = 'Ms.'; + $request->updatedAt = DateTime::createFromFormat('Y-m-d\TH:i:sP', '2022-05-18T10:03:04.921Z'); + $request->workspaceId = 'quia'; + + $response = $sdk->plugins->upsertPlugin($request); -* [getPlugins](getplugins.md) - Get all plugins for the current workspace. -* [runPlugin](runplugin.md) - Run a plugin -* [upsertPlugin](upsertplugin.md) - Upsert a plugin \ No newline at end of file + if ($response->plugin !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` diff --git a/docs/plugins/getplugins.md b/docs/plugins/getplugins.md deleted file mode 100755 index 571651a..0000000 --- a/docs/plugins/getplugins.md +++ /dev/null @@ -1,28 +0,0 @@ -# getPlugins -Available in: `plugins` - -Get all plugins for the current workspace. - -## Example Usage -```php -build(); - -try { - $response = $sdk->plugins->getPlugins(); - - if ($response->plugins !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/plugins/runplugin.md b/docs/plugins/runplugin.md deleted file mode 100755 index 7306eb7..0000000 --- a/docs/plugins/runplugin.md +++ /dev/null @@ -1,43 +0,0 @@ -# runPlugin -Available in: `plugins` - -Run a plugin - -## Example Usage -```php -build(); - -try { - $request = new RunPluginRequest(); - $request->filters = new Filters(); - $request->filters->filters = [ - new Filter(), - new Filter(), - new Filter(), - ]; - $request->filters->limit = 208876; - $request->filters->offset = 635059; - $request->filters->operator = 'consequuntur'; - $request->pluginID = 'repellat'; - - $response = $sdk->plugins->runPlugin($request); - - if ($response->boundedRequests !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/plugins/upsertplugin.md b/docs/plugins/upsertplugin.md deleted file mode 100755 index 7daddaa..0000000 --- a/docs/plugins/upsertplugin.md +++ /dev/null @@ -1,38 +0,0 @@ -# upsertPlugin -Available in: `plugins` - -Upsert a plugin - -## Example Usage -```php -build(); - -try { - $request = new Plugin(); - $request->code = 'mollitia'; - $request->createdAt = DateTime::createFromFormat('Y-m-d\TH:i:sP', '2022-06-30T02:19:51.375Z'); - $request->evalHash = 'commodi'; - $request->pluginId = 'quam'; - $request->title = 'Ms.'; - $request->updatedAt = DateTime::createFromFormat('Y-m-d\TH:i:sP', '2022-05-18T10:03:04.921Z'); - $request->workspaceId = 'quia'; - - $response = $sdk->plugins->upsertPlugin($request); - - if ($response->plugin !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/requests/README.md b/docs/requests/README.md index ec16e04..06fcabc 100755 --- a/docs/requests/README.md +++ b/docs/requests/README.md @@ -1,8 +1,122 @@ # requests +## Overview + REST APIs for retrieving request information +### Available Operations + +* [generateRequestPostmanCollection](#generaterequestpostmancollection) - Generate a Postman collection for a particular request. +* [getRequestFromEventLog](#getrequestfromeventlog) - Get information about a particular request. +* [queryEventLog](#queryeventlog) - Query the event log to retrieve a list of requests. + +## generateRequestPostmanCollection + +Generates a Postman collection for a particular request. +Allowing it to be replayed with the same inputs that were captured by the SDK. + +### Example Usage + +```php +build(); + +try { + $request = new GenerateRequestPostmanCollectionRequest(); + $request->requestID = 'quis'; + + $response = $sdk->requests->generateRequestPostmanCollection($request); + + if ($response->postmanCollection !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getRequestFromEventLog + +Get information about a particular request. + +### Example Usage + +```php +build(); + +try { + $request = new GetRequestFromEventLogRequest(); + $request->requestID = 'vitae'; + + $response = $sdk->requests->getRequestFromEventLog($request); + + if ($response->unboundedRequest !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## queryEventLog + +Supports retrieving a list of request captured by the SDK for this workspace. +Allows the filtering of requests on a number of criteria such as ApiID, VersionID, Path, Method, etc. + +### Example Usage + +```php +build(); + +try { + $request = new QueryEventLogRequest(); + $request->filters = new Filters(); + $request->filters->filters = [ + new Filter(), + new Filter(), + new Filter(), + ]; + $request->filters->limit = 656330; + $request->filters->offset = 317202; + $request->filters->operator = 'odit'; + + $response = $sdk->requests->queryEventLog($request); -* [generateRequestPostmanCollection](generaterequestpostmancollection.md) - Generate a Postman collection for a particular request. -* [getRequestFromEventLog](getrequestfromeventlog.md) - Get information about a particular request. -* [queryEventLog](queryeventlog.md) - Query the event log to retrieve a list of requests. \ No newline at end of file + if ($response->boundedRequests !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` diff --git a/docs/requests/generaterequestpostmancollection.md b/docs/requests/generaterequestpostmancollection.md deleted file mode 100755 index 1e81ec7..0000000 --- a/docs/requests/generaterequestpostmancollection.md +++ /dev/null @@ -1,33 +0,0 @@ -# generateRequestPostmanCollection -Available in: `requests` - -Generates a Postman collection for a particular request. -Allowing it to be replayed with the same inputs that were captured by the SDK. - -## Example Usage -```php -build(); - -try { - $request = new GenerateRequestPostmanCollectionRequest(); - $request->requestID = 'quis'; - - $response = $sdk->requests->generateRequestPostmanCollection($request); - - if ($response->postmanCollection !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/requests/getrequestfromeventlog.md b/docs/requests/getrequestfromeventlog.md deleted file mode 100755 index 0f3bf46..0000000 --- a/docs/requests/getrequestfromeventlog.md +++ /dev/null @@ -1,32 +0,0 @@ -# getRequestFromEventLog -Available in: `requests` - -Get information about a particular request. - -## Example Usage -```php -build(); - -try { - $request = new GetRequestFromEventLogRequest(); - $request->requestID = 'vitae'; - - $response = $sdk->requests->getRequestFromEventLog($request); - - if ($response->unboundedRequest !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/requests/queryeventlog.md b/docs/requests/queryeventlog.md deleted file mode 100755 index 74206c3..0000000 --- a/docs/requests/queryeventlog.md +++ /dev/null @@ -1,43 +0,0 @@ -# queryEventLog -Available in: `requests` - -Supports retrieving a list of request captured by the SDK for this workspace. -Allows the filtering of requests on a number of criteria such as ApiID, VersionID, Path, Method, etc. - -## Example Usage -```php -build(); - -try { - $request = new QueryEventLogRequest(); - $request->filters = new Filters(); - $request->filters->filters = [ - new Filter(), - new Filter(), - new Filter(), - ]; - $request->filters->limit = 656330; - $request->filters->offset = 317202; - $request->filters->operator = 'odit'; - - $response = $sdk->requests->queryEventLog($request); - - if ($response->boundedRequests !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/schemas/README.md b/docs/schemas/README.md index 62cb6fc..fbf4c24 100755 --- a/docs/schemas/README.md +++ b/docs/schemas/README.md @@ -1,13 +1,303 @@ # schemas +## Overview + REST APIs for managing Schema entities +### Available Operations + +* [deleteSchema](#deleteschema) - Delete a particular schema revision for an Api. +* [downloadSchema](#downloadschema) - Download the latest schema for a particular apiID. +* [downloadSchemaRevision](#downloadschemarevision) - Download a particular schema revision for an Api. +* [getSchema](#getschema) - Get information about the latest schema. +* [getSchemaDiff](#getschemadiff) - Get a diff of two schema revisions for an Api. +* [getSchemaRevision](#getschemarevision) - Get information about a particular schema revision for an Api. +* [getSchemas](#getschemas) - Get information about all schemas associated with a particular apiID. +* [registerSchema](#registerschema) - Register a schema. + +## deleteSchema + +Delete a particular schema revision for an Api. + +### Example Usage + +```php +build(); + +try { + $request = new DeleteSchemaRequest(); + $request->apiID = 'quo'; + $request->revisionID = 'sequi'; + $request->versionID = 'tenetur'; + + $response = $sdk->schemas->deleteSchema($request); + + if ($response->statusCode === 200) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## downloadSchema + +Download the latest schema for a particular apiID. + +### Example Usage + +```php +build(); + +try { + $request = new DownloadSchemaRequest(); + $request->apiID = 'ipsam'; + $request->versionID = 'id'; + + $response = $sdk->schemas->downloadSchema($request); + + if ($response->schema !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## downloadSchemaRevision + +Download a particular schema revision for an Api. + +### Example Usage + +```php +build(); + +try { + $request = new DownloadSchemaRevisionRequest(); + $request->apiID = 'possimus'; + $request->revisionID = 'aut'; + $request->versionID = 'quasi'; + + $response = $sdk->schemas->downloadSchemaRevision($request); + + if ($response->schema !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getSchema + +Returns information about the last uploaded schema for a particular API version. +This won't include the schema itself, that can be retrieved via the downloadSchema operation. + +### Example Usage + +```php +build(); + +try { + $request = new GetSchemaRequest(); + $request->apiID = 'error'; + $request->versionID = 'temporibus'; + + $response = $sdk->schemas->getSchema($request); + + if ($response->schema !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getSchemaDiff + +Get a diff of two schema revisions for an Api. + +### Example Usage + +```php +build(); + +try { + $request = new GetSchemaDiffRequest(); + $request->apiID = 'laborum'; + $request->baseRevisionID = 'quasi'; + $request->targetRevisionID = 'reiciendis'; + $request->versionID = 'voluptatibus'; + + $response = $sdk->schemas->getSchemaDiff($request); + + if ($response->schemaDiff !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getSchemaRevision + +Returns information about the last uploaded schema for a particular schema revision. +This won't include the schema itself, that can be retrieved via the downloadSchema operation. + +### Example Usage + +```php +build(); + +try { + $request = new GetSchemaRevisionRequest(); + $request->apiID = 'vero'; + $request->revisionID = 'nihil'; + $request->versionID = 'praesentium'; + + $response = $sdk->schemas->getSchemaRevision($request); + + if ($response->schema !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## getSchemas + +Returns information the schemas associated with a particular apiID. +This won't include the schemas themselves, they can be retrieved via the downloadSchema operation. + +### Example Usage + +```php +build(); + +try { + $request = new GetSchemasRequest(); + $request->apiID = 'voluptatibus'; + $request->versionID = 'ipsa'; + + $response = $sdk->schemas->getSchemas($request); + + if ($response->schemata !== null) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` + +## registerSchema + +Allows uploading a schema for a particular API version. +This will be used to populate ApiEndpoints and used as a base for any schema generation if present. + +### Example Usage + +```php +build(); + +try { + $request = new RegisterSchemaRequest(); + $request->requestBody = new RegisterSchemaRequestBody(); + $request->requestBody->file = new RegisterSchemaRequestBodyFile(); + $request->requestBody->file->content = 'omnis'; + $request->requestBody->file->file = 'voluptate'; + $request->apiID = 'cum'; + $request->versionID = 'perferendis'; + + $response = $sdk->schemas->registerSchema($request); -* [deleteSchema](deleteschema.md) - Delete a particular schema revision for an Api. -* [downloadSchema](downloadschema.md) - Download the latest schema for a particular apiID. -* [downloadSchemaRevision](downloadschemarevision.md) - Download a particular schema revision for an Api. -* [getSchema](getschema.md) - Get information about the latest schema. -* [getSchemaDiff](getschemadiff.md) - Get a diff of two schema revisions for an Api. -* [getSchemaRevision](getschemarevision.md) - Get information about a particular schema revision for an Api. -* [getSchemas](getschemas.md) - Get information about all schemas associated with a particular apiID. -* [registerSchema](registerschema.md) - Register a schema. \ No newline at end of file + if ($response->statusCode === 200) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` diff --git a/docs/schemas/deleteschema.md b/docs/schemas/deleteschema.md deleted file mode 100755 index 9182c4e..0000000 --- a/docs/schemas/deleteschema.md +++ /dev/null @@ -1,34 +0,0 @@ -# deleteSchema -Available in: `schemas` - -Delete a particular schema revision for an Api. - -## Example Usage -```php -build(); - -try { - $request = new DeleteSchemaRequest(); - $request->apiID = 'quo'; - $request->revisionID = 'sequi'; - $request->versionID = 'tenetur'; - - $response = $sdk->schemas->deleteSchema($request); - - if ($response->statusCode === 200) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/schemas/downloadschema.md b/docs/schemas/downloadschema.md deleted file mode 100755 index aaee6b7..0000000 --- a/docs/schemas/downloadschema.md +++ /dev/null @@ -1,33 +0,0 @@ -# downloadSchema -Available in: `schemas` - -Download the latest schema for a particular apiID. - -## Example Usage -```php -build(); - -try { - $request = new DownloadSchemaRequest(); - $request->apiID = 'ipsam'; - $request->versionID = 'id'; - - $response = $sdk->schemas->downloadSchema($request); - - if ($response->schema !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/schemas/downloadschemarevision.md b/docs/schemas/downloadschemarevision.md deleted file mode 100755 index 9368620..0000000 --- a/docs/schemas/downloadschemarevision.md +++ /dev/null @@ -1,34 +0,0 @@ -# downloadSchemaRevision -Available in: `schemas` - -Download a particular schema revision for an Api. - -## Example Usage -```php -build(); - -try { - $request = new DownloadSchemaRevisionRequest(); - $request->apiID = 'possimus'; - $request->revisionID = 'aut'; - $request->versionID = 'quasi'; - - $response = $sdk->schemas->downloadSchemaRevision($request); - - if ($response->schema !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/schemas/getschema.md b/docs/schemas/getschema.md deleted file mode 100755 index 552712c..0000000 --- a/docs/schemas/getschema.md +++ /dev/null @@ -1,34 +0,0 @@ -# getSchema -Available in: `schemas` - -Returns information about the last uploaded schema for a particular API version. -This won't include the schema itself, that can be retrieved via the downloadSchema operation. - -## Example Usage -```php -build(); - -try { - $request = new GetSchemaRequest(); - $request->apiID = 'error'; - $request->versionID = 'temporibus'; - - $response = $sdk->schemas->getSchema($request); - - if ($response->schema !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/schemas/getschemadiff.md b/docs/schemas/getschemadiff.md deleted file mode 100755 index 19f49c7..0000000 --- a/docs/schemas/getschemadiff.md +++ /dev/null @@ -1,35 +0,0 @@ -# getSchemaDiff -Available in: `schemas` - -Get a diff of two schema revisions for an Api. - -## Example Usage -```php -build(); - -try { - $request = new GetSchemaDiffRequest(); - $request->apiID = 'laborum'; - $request->baseRevisionID = 'quasi'; - $request->targetRevisionID = 'reiciendis'; - $request->versionID = 'voluptatibus'; - - $response = $sdk->schemas->getSchemaDiff($request); - - if ($response->schemaDiff !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/schemas/getschemarevision.md b/docs/schemas/getschemarevision.md deleted file mode 100755 index 3857e5a..0000000 --- a/docs/schemas/getschemarevision.md +++ /dev/null @@ -1,35 +0,0 @@ -# getSchemaRevision -Available in: `schemas` - -Returns information about the last uploaded schema for a particular schema revision. -This won't include the schema itself, that can be retrieved via the downloadSchema operation. - -## Example Usage -```php -build(); - -try { - $request = new GetSchemaRevisionRequest(); - $request->apiID = 'vero'; - $request->revisionID = 'nihil'; - $request->versionID = 'praesentium'; - - $response = $sdk->schemas->getSchemaRevision($request); - - if ($response->schema !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/schemas/getschemas.md b/docs/schemas/getschemas.md deleted file mode 100755 index 08e901c..0000000 --- a/docs/schemas/getschemas.md +++ /dev/null @@ -1,34 +0,0 @@ -# getSchemas -Available in: `schemas` - -Returns information the schemas associated with a particular apiID. -This won't include the schemas themselves, they can be retrieved via the downloadSchema operation. - -## Example Usage -```php -build(); - -try { - $request = new GetSchemasRequest(); - $request->apiID = 'voluptatibus'; - $request->versionID = 'ipsa'; - - $response = $sdk->schemas->getSchemas($request); - - if ($response->schemata !== null) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/schemas/registerschema.md b/docs/schemas/registerschema.md deleted file mode 100755 index 458f528..0000000 --- a/docs/schemas/registerschema.md +++ /dev/null @@ -1,40 +0,0 @@ -# registerSchema -Available in: `schemas` - -Allows uploading a schema for a particular API version. -This will be used to populate ApiEndpoints and used as a base for any schema generation if present. - -## Example Usage -```php -build(); - -try { - $request = new RegisterSchemaRequest(); - $request->requestBody = new RegisterSchemaRequestBody(); - $request->requestBody->file = new RegisterSchemaRequestBodyFile(); - $request->requestBody->file->content = 'omnis'; - $request->requestBody->file->file = 'voluptate'; - $request->apiID = 'cum'; - $request->versionID = 'perferendis'; - - $response = $sdk->schemas->registerSchema($request); - - if ($response->statusCode === 200) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/docs/sdk/README.md b/docs/sdk/README.md index f580365..425639a 100755 --- a/docs/sdk/README.md +++ b/docs/sdk/README.md @@ -1,8 +1,40 @@ # SDK +## Overview + The Speakeasy API allows teams to manage common operations with their APIs The Speakeasy Platform Documentation +### Available Operations + +* [validateApiKey](#validateapikey) - Validate the current api key. + +## validateApiKey + +Validate the current api key. + +### Example Usage + +```php +build(); + +try { + $response = $sdk->sdk->validateApiKey(); -* [validateApiKey](validateapikey.md) - Validate the current api key. \ No newline at end of file + if ($response->statusCode === 200) { + // handle response + } +} catch (Exception $e) { + // handle exception +} +``` diff --git a/docs/sdk/validateapikey.md b/docs/sdk/validateapikey.md deleted file mode 100755 index 20fbb29..0000000 --- a/docs/sdk/validateapikey.md +++ /dev/null @@ -1,28 +0,0 @@ -# validateApiKey -Available in: `sdk` - -Validate the current api key. - -## Example Usage -```php -build(); - -try { - $response = $sdk->sdk->validateApiKey(); - - if ($response->statusCode === 200) { - // handle response - } -} catch (Exception $e) { - // handle exception -} -``` \ No newline at end of file diff --git a/files.gen b/files.gen index 040ec8a..0903ffe 100755 --- a/files.gen +++ b/files.gen @@ -116,46 +116,11 @@ src/Models/Shared/SchemaDiffValueChange.php src/Models/Shared/SchemaDiff.php src/Models/Shared/Security.php docs/sdk/README.md -docs/sdk/validateapikey.md docs/apiendpoints/README.md -docs/apiendpoints/deleteapiendpoint.md -docs/apiendpoints/findapiendpoint.md -docs/apiendpoints/generateopenapispecforapiendpoint.md -docs/apiendpoints/generatepostmancollectionforapiendpoint.md -docs/apiendpoints/getallapiendpoints.md -docs/apiendpoints/getallforversionapiendpoints.md -docs/apiendpoints/getapiendpoint.md -docs/apiendpoints/upsertapiendpoint.md docs/apis/README.md -docs/apis/deleteapi.md -docs/apis/generateopenapispec.md -docs/apis/generatepostmancollection.md -docs/apis/getallapiversions.md -docs/apis/getapis.md -docs/apis/upsertapi.md docs/embeds/README.md -docs/embeds/getembedaccesstoken.md -docs/embeds/getvalidembedaccesstokens.md -docs/embeds/revokeembedaccesstoken.md docs/metadata/README.md -docs/metadata/deleteversionmetadata.md -docs/metadata/getversionmetadata.md -docs/metadata/insertversionmetadata.md docs/plugins/README.md -docs/plugins/getplugins.md -docs/plugins/runplugin.md -docs/plugins/upsertplugin.md docs/requests/README.md -docs/requests/generaterequestpostmancollection.md -docs/requests/getrequestfromeventlog.md -docs/requests/queryeventlog.md docs/schemas/README.md -docs/schemas/deleteschema.md -docs/schemas/downloadschema.md -docs/schemas/downloadschemarevision.md -docs/schemas/getschema.md -docs/schemas/getschemadiff.md -docs/schemas/getschemarevision.md -docs/schemas/getschemas.md -docs/schemas/registerschema.md USAGE.md \ No newline at end of file diff --git a/gen.yaml b/gen.yaml index e2960c8..135aafb 100644 --- a/gen.yaml +++ b/gen.yaml @@ -2,13 +2,13 @@ configVersion: 1.0.0 management: docChecksum: 2bba3b8f9d211b02569b3f9aff0d34b4 docVersion: 0.3.0 - speakeasyVersion: 1.23.0 - generationVersion: 2.21.0 + speakeasyVersion: 1.23.1 + generationVersion: 2.21.1 generation: telemetryEnabled: true sdkClassName: SDK singleTagPerOp: false php: - version: 0.15.0 + version: 0.15.1 namespace: Speakeasy\SpeakeasyClientSDK packageName: speakeasy-api/speakeasy-client-sdk-php diff --git a/src/SDK.php b/src/SDK.php index cbba97d..aff4775 100755 --- a/src/SDK.php +++ b/src/SDK.php @@ -80,8 +80,8 @@ class SDK private ?Models\Shared\Security $_security; private string $_serverUrl; private string $_language = 'php'; - private string $_sdkVersion = '0.15.0'; - private string $_genVersion = '2.21.0'; + private string $_sdkVersion = '0.15.1'; + private string $_genVersion = '2.21.1'; /** * Returns a new instance of the SDK builder used to configure and create the SDK instance.