Skip to content

Commit 0aaeca4

Browse files
author
LaunchDarklyReleaseBot
committed
Version 14.0.0 automatically generated from ld-openapi.
1 parent 40ddbf7 commit 0aaeca4

File tree

1,011 files changed

+16906
-4127
lines changed

Some content is hidden

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

1,011 files changed

+16906
-4127
lines changed

.openapi-generator/FILES

+150-21
Large diffs are not rendered by default.

README.md

+92-27
Large diffs are not rendered by default.

docs/AccessAllowedReason.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,18 @@ Name | Type | Description | Notes
88
**notResources** | **[String]** | Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field. | [optional]
99
**actions** | **[String]** | Actions to perform on a resource | [optional]
1010
**notActions** | **[String]** | Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field. | [optional]
11-
**effect** | **String** | |
11+
**effect** | **String** | Whether this statement should allow or deny actions on the resources. |
1212
**roleName** | **String** | | [optional]
1313

1414

15+
16+
## Enum: EffectEnum
17+
18+
19+
* `allow` (value: `"allow"`)
20+
21+
* `deny` (value: `"deny"`)
22+
23+
24+
25+

docs/AccessDeniedReason.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,18 @@ Name | Type | Description | Notes
88
**notResources** | **[String]** | Targeted resources are the resources NOT in this list. The <code>resources</code> and <code>notActions</code> fields must be empty to use this field. | [optional]
99
**actions** | **[String]** | Actions to perform on a resource | [optional]
1010
**notActions** | **[String]** | Targeted actions are the actions NOT in this list. The <code>actions</code> and <code>notResources</code> fields must be empty to use this field. | [optional]
11-
**effect** | **String** | |
11+
**effect** | **String** | Whether this statement should allow or deny actions on the resources. |
1212
**roleName** | **String** | | [optional]
1313

1414

15+
16+
## Enum: EffectEnum
17+
18+
19+
* `allow` (value: `"allow"`)
20+
21+
* `deny` (value: `"deny"`)
22+
23+
24+
25+

docs/AccessTokensApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Name | Type | Description | Notes
174174
175175
Patch access token
176176

177-
Update an access token's settings. The request should be a valid JSON Patch document describing the changes to be made to the access token.
177+
Update an access token's settings. Updating an access token uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).
178178

179179
### Example
180180

docs/AccountMembersApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Name | Type | Description | Notes
180180
181181
Modify an account member
182182

183-
Update a single account member. The request should be a valid JSON Patch document describing the changes to be made to the member. To update fields in the account member object that are arrays, set the `path` to the name of the field and then append `/<array index>`. Using `/0` appends to the beginning of the array. For example, to add a new custom role to a member, use the following request body: ``` [ { \"op\": \"add\", \"path\": \"/customRoles/0\", \"value\": \"some-role-id\" } ] ``` When SAML SSO or SCIM is enabled for the account, account members are managed in the Identity Provider (IdP). Requests to update account members will succeed, but the IdP will override the update shortly afterwards.
183+
Update a single account member. Updating a member uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates). To update fields in the account member object that are arrays, set the `path` to the name of the field and then append `/<array index>`. Use `/0` to add to the beginning of the array. Use `/-` to add to the end of the array. For example, to add a new custom role to a member, use the following request body: ``` [ { \"op\": \"add\", \"path\": \"/customRoles/0\", \"value\": \"some-role-id\" } ] ``` You can update only an account member's role or custom role using a JSON patch. Members can update their own names and email addresses though the LaunchDarkly UI. When SAML SSO or SCIM is enabled for the account, account members are managed in the Identity Provider (IdP). Requests to update account members will succeed, but the IdP will override the update shortly afterwards.
184184

185185
### Example
186186

docs/AccountMembersBetaApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Method | HTTP request | Description
1414
1515
Modify account members
1616

