Skip to content

Commit a32e1ea

Browse files
author
LaunchDarklyReleaseBot
committed
Version 10.0.0 automatically generated from ld-openapi.
1 parent d67d45c commit a32e1ea

File tree

751 files changed

+9360
-1733
lines changed

Some content is hidden

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

751 files changed

+9360
-1733
lines changed

.openapi-generator/FILES

Lines changed: 75 additions & 6 deletions
Large diffs are not rendered by default.

.openapi-generator/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5.3.0
1+
6.0.0

README.md

Lines changed: 109 additions & 141 deletions
Large diffs are not rendered by default.

docs/AccountMembersApi.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ null (empty response body)
7070
7171
Get account member
7272

73-
Get a single account member by ID. `me` is a reserved value for the `id` parameter and returns the caller's member information.
73+
Get a single account member by member ID. `me` is a reserved value for the `id` parameter and returns the caller's member information.
7474

7575
### Example
7676

@@ -121,7 +121,7 @@ Name | Type | Description | Notes
121121
122122
List account members
123123

124-
Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports three fields for filters: `query`, `role`, and `lastSeen`: - `query` is a string that matches against the members' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `lastSeen` is a JSON object in 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. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member's email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest.
124+
Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Filtering members LaunchDarkly supports three fields for filters: `query`, `role`, and `lastSeen`: - `query` is a string that matches against the members' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `team` is a string that matches against the key of the teams the members belong to. It is not case sensitive. - `lastSeen` is a JSON object in 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. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member's email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest.
125125

126126
### Example
127127

@@ -137,7 +137,7 @@ ApiKey.apiKey = 'YOUR API KEY';
137137
let apiInstance = new LaunchDarklyApi.AccountMembersApi();
138138
let opts = {
139139
'limit': 789, // Number | The number of members to return in the response. Defaults to 20.
140-
'offset': 789, // Number | Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first ten items and then return the next `limit` items.
140+
'offset': 789, // Number | Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`.
141141
'filter': "filter_example", // String | A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above.
142142
'sort': "sort_example" // String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.
143143
};
@@ -156,7 +156,7 @@ apiInstance.getMembers(opts, (error, data, response) => {
156156
Name | Type | Description | Notes
157157
------------- | ------------- | ------------- | -------------
158158
**limit** | **Number**| The number of members to return in the response. Defaults to 20. | [optional]
159-
**offset** | **Number**| Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first ten items and then return the next `limit` items. | [optional]
159+
**offset** | **Number**| Where to start in the list. This is for use with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. | [optional]
160160
**filter** | **String**| A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. | [optional]
161161
**sort** | **String**| A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. | [optional]
162162

@@ -286,7 +286,7 @@ Name | Type | Description | Notes
286286
287287
Invite new members
288288

289-
> ### Full use of this API resource is only available to accounts with paid subscriptions > > The ability to bulk invite members is a paid feature. Single members may be invited if not on a paid plan. Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).
289+
> ### Full use of this API resource is only available to customers on an Enterprise plan > > The ability to bulk invite members is an Enterprise feature. On a starter or Pro plan? You can invite members individually. Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. Requests to create account members will not work if SCIM is enabled for the account. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).
290290

291291
### Example
292292

docs/ActionInputRep.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**instructions** | **Object** | | [optional]
7+
**instructions** | **Object** | An array of instructions for the stage. Each object in the array uses the semantic patch format for updating a feature flag. | [optional]
88

99

docs/ApprovalConditionInputRep.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**description** | **String** | | [optional]
88
**notifyMemberIds** | **[String]** | | [optional]
9+
**notifyTeamKeys** | **[String]** | | [optional]
910

1011

docs/ApprovalsApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Method | HTTP request | Description
2020
2121
Delete approval request
2222

23-
Delete an approval request for a feature flag
23+
Delete an approval request for a feature flag.
2424

2525
### Example
2626

@@ -77,7 +77,7 @@ null (empty response body)
7777
7878
Get approval request
7979

80-
Get a single approval request for a feature flag
80+
Get a single approval request for a feature flag.
8181

8282
### Example
8383

@@ -134,7 +134,7 @@ Name | Type | Description | Notes
134134
135135
List all approval requests
136136

137-
Get all approval requests for a feature flag
137+
Get all approval requests for a feature flag.
138138

139139
### Example
140140

@@ -189,7 +189,7 @@ Name | Type | Description | Notes
189189
190190
Create approval request
191191

192-
Create an approval request for a feature flag
192+
Create an approval request for a feature flag.
193193

194194
### Example
195195

@@ -246,7 +246,7 @@ Name | Type | Description | Notes
246246
247247
Apply approval request
248248

249-
Apply approval request by either approving or declining changes.
249+
Apply an approval request that has been approved.
250250

251251
### Example
252252

@@ -305,7 +305,7 @@ Name | Type | Description | Notes
305305
306306
Review approval request
307307

308-
Review approval request by either approving or declining changes.
308+
Review an approval request by approving or denying changes.
309309

310310
### Example
311311

@@ -380,7 +380,7 @@ ApiKey.apiKey = 'YOUR API KEY';
380380
let apiInstance = new LaunchDarklyApi.ApprovalsApi();
381381
let projectKey = "projectKey_example"; // String | The project key
382382
let featureFlagKey = "featureFlagKey_example"; // String | The feature flag key
383-
let environmentKey = "environmentKey_example"; // String | The environment key
383+
let environmentKey = "environmentKey_example"; // String | The environment key for the target environment
384384
let createCopyFlagConfigApprovalRequestRequest = new LaunchDarklyApi.CreateCopyFlagConfigApprovalRequestRequest(); // CreateCopyFlagConfigApprovalRequestRequest |
385385
apiInstance.postFlagCopyConfigApprovalRequest(projectKey, featureFlagKey, environmentKey, createCopyFlagConfigApprovalRequestRequest, (error, data, response) => {
386386
if (error) {
@@ -398,7 +398,7 @@ Name | Type | Description | Notes
398398
------------- | ------------- | ------------- | -------------
399399
**projectKey** | **String**| The project key |
400400
**featureFlagKey** | **String**| The feature flag key |
401-
**environmentKey** | **String**| The environment key |
401+
**environmentKey** | **String**| The environment key for the target environment |
402402
**createCopyFlagConfigApprovalRequestRequest** | [**CreateCopyFlagConfigApprovalRequestRequest**](CreateCopyFlagConfigApprovalRequestRequest.md)| |
403403

404404
### Return type

docs/AuditLogApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Name | Type | Description | Notes
7676
7777
Get audit log entry
7878

79-
Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation: - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity
79+
Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation, including: - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity
8080

8181
### Example
8282

docs/Client.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# LaunchDarklyApi.Client
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**links** | [**{String: Link}**](Link.md) | Links to related resources. |
8+
**name** | **String** | Client name |
9+
**description** | **String** | Client description | [optional]
10+
**accountId** | **String** | The account ID the client is registered under |
11+
**clientId** | **String** | The client's unique ID |
12+
**clientSecret** | **String** | The client secret. This will only be shown upon creation. | [optional]
13+
**redirectUri** | **String** | The client's redirect URI |
14+
**creationDate** | **Number** | |
15+
16+

docs/ClientCollection.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# LaunchDarklyApi.ClientCollection
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**links** | [**{String: Link}**](Link.md) | |
8+
**items** | [**[Client]**](Client.md) | List of client objects |
9+
10+

0 commit comments

Comments
 (0)