Skip to content

Commit c664e4e

Browse files
author
LaunchDarklyReleaseBot
committed
Version 17.0.0 automatically generated from ld-openapi.
1 parent d40fbca commit c664e4e

File tree

1,084 files changed

+14306
-1919
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,084 files changed

+14306
-1919
lines changed

.openapi-generator/FILES

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

README.md

Lines changed: 78 additions & 18 deletions
Large diffs are not rendered by default.

docs/AccountMembersApi.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ null (empty response body)
6666

6767
## getMember
6868

69-
> Member getMember(id)
69+
> Member getMember(id, opts)
7070
7171
Get account member
7272

@@ -85,7 +85,10 @@ ApiKey.apiKey = 'YOUR API KEY';
8585

8686
let apiInstance = new LaunchDarklyApi.AccountMembersApi();
8787
let id = "id_example"; // String | The member ID
88-
apiInstance.getMember(id, (error, data, response) => {
88+
let opts = {
89+
'expand': "expand_example" // String | A comma-separated list of properties that can reveal additional information in the response.
90+
};
91+
apiInstance.getMember(id, opts, (error, data, response) => {
8992
if (error) {
9093
console.error(error);
9194
} else {
@@ -100,6 +103,7 @@ apiInstance.getMember(id, (error, data, response) => {
100103
Name | Type | Description | Notes
101104
------------- | ------------- | ------------- | -------------
102105
**id** | **String**| The member ID |
106+
**expand** | **String**| A comma-separated list of properties that can reveal additional information in the response. | [optional]
103107

104108
### Return type
105109

@@ -121,7 +125,7 @@ Name | Type | Description | Notes
121125
122126
List account members
123127

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 the following fields for filters: - `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. - `noteam` is a boolean that filters the list of members who are not on a team if true and members on a team if false. - `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. - `accessCheck` is a string that represents a specific action on a specific resource and is in the format `<ActionSpecifier>:<ResourceSpecifier>`. It filters the list to members who have the ability to perform that action on that resource. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://apidocs.launchdarkly.com/#section/Overview/Versioning). - For example, the filter `accessCheck:createApprovalRequest:proj/default:env/test:flag/alternate-page` matches members with the ability to create an approval request for the `alternate-page` flag in the `test` environment of the `default` project. - Wildcard and tag filters are not supported when filtering for access. 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 `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.
128+
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 the following fields for filters: - `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`. - `id` is a `|` separated list of member IDs. It filters the list to members who match any of the IDs in the list. - `email` is a `|` separated list of member emails. It filters the list to members who match any of the emails in the list. - `team` is a string that matches against the key of the teams the members belong to. It is not case sensitive. - `noteam` is a boolean that filters the list of members who are not on a team if true and members on a team if false. - `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. - `accessCheck` is a string that represents a specific action on a specific resource and is in the format `<ActionSpecifier>:<ResourceSpecifier>`. It filters the list to members who have the ability to perform that action on that resource. Note: `accessCheck` is only supported in API version `20220603` and earlier. To learn more, read [Versioning](https://apidocs.launchdarkly.com/#section/Overview/Versioning). - For example, the filter `accessCheck:createApprovalRequest:proj/default:env/test:flag/alternate-page` matches members with the ability to create an approval request for the `alternate-page` flag in the `test` environment of the `default` project. - Wildcard and tag filters are not supported when filtering for access. 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 `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.
125129

126130
### Example
127131

@@ -139,6 +143,7 @@ let opts = {
139143
'limit': 789, // Number | The number of members to return in the response. Defaults to 20.
140144
'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`.
141145
'filter': "filter_example", // String | A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above.
146+
'expand': "expand_example", // String | A comma-separated list of properties that can reveal additional information in the response.
142147
'sort': "sort_example" // String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.
143148
};
144149
apiInstance.getMembers(opts, (error, data, response) => {
@@ -158,6 +163,7 @@ Name | Type | Description | Notes
158163
**limit** | **Number**| The number of members to return in the response. Defaults to 20. | [optional]
159164
**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]
160165
**filter** | **String**| A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. | [optional]
166+
**expand** | **String**| A comma-separated list of properties that can reveal additional information in the response. | [optional]
161167
**sort** | **String**| A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. | [optional]
162168

163169
### Return type

0 commit comments

Comments
 (0)