Skip to content

Commit 0f7d20f

Browse files
author
LaunchDarklyReleaseBot
committed
Version 10.0.0 automatically generated from ld-openapi.
1 parent 3de288d commit 0f7d20f

File tree

772 files changed

+13519
-2348
lines changed

Some content is hidden

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

772 files changed

+13519
-2348
lines changed

.openapi-generator/FILES

+75-6
Large diffs are not rendered by default.

.openapi-generator/VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5.3.0
1+
6.0.0

.travis.yml

+1-1
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-9.0.1.gem
14+
- gem install ./launchdarkly_api-10.0.0.gem

README.md

+112-144
Large diffs are not rendered by default.

docs/AccountMembersApi.md

+7-7
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 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 and 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`. - `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 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.
163163

164164
### Examples
165165

@@ -177,7 +177,7 @@ end
177177
api_instance = LaunchDarklyApi::AccountMembersApi.new
178178
opts = {
179179
limit: 789, # Integer | The number of members to return in the response. Defaults to 20.
180-
offset: 789, # Integer | 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.
180+
offset: 789, # Integer | 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`.
181181
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above.
182182
sort: 'sort_example' # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.
183183
}
@@ -214,7 +214,7 @@ end
214214
| Name | Type | Description | Notes |
215215
| ---- | ---- | ----------- | ----- |
216216
| **limit** | **Integer** | The number of members to return in the response. Defaults to 20. | [optional] |
217-
| **offset** | **Integer** | 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] |
217+
| **offset** | **Integer** | 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] |
218218
| **filter** | **String** | A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained above. | [optional] |
219219
| **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. | [optional] |
220220

@@ -328,7 +328,7 @@ end
328328

329329
api_instance = LaunchDarklyApi::AccountMembersApi.new
330330
id = 'id_example' # String | The member ID
331-
member_teams_post_input = LaunchDarklyApi::MemberTeamsPostInput.new({team_keys: ['team_keys_example']}) # MemberTeamsPostInput |
331+
member_teams_post_input = LaunchDarklyApi::MemberTeamsPostInput.new({team_keys: ["team1", "team2"]}) # MemberTeamsPostInput |
332332

333333
begin
334334
# Add a member to teams
@@ -384,7 +384,7 @@ end
384384
385385
Invite new members
386386

387-
> ### 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).
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).
388388

389389
### Examples
390390

@@ -400,7 +400,7 @@ LaunchDarklyApi.configure do |config|
400400
end
401401

402402
api_instance = LaunchDarklyApi::AccountMembersApi.new
403-
new_member_form = [LaunchDarklyApi::NewMemberForm.new({email: 'email_example'})] # Array<NewMemberForm> |
403+
new_member_form = [LaunchDarklyApi::NewMemberForm.new({email: '[email protected]'})] # Array<NewMemberForm> |
404404

405405
begin
406406
# Invite new members

docs/ActionInputRep.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
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
## Example
1010

1111
```ruby
1212
require 'launchdarkly_api'
1313

1414
instance = LaunchDarklyApi::ActionInputRep.new(
15-
instructions: null
15+
instructions: {&quot;instructions&quot;: [{ &quot;kind&quot;: &quot;turnFlagOn&quot;}]}
1616
)
1717
```
1818

docs/ActionOutputRep.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
77
| **kind** | **String** | | |
8-
| **instructions** | **Array&lt;Object&gt;** | | |
8+
| **instructions** | **Array&lt;Hash&gt;** | | |
99

1010
## Example
1111

docs/ApprovalConditionInputRep.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
| ---- | ---- | ----------- | ----- |
77
| **description** | **String** | | [optional] |
88
| **notify_member_ids** | **Array&lt;String&gt;** | | [optional] |
9+
| **notify_team_keys** | **Array&lt;String&gt;** | | [optional] |
910

1011
## Example
1112

@@ -14,7 +15,8 @@ require 'launchdarkly_api'
1415

