launchdarkly_api 2.0.32 → 3.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +168 -154
- data/docs/Clause.md +1 -0
- data/docs/FeatureFlags.md +1 -0
- data/docs/FeatureFlagsApi.md +133 -4
- data/docs/Member.md +1 -0
- data/docs/Members.md +1 -0
- data/docs/SemanticPatchOperation.md +9 -0
- data/docs/SemanticPatchOperationInstructions.md +8 -0
- data/docs/TeamMembersApi.md +63 -3
- data/docs/UserSegmentsApi.md +121 -0
- data/docs/UserSettingsApi.md +121 -0
- data/docs/UserTargetingExpirationForFlag.md +14 -0
- data/docs/UserTargetingExpirationForFlags.md +9 -0
- data/docs/UserTargetingExpirationForSegment.md +14 -0
- data/docs/UserTargetingExpirationOnFlagsForUser.md +9 -0
- data/docs/UserTargetingExpirationResourceIdForFlag.md +12 -0
- data/docs/Variation.md +1 -0
- data/launchdarkly_api.gemspec +1 -1
- data/lib/launchdarkly_api.rb +8 -1
- data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
- data/lib/launchdarkly_api/api/custom_roles_api.rb +1 -1
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +1 -1
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +1 -1
- data/lib/launchdarkly_api/api/environments_api.rb +1 -1
- data/lib/launchdarkly_api/api/feature_flags_api.rb +153 -7
- data/lib/launchdarkly_api/api/projects_api.rb +1 -1
- data/lib/launchdarkly_api/api/root_api.rb +1 -1
- data/lib/launchdarkly_api/api/team_members_api.rb +59 -1
- data/lib/launchdarkly_api/api/user_segments_api.rb +135 -1
- data/lib/launchdarkly_api/api/user_settings_api.rb +135 -1
- data/lib/launchdarkly_api/api/users_api.rb +1 -1
- data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
- data/lib/launchdarkly_api/api_client.rb +1 -1
- data/lib/launchdarkly_api/api_error.rb +1 -1
- data/lib/launchdarkly_api/configuration.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entries.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +1 -1
- data/lib/launchdarkly_api/models/clause.rb +11 -2
- data/lib/launchdarkly_api/models/copy_actions.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property_values.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role_body.rb +1 -1
- data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
- data/lib/launchdarkly_api/models/defaults.rb +1 -1
- data/lib/launchdarkly_api/models/destination.rb +1 -1
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +1 -1
- data/lib/launchdarkly_api/models/destination_body.rb +1 -1
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +1 -1
- data/lib/launchdarkly_api/models/destination_m_particle.rb +1 -1
- data/lib/launchdarkly_api/models/destination_segment.rb +1 -1
- data/lib/launchdarkly_api/models/destinations.rb +1 -1
- data/lib/launchdarkly_api/models/environment.rb +1 -1
- data/lib/launchdarkly_api/models/environment_post.rb +1 -1
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/events.rb +1 -1
- data/lib/launchdarkly_api/models/fallthrough.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_config.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flags.rb +14 -5
- data/lib/launchdarkly_api/models/flag_list_item.rb +1 -1
- data/lib/launchdarkly_api/models/id.rb +1 -1
- data/lib/launchdarkly_api/models/link.rb +1 -1
- data/lib/launchdarkly_api/models/links.rb +1 -1
- data/lib/launchdarkly_api/models/ma_uby_category.rb +1 -1
- data/lib/launchdarkly_api/models/mau.rb +1 -1
- data/lib/launchdarkly_api/models/mau_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/member.rb +11 -2
- data/lib/launchdarkly_api/models/members.rb +14 -5
- data/lib/launchdarkly_api/models/members_body.rb +1 -1
- data/lib/launchdarkly_api/models/patch_comment.rb +1 -1
- data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/policy.rb +1 -1
- data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
- data/lib/launchdarkly_api/models/project.rb +1 -1
- data/lib/launchdarkly_api/models/project_body.rb +1 -1
- data/lib/launchdarkly_api/models/projects.rb +1 -1
- data/lib/launchdarkly_api/models/role.rb +1 -1
- data/lib/launchdarkly_api/models/rollout.rb +1 -1
- data/lib/launchdarkly_api/models/rule.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +199 -0
- data/lib/launchdarkly_api/models/semantic_patch_operation_instructions.rb +184 -0
- data/lib/launchdarkly_api/models/site.rb +1 -1
- data/lib/launchdarkly_api/models/statement.rb +1 -1
- data/lib/launchdarkly_api/models/stream.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_series.rb +1 -1
- data/lib/launchdarkly_api/models/streams.rb +1 -1
- data/lib/launchdarkly_api/models/target.rb +1 -1
- data/lib/launchdarkly_api/models/usage.rb +1 -1
- data/lib/launchdarkly_api/models/usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/user.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_setting.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_settings.rb +1 -1
- data/lib/launchdarkly_api/models/user_record.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
- data/lib/launchdarkly_api/models/user_segments.rb +1 -1
- data/lib/launchdarkly_api/models/user_settings_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +240 -0
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +194 -0
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +240 -0
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +194 -0
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +219 -0
- data/lib/launchdarkly_api/models/users.rb +1 -1
- data/lib/launchdarkly_api/models/variation.rb +11 -2
- data/lib/launchdarkly_api/models/webhook.rb +1 -1
- data/lib/launchdarkly_api/models/webhook_body.rb +1 -1
- data/lib/launchdarkly_api/models/webhooks.rb +1 -1
- data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
- data/lib/launchdarkly_api/version.rb +2 -2
- data/openapi.yml +297 -4
- data/spec/api/audit_log_api_spec.rb +1 -1
- data/spec/api/custom_roles_api_spec.rb +1 -1
- data/spec/api/customer_metrics_api_spec.rb +1 -1
- data/spec/api/data_export_destinations_api_spec.rb +1 -1
- data/spec/api/environments_api_spec.rb +1 -1
- data/spec/api/feature_flags_api_spec.rb +34 -3
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/root_api_spec.rb +1 -1
- data/spec/api/team_members_api_spec.rb +15 -1
- data/spec/api/user_segments_api_spec.rb +28 -1
- data/spec/api/user_settings_api_spec.rb +28 -1
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/audit_log_entries_spec.rb +1 -1
- data/spec/models/audit_log_entry_spec.rb +1 -1
- data/spec/models/audit_log_entry_target_spec.rb +1 -1
- data/spec/models/clause_spec.rb +7 -1
- data/spec/models/copy_actions_spec.rb +1 -1
- data/spec/models/custom_property_spec.rb +1 -1
- data/spec/models/custom_property_values_spec.rb +1 -1
- data/spec/models/custom_role_body_spec.rb +1 -1
- data/spec/models/custom_role_spec.rb +1 -1
- data/spec/models/custom_roles_spec.rb +1 -1
- data/spec/models/defaults_spec.rb +1 -1
- data/spec/models/destination_amazon_kinesis_spec.rb +1 -1
- data/spec/models/destination_body_spec.rb +1 -1
- data/spec/models/destination_google_pub_sub_spec.rb +1 -1
- data/spec/models/destination_m_particle_spec.rb +1 -1
- data/spec/models/destination_segment_spec.rb +1 -1
- data/spec/models/destination_spec.rb +1 -1
- data/spec/models/destinations_spec.rb +1 -1
- data/spec/models/environment_post_spec.rb +1 -1
- data/spec/models/environment_spec.rb +1 -1
- data/spec/models/evaluation_usage_error_spec.rb +1 -1
- data/spec/models/events_spec.rb +1 -1
- data/spec/models/fallthrough_spec.rb +1 -1
- data/spec/models/feature_flag_body_spec.rb +1 -1
- data/spec/models/feature_flag_config_spec.rb +1 -1
- data/spec/models/feature_flag_copy_body_spec.rb +1 -1
- data/spec/models/feature_flag_copy_object_spec.rb +1 -1
- data/spec/models/feature_flag_spec.rb +1 -1
- data/spec/models/feature_flag_status_across_environments_spec.rb +1 -1
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +1 -1
- data/spec/models/feature_flag_status_spec.rb +1 -1
- data/spec/models/feature_flag_statuses_spec.rb +1 -1
- data/spec/models/feature_flags_spec.rb +7 -1
- data/spec/models/flag_list_item_spec.rb +1 -1
- data/spec/models/id_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/links_spec.rb +1 -1
- data/spec/models/ma_uby_category_spec.rb +1 -1
- data/spec/models/mau_metadata_spec.rb +1 -1
- data/spec/models/mau_spec.rb +1 -1
- data/spec/models/member_spec.rb +7 -1
- data/spec/models/members_body_spec.rb +1 -1
- data/spec/models/members_spec.rb +7 -1
- data/spec/models/patch_comment_spec.rb +1 -1
- data/spec/models/patch_operation_spec.rb +1 -1
- data/spec/models/policy_spec.rb +1 -1
- data/spec/models/prerequisite_spec.rb +1 -1
- data/spec/models/project_body_spec.rb +1 -1
- data/spec/models/project_spec.rb +1 -1
- data/spec/models/projects_spec.rb +1 -1
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollout_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/semantic_patch_operation_instructions_spec.rb +41 -0
- data/spec/models/semantic_patch_operation_spec.rb +47 -0
- data/spec/models/site_spec.rb +1 -1
- data/spec/models/statement_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_spec.rb +1 -1
- data/spec/models/stream_by_sdk_spec.rb +1 -1
- data/spec/models/stream_links_spec.rb +1 -1
- data/spec/models/stream_sdk_version_data_spec.rb +1 -1
- data/spec/models/stream_sdk_version_spec.rb +1 -1
- data/spec/models/stream_spec.rb +1 -1
- data/spec/models/stream_usage_error_spec.rb +1 -1
- data/spec/models/stream_usage_links_spec.rb +1 -1
- data/spec/models/stream_usage_metadata_spec.rb +1 -1
- data/spec/models/stream_usage_series_spec.rb +1 -1
- data/spec/models/streams_spec.rb +1 -1
- data/spec/models/target_spec.rb +1 -1
- data/spec/models/usage_error_spec.rb +1 -1
- data/spec/models/usage_links_spec.rb +1 -1
- data/spec/models/usage_spec.rb +1 -1
- data/spec/models/user_flag_setting_spec.rb +1 -1
- data/spec/models/user_flag_settings_spec.rb +1 -1
- data/spec/models/user_record_spec.rb +1 -1
- data/spec/models/user_segment_body_spec.rb +1 -1
- data/spec/models/user_segment_rule_spec.rb +1 -1
- data/spec/models/user_segment_spec.rb +1 -1
- data/spec/models/user_segments_spec.rb +1 -1
- data/spec/models/user_settings_body_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +77 -0
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +47 -0
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +77 -0
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +47 -0
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +65 -0
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/variation_spec.rb +7 -1
- data/spec/models/webhook_body_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/webhooks_spec.rb +1 -1
- data/spec/models/weighted_variation_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +109 -81
data/docs/Member.md
CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
9
9
|
**email** | **String** | | [optional]
|
10
10
|
**first_name** | **String** | | [optional]
|
11
11
|
**last_name** | **String** | | [optional]
|
12
|
+
**_verified** | **BOOLEAN** | | [optional]
|
12
13
|
**_pending_invite** | **BOOLEAN** | | [optional]
|
13
14
|
**is_beta** | **BOOLEAN** | | [optional]
|
14
15
|
**custom_roles** | [**Array<Id>**](Id.md) | | [optional]
|
data/docs/Members.md
CHANGED
@@ -0,0 +1,9 @@
|
|
1
|
+
# LaunchDarklyApi::SemanticPatchOperation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**comment** | **String** | | [optional]
|
7
|
+
**instructions** | [**Array<SemanticPatchOperationInstructions>**](SemanticPatchOperationInstructions.md) | |
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# LaunchDarklyApi::SemanticPatchOperationInstructions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**kind** | **String** | The name of the modification you would like to perform on a resource. | [optional]
|
7
|
+
|
8
|
+
|
data/docs/TeamMembersApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://app.launchdarkly.com/api/v2*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**delete_member**](TeamMembersApi.md#delete_member) | **DELETE** /members/{memberId} | Delete a team member by ID.
|
8
|
+
[**get_me**](TeamMembersApi.md#get_me) | **GET** /members/me | Get the current team member associated with the token
|
8
9
|
[**get_member**](TeamMembersApi.md#get_member) | **GET** /members/{memberId} | Get a single team member by ID.
|
9
10
|
[**get_members**](TeamMembersApi.md#get_members) | **GET** /members | Returns a list of all members in the account.
|
10
11
|
[**patch_member**](TeamMembersApi.md#patch_member) | **PATCH** /members/{memberId} | Modify a team member by ID.
|
@@ -62,6 +63,52 @@ nil (empty response body)
|
|
62
63
|
|
63
64
|
|
64
65
|
|
66
|
+
# **get_me**
|
67
|
+
> Member get_me
|
68
|
+
|
69
|
+
Get the current team member associated with the token
|
70
|
+
|
71
|
+
### Example
|
72
|
+
```ruby
|
73
|
+
# load the gem
|
74
|
+
require 'launchdarkly_api'
|
75
|
+
# setup authorization
|
76
|
+
LaunchDarklyApi.configure do |config|
|
77
|
+
# Configure API key authorization: Token
|
78
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
79
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
80
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
81
|
+
end
|
82
|
+
|
83
|
+
api_instance = LaunchDarklyApi::TeamMembersApi.new
|
84
|
+
|
85
|
+
begin
|
86
|
+
#Get the current team member associated with the token
|
87
|
+
result = api_instance.get_me
|
88
|
+
p result
|
89
|
+
rescue LaunchDarklyApi::ApiError => e
|
90
|
+
puts "Exception when calling TeamMembersApi->get_me: #{e}"
|
91
|
+
end
|
92
|
+
```
|
93
|
+
|
94
|
+
### Parameters
|
95
|
+
This endpoint does not need any parameter.
|
96
|
+
|
97
|
+
### Return type
|
98
|
+
|
99
|
+
[**Member**](Member.md)
|
100
|
+
|
101
|
+
### Authorization
|
102
|
+
|
103
|
+
[Token](../README.md#Token)
|
104
|
+
|
105
|
+
### HTTP request headers
|
106
|
+
|
107
|
+
- **Content-Type**: application/json
|
108
|
+
- **Accept**: application/json
|
109
|
+
|
110
|
+
|
111
|
+
|
65
112
|
# **get_member**
|
66
113
|
> Member get_member(member_id, )
|
67
114
|
|
@@ -115,7 +162,7 @@ Name | Type | Description | Notes
|
|
115
162
|
|
116
163
|
|
117
164
|
# **get_members**
|
118
|
-
> Members get_members
|
165
|
+
> Members get_members(opts)
|
119
166
|
|
120
167
|
Returns a list of all members in the account.
|
121
168
|
|
@@ -133,9 +180,16 @@ end
|
|
133
180
|
|
134
181
|
api_instance = LaunchDarklyApi::TeamMembersApi.new
|
135
182
|
|
183
|
+
opts = {
|
184
|
+
limit: 8.14, # Float | The number of objects to return. Defaults to -1, which returns everything.
|
185
|
+
offset: 8.14, # Float | Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
|
186
|
+
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value.
|
187
|
+
sort: 'sort_example' # String | A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
|
188
|
+
}
|
189
|
+
|
136
190
|
begin
|
137
191
|
#Returns a list of all members in the account.
|
138
|
-
result = api_instance.get_members
|
192
|
+
result = api_instance.get_members(opts)
|
139
193
|
p result
|
140
194
|
rescue LaunchDarklyApi::ApiError => e
|
141
195
|
puts "Exception when calling TeamMembersApi->get_members: #{e}"
|
@@ -143,7 +197,13 @@ end
|
|
143
197
|
```
|
144
198
|
|
145
199
|
### Parameters
|
146
|
-
|
200
|
+
|
201
|
+
Name | Type | Description | Notes
|
202
|
+
------------- | ------------- | ------------- | -------------
|
203
|
+
**limit** | **Float**| The number of objects to return. Defaults to -1, which returns everything. | [optional]
|
204
|
+
**offset** | **Float**| Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items. | [optional]
|
205
|
+
**filter** | **String**| A comma-separated list of filters. Each filter is of the form field:value. | [optional]
|
206
|
+
**sort** | **String**| A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order. | [optional]
|
147
207
|
|
148
208
|
### Return type
|
149
209
|
|
data/docs/UserSegmentsApi.md
CHANGED
@@ -5,8 +5,10 @@ All URIs are relative to *https://app.launchdarkly.com/api/v2*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**delete_user_segment**](UserSegmentsApi.md#delete_user_segment) | **DELETE** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Delete a user segment.
|
8
|
+
[**get_expiring_user_targets_on_segment**](UserSegmentsApi.md#get_expiring_user_targets_on_segment) | **GET** /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for user segment
|
8
9
|
[**get_user_segment**](UserSegmentsApi.md#get_user_segment) | **GET** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Get a single user segment by key.
|
9
10
|
[**get_user_segments**](UserSegmentsApi.md#get_user_segments) | **GET** /segments/{projectKey}/{environmentKey} | Get a list of all user segments in the given project.
|
11
|
+
[**patch_expiring_user_targets_on_segment**](UserSegmentsApi.md#patch_expiring_user_targets_on_segment) | **PATCH** /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on user segment
|
10
12
|
[**patch_user_segment**](UserSegmentsApi.md#patch_user_segment) | **PATCH** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Perform a partial update to a user segment.
|
11
13
|
[**post_user_segment**](UserSegmentsApi.md#post_user_segment) | **POST** /segments/{projectKey}/{environmentKey} | Creates a new user segment.
|
12
14
|
|
@@ -68,6 +70,64 @@ nil (empty response body)
|
|
68
70
|
|
69
71
|
|
70
72
|
|
73
|
+
# **get_expiring_user_targets_on_segment**
|
74
|
+
> UserTargetingExpirationForSegment get_expiring_user_targets_on_segment(project_key, environment_key, user_segment_key, )
|
75
|
+
|
76
|
+
Get expiring user targets for user segment
|
77
|
+
|
78
|
+
### Example
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'launchdarkly_api'
|
82
|
+
# setup authorization
|
83
|
+
LaunchDarklyApi.configure do |config|
|
84
|
+
# Configure API key authorization: Token
|
85
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
86
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
87
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = LaunchDarklyApi::UserSegmentsApi.new
|
91
|
+
|
92
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
93
|
+
|
94
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
95
|
+
|
96
|
+
user_segment_key = 'user_segment_key_example' # String | The user segment's key. The key identifies the user segment in your code.
|
97
|
+
|
98
|
+
|
99
|
+
begin
|
100
|
+
#Get expiring user targets for user segment
|
101
|
+
result = api_instance.get_expiring_user_targets_on_segment(project_key, environment_key, user_segment_key, )
|
102
|
+
p result
|
103
|
+
rescue LaunchDarklyApi::ApiError => e
|
104
|
+
puts "Exception when calling UserSegmentsApi->get_expiring_user_targets_on_segment: #{e}"
|
105
|
+
end
|
106
|
+
```
|
107
|
+
|
108
|
+
### Parameters
|
109
|
+
|
110
|
+
Name | Type | Description | Notes
|
111
|
+
------------- | ------------- | ------------- | -------------
|
112
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
113
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
114
|
+
**user_segment_key** | **String**| The user segment's key. The key identifies the user segment in your code. |
|
115
|
+
|
116
|
+
### Return type
|
117
|
+
|
118
|
+
[**UserTargetingExpirationForSegment**](UserTargetingExpirationForSegment.md)
|
119
|
+
|
120
|
+
### Authorization
|
121
|
+
|
122
|
+
[Token](../README.md#Token)
|
123
|
+
|
124
|
+
### HTTP request headers
|
125
|
+
|
126
|
+
- **Content-Type**: application/json
|
127
|
+
- **Accept**: application/json
|
128
|
+
|
129
|
+
|
130
|
+
|
71
131
|
# **get_user_segment**
|
72
132
|
> UserSegment get_user_segment(project_key, environment_key, user_segment_key, )
|
73
133
|
|
@@ -185,6 +245,67 @@ Name | Type | Description | Notes
|
|
185
245
|
|
186
246
|
|
187
247
|
|
248
|
+
# **patch_expiring_user_targets_on_segment**
|
249
|
+
> UserTargetingExpirationForSegment patch_expiring_user_targets_on_segment(project_key, environment_key, user_segment_key, semantic_patch_with_comment)
|
250
|
+
|
251
|
+
Update, add, or delete expiring user targets on user segment
|
252
|
+
|
253
|
+
### Example
|
254
|
+
```ruby
|
255
|
+
# load the gem
|
256
|
+
require 'launchdarkly_api'
|
257
|
+
# setup authorization
|
258
|
+
LaunchDarklyApi.configure do |config|
|
259
|
+
# Configure API key authorization: Token
|
260
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
261
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
262
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
263
|
+
end
|
264
|
+
|
265
|
+
api_instance = LaunchDarklyApi::UserSegmentsApi.new
|
266
|
+
|
267
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
268
|
+
|
269
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
270
|
+
|
271
|
+
user_segment_key = 'user_segment_key_example' # String | The user segment's key. The key identifies the user segment in your code.
|
272
|
+
|
273
|
+
semantic_patch_with_comment = nil # Object | Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
|
274
|
+
|
275
|
+
|
276
|
+
begin
|
277
|
+
#Update, add, or delete expiring user targets on user segment
|
278
|
+
result = api_instance.patch_expiring_user_targets_on_segment(project_key, environment_key, user_segment_key, semantic_patch_with_comment)
|
279
|
+
p result
|
280
|
+
rescue LaunchDarklyApi::ApiError => e
|
281
|
+
puts "Exception when calling UserSegmentsApi->patch_expiring_user_targets_on_segment: #{e}"
|
282
|
+
end
|
283
|
+
```
|
284
|
+
|
285
|
+
### Parameters
|
286
|
+
|
287
|
+
Name | Type | Description | Notes
|
288
|
+
------------- | ------------- | ------------- | -------------
|
289
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
290
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
291
|
+
**user_segment_key** | **String**| The user segment's key. The key identifies the user segment in your code. |
|
292
|
+
**semantic_patch_with_comment** | **Object**| Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. |
|
293
|
+
|
294
|
+
### Return type
|
295
|
+
|
296
|
+
[**UserTargetingExpirationForSegment**](UserTargetingExpirationForSegment.md)
|
297
|
+
|
298
|
+
### Authorization
|
299
|
+
|
300
|
+
[Token](../README.md#Token)
|
301
|
+
|
302
|
+
### HTTP request headers
|
303
|
+
|
304
|
+
- **Content-Type**: application/json
|
305
|
+
- **Accept**: application/json
|
306
|
+
|
307
|
+
|
308
|
+
|
188
309
|
# **patch_user_segment**
|
189
310
|
> UserSegment patch_user_segment(project_key, environment_key, user_segment_key, patch_only)
|
190
311
|
|
data/docs/UserSettingsApi.md
CHANGED
@@ -4,11 +4,71 @@ All URIs are relative to *https://app.launchdarkly.com/api/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**get_expiring_user_targets_for_user**](UserSettingsApi.md#get_expiring_user_targets_for_user) | **GET** /users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} | Get expiring dates on flags for user
|
7
8
|
[**get_user_flag_setting**](UserSettingsApi.md#get_user_flag_setting) | **GET** /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} | Fetch a single flag setting for a user by key.
|
8
9
|
[**get_user_flag_settings**](UserSettingsApi.md#get_user_flag_settings) | **GET** /users/{projectKey}/{environmentKey}/{userKey}/flags | Fetch a single flag setting for a user by key.
|
10
|
+
[**patch_expiring_user_targets_for_flags**](UserSettingsApi.md#patch_expiring_user_targets_for_flags) | **PATCH** /users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets for a single user on all flags
|
9
11
|
[**put_flag_setting**](UserSettingsApi.md#put_flag_setting) | **PUT** /users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey} | Specifically enable or disable a feature flag for a user based on their key.
|
10
12
|
|
11
13
|
|
14
|
+
# **get_expiring_user_targets_for_user**
|
15
|
+
> UserTargetingExpirationOnFlagsForUser get_expiring_user_targets_for_user(project_key, environment_key, user_key, )
|
16
|
+
|
17
|
+
Get expiring dates on flags for user
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'launchdarkly_api'
|
23
|
+
# setup authorization
|
24
|
+
LaunchDarklyApi.configure do |config|
|
25
|
+
# Configure API key authorization: Token
|
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::UserSettingsApi.new
|
32
|
+
|
33
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
34
|
+
|
35
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
36
|
+
|
37
|
+
user_key = 'user_key_example' # String | The user's key.
|
38
|
+
|
39
|
+
|
40
|
+
begin
|
41
|
+
#Get expiring dates on flags for user
|
42
|
+
result = api_instance.get_expiring_user_targets_for_user(project_key, environment_key, user_key, )
|
43
|
+
p result
|
44
|
+
rescue LaunchDarklyApi::ApiError => e
|
45
|
+
puts "Exception when calling UserSettingsApi->get_expiring_user_targets_for_user: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Parameters
|
50
|
+
|
51
|
+
Name | Type | Description | Notes
|
52
|
+
------------- | ------------- | ------------- | -------------
|
53
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
54
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
55
|
+
**user_key** | **String**| The user's key. |
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
[**UserTargetingExpirationOnFlagsForUser**](UserTargetingExpirationOnFlagsForUser.md)
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[Token](../README.md#Token)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: application/json
|
68
|
+
- **Accept**: application/json
|
69
|
+
|
70
|
+
|
71
|
+
|
12
72
|
# **get_user_flag_setting**
|
13
73
|
> UserFlagSetting get_user_flag_setting(project_key, environment_key, user_key, feature_flag_key, )
|
14
74
|
|
@@ -128,6 +188,67 @@ Name | Type | Description | Notes
|
|
128
188
|
|
129
189
|
|
130
190
|
|
191
|
+
# **patch_expiring_user_targets_for_flags**
|
192
|
+
> UserTargetingExpirationOnFlagsForUser patch_expiring_user_targets_for_flags(project_key, environment_key, user_key, semantic_patch_with_comment)
|
193
|
+
|
194
|
+
Update, add, or delete expiring user targets for a single user on all flags
|
195
|
+
|
196
|
+
### Example
|
197
|
+
```ruby
|
198
|
+
# load the gem
|
199
|
+
require 'launchdarkly_api'
|
200
|
+
# setup authorization
|
201
|
+
LaunchDarklyApi.configure do |config|
|
202
|
+
# Configure API key authorization: Token
|
203
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
204
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
205
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
206
|
+
end
|
207
|
+
|
208
|
+
api_instance = LaunchDarklyApi::UserSettingsApi.new
|
209
|
+
|
210
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
211
|
+
|
212
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
213
|
+
|
214
|
+
user_key = 'user_key_example' # String | The user's key.
|
215
|
+
|
216
|
+
semantic_patch_with_comment = nil # Object | Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
|
217
|
+
|
218
|
+
|
219
|
+
begin
|
220
|
+
#Update, add, or delete expiring user targets for a single user on all flags
|
221
|
+
result = api_instance.patch_expiring_user_targets_for_flags(project_key, environment_key, user_key, semantic_patch_with_comment)
|
222
|
+
p result
|
223
|
+
rescue LaunchDarklyApi::ApiError => e
|
224
|
+
puts "Exception when calling UserSettingsApi->patch_expiring_user_targets_for_flags: #{e}"
|
225
|
+
end
|
226
|
+
```
|
227
|
+
|
228
|
+
### Parameters
|
229
|
+
|
230
|
+
Name | Type | Description | Notes
|
231
|
+
------------- | ------------- | ------------- | -------------
|
232
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
233
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
234
|
+
**user_key** | **String**| The user's key. |
|
235
|
+
**semantic_patch_with_comment** | **Object**| Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. |
|
236
|
+
|
237
|
+
### Return type
|
238
|
+
|
239
|
+
[**UserTargetingExpirationOnFlagsForUser**](UserTargetingExpirationOnFlagsForUser.md)
|
240
|
+
|
241
|
+
### Authorization
|
242
|
+
|
243
|
+
[Token](../README.md#Token)
|
244
|
+
|
245
|
+
### HTTP request headers
|
246
|
+
|
247
|
+
- **Content-Type**: application/json
|
248
|
+
- **Accept**: application/json
|
249
|
+
|
250
|
+
|
251
|
+
|
131
252
|
# **put_flag_setting**
|
132
253
|
> put_flag_setting(project_key, environment_key, user_key, feature_flag_key, user_settings_body)
|
133
254
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# LaunchDarklyApi::UserTargetingExpirationForFlag
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expiration_date** | **Integer** | Date scheduled for expiration | [optional]
|
7
|
+
**variation_id** | **String** | the ID of the variation that the user is targeted on a flag | [optional]
|
8
|
+
**user_key** | **String** | Unique identifier for the user | [optional]
|
9
|
+
**_id** | **String** | | [optional]
|
10
|
+
**_resource_id** | [**UserTargetingExpirationResourceIdForFlag**](UserTargetingExpirationResourceIdForFlag.md) | | [optional]
|
11
|
+
**_links** | [**Links**](Links.md) | | [optional]
|
12
|
+
**_version** | **Integer** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# LaunchDarklyApi::UserTargetingExpirationForFlags
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**_links** | [**Links**](Links.md) | | [optional]
|
7
|
+
**items** | [**Array<UserTargetingExpirationForFlag>**](UserTargetingExpirationForFlag.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# LaunchDarklyApi::UserTargetingExpirationForSegment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expiration_date** | **Integer** | Date scheduled for expiration | [optional]
|
7
|
+
**target_type** | **String** | either the included or excluded variation that the user is targeted on a segment | [optional]
|
8
|
+
**user_key** | **String** | Unique identifier for the user | [optional]
|
9
|
+
**_id** | **String** | | [optional]
|
10
|
+
**_resource_id** | [**UserTargetingExpirationResourceIdForFlag**](UserTargetingExpirationResourceIdForFlag.md) | | [optional]
|
11
|
+
**_links** | [**Links**](Links.md) | | [optional]
|
12
|
+
**_version** | **Integer** | | [optional]
|
13
|
+
|
14
|
+
|