Skip to content

Commit d8bb8e8

Browse files
author
LaunchDarklyReleaseBot
committed
Version 12.0.0 automatically generated from ld-openapi.
1 parent 53cb0eb commit d8bb8e8

File tree

870 files changed

+41270
-2801
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

870 files changed

+41270
-2801
lines changed

.openapi-generator/FILES

+138-3
Large diffs are not rendered by default.

README.md

+77-12
Large diffs are not rendered by default.

composer.json

+2-2
Large diffs are not rendered by default.

docs/Api/AccountUsageBetaApi.md

+68-3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**getEvaluationsUsage()**](AccountUsageBetaApi.md#getEvaluationsUsage) | **GET** /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey} | Get evaluations usage
88
[**getEventsUsage()**](AccountUsageBetaApi.md#getEventsUsage) | **GET** /api/v2/usage/events/{type} | Get events usage
9+
[**getExperimentationKeysUsage()**](AccountUsageBetaApi.md#getExperimentationKeysUsage) | **GET** /api/v2/usage/experimentation-keys | Get experimentation keys usage
910
[**getMauSdksByType()**](AccountUsageBetaApi.md#getMauSdksByType) | **GET** /api/v2/usage/mau/sdks | Get MAU SDKs by type
1011
[**getMauUsage()**](AccountUsageBetaApi.md#getMauUsage) | **GET** /api/v2/usage/mau | Get MAU usage
1112
[**getMauUsageByCategory()**](AccountUsageBetaApi.md#getMauUsageByCategory) | **GET** /api/v2/usage/mau/bycategory | Get MAU usage by category
@@ -152,6 +153,70 @@ Name | Type | Description | Notes
152153
[[Back to Model list]](../../README.md#models)
153154
[[Back to README]](../../README.md)
154155

156+
## `getExperimentationKeysUsage()`
157+
158+
```php
159+
getExperimentationKeysUsage($from, $to): \LaunchDarklyApi\Model\SeriesIntervalsRep
160+
```
161+
162+
Get experimentation keys usage
163+
164+
Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a max of 31 days.
165+
166+
### Example
167+
168+
```php
169+
<?php
170+
require_once(__DIR__ . '/vendor/autoload.php');
171+
172+
173+
// Configure API key authorization: ApiKey
174+
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
175+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
176+
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
177+
178+
179+
$apiInstance = new LaunchDarklyApi\Api\AccountUsageBetaApi(
180+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
181+
// This is optional, `GuzzleHttp\Client` will be used as default.
182+
new GuzzleHttp\Client(),
183+
$config
184+
);
185+
$from = 'from_example'; // string | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
186+
$to = 'to_example'; // string | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
187+
188+
try {
189+
$result = $apiInstance->getExperimentationKeysUsage($from, $to);
190+
print_r($result);
191+
} catch (Exception $e) {
192+
echo 'Exception when calling AccountUsageBetaApi->getExperimentationKeysUsage: ', $e->getMessage(), PHP_EOL;
193+
}
194+
```
195+
196+
### Parameters
197+
198+
Name | Type | Description | Notes
199+
------------- | ------------- | ------------- | -------------
200+
**from** | **string**| The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | [optional]
201+
**to** | **string**| The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | [optional]
202+
203+
### Return type
204+
205+
[**\LaunchDarklyApi\Model\SeriesIntervalsRep**](../Model/SeriesIntervalsRep.md)
206+
207+
### Authorization
208+
209+
[ApiKey](../../README.md#ApiKey)
210+
211+
### HTTP request headers
212+
213+
- **Content-Type**: Not defined
214+
- **Accept**: `application/json`
215+
216+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
217+
[[Back to Model list]](../../README.md#models)
218+
[[Back to README]](../../README.md)
219+
155220
## `getMauSdksByType()`
156221

157222
```php
@@ -160,7 +225,7 @@ getMauSdksByType($from, $to, $sdktype): \LaunchDarklyApi\Model\SdkListRep
160225

161226
Get MAU SDKs by type
162227

163-
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.
228+
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
164229

165230
### Example
166231

@@ -226,7 +291,7 @@ getMauUsage($from, $to, $project, $environment, $sdktype, $sdk, $anonymous, $gro
226291

227292
Get MAU usage
228293

229-
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.
294+
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
230295

231296
### Example
232297

@@ -302,7 +367,7 @@ getMauUsageByCategory($from, $to): \LaunchDarklyApi\Model\SeriesListRep
302367

303368
Get MAU usage by category
304369

305-
Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.
370+
Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
306371

307372
### Example
308373

docs/Api/ApprovalsApi.md

+32-32
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@ All URIs are relative to https://app.launchdarkly.com.
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**deleteApprovalRequest()**](ApprovalsApi.md#deleteApprovalRequest) | **DELETE** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} | Delete approval request
7+
[**deleteApprovalRequestForFlag()**](ApprovalsApi.md#deleteApprovalRequestForFlag) | **DELETE** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} | Delete approval request for a flag
88
[**getApprovalForFlag()**](ApprovalsApi.md#getApprovalForFlag) | **GET** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id} | Get approval request for a flag
99
[**getApprovalsForFlag()**](ApprovalsApi.md#getApprovalsForFlag) | **GET** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | List approval requests for a flag
10-
[**postApprovalRequest()**](ApprovalsApi.md#postApprovalRequest) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Create approval request
11-
[**postApprovalRequestApplyRequest()**](ApprovalsApi.md#postApprovalRequestApplyRequest) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/apply | Apply approval request
12-
[**postApprovalRequestReview()**](ApprovalsApi.md#postApprovalRequestReview) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews | Review approval request
10+
[**postApprovalRequestApplyForFlag()**](ApprovalsApi.md#postApprovalRequestApplyForFlag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/apply | Apply approval request for a flag
11+
[**postApprovalRequestForFlag()**](ApprovalsApi.md#postApprovalRequestForFlag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Create approval request for a flag
12+
[**postApprovalRequestReviewForFlag()**](ApprovalsApi.md#postApprovalRequestReviewForFlag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews | Review approval request for a flag
1313
[**postFlagCopyConfigApprovalRequest()**](ApprovalsApi.md#postFlagCopyConfigApprovalRequest) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy | Create approval request to copy flag configurations across environments
1414

1515

16-
## `deleteApprovalRequest()`
16+
## `deleteApprovalRequestForFlag()`
1717

1818
```php
19-
deleteApprovalRequest($project_key, $feature_flag_key, $environment_key, $id)
19+
deleteApprovalRequestForFlag($project_key, $feature_flag_key, $environment_key, $id)
2020
```
2121

22-
Delete approval request
22+
Delete approval request for a flag
2323

2424
Delete an approval request for a feature flag.
2525

@@ -48,9 +48,9 @@ $environment_key = 'environment_key_example'; // string | The environment key
4848
$id = 'id_example'; // string | The feature flag approval request ID
4949

5050
try {
51-
$apiInstance->deleteApprovalRequest($project_key, $feature_flag_key, $environment_key, $id);
51+
$apiInstance->deleteApprovalRequestForFlag($project_key, $feature_flag_key, $environment_key, $id);
5252
} catch (Exception $e) {
53-
echo 'Exception when calling ApprovalsApi->deleteApprovalRequest: ', $e->getMessage(), PHP_EOL;
53+
echo 'Exception when calling ApprovalsApi->deleteApprovalRequestForFlag: ', $e->getMessage(), PHP_EOL;
5454
}
5555
```
5656

@@ -214,15 +214,15 @@ Name | Type | Description | Notes
214214
[[Back to Model list]](../../README.md#models)
215215
[[Back to README]](../../README.md)
216216

217-
## `postApprovalRequest()`
217+
## `postApprovalRequestApplyForFlag()`
218218

219219
```php
220-
postApprovalRequest($project_key, $feature_flag_key, $environment_key, $create_flag_config_approval_request_request): \LaunchDarklyApi\Model\FlagConfigApprovalRequestResponse
220+
postApprovalRequestApplyForFlag($project_key, $feature_flag_key, $environment_key, $id, $post_approval_request_apply_request): \LaunchDarklyApi\Model\FlagConfigApprovalRequestResponse
221221
```
222222

223-
Create approval request
223+
Apply approval request for a flag
224224

225-
Create an approval request for a feature flag.
225+
Apply an approval request that has been approved.
226226

227227
### Example
228228

@@ -246,13 +246,14 @@ $apiInstance = new LaunchDarklyApi\Api\ApprovalsApi(
246246
$project_key = 'project_key_example'; // string | The project key
247247
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
248248
$environment_key = 'environment_key_example'; // string | The environment key
249-
$create_flag_config_approval_request_request = new \LaunchDarklyApi\Model\CreateFlagConfigApprovalRequestRequest(); // \LaunchDarklyApi\Model\CreateFlagConfigApprovalRequestRequest
249+
$id = 'id_example'; // string | The feature flag approval request ID
250+
$post_approval_request_apply_request = new \LaunchDarklyApi\Model\PostApprovalRequestApplyRequest(); // \LaunchDarklyApi\Model\PostApprovalRequestApplyRequest
250251

251252
try {
252-
$result = $apiInstance->postApprovalRequest($project_key, $feature_flag_key, $environment_key, $create_flag_config_approval_request_request);
253+
$result = $apiInstance->postApprovalRequestApplyForFlag($project_key, $feature_flag_key, $environment_key, $id, $post_approval_request_apply_request);
253254
print_r($result);
254255
} catch (Exception $e) {
255-
echo 'Exception when calling ApprovalsApi->postApprovalRequest: ', $e->getMessage(), PHP_EOL;
256+
echo 'Exception when calling ApprovalsApi->postApprovalRequestApplyForFlag: ', $e->getMessage(), PHP_EOL;
256257
}
257258
```
258259

@@ -263,7 +264,8 @@ Name | Type | Description | Notes
263264
**project_key** | **string**| The project key |
264265
**feature_flag_key** | **string**| The feature flag key |
265266
**environment_key** | **string**| The environment key |
266-
**create_flag_config_approval_request_request** | [**\LaunchDarklyApi\Model\CreateFlagConfigApprovalRequestRequest**](../Model/CreateFlagConfigApprovalRequestRequest.md)| |
267+
**id** | **string**| The feature flag approval request ID |
268+
**post_approval_request_apply_request** | [**\LaunchDarklyApi\Model\PostApprovalRequestApplyRequest**](../Model/PostApprovalRequestApplyRequest.md)| |
267269

268270
### Return type
269271

@@ -282,15 +284,15 @@ Name | Type | Description | Notes
282284
[[Back to Model list]](../../README.md#models)
283285
[[Back to README]](../../README.md)
284286

285-
## `postApprovalRequestApplyRequest()`
287+
## `postApprovalRequestForFlag()`
286288

287289
```php
288-
postApprovalRequestApplyRequest($project_key, $feature_flag_key, $environment_key, $id, $post_approval_request_apply_request): \LaunchDarklyApi\Model\FlagConfigApprovalRequestResponse
290+
postApprovalRequestForFlag($project_key, $feature_flag_key, $environment_key, $create_flag_config_approval_request_request): \LaunchDarklyApi\Model\FlagConfigApprovalRequestResponse
289291
```
290292

291-
Apply approval request
293+
Create approval request for a flag
292294

293-
Apply an approval request that has been approved.
295+
Create an approval request for a feature flag.
294296

295297
### Example
296298

@@ -314,14 +316,13 @@ $apiInstance = new LaunchDarklyApi\Api\ApprovalsApi(
314316
$project_key = 'project_key_example'; // string | The project key
315317
$feature_flag_key = 'feature_flag_key_example'; // string | The feature flag key
316318
$environment_key = 'environment_key_example'; // string | The environment key
317-
$id = 'id_example'; // string | The feature flag approval request ID
318-
$post_approval_request_apply_request = new \LaunchDarklyApi\Model\PostApprovalRequestApplyRequest(); // \LaunchDarklyApi\Model\PostApprovalRequestApplyRequest
319+
$create_flag_config_approval_request_request = new \LaunchDarklyApi\Model\CreateFlagConfigApprovalRequestRequest(); // \LaunchDarklyApi\Model\CreateFlagConfigApprovalRequestRequest
319320

320321
try {
321-
$result = $apiInstance->postApprovalRequestApplyRequest($project_key, $feature_flag_key, $environment_key, $id, $post_approval_request_apply_request);
322+
$result = $apiInstance->postApprovalRequestForFlag($project_key, $feature_flag_key, $environment_key, $create_flag_config_approval_request_request);
322323
print_r($result);
323324
} catch (Exception $e) {
324-
echo 'Exception when calling ApprovalsApi->postApprovalRequestApplyRequest: ', $e->getMessage(), PHP_EOL;
325+
echo 'Exception when calling ApprovalsApi->postApprovalRequestForFlag: ', $e->getMessage(), PHP_EOL;
325326
}
326327
```
327328

@@ -332,8 +333,7 @@ Name | Type | Description | Notes
332333
**project_key** | **string**| The project key |
333334
**feature_flag_key** | **string**| The feature flag key |
334335
**environment_key** | **string**| The environment key |
335-
**id** | **string**| The feature flag approval request ID |
336-
**post_approval_request_apply_request** | [**\LaunchDarklyApi\Model\PostApprovalRequestApplyRequest**](../Model/PostApprovalRequestApplyRequest.md)| |
336+
**create_flag_config_approval_request_request** | [**\LaunchDarklyApi\Model\CreateFlagConfigApprovalRequestRequest**](../Model/CreateFlagConfigApprovalRequestRequest.md)| |
337337

338338
### Return type
339339

@@ -352,13 +352,13 @@ Name | Type | Description | Notes
352352
[[Back to Model list]](../../README.md#models)
353353
[[Back to README]](../../README.md)
354354

355-
## `postApprovalRequestReview()`
355+
## `postApprovalRequestReviewForFlag()`
356356

357357
```php
358-
postApprovalRequestReview($project_key, $feature_flag_key, $environment_key, $id, $post_approval_request_review_request): \LaunchDarklyApi\Model\FlagConfigApprovalRequestResponse
358+
postApprovalRequestReviewForFlag($project_key, $feature_flag_key, $environment_key, $id, $post_approval_request_review_request): \LaunchDarklyApi\Model\FlagConfigApprovalRequestResponse
359359
```
360360

361-
Review approval request
361+
Review approval request for a flag
362362

363363
Review an approval request by approving or denying changes.
364364

@@ -388,10 +388,10 @@ $id = 'id_example'; // string | The feature flag approval request ID
388388
$post_approval_request_review_request = new \LaunchDarklyApi\Model\PostApprovalRequestReviewRequest(); // \LaunchDarklyApi\Model\PostApprovalRequestReviewRequest
389389

390390
try {
391-
$result = $apiInstance->postApprovalRequestReview($project_key, $feature_flag_key, $environment_key, $id, $post_approval_request_review_request);
391+
$result = $apiInstance->postApprovalRequestReviewForFlag($project_key, $feature_flag_key, $environment_key, $id, $post_approval_request_review_request);
392392
print_r($result);
393393
} catch (Exception $e) {
394-
echo 'Exception when calling ApprovalsApi->postApprovalRequestReview: ', $e->getMessage(), PHP_EOL;
394+
echo 'Exception when calling ApprovalsApi->postApprovalRequestReviewForFlag: ', $e->getMessage(), PHP_EOL;
395395
}
396396
```
397397

0 commit comments

Comments
 (0)