1516
instance = LaunchDarklyApi::ApprovalConditionInputRep.new(
1617
description: null,
17-
notify_member_ids: null
18+
notify_member_ids: null,
19+
notify_team_keys: null
1820
)
1921
```
2022

docs/ApprovalsApi.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ All URIs are relative to *https://app.launchdarkly.com*
1919
2020
Delete approval request
2121

22-
Delete an approval request for a feature flag
22+
Delete an approval request for a feature flag.
2323

2424
### Examples
2525

@@ -95,7 +95,7 @@ nil (empty response body)
9595
9696
Get approval request
9797

98-
Get a single approval request for a feature flag
98+
Get a single approval request for a feature flag.
9999

100100
### Examples
101101

@@ -172,7 +172,7 @@ end
172172
173173
List all approval requests
174174

175-
Get all approval requests for a feature flag
175+
Get all approval requests for a feature flag.
176176

177177
### Examples
178178

@@ -247,7 +247,7 @@ end
247247
248248
Create approval request
249249

250-
Create an approval request for a feature flag
250+
Create an approval request for a feature flag.
251251

252252
### Examples
253253

@@ -266,7 +266,7 @@ api_instance = LaunchDarklyApi::ApprovalsApi.new
266266
project_key = 'project_key_example' # String | The project key
267267
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
268268
environment_key = 'environment_key_example' # String | The environment key
269-
create_flag_config_approval_request_request = LaunchDarklyApi::CreateFlagConfigApprovalRequestRequest.new({description: 'description_example', instructions: [3.56], notify_member_ids: ['notify_member_ids_example']}) # CreateFlagConfigApprovalRequestRequest |
269+
create_flag_config_approval_request_request = LaunchDarklyApi::CreateFlagConfigApprovalRequestRequest.new({description: 'Requesting to update targeting', instructions: [{ key: 3.56}]}) # CreateFlagConfigApprovalRequestRequest |
270270

271271
begin
272272
# Create approval request
@@ -324,7 +324,7 @@ end
324324
325325
Apply approval request
326326

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

329329
### Examples
330330

@@ -403,7 +403,7 @@ end
403403
404404
Review approval request
405405

406-
Review approval request by either approving or declining changes.
406+
Review an approval request by approving or denying changes.
407407

408408
### Examples
409409

@@ -500,8 +500,8 @@ end
500500
api_instance = LaunchDarklyApi::ApprovalsApi.new
501501
project_key = 'project_key_example' # String | The project key
502502
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
503-
environment_key = 'environment_key_example' # String | The environment key
504-
create_copy_flag_config_approval_request_request = LaunchDarklyApi::CreateCopyFlagConfigApprovalRequestRequest.new({description: 'description_example', notify_member_ids: ['notify_member_ids_example'], source: LaunchDarklyApi::SourceFlag.new({key: 'key_example'})}) # CreateCopyFlagConfigApprovalRequestRequest |
503+
environment_key = 'environment_key_example' # String | The environment key for the target environment
504+
create_copy_flag_config_approval_request_request = LaunchDarklyApi::CreateCopyFlagConfigApprovalRequestRequest.new({description: 'copy flag settings to another environment', source: LaunchDarklyApi::SourceFlag.new({key: 'example-environment-key'})}) # CreateCopyFlagConfigApprovalRequestRequest |
505505

506506
begin
507507
# Create approval request to copy flag configurations across environments
@@ -536,7 +536,7 @@ end
536536
| ---- | ---- | ----------- | ----- |
537537
| **project_key** | **String** | The project key | |
538538
| **feature_flag_key** | **String** | The feature flag key | |
539-
| **environment_key** | **String** | The environment key | |
539+
| **environment_key** | **String** | The environment key for the target environment | |
540540
| **create_copy_flag_config_approval_request_request** | [**CreateCopyFlagConfigApprovalRequestRequest**](CreateCopyFlagConfigApprovalRequestRequest.md) | | |
541541

542542
### Return type

docs/AuditLogApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ end
9595
9696
Get audit log entry
9797

98-
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
98+
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
9999

100100
### Examples
101101

docs/Client.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# LaunchDarklyApi::Client
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **_links** | [**Hash&lt;String, Link&gt;**](Link.md) | Links to related resources. | |
8+
| **name** | **String** | Client name | |
9+
| **description** | **String** | Client description | [optional] |
10+
| **_account_id** | **String** | The account ID the client is registered under | |
11+
| **_client_id** | **String** | The client&#39;s unique ID | |
12+
| **_client_secret** | **String** | The client secret. This will only be shown upon creation. | [optional] |
13+
| **redirect_uri** | **String** | The client&#39;s redirect URI | |
14+
| **_creation_date** | **Integer** | | |
15+
16+
## Example
17+
18+
```ruby
19+
require 'launchdarkly_api'
20+
21+
instance = LaunchDarklyApi::Client.new(
22+
_links: {&quot;parent&quot;:{&quot;href&quot;:&quot;/api/v2/oauth/clients&quot;,&quot;type&quot;:&quot;application/json&quot;},&quot;self&quot;:{&quot;href&quot;:&quot;/api/v2/oauth/clients/50666563-9144-4125-b822-33f308227e45&quot;,&quot;type&quot;:&quot;application/json&quot;}},
23+
name: null,
24+
description: null,
25+
_account_id: null,
26+
_client_id: null,
27+
_client_secret: null,
28+
redirect_uri: null,
29+
_creation_date: null
30+
)
31+
```
32+

docs/ClientCollection.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# LaunchDarklyApi::ClientCollection
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **_links** | [**Hash&lt;String, Link&gt;**](Link.md) | | |
8+
| **items** | [**Array&lt;Client&gt;**](Client.md) | List of client objects | |
9+
10+
## Example
11+
12+
```ruby
13+
require 'launchdarkly_api'
14+
15+
instance = LaunchDarklyApi::ClientCollection.new(
16+
_links: {&quot;self&quot;:{&quot;href&quot;:&quot;/api/v2/oauth/clients&quot;,&quot;type&quot;:&quot;application/json&quot;}},
17+
items: null
18+
)
19+
```
20+

docs/ClientSideAvailabilityPost.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7-
| **using_environment_id** | **Boolean** | | |
8-
| **using_mobile_key** | **Boolean** | | |
7+
| **using_environment_id** | **Boolean** | Whether to enable availability for client-side SDKs. | |
8+
| **using_mobile_key** | **Boolean** | Whether to enable availability for mobile SDKs. | |
99

1010
## Example
1111

1212
```ruby
1313
require 'launchdarkly_api'
1414

1515
instance = LaunchDarklyApi::ClientSideAvailabilityPost.new(
16-
using_environment_id: null,
17-
using_mobile_key: null
16+
using_environment_id: true,
17+
using_mobile_key: true
1818
)
1919
```
2020

0 commit comments

Comments
 (0)