Skip to content

Commit a29d6db

Browse files
author
LaunchDarklyReleaseBot
committed
Version 12.0.0 automatically generated from ld-openapi.
1 parent abd73a8 commit a29d6db

File tree

867 files changed

+14995
-1502
lines changed

Some content is hidden

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

867 files changed

+14995
-1502
lines changed

‎.openapi-generator/FILES

Lines changed: 138 additions & 3 deletions
Large diffs are not rendered by default.

‎README.md

Lines changed: 77 additions & 12 deletions
Large diffs are not rendered by default.

‎docs/AccountUsageBetaApi.md

Lines changed: 59 additions & 3 deletions
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
@@ -135,13 +136,68 @@ Name | Type | Description | Notes
135136
- **Accept**: application/json
136137

137138

139+
## getExperimentationKeysUsage
140+
141+
> SeriesIntervalsRep getExperimentationKeysUsage(opts)
142+
143+
Get experimentation keys usage
144+
145+
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.
146+
147+
### Example
148+
149+
```javascript
150+
import LaunchDarklyApi from 'launchdarkly-api';
151+
let defaultClient = LaunchDarklyApi.ApiClient.instance;
152+
// Configure API key authorization: ApiKey
153+
let ApiKey = defaultClient.authentications['ApiKey'];
154+
ApiKey.apiKey = 'YOUR API KEY';
155+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
156+
//ApiKey.apiKeyPrefix = 'Token';
157+
158+
let apiInstance = new LaunchDarklyApi.AccountUsageBetaApi();
159+
let opts = {
160+
'from': "from_example", // String | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
161+
'to': "to_example" // String | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
162+
};
163+
apiInstance.getExperimentationKeysUsage(opts, (error, data, response) => {
164+
if (error) {
165+
console.error(error);
166+
} else {
167+
console.log('API called successfully. Returned data: ' + data);
168+
}
169+
});
170+
```
171+
172+
### Parameters
173+
174+
175+
Name | Type | Description | Notes
176+
------------- | ------------- | ------------- | -------------
177+
**from** | **String**| The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | [optional]
178+
**to** | **String**| The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | [optional]
179+
180+
### Return type
181+
182+
[**SeriesIntervalsRep**](SeriesIntervalsRep.md)
183+
184+
### Authorization
185+
186+
[ApiKey](../README.md#ApiKey)
187+
188+
### HTTP request headers
189+
190+
- **Content-Type**: Not defined
191+
- **Accept**: application/json
192+
193+
138194
## getMauSdksByType
139195

140196
> SdkListRep getMauSdksByType(opts)
141197
142198
Get MAU SDKs by type
143199

144-
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.
200+
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).
145201

146202
### Example
147203

@@ -198,7 +254,7 @@ Name | Type | Description | Notes
198254
199255
Get MAU usage
200256

201-
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.
257+
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).
202258

203259
### Example
204260

@@ -265,7 +321,7 @@ Name | Type | Description | Notes
265321
266322
Get MAU usage by category
267323