17-
Perform a partial update to multiple members. Updating members uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](/reference#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating members. #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly's built-in roles](https://docs.launchdarkly.com/home/members/built-in-roles). - `memberIDs`: List of member IDs. #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are excluded from the update. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly's built-in roles](https://docs.launchdarkly.com/home/members/built-in-roles). - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are excluded from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs.
17+
Perform a partial update to multiple members. Updating members uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](/reference#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating members. <details> <summary>Click to expand instructions for <strong>updating members</strong></summary> #### replaceMembersRoles Replaces the roles of the specified members. This also removes all custom roles assigned to the specified members. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly's built-in roles](https://docs.launchdarkly.com/home/members/built-in-roles). - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMemberRoles\", \"value\": \"reader\", \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersRoles Replaces the roles of all members. This also removes all custom roles assigned to the specified members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `value`: The new role. Must be a valid built-in role. To learn more about built-in roles, read [LaunchDarkly's built-in roles](https://docs.launchdarkly.com/home/members/built-in-roles). - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersRoles\", \"value\": \"reader\", \"filterLastSeen\": { \"never\": true } }] } ``` #### replaceMembersCustomRoles Replaces the custom roles of the specified members. ##### Parameters - `values`: List of new custom roles. Must be a valid custom role key or ID. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` #### replaceAllMembersCustomRoles Replaces the custom roles of all members. Members that match any of the filters are **excluded** from the update. ##### Parameters - `values`: List of new roles. Must be a valid custom role key or ID. - `filterLastSeen`: (Optional) A JSON object with one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. - `filterQuery`: (Optional) A string that matches against the members' emails and names. It is not case sensitive. - `filterRoles`: (Optional) A `|` separated list of roles and custom roles. For the purposes of this filtering, `Owner` counts as `Admin`. - `filterTeamKey`: (Optional) A string that matches against the key of the team the members belong to. It is not case sensitive. - `ignoredMemberIDs`: (Optional) A list of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceAllMembersCustomRoles\", \"values\": [ \"example-custom-role\" ], \"filterLastSeen\": { \"never\": true } }] } ``` </details>
1818

1919
### Example
2020

docs/AccountUsageBetaApi.md

+59-3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Method | HTTP request | Description
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
99
[**getExperimentationKeysUsage**](AccountUsageBetaApi.md#getExperimentationKeysUsage) | **GET** /api/v2/usage/experimentation-keys | Get experimentation keys usage
10+
[**getExperimentationUnitsUsage**](AccountUsageBetaApi.md#getExperimentationUnitsUsage) | **GET** /api/v2/usage/experimentation-units | Get experimentation units usage
1011
[**getMauSdksByType**](AccountUsageBetaApi.md#getMauSdksByType) | **GET** /api/v2/usage/mau/sdks | Get MAU SDKs by type
1112
[**getMauUsage**](AccountUsageBetaApi.md#getMauUsage) | **GET** /api/v2/usage/mau | Get MAU usage
1213
[**getMauUsageByCategory**](AccountUsageBetaApi.md#getMauUsageByCategory) | **GET** /api/v2/usage/mau/bycategory | Get MAU usage by category
@@ -191,13 +192,68 @@ Name | Type | Description | Notes
191192
- **Accept**: application/json
192193

193194

195+
## getExperimentationUnitsUsage
196+
197+
> SeriesIntervalsRep getExperimentationUnitsUsage(opts)
198+
199+
Get experimentation units usage
200+
201+
Get a time-series array of the number of monthly experimentation units from your account. The granularity is always daily, with a maximum of 31 days.
202+
203+
### Example
204+
205+
```javascript
206+
import LaunchDarklyApi from 'launchdarkly-api';
207+
let defaultClient = LaunchDarklyApi.ApiClient.instance;
208+
// Configure API key authorization: ApiKey
209+
let ApiKey = defaultClient.authentications['ApiKey'];
210+
ApiKey.apiKey = 'YOUR API KEY';
211+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
212+
//ApiKey.apiKeyPrefix = 'Token';
213+
214+
let apiInstance = new LaunchDarklyApi.AccountUsageBetaApi();
215+
let opts = {
216+
'from': "from_example", // String | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
217+
'to': "to_example" // String | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
218+
};
219+
apiInstance.getExperimentationUnitsUsage(opts, (error, data, response) => {
220+
if (error) {
221+
console.error(error);
222+
} else {
223+
console.log('API called successfully. Returned data: ' + data);
224+
}
225+
});
226+
```
227+
228+
### Parameters
229+
230+
231+
Name | Type | Description | Notes
232+
------------- | ------------- | ------------- | -------------
233+
**from** | **String**| The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | [optional]
234+
**to** | **String**| The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | [optional]
235+
236+
### Return type
237+
238+
[**SeriesIntervalsRep**](SeriesIntervalsRep.md)
239+
240+
### Authorization
241+
242+
[ApiKey](../README.md#ApiKey)
243+
244+
### HTTP request headers
245+
246+
- **Content-Type**: Not defined
247+
- **Accept**: application/json
248+
249+
194250
## getMauSdksByType
195251

196252
> SdkListRep getMauSdksByType(opts)
197253
198254
Get MAU SDKs by type
199255

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/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
256+
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. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
201257

202258
### Example
203259

@@ -254,7 +310,7 @@ Name | Type | Description | Notes
254310
255311
Get MAU usage
256312

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/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
313+
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. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
258314

259315
### Example
260316

@@ -321,7 +377,7 @@ Name | Type | Description | Notes
321377
322378
Get MAU usage by category
323379

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/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
380+
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. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
325381

326382
### Example
327383

docs/ApplicationCollectionRep.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# LaunchDarklyApi.ApplicationCollectionRep
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**links** | [**{String: Link}**](Link.md) | The location and content type of related resources | [optional]
8+
**items** | [**[ApplicationRep]**](ApplicationRep.md) | A list of applications | [optional]
9+
**totalCount** | **Number** | The number of applications | [optional]
10+
11+

0 commit comments

Comments
 (0)