launchdarkly_api 18.0.1 → 18.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +6 -5
- data/docs/AIConfigVariationPost.md +1 -1
- data/docs/AIConfigsBetaApi.md +1 -1
- data/docs/AccountMembersApi.md +72 -0
- data/docs/CovarianceInfoRep.md +22 -0
- data/docs/Environment.md +2 -0
- data/docs/Experiment.md +2 -0
- data/docs/ExperimentPost.md +3 -1
- data/docs/IterationInput.md +2 -0
- data/docs/IterationRep.md +3 -1
- data/docs/MetricsApi.md +2 -2
- data/docs/MetricsBetaApi.md +3 -3
- data/docs/PostReleasePolicyRequest.md +1 -1
- data/docs/PutReleasePolicyRequest.md +1 -1
- data/docs/ReleasePolicy.md +1 -1
- data/lib/launchdarkly_api/api/account_members_api.rb +68 -0
- data/lib/launchdarkly_api/api/metrics_api.rb +2 -2
- data/lib/launchdarkly_api/api/metrics_beta_api.rb +4 -4
- data/lib/launchdarkly_api/models/ai_config_variation_post.rb +0 -17
- data/lib/launchdarkly_api/{api/account_members_beta_api.rb → models/covariance_info_rep.rb} +264 -63
- data/lib/launchdarkly_api/models/environment.rb +10 -1
- data/lib/launchdarkly_api/models/experiment.rb +13 -1
- data/lib/launchdarkly_api/models/experiment_post.rb +16 -4
- data/lib/launchdarkly_api/models/iteration_input.rb +11 -1
- data/lib/launchdarkly_api/models/iteration_rep.rb +13 -4
- data/lib/launchdarkly_api/version.rb +1 -1
- data/lib/launchdarkly_api.rb +1 -1
- data/spec/api/account_members_api_spec.rb +12 -0
- data/spec/api/metrics_api_spec.rb +1 -1
- data/spec/api/metrics_beta_api_spec.rb +2 -2
- data/spec/{api/account_members_beta_api_spec.rb → models/covariance_info_rep_spec.rb} +18 -17
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/experiment_post_spec.rb +6 -0
- data/spec/models/experiment_spec.rb +6 -0
- data/spec/models/iteration_input_spec.rb +6 -0
- data/spec/models/iteration_rep_spec.rb +6 -0
- metadata +6 -6
- data/docs/AccountMembersBetaApi.md +0 -79
data/lib/launchdarkly_api.rb
CHANGED
|
@@ -148,6 +148,7 @@ require 'launchdarkly_api/models/context_search'
|
|
|
148
148
|
require 'launchdarkly_api/models/contexts'
|
|
149
149
|
require 'launchdarkly_api/models/copied_from_env'
|
|
150
150
|
require 'launchdarkly_api/models/core_link'
|
|
151
|
+
require 'launchdarkly_api/models/covariance_info_rep'
|
|
151
152
|
require 'launchdarkly_api/models/create_announcement_body'
|
|
152
153
|
require 'launchdarkly_api/models/create_approval_request_request'
|
|
153
154
|
require 'launchdarkly_api/models/create_copy_flag_config_approval_request_request'
|
|
@@ -601,7 +602,6 @@ require 'launchdarkly_api/models/workflow_templates_listing_output_rep'
|
|
|
601
602
|
require 'launchdarkly_api/api/ai_configs_beta_api'
|
|
602
603
|
require 'launchdarkly_api/api/access_tokens_api'
|
|
603
604
|
require 'launchdarkly_api/api/account_members_api'
|
|
604
|
-
require 'launchdarkly_api/api/account_members_beta_api'
|
|
605
605
|
require 'launchdarkly_api/api/account_usage_beta_api'
|
|
606
606
|
require 'launchdarkly_api/api/announcements_api'
|
|
607
607
|
require 'launchdarkly_api/api/applications_beta_api'
|
|
@@ -86,6 +86,18 @@ describe 'AccountMembersApi' do
|
|
|
86
86
|
end
|
|
87
87
|
end
|
|
88
88
|
|
|
89
|
+
# unit tests for patch_members
|
|
90
|
+
# Modify account members
|
|
91
|
+
# > ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). 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](https://launchdarkly.com/docs/api#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 [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/roles). - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoles\", \"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 [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/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 } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` </details>
|
|
92
|
+
# @param members_patch_input
|
|
93
|
+
# @param [Hash] opts the optional parameters
|
|
94
|
+
# @return [BulkEditMembersRep]
|
|
95
|
+
describe 'patch_members test' do
|
|
96
|
+
it 'should work' do
|
|
97
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
89
101
|
# unit tests for post_member_teams
|
|
90
102
|
# Add a member to teams
|
|
91
103
|
# Add one member to one or more teams.
|
|
@@ -69,7 +69,7 @@ describe 'MetricsApi' do
|
|
|
69
69
|
# @option opts [Integer] :limit The number of metrics to return in the response. Defaults to 20. Maximum limit is 50.
|
|
70
70
|
# @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items.
|
|
71
71
|
# @option opts [String] :sort A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `createdAt` or `name`.
|
|
72
|
-
# @option opts [String] :filter A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, 'eventKind', 'isNumeric', 'unitAggregationType`, `hasConnections`, `maintainerIds`, `maintainerTeamKey` and `
|
|
72
|
+
# @option opts [String] :filter A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, 'eventKind', 'isNumeric', 'unitAggregationType`, `hasConnections`, `maintainerIds`, `maintainerTeamKey`, `view`, and `dataSourceKeys`. To learn more about the filter syntax, read the 'Filtering metrics' section above.
|
|
73
73
|
# @return [MetricCollectionRep]
|
|
74
74
|
describe 'get_metrics test' do
|
|
75
75
|
it 'should work' do
|
|
@@ -74,12 +74,12 @@ describe 'MetricsBetaApi' do
|
|
|
74
74
|
|
|
75
75
|
# unit tests for get_metric_groups
|
|
76
76
|
# List metric groups
|
|
77
|
-
# Get a list of all metric groups for the specified project. ### Expanding the metric groups response
|
|
77
|
+
# Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an `expand` query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
|
|
78
78
|
# @param project_key The project key
|
|
79
79
|
# @param [Hash] opts the optional parameters
|
|
80
80
|
# @option opts [String] :filter Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`.
|
|
81
81
|
# @option opts [String] :sort A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.
|
|
82
|
-
# @option opts [String] :expand
|
|
82
|
+
# @option opts [String] :expand This parameter is reserved for future use and is not currently supported on this endpoint.
|
|
83
83
|
# @option opts [Integer] :limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
|
|
84
84
|
# @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items.
|
|
85
85
|
# @return [MetricGroupCollectionRep]
|
|
@@ -12,33 +12,34 @@ Generator version: 7.16.0
|
|
|
12
12
|
|
|
13
13
|
require 'spec_helper'
|
|
14
14
|
require 'json'
|
|
15
|
+
require 'date'
|
|
15
16
|
|
|
16
|
-
# Unit tests for LaunchDarklyApi::
|
|
17
|
+
# Unit tests for LaunchDarklyApi::CovarianceInfoRep
|
|
17
18
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
18
19
|
# Please update as you see appropriate
|
|
19
|
-
describe
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
20
|
+
describe LaunchDarklyApi::CovarianceInfoRep do
|
|
21
|
+
#let(:instance) { LaunchDarklyApi::CovarianceInfoRep.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of CovarianceInfoRep' do
|
|
24
|
+
it 'should create an instance of CovarianceInfoRep' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(LaunchDarklyApi::CovarianceInfoRep)
|
|
27
|
+
end
|
|
23
28
|
end
|
|
24
29
|
|
|
25
|
-
|
|
26
|
-
|
|
30
|
+
describe 'test attribute "id"' do
|
|
31
|
+
it 'should work' do
|
|
32
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
33
|
+
end
|
|
27
34
|
end
|
|
28
35
|
|
|
29
|
-
describe 'test
|
|
30
|
-
it 'should
|
|
31
|
-
|
|
36
|
+
describe 'test attribute "file_name"' do
|
|
37
|
+
it 'should work' do
|
|
38
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
32
39
|
end
|
|
33
40
|
end
|
|
34
41
|
|
|
35
|
-
|
|
36
|
-
# Modify account members
|
|
37
|
-
# > ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). 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](https://launchdarkly.com/docs/api#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 [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/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 [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/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 } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` </details>
|
|
38
|
-
# @param members_patch_input
|
|
39
|
-
# @param [Hash] opts the optional parameters
|
|
40
|
-
# @return [BulkEditMembersRep]
|
|
41
|
-
describe 'patch_members test' do
|
|
42
|
+
describe 'test attribute "created_at"' do
|
|
42
43
|
it 'should work' do
|
|
43
44
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
44
45
|
end
|
|
@@ -81,6 +81,12 @@ describe LaunchDarklyApi::Environment do
|
|
|
81
81
|
end
|
|
82
82
|
end
|
|
83
83
|
|
|
84
|
+
describe 'test attribute "_access"' do
|
|
85
|
+
it 'should work' do
|
|
86
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
|
|
84
90
|
describe 'test attribute "default_track_events"' do
|
|
85
91
|
it 'should work' do
|
|
86
92
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -75,6 +75,12 @@ describe LaunchDarklyApi::Experiment do
|
|
|
75
75
|
end
|
|
76
76
|
end
|
|
77
77
|
|
|
78
|
+
describe 'test attribute "tags"' do
|
|
79
|
+
it 'should work' do
|
|
80
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
|
|
78
84
|
describe 'test attribute "_links"' do
|
|
79
85
|
it 'should work' do
|
|
80
86
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -75,6 +75,12 @@ describe LaunchDarklyApi::IterationInput do
|
|
|
75
75
|
end
|
|
76
76
|
end
|
|
77
77
|
|
|
78
|
+
describe 'test attribute "covariance_id"' do
|
|
79
|
+
it 'should work' do
|
|
80
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
81
|
+
end
|
|
82
|
+
end
|
|
83
|
+
|
|
78
84
|
describe 'test attribute "attributes"' do
|
|
79
85
|
it 'should work' do
|
|
80
86
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -153,4 +153,10 @@ describe LaunchDarklyApi::IterationRep do
|
|
|
153
153
|
end
|
|
154
154
|
end
|
|
155
155
|
|
|
156
|
+
describe 'test attribute "covariance_info"' do
|
|
157
|
+
it 'should work' do
|
|
158
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
159
|
+
end
|
|
160
|
+
end
|
|
161
|
+
|
|
156
162
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: launchdarkly_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 18.0
|
|
4
|
+
version: 18.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenAPI-Generator
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-10-
|
|
11
|
+
date: 2025-10-29 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -441,7 +441,6 @@ files:
|
|
|
441
441
|
- docs/AccessTokenPost.md
|
|
442
442
|
- docs/AccessTokensApi.md
|
|
443
443
|
- docs/AccountMembersApi.md
|
|
444
|
-
- docs/AccountMembersBetaApi.md
|
|
445
444
|
- docs/AccountUsageBetaApi.md
|
|
446
445
|
- docs/ActionInput.md
|
|
447
446
|
- docs/ActionOutput.md
|
|
@@ -548,6 +547,7 @@ files:
|
|
|
548
547
|
- docs/ContextsApi.md
|
|
549
548
|
- docs/CopiedFromEnv.md
|
|
550
549
|
- docs/CoreLink.md
|
|
550
|
+
- docs/CovarianceInfoRep.md
|
|
551
551
|
- docs/CreateAnnouncementBody.md
|
|
552
552
|
- docs/CreateApprovalRequestRequest.md
|
|
553
553
|
- docs/CreateCopyFlagConfigApprovalRequestRequest.md
|
|
@@ -1044,7 +1044,6 @@ files:
|
|
|
1044
1044
|
- lib/launchdarkly_api.rb
|
|
1045
1045
|
- lib/launchdarkly_api/api/access_tokens_api.rb
|
|
1046
1046
|
- lib/launchdarkly_api/api/account_members_api.rb
|
|
1047
|
-
- lib/launchdarkly_api/api/account_members_beta_api.rb
|
|
1048
1047
|
- lib/launchdarkly_api/api/account_usage_beta_api.rb
|
|
1049
1048
|
- lib/launchdarkly_api/api/ai_configs_beta_api.rb
|
|
1050
1049
|
- lib/launchdarkly_api/api/announcements_api.rb
|
|
@@ -1232,6 +1231,7 @@ files:
|
|
|
1232
1231
|
- lib/launchdarkly_api/models/contexts.rb
|
|
1233
1232
|
- lib/launchdarkly_api/models/copied_from_env.rb
|
|
1234
1233
|
- lib/launchdarkly_api/models/core_link.rb
|
|
1234
|
+
- lib/launchdarkly_api/models/covariance_info_rep.rb
|
|
1235
1235
|
- lib/launchdarkly_api/models/create_announcement_body.rb
|
|
1236
1236
|
- lib/launchdarkly_api/models/create_approval_request_request.rb
|
|
1237
1237
|
- lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb
|
|
@@ -1683,7 +1683,6 @@ files:
|
|
|
1683
1683
|
- lib/launchdarkly_api/version.rb
|
|
1684
1684
|
- spec/api/access_tokens_api_spec.rb
|
|
1685
1685
|
- spec/api/account_members_api_spec.rb
|
|
1686
|
-
- spec/api/account_members_beta_api_spec.rb
|
|
1687
1686
|
- spec/api/account_usage_beta_api_spec.rb
|
|
1688
1687
|
- spec/api/ai_configs_beta_api_spec.rb
|
|
1689
1688
|
- spec/api/announcements_api_spec.rb
|
|
@@ -1868,6 +1867,7 @@ files:
|
|
|
1868
1867
|
- spec/models/contexts_spec.rb
|
|
1869
1868
|
- spec/models/copied_from_env_spec.rb
|
|
1870
1869
|
- spec/models/core_link_spec.rb
|
|
1870
|
+
- spec/models/covariance_info_rep_spec.rb
|
|
1871
1871
|
- spec/models/create_announcement_body_spec.rb
|
|
1872
1872
|
- spec/models/create_approval_request_request_spec.rb
|
|
1873
1873
|
- spec/models/create_copy_flag_config_approval_request_request_spec.rb
|
|
@@ -2363,7 +2363,6 @@ test_files:
|
|
|
2363
2363
|
- spec/api/o_auth2_clients_api_spec.rb
|
|
2364
2364
|
- spec/api/metrics_beta_api_spec.rb
|
|
2365
2365
|
- spec/api/scheduled_changes_api_spec.rb
|
|
2366
|
-
- spec/api/account_members_beta_api_spec.rb
|
|
2367
2366
|
- spec/api/insights_flag_events_beta_api_spec.rb
|
|
2368
2367
|
- spec/api/contexts_api_spec.rb
|
|
2369
2368
|
- spec/api/insights_scores_beta_api_spec.rb
|
|
@@ -2630,6 +2629,7 @@ test_files:
|
|
|
2630
2629
|
- spec/models/import_spec.rb
|
|
2631
2630
|
- spec/models/flag_event_experiment_iteration_spec.rb
|
|
2632
2631
|
- spec/models/big_segment_store_integration_collection_links_spec.rb
|
|
2632
|
+
- spec/models/covariance_info_rep_spec.rb
|
|
2633
2633
|
- spec/models/announcement_access_spec.rb
|
|
2634
2634
|
- spec/models/trigger_post_spec.rb
|
|
2635
2635
|
- spec/models/view_link_request_spec.rb
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# LaunchDarklyApi::AccountMembersBetaApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://app.launchdarkly.com*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**patch_members**](AccountMembersBetaApi.md#patch_members) | **PATCH** /api/v2/members | Modify account members |
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
## patch_members
|
|
11
|
-
|
|
12
|
-
> <BulkEditMembersRep> patch_members(members_patch_input)
|
|
13
|
-
|
|
14
|
-
Modify account members
|
|
15
|
-
|
|
16
|
-
> ### Full use of this API resource is an Enterprise feature > > The ability to perform a partial update to multiple members is available to customers on an Enterprise plan. If you are on another plan, you can update members individually. To learn more, [read about our pricing](https://launchdarkly.com/pricing/). To upgrade your plan, [contact Sales](https://launchdarkly.com/contact-sales/). 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](https://launchdarkly.com/docs/api#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 [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/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 [base role](https://launchdarkly.com/docs/home/getting-started/vocabulary#base-role). To learn more, read [Roles](https://launchdarkly.com/docs/home/account/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 } }] } ``` #### replaceMembersRoleAttributes Replaces the role attributes of the specified members. ##### Parameters - `value`: Map of role attribute keys to lists of values. - `memberIDs`: List of member IDs. Here's an example: ```json { \"instructions\": [{ \"kind\": \"replaceMembersRoleAttributes\", \"value\": { \"myRoleProjectKey\": [\"mobile\", \"web\"], \"myRoleEnvironmentKey\": [\"production\"] }, \"memberIDs\": [ \"1234a56b7c89d012345e678f\", \"507f1f77bcf86cd799439011\" ] }] } ``` </details>
|
|
17
|
-
|
|
18
|
-
### Examples
|
|
19
|
-
|
|
20
|
-
```ruby
|
|
21
|
-
require 'time'
|
|
22
|
-
require 'launchdarkly_api'
|
|
23
|
-
# setup authorization
|
|
24
|
-
LaunchDarklyApi.configure do |config|
|
|
25
|
-
# Configure API key authorization: ApiKey
|
|
26
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
27
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
28
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
29
|
-
end
|
|
30
|
-
|
|
31
|
-
api_instance = LaunchDarklyApi::AccountMembersBetaApi.new
|
|
32
|
-
members_patch_input = LaunchDarklyApi::MembersPatchInput.new({instructions: [{ key: 3.56}]}) # MembersPatchInput |
|
|
33
|
-
|
|
34
|
-
begin
|
|
35
|
-
# Modify account members
|
|
36
|
-
result = api_instance.patch_members(members_patch_input)
|
|
37
|
-
p result
|
|
38
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
39
|
-
puts "Error when calling AccountMembersBetaApi->patch_members: #{e}"
|
|
40
|
-
end
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
#### Using the patch_members_with_http_info variant
|
|
44
|
-
|
|
45
|
-
This returns an Array which contains the response data, status code and headers.
|
|
46
|
-
|
|
47
|
-
> <Array(<BulkEditMembersRep>, Integer, Hash)> patch_members_with_http_info(members_patch_input)
|
|
48
|
-
|
|
49
|
-
```ruby
|
|
50
|
-
begin
|
|
51
|
-
# Modify account members
|
|
52
|
-
data, status_code, headers = api_instance.patch_members_with_http_info(members_patch_input)
|
|
53
|
-
p status_code # => 2xx
|
|
54
|
-
p headers # => { ... }
|
|
55
|
-
p data # => <BulkEditMembersRep>
|
|
56
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
57
|
-
puts "Error when calling AccountMembersBetaApi->patch_members_with_http_info: #{e}"
|
|
58
|
-
end
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
### Parameters
|
|
62
|
-
|
|
63
|
-
| Name | Type | Description | Notes |
|
|
64
|
-
| ---- | ---- | ----------- | ----- |
|
|
65
|
-
| **members_patch_input** | [**MembersPatchInput**](MembersPatchInput.md) | | |
|
|
66
|
-
|
|
67
|
-
### Return type
|
|
68
|
-
|
|
69
|
-
[**BulkEditMembersRep**](BulkEditMembersRep.md)
|
|
70
|
-
|
|
71
|
-
### Authorization
|
|
72
|
-
|
|
73
|
-
[ApiKey](../README.md#ApiKey)
|
|
74
|
-
|
|
75
|
-
### HTTP request headers
|
|
76
|
-
|
|
77
|
-
- **Content-Type**: application/json
|
|
78
|
-
- **Accept**: application/json
|
|
79
|
-
|