ci: regenerated with OpenAPI Doc 0.3.0, Speakeasy CLI 1.126.0

speakeasy-api · Dec 12, 2023 · 73ddaee · 73ddaee
1 parent 1033af7
commit 73ddaee
Show file tree

Hide file tree

Showing 14 changed files with 178 additions and 218 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ use Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
 $sdk = SpeakeasyClientSDK\SDK::builder()
     ->setSecurity($security)
@@ -117,6 +117,26 @@ try {
 
 
 
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+## Server Selection
+
+### Select Server by Name
+
+You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
+
+| Name | Server | Variables |
+| ----- | ------ | --------- |
+| `prod` | `https://api.prod.speakeasyapi.dev` | None |
+
+
+
+### Override Server URL Per-Client
+
+The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
+<!-- End Server Selection [server] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 

diff --git a/RELEASES.md b/RELEASES.md
@@ -554,4 +554,14 @@ Based on:
 ### Generated
 - [php v0.33.2] .
 ### Releases
-- [Composer v0.33.2] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.33.2 - .
+- [Composer v0.33.2] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.33.2 - .
+
+## 2023-12-12 00:12:47
+### Changes
+Based on:
+- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.126.0 (2.213.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [php v0.34.0] .
+### Releases
+- [Composer v0.34.0] https://packagist.org/packages/speakeasy-api/speakeasy-client-sdk-php#v0.34.0 - .
diff --git a/USAGE.md b/USAGE.md
@@ -10,7 +10,7 @@ use Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
 $sdk = SpeakeasyClientSDK\SDK::builder()
     ->setSecurity($security)

diff --git a/docs/Models/Shared/Security.md b/docs/Models/Shared/Security.md
@@ -3,6 +3,6 @@
 
 ## Fields
 
-| Field              | Type               | Required           | Description        | Example            |
-| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
-| `apiKey`           | *string*           | :heavy_check_mark: | N/A                |                    |
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `apiKey`           | *string*           | :heavy_check_mark: | N/A                |
diff --git a/docs/sdks/apiendpoints/README.md b/docs/sdks/apiendpoints/README.md
@@ -33,17 +33,15 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\DeleteApiEndpointRequest();
+        $request = new Operations\DeleteApiEndpointRequest();
     $request->apiEndpointID = 'string';
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apiEndpoints->deleteApiEndpoint($request);
 
@@ -85,17 +83,15 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\FindApiEndpointRequest();
+        $request = new Operations\FindApiEndpointRequest();
     $request->apiID = 'string';
     $request->displayName = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apiEndpoints->findApiEndpoint($request);
 
@@ -137,17 +133,15 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GenerateOpenApiSpecForApiEndpointRequest();
+        $request = new Operations\GenerateOpenApiSpecForApiEndpointRequest();
     $request->apiEndpointID = 'string';
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apiEndpoints->generateOpenApiSpecForApiEndpoint($request);
 
@@ -188,17 +182,15 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GeneratePostmanCollectionForApiEndpointRequest();
+        $request = new Operations\GeneratePostmanCollectionForApiEndpointRequest();
     $request->apiEndpointID = 'string';
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apiEndpoints->generatePostmanCollectionForApiEndpoint($request);
 
@@ -239,15 +231,13 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GetAllApiEndpointsRequest();
-    $request->apiID = 'string';
+        $request = new Operations\GetAllApiEndpointsRequest();
+    $request->apiID = 'string';;
 
     $response = $sdk->apiEndpoints->getAllApiEndpoints($request);
 
@@ -288,16 +278,14 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GetAllForVersionApiEndpointsRequest();
+        $request = new Operations\GetAllForVersionApiEndpointsRequest();
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apiEndpoints->getAllForVersionApiEndpoints($request);
 
@@ -338,17 +326,15 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GetApiEndpointRequest();
+        $request = new Operations\GetApiEndpointRequest();
     $request->apiEndpointID = 'string';
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apiEndpoints->getApiEndpoint($request);
 
@@ -389,14 +375,12 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\UpsertApiEndpointRequest();
+        $request = new Operations\UpsertApiEndpointRequest();
     $request->apiEndpoint = new Shared\ApiEndpointInput();
     $request->apiEndpoint->apiEndpointId = 'string';
     $request->apiEndpoint->description = 'Public-key systematic attitude';
@@ -406,7 +390,7 @@ try {
     $request->apiEndpoint->versionId = 'string';
     $request->apiEndpointID = 'string';
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apiEndpoints->upsertApiEndpoint($request);
 

diff --git a/docs/sdks/apis/README.md b/docs/sdks/apis/README.md
@@ -31,16 +31,14 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\DeleteApiRequest();
+        $request = new Operations\DeleteApiRequest();
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apis->deleteApi($request);
 
@@ -82,16 +80,14 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GenerateOpenApiSpecRequest();
+        $request = new Operations\GenerateOpenApiSpecRequest();
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apis->generateOpenApiSpec($request);
 
@@ -132,16 +128,14 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GeneratePostmanCollectionRequest();
+        $request = new Operations\GeneratePostmanCollectionRequest();
     $request->apiID = 'string';
-    $request->versionID = 'string';
+    $request->versionID = 'string';;
 
     $response = $sdk->apis->generatePostmanCollection($request);
 
@@ -183,22 +177,20 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GetAllApiVersionsRequest();
+        $request = new Operations\GetAllApiVersionsRequest();
     $request->apiID = 'string';
     $request->metadata = [
         'azure' => [
             'string',
         ],
     ];
     $request->op = new Operations\Op();
-    $request->op->and = false;
+    $request->op->and = false;;
 
     $response = $sdk->apis->getAllApiVersions($request);
 
@@ -240,21 +232,19 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\GetApisRequest();
+        $request = new Operations\GetApisRequest();
     $request->metadata = [
         'South' => [
             'string',
         ],
     ];
     $request->op = new Operations\QueryParamOp();
-    $request->op->and = false;
+    $request->op->and = false;;
 
     $response = $sdk->apis->getApis($request);
 
@@ -296,14 +286,12 @@ use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
 use \Speakeasy\SpeakeasyClientSDK\Models\Operations;
 
 $security = new Shared\Security();
-$security->apiKey = '';
+$security->apiKey = '<YOUR_API_KEY_HERE>';
 
-$sdk = SpeakeasyClientSDK\SDK::builder()
-    ->setSecurity($security)
-    ->build();
+$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();
 
 try {
-    $request = new Operations\UpsertApiRequest();
+        $request = new Operations\UpsertApiRequest();
     $request->api = new Shared\ApiInput();
     $request->api->apiId = 'string';
     $request->api->description = 'Synchronised 5th generation knowledge user';
@@ -313,7 +301,7 @@ try {
         ],
     ];
     $request->api->versionId = 'string';
-    $request->apiID = 'string';
+    $request->apiID = 'string';;
 
     $response = $sdk->apis->upsertApi($request);