268-
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`.
324+
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).
269325

270326
### Example
271327

‎docs/ApprovalConditionInput.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**description** | **String** | | [optional]
8-
**notifyMemberIds** | **[String]** | | [optional]
9-
**notifyTeamKeys** | **[String]** | | [optional]
7+
**description** | **String** | A description of the approval required for this stage | [optional]
8+
**notifyMemberIds** | **[String]** | A list of member IDs for the members to request approval from for this stage | [optional]
9+
**notifyTeamKeys** | **[String]** | A list of team keys for the teams to request approval from for this stage | [optional]
1010

1111

‎docs/ApprovalRequestResponse.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# LaunchDarklyApi.ApprovalRequestResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **String** | The ID of this approval request |
8+
**version** | **Number** | Version of the approval request |
9+
**creationDate** | **Number** | |
10+
**serviceKind** | **String** | |
11+
**requestorId** | **String** | The ID of the member who requested the approval | [optional]
12+
**description** | **String** | A human-friendly name for the approval request | [optional]
13+
**reviewStatus** | **String** | Current status of the review of this approval request |
14+
**allReviews** | [**[ReviewResponse]**](ReviewResponse.md) | An array of individual reviews of this approval request |
15+
**notifyMemberIds** | **[String]** | An array of member IDs. These members are notified to review the approval request. |
16+
**appliedDate** | **Number** | | [optional]
17+
**appliedByMemberId** | **String** | The member ID of the member who applied the approval request | [optional]
18+
**status** | **String** | Current status of the approval request |
19+
**instructions** | **[Object]** | |
20+
**conflicts** | [**[Conflict]**](Conflict.md) | Details on any conflicting approval requests |
21+
**links** | **{String: Object}** | The location and content type of related resources |
22+
**executionDate** | **Number** | | [optional]
23+
**operatingOnId** | **String** | ID of scheduled change to edit or delete | [optional]
24+
**integrationMetadata** | [**IntegrationMetadata**](IntegrationMetadata.md) | | [optional]
25+
**source** | [**CopiedFromEnv**](CopiedFromEnv.md) | | [optional]
26+
**customWorkflowMetadata** | [**CustomWorkflowMeta**](CustomWorkflowMeta.md) | | [optional]
27+
**resourceId** | **String** | String representation of a resource | [optional]
28+
**approvalSettings** | [**ApprovalSettings**](ApprovalSettings.md) | | [optional]
29+
30+
31+
32+
## Enum: ReviewStatusEnum
33+
34+
35+
* `approved` (value: `"approved"`)
36+
37+
* `declined` (value: `"declined"`)
38+
39+
* `pending` (value: `"pending"`)
40+
41+
42+
43+
44+
45+
## Enum: StatusEnum
46+
47+
48+
* `pending` (value: `"pending"`)
49+
50+
* `completed` (value: `"completed"`)
51+
52+
* `failed` (value: `"failed"`)
53+
54+
* `scheduled` (value: `"scheduled"`)
55+
56+
57+
58+

‎docs/ApprovalsApi.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ 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

1616

17-
## deleteApprovalRequest
17+
## deleteApprovalRequestForFlag
1818

19-
> deleteApprovalRequest(projectKey, featureFlagKey, environmentKey, id)
19+
> deleteApprovalRequestForFlag(projectKey, featureFlagKey, environmentKey, id)
2020
21-
Delete approval request
21+
Delete approval request for a flag
2222

2323
Delete an approval request for a feature flag.
2424

@@ -38,7 +38,7 @@ let projectKey = "projectKey_example"; // String | The project key
3838
let featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
3939
let environmentKey = "environmentKey_example"; // String | The environment key
4040
let id = "id_example"; // String | The feature flag approval request ID
41-
apiInstance.deleteApprovalRequest(projectKey, featureFlagKey, environmentKey, id, (error, data, response) => {
41+
apiInstance.deleteApprovalRequestForFlag(projectKey, featureFlagKey, environmentKey, id, (error, data, response) => {
4242
if (error) {
4343
console.error(error);
4444
} else {
@@ -183,13 +183,13 @@ Name | Type | Description | Notes
183183
- **Accept**: application/json
184184

185185

186-
## postApprovalRequest
186+
## postApprovalRequestApplyForFlag
187187

188-
> FlagConfigApprovalRequestResponse postApprovalRequest(projectKey, featureFlagKey, environmentKey, createFlagConfigApprovalRequestRequest)
188+
> FlagConfigApprovalRequestResponse postApprovalRequestApplyForFlag(projectKey, featureFlagKey, environmentKey, id, postApprovalRequestApplyRequest)
189189
190-
Create approval request
190+
Apply approval request for a flag
191191

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

194194
### Example
195195

@@ -206,8 +206,9 @@ let apiInstance = new LaunchDarklyApi.ApprovalsApi();
206206
let projectKey = "projectKey_example"; // String | The project key
207207
let featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
208208
let environmentKey = "environmentKey_example"; // String | The environment key
209-
let createFlagConfigApprovalRequestRequest = new LaunchDarklyApi.CreateFlagConfigApprovalRequestRequest(); // CreateFlagConfigApprovalRequestRequest |
210-
apiInstance.postApprovalRequest(projectKey, featureFlagKey, environmentKey, createFlagConfigApprovalRequestRequest, (error, data, response) => {
209+
let id = "id_example"; // String | The feature flag approval request ID
210+
let postApprovalRequestApplyRequest = new LaunchDarklyApi.PostApprovalRequestApplyRequest(); // PostApprovalRequestApplyRequest |
211+
apiInstance.postApprovalRequestApplyForFlag(projectKey, featureFlagKey, environmentKey, id, postApprovalRequestApplyRequest, (error, data, response) => {
211212
if (error) {
212213
console.error(error);
213214
} else {
@@ -224,7 +225,8 @@ Name | Type | Description | Notes
224225
**projectKey** | **String**| The project key |
225226
**featureFlagKey** | **String**| The feature flag key |
226227
**environmentKey** | **String**| The environment key |
227-
**createFlagConfigApprovalRequestRequest** | [**CreateFlagConfigApprovalRequestRequest**](CreateFlagConfigApprovalRequestRequest.md)| |
228+
**id** | **String**| The feature flag approval request ID |
229+
**postApprovalRequestApplyRequest** | [**PostApprovalRequestApplyRequest**](PostApprovalRequestApplyRequest.md)| |
228230

229231
### Return type
230232

@@ -240,13 +242,13 @@ Name | Type | Description | Notes
240242
- **Accept**: application/json
241243

242244

243-
## postApprovalRequestApplyRequest
245+
## postApprovalRequestForFlag
244246

245-
> FlagConfigApprovalRequestResponse postApprovalRequestApplyRequest(projectKey, featureFlagKey, environmentKey, id, postApprovalRequestApplyRequest)
247+
> FlagConfigApprovalRequestResponse postApprovalRequestForFlag(projectKey, featureFlagKey, environmentKey, createFlagConfigApprovalRequestRequest)
246248
247-
Apply approval request
249+
Create approval request for a flag
248250

249-
Apply an approval request that has been approved.
251+
Create an approval request for a feature flag.
250252

251253
### Example
252254

@@ -263,9 +265,8 @@ let apiInstance = new LaunchDarklyApi.ApprovalsApi();
263265
let projectKey = "projectKey_example"; // String | The project key
264266
let featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
265267
let environmentKey = "environmentKey_example"; // String | The environment key
266-
let id = "id_example"; // String | The feature flag approval request ID
267-
let postApprovalRequestApplyRequest = new LaunchDarklyApi.PostApprovalRequestApplyRequest(); // PostApprovalRequestApplyRequest |
268-
apiInstance.postApprovalRequestApplyRequest(projectKey, featureFlagKey, environmentKey, id, postApprovalRequestApplyRequest, (error, data, response) => {
268+
let createFlagConfigApprovalRequestRequest = new LaunchDarklyApi.CreateFlagConfigApprovalRequestRequest(); // CreateFlagConfigApprovalRequestRequest |
269+
apiInstance.postApprovalRequestForFlag(projectKey, featureFlagKey, environmentKey, createFlagConfigApprovalRequestRequest, (error, data, response) => {
269270
if (error) {
270271
console.error(error);
271272
} else {
@@ -282,8 +283,7 @@ Name | Type | Description | Notes
282283
**projectKey** | **String**| The project key |
283284
**featureFlagKey** | **String**| The feature flag key |
284285
**environmentKey** | **String**| The environment key |
285-
**id** | **String**| The feature flag approval request ID |
286-
**postApprovalRequestApplyRequest** | [**PostApprovalRequestApplyRequest**](PostApprovalRequestApplyRequest.md)| |
286+
**createFlagConfigApprovalRequestRequest** | [**CreateFlagConfigApprovalRequestRequest**](CreateFlagConfigApprovalRequestRequest.md)| |
287287

288288
### Return type
289289

@@ -299,11 +299,11 @@ Name | Type | Description | Notes
299299
- **Accept**: application/json
300300

301301

302-
## postApprovalRequestReview
302+
## postApprovalRequestReviewForFlag
303303

304-
> FlagConfigApprovalRequestResponse postApprovalRequestReview(projectKey, featureFlagKey, environmentKey, id, postApprovalRequestReviewRequest)
304+
> FlagConfigApprovalRequestResponse postApprovalRequestReviewForFlag(projectKey, featureFlagKey, environmentKey, id, postApprovalRequestReviewRequest)
305305
306-
Review approval request
306+
Review approval request for a flag
307307

308308
Review an approval request by approving or denying changes.
309309

@@ -324,7 +324,7 @@ let featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
324324
let environmentKey = "environmentKey_example"; // String | The environment key
325325
let id = "id_example"; // String | The feature flag approval request ID
326326
let postApprovalRequestReviewRequest = new LaunchDarklyApi.PostApprovalRequestReviewRequest(); // PostApprovalRequestReviewRequest |
327-
apiInstance.postApprovalRequestReview(projectKey, featureFlagKey, environmentKey, id, postApprovalRequestReviewRequest, (error, data, response) => {
327+
apiInstance.postApprovalRequestReviewForFlag(projectKey, featureFlagKey, environmentKey, id, postApprovalRequestReviewRequest, (error, data, response) => {
328328
if (error) {
329329
console.error(error);
330330
} else {

0 commit comments

Comments
 (0)