Skip to content

Commit b5039f8

Browse files
author
LaunchDarklyReleaseBot
committed
Version 11.0.0 automatically generated from ld-openapi.
1 parent f86ebb8 commit b5039f8

File tree

962 files changed

+16649
-15756
lines changed

Some content is hidden

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

962 files changed

+16649
-15756
lines changed

.openapi-generator/FILES

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

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ script:
1111
- bundle install --path vendor/bundle
1212
- bundle exec rspec
1313
- gem build launchdarkly_api.gemspec
14-
- gem install ./launchdarkly_api-10.0.0.gem
14+
- gem install ./launchdarkly_api-11.0.0.gem

README.md

Lines changed: 122 additions & 100 deletions
Large diffs are not rendered by default.

docs/AccessAllowedReason.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
77
| **resources** | **Array<String>** | Resource specifier strings | [optional] |
8-
| **not_resources** | **Array<String>** | Targeted resources are the resources NOT in this list. The \"resources\" and \"notActions\" fields must be empty to use this field. | [optional] |
8+
| **not_resources** | **Array<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** | **Array<String>** | Actions to perform on a resource | [optional] |
10-
| **not_actions** | **Array<String>** | Targeted actions are the actions NOT in this list. The \"actions\" and \"notResources\" fields must be empty to use this field. | [optional] |
10+
| **not_actions** | **Array<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] |
1111
| **effect** | **String** | | |
1212
| **role_name** | **String** | | [optional] |
1313

@@ -17,9 +17,9 @@
1717
require 'launchdarkly_api'
1818

1919
instance = LaunchDarklyApi::AccessAllowedReason.new(
20-
resources: null,
20+
resources: ["proj/*:env/*;qa_*:/flag/*"],
2121
not_resources: null,
22-
actions: null,
22+
actions: ["*"],
2323
not_actions: null,
2424
effect: null,
2525
role_name: null

docs/AccessDeniedReason.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
77
| **resources** | **Array<String>** | Resource specifier strings | [optional] |
8-
| **not_resources** | **Array<String>** | Targeted resources are the resources NOT in this list. The \"resources\" and \"notActions\" fields must be empty to use this field. | [optional] |
8+
| **not_resources** | **Array<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** | **Array<String>** | Actions to perform on a resource | [optional] |
10-
| **not_actions** | **Array<String>** | Targeted actions are the actions NOT in this list. The \"actions\" and \"notResources\" fields must be empty to use this field. | [optional] |
10+
| **not_actions** | **Array<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] |
1111
| **effect** | **String** | | |
1212
| **role_name** | **String** | | [optional] |
1313

@@ -17,9 +17,9 @@
1717
require 'launchdarkly_api'
1818

1919
instance = LaunchDarklyApi::AccessDeniedReason.new(
20-
resources: null,
20+
resources: ["proj/*:env/*;qa_*:/flag/*"],
2121
not_resources: null,
22-
actions: null,
22+
actions: ["*"],
2323
not_actions: null,
2424
effect: null,
2525
role_name: null

docs/AccessDeniedReasonRep.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/AccessDeniedRep.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/AccessRep.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/AccountMembersApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ nil (empty response body)
8888
8989
Get account member
9090

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

9393
### Examples
9494

@@ -159,7 +159,7 @@ end
159159
160160
List account members
161161

162-
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.
162+
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. - 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.
163163

164164
### Examples
165165

@@ -238,7 +238,7 @@ end
238238
239239
Modify an account member
240240

241-
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\" } ] ``` Requests to update account members will not work if SCIM is enabled for the account.
241+
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.
242242

243243
### Examples
244244

@@ -384,7 +384,7 @@ end
384384
385385
Invite new members
386386

387-
> ### 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).
387+
> ### Full use of this API resource is an Enterprise feature > > The ability to bulk invite members is available to customers on an Enterprise plan. If you are on a Pro plan, you can invite members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). 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).
388388

389389
### Examples
390390

0 commit comments

Comments
 (0)