launchdarkly_api 3.3.2 → 3.7.1
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 +198 -168
- data/docs/AccessTokensApi.md +333 -0
- data/docs/ClientSideAvailability.md +9 -0
- data/docs/EnvironmentsApi.md +120 -0
- data/docs/FeatureFlag.md +1 -0
- data/docs/FeatureFlagBody.md +1 -0
- data/docs/FeatureFlagScheduledChange.md +11 -0
- data/docs/FeatureFlagScheduledChanges.md +9 -0
- data/docs/FeatureFlagScheduledChangesConflicts.md +8 -0
- data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +9 -0
- data/docs/FeatureFlagsApi.md +2 -2
- data/docs/Project.md +1 -0
- data/docs/ProjectBody.md +1 -0
- data/docs/RelayProxyConfig.md +15 -0
- data/docs/RelayProxyConfigBody.md +9 -0
- data/docs/RelayProxyConfigs.md +8 -0
- data/docs/RelayProxyConfigurationsApi.md +326 -0
- data/docs/ScheduledChangesFeatureFlagConflict.md +9 -0
- data/docs/SemanticPatchInstruction.md +7 -0
- data/docs/{SemanticPatchOperationInstructions.md → SemanticPatchInstructionInner.md} +1 -1
- data/docs/SemanticPatchOperation.md +1 -1
- data/docs/Token.md +22 -0
- data/docs/TokenBody.md +13 -0
- data/docs/Tokens.md +9 -0
- data/docs/UnboundedSegmentTargetChanges.md +9 -0
- data/docs/UnboundedSegmentTargetsBody.md +9 -0
- data/docs/UserSegment.md +1 -0
- data/docs/UserSegmentBody.md +1 -0
- data/docs/UserSegmentsApi.md +61 -0
- data/launchdarkly_api.gemspec +1 -1
- data/lib/launchdarkly_api.rb +19 -2
- data/lib/launchdarkly_api/api/access_tokens_api.rb +340 -0
- 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 +123 -1
- data/lib/launchdarkly_api/api/feature_flags_api.rb +3 -3
- data/lib/launchdarkly_api/api/projects_api.rb +1 -1
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +337 -0
- data/lib/launchdarkly_api/api/root_api.rb +1 -1
- data/lib/launchdarkly_api/api/team_members_api.rb +1 -1
- data/lib/launchdarkly_api/api/user_segments_api.rb +70 -1
- data/lib/launchdarkly_api/api/user_settings_api.rb +1 -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 +1 -1
- data/lib/launchdarkly_api/models/client_side_availability.rb +194 -0
- 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 +11 -2
- data/lib/launchdarkly_api/models/feature_flag_body.rb +11 -2
- 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_scheduled_change.rb +211 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +194 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +185 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +195 -0
- 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 +1 -1
- 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 +1 -1
- data/lib/launchdarkly_api/models/members.rb +1 -1
- 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 +14 -5
- data/lib/launchdarkly_api/models/project_body.rb +14 -5
- data/lib/launchdarkly_api/models/projects.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +288 -0
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +195 -0
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +185 -0
- 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/scheduled_changes_feature_flag_conflict.rb +194 -0
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +174 -0
- data/lib/launchdarkly_api/models/{semantic_patch_operation_instructions.rb → semantic_patch_instruction_inner.rb} +2 -2
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +3 -5
- 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/token.rb +322 -0
- data/lib/launchdarkly_api/models/token_body.rb +237 -0
- data/lib/launchdarkly_api/models/tokens.rb +194 -0
- data/lib/launchdarkly_api/models/unbounded_segment_target_changes.rb +198 -0
- data/lib/launchdarkly_api/models/unbounded_segment_targets_body.rb +192 -0
- 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 +12 -2
- data/lib/launchdarkly_api/models/user_segment_body.rb +12 -2
- 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 +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/users.rb +1 -1
- data/lib/launchdarkly_api/models/variation.rb +1 -1
- 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 +639 -12
- data/spec/api/access_tokens_api_spec.rb +103 -0
- 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 +27 -1
- data/spec/api/feature_flags_api_spec.rb +2 -2
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/relay_proxy_configurations_api_spec.rb +102 -0
- data/spec/api/root_api_spec.rb +1 -1
- data/spec/api/team_members_api_spec.rb +1 -1
- data/spec/api/user_segments_api_spec.rb +15 -1
- data/spec/api/user_settings_api_spec.rb +1 -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 +1 -1
- data/spec/models/client_side_availability_spec.rb +47 -0
- 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 +7 -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_scheduled_change_spec.rb +59 -0
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +47 -0
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +41 -0
- data/spec/models/feature_flag_scheduled_changes_spec.rb +47 -0
- data/spec/models/feature_flag_spec.rb +7 -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 +1 -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 +1 -1
- data/spec/models/members_body_spec.rb +1 -1
- data/spec/models/members_spec.rb +1 -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 +7 -1
- data/spec/models/project_spec.rb +7 -1
- data/spec/models/projects_spec.rb +1 -1
- data/spec/models/relay_proxy_config_body_spec.rb +47 -0
- data/spec/models/relay_proxy_config_spec.rb +83 -0
- data/spec/models/relay_proxy_configs_spec.rb +41 -0
- 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/scheduled_changes_feature_flag_conflict_spec.rb +47 -0
- data/spec/models/{semantic_patch_operation_instructions_spec.rb → semantic_patch_instruction_inner_spec.rb} +7 -7
- data/spec/models/semantic_patch_instruction_spec.rb +35 -0
- data/spec/models/semantic_patch_operation_spec.rb +1 -1
- 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/token_body_spec.rb +71 -0
- data/spec/models/token_spec.rb +125 -0
- data/spec/models/tokens_spec.rb +47 -0
- data/spec/models/unbounded_segment_target_changes_spec.rb +47 -0
- data/spec/models/unbounded_segment_targets_body_spec.rb +47 -0
- 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 +7 -1
- data/spec/models/user_segment_rule_spec.rb +1 -1
- data/spec/models/user_segment_spec.rb +7 -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 +1 -1
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +1 -1
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/variation_spec.rb +1 -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 +160 -92
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::ClientSideAvailability
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**using_environment_id** | **BOOLEAN** | When set to true, this flag will be available to SDKs using the client-side id. | [optional]
|
|
7
|
+
**using_mobile_key** | **BOOLEAN** | When set to true, this flag will be available to SDKS using a mobile key. | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/EnvironmentsApi.md
CHANGED
|
@@ -8,6 +8,8 @@ Method | HTTP request | Description
|
|
|
8
8
|
[**get_environment**](EnvironmentsApi.md#get_environment) | **GET** /projects/{projectKey}/environments/{environmentKey} | Get an environment given a project and key.
|
|
9
9
|
[**patch_environment**](EnvironmentsApi.md#patch_environment) | **PATCH** /projects/{projectKey}/environments/{environmentKey} | Modify an environment by ID.
|
|
10
10
|
[**post_environment**](EnvironmentsApi.md#post_environment) | **POST** /projects/{projectKey}/environments | Create a new environment in a specified project with a given name, key, and swatch color.
|
|
11
|
+
[**reset_environment_mobile_key**](EnvironmentsApi.md#reset_environment_mobile_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/mobileKey | Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
|
|
12
|
+
[**reset_environment_sdk_key**](EnvironmentsApi.md#reset_environment_sdk_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/apiKey | Reset an environment's SDK key with an optional expiry time for the old key.
|
|
11
13
|
|
|
12
14
|
|
|
13
15
|
# **delete_environment**
|
|
@@ -232,3 +234,121 @@ Name | Type | Description | Notes
|
|
|
232
234
|
|
|
233
235
|
|
|
234
236
|
|
|
237
|
+
# **reset_environment_mobile_key**
|
|
238
|
+
> Environment reset_environment_mobile_key(project_key, environment_key, , opts)
|
|
239
|
+
|
|
240
|
+
Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
|
|
241
|
+
|
|
242
|
+
### Example
|
|
243
|
+
```ruby
|
|
244
|
+
# load the gem
|
|
245
|
+
require 'launchdarkly_api'
|
|
246
|
+
# setup authorization
|
|
247
|
+
LaunchDarklyApi.configure do |config|
|
|
248
|
+
# Configure API key authorization: Token
|
|
249
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
250
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
251
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
api_instance = LaunchDarklyApi::EnvironmentsApi.new
|
|
255
|
+
|
|
256
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
257
|
+
|
|
258
|
+
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.
|
|
259
|
+
|
|
260
|
+
opts = {
|
|
261
|
+
expiry: 789 # Integer | The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version.
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
begin
|
|
265
|
+
#Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
|
|
266
|
+
result = api_instance.reset_environment_mobile_key(project_key, environment_key, , opts)
|
|
267
|
+
p result
|
|
268
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
269
|
+
puts "Exception when calling EnvironmentsApi->reset_environment_mobile_key: #{e}"
|
|
270
|
+
end
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
### Parameters
|
|
274
|
+
|
|
275
|
+
Name | Type | Description | Notes
|
|
276
|
+
------------- | ------------- | ------------- | -------------
|
|
277
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
278
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
279
|
+
**expiry** | **Integer**| The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version. | [optional]
|
|
280
|
+
|
|
281
|
+
### Return type
|
|
282
|
+
|
|
283
|
+
[**Environment**](Environment.md)
|
|
284
|
+
|
|
285
|
+
### Authorization
|
|
286
|
+
|
|
287
|
+
[Token](../README.md#Token)
|
|
288
|
+
|
|
289
|
+
### HTTP request headers
|
|
290
|
+
|
|
291
|
+
- **Content-Type**: application/json
|
|
292
|
+
- **Accept**: application/json
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
# **reset_environment_sdk_key**
|
|
297
|
+
> Environment reset_environment_sdk_key(project_key, environment_key, , opts)
|
|
298
|
+
|
|
299
|
+
Reset an environment's SDK key with an optional expiry time for the old key.
|
|
300
|
+
|
|
301
|
+
### Example
|
|
302
|
+
```ruby
|
|
303
|
+
# load the gem
|
|
304
|
+
require 'launchdarkly_api'
|
|
305
|
+
# setup authorization
|
|
306
|
+
LaunchDarklyApi.configure do |config|
|
|
307
|
+
# Configure API key authorization: Token
|
|
308
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
309
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
310
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
api_instance = LaunchDarklyApi::EnvironmentsApi.new
|
|
314
|
+
|
|
315
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
316
|
+
|
|
317
|
+
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.
|
|
318
|
+
|
|
319
|
+
opts = {
|
|
320
|
+
expiry: 789 # Integer | An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately.
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
begin
|
|
324
|
+
#Reset an environment's SDK key with an optional expiry time for the old key.
|
|
325
|
+
result = api_instance.reset_environment_sdk_key(project_key, environment_key, , opts)
|
|
326
|
+
p result
|
|
327
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
328
|
+
puts "Exception when calling EnvironmentsApi->reset_environment_sdk_key: #{e}"
|
|
329
|
+
end
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### Parameters
|
|
333
|
+
|
|
334
|
+
Name | Type | Description | Notes
|
|
335
|
+
------------- | ------------- | ------------- | -------------
|
|
336
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
337
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
338
|
+
**expiry** | **Integer**| An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately. | [optional]
|
|
339
|
+
|
|
340
|
+
### Return type
|
|
341
|
+
|
|
342
|
+
[**Environment**](Environment.md)
|
|
343
|
+
|
|
344
|
+
### Authorization
|
|
345
|
+
|
|
346
|
+
[Token](../README.md#Token)
|
|
347
|
+
|
|
348
|
+
### HTTP request headers
|
|
349
|
+
|
|
350
|
+
- **Content-Type**: application/json
|
|
351
|
+
- **Accept**: application/json
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
data/docs/FeatureFlag.md
CHANGED
|
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
21
21
|
**environments** | [**Hash<String, FeatureFlagConfig>**](FeatureFlagConfig.md) | | [optional]
|
|
22
22
|
**archived_date** | **Integer** | A unix epoch time in milliseconds specifying the archived time of this flag. | [optional]
|
|
23
23
|
**archived** | **BOOLEAN** | Whether or not this flag is archived. | [optional]
|
|
24
|
+
**client_side_availability** | [**ClientSideAvailability**](ClientSideAvailability.md) | | [optional]
|
|
24
25
|
**defaults** | [**Defaults**](Defaults.md) | | [optional]
|
|
25
26
|
|
|
26
27
|
|
data/docs/FeatureFlagBody.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**temporary** | **BOOLEAN** | Whether or not the flag is a temporary flag. | [optional]
|
|
11
11
|
**tags** | **Array<String>** | Tags for the feature flag. | [optional]
|
|
12
12
|
**include_in_snippet** | **BOOLEAN** | Whether or not this flag should be made available to the client-side JavaScript SDK. | [optional]
|
|
13
|
+
**client_side_availability** | [**ClientSideAvailability**](ClientSideAvailability.md) | | [optional]
|
|
13
14
|
**defaults** | [**Defaults**](Defaults.md) | | [optional]
|
|
14
15
|
|
|
15
16
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagScheduledChange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**execution_date** | **Integer** | A unix epoch time in milliseconds specifying the date the scheduled changes will be applied | [optional]
|
|
7
|
+
**_version** | **Integer** | | [optional]
|
|
8
|
+
**_id** | **String** | | [optional]
|
|
9
|
+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagScheduledChanges
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_links** | [**Links**](Links.md) | | [optional]
|
|
7
|
+
**items** | [**Array<FeatureFlagScheduledChange>**](FeatureFlagScheduledChange.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagScheduledChangesConflicts
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**instructions** | [**Array<FeatureFlagScheduledChangesConflictsInstructions>**](FeatureFlagScheduledChangesConflictsInstructions.md) | | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagScheduledChangesConflictsInstructions
|
|
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
|
+
**conflicts** | [**Array<ScheduledChangesFeatureFlagConflict>**](ScheduledChangesFeatureFlagConflict.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/FeatureFlagsApi.md
CHANGED
|
@@ -438,7 +438,7 @@ project_key = 'project_key_example' # String | The project key, used to tie the
|
|
|
438
438
|
opts = {
|
|
439
439
|
env: ['env_example'] # Array<String> | By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment.
|
|
440
440
|
summary: true, # BOOLEAN | By default in api version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned.
|
|
441
|
-
archived: true, # BOOLEAN | When set to 1, archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags.
|
|
441
|
+
archived: true, # BOOLEAN | When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags.
|
|
442
442
|
limit: 8.14, # Float | The number of objects to return. Defaults to -1, which returns everything.
|
|
443
443
|
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.
|
|
444
444
|
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value.
|
|
@@ -462,7 +462,7 @@ Name | Type | Description | Notes
|
|
|
462
462
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
463
463
|
**env** | [**Array<String>**](String.md)| By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment. | [optional]
|
|
464
464
|
**summary** | **BOOLEAN**| By default in api version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned. | [optional]
|
|
465
|
-
**archived** | **BOOLEAN**| When set to 1, archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags. | [optional]
|
|
465
|
+
**archived** | **BOOLEAN**| When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags. | [optional]
|
|
466
466
|
**limit** | **Float**| The number of objects to return. Defaults to -1, which returns everything. | [optional]
|
|
467
467
|
**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]
|
|
468
468
|
**filter** | **String**| A comma-separated list of filters. Each filter is of the form field:value. | [optional]
|
data/docs/Project.md
CHANGED
|
@@ -10,5 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**include_in_snippet_by_default** | **BOOLEAN** | | [optional]
|
|
11
11
|
**environments** | [**Array<Environment>**](Environment.md) | | [optional]
|
|
12
12
|
**tags** | **Array<String>** | An array of tags for this project. | [optional]
|
|
13
|
+
**default_client_side_availability** | [**ClientSideAvailability**](ClientSideAvailability.md) | | [optional]
|
|
13
14
|
|
|
14
15
|
|
data/docs/ProjectBody.md
CHANGED
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**include_in_snippet_by_default** | **BOOLEAN** | | [optional]
|
|
9
9
|
**tags** | **Array<String>** | | [optional]
|
|
10
10
|
**environments** | [**Array<EnvironmentPost>**](EnvironmentPost.md) | | [optional]
|
|
11
|
+
**default_client_side_availability** | [**ClientSideAvailability**](ClientSideAvailability.md) | | [optional]
|
|
11
12
|
|
|
12
13
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# LaunchDarklyApi::RelayProxyConfig
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_id** | [**Id**](Id.md) | |
|
|
7
|
+
**_creator** | [**Member**](Member.md) | |
|
|
8
|
+
**name** | **String** | A human-friendly name for the relay proxy configuration |
|
|
9
|
+
**policy** | [**Array<Policy>**](Policy.md) | |
|
|
10
|
+
**full_key** | **String** | Full secret key. Only included if creating or resetting the relay proxy configuration | [optional]
|
|
11
|
+
**display_key** | **String** | The last 4 digits of the unique secret key for this relay proxy configuration |
|
|
12
|
+
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the creation time of this relay proxy configuration |
|
|
13
|
+
**last_modified** | **Integer** | A unix epoch time in milliseconds specifying the last time this relay proxy configuration was modified |
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::RelayProxyConfigBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | A human-friendly name for the relay proxy configuration | [optional]
|
|
7
|
+
**policy** | [**Array<Policy>**](Policy.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,326 @@
|
|
|
1
|
+
# LaunchDarklyApi::RelayProxyConfigurationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://app.launchdarkly.com/api/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**delete_relay_proxy_config**](RelayProxyConfigurationsApi.md#delete_relay_proxy_config) | **DELETE** /account/relay-auto-configs/{id} | Delete a relay proxy configuration by ID.
|
|
8
|
+
[**get_relay_proxy_config**](RelayProxyConfigurationsApi.md#get_relay_proxy_config) | **GET** /account/relay-auto-configs/{id} | Get a single relay proxy configuration by ID.
|
|
9
|
+
[**get_relay_proxy_configs**](RelayProxyConfigurationsApi.md#get_relay_proxy_configs) | **GET** /account/relay-auto-configs | Returns a list of relay proxy configurations in the account.
|
|
10
|
+
[**patch_relay_proxy_config**](RelayProxyConfigurationsApi.md#patch_relay_proxy_config) | **PATCH** /account/relay-auto-configs/{id} | Modify a relay proxy configuration by ID.
|
|
11
|
+
[**post_relay_auto_config**](RelayProxyConfigurationsApi.md#post_relay_auto_config) | **POST** /account/relay-auto-configs | Create a new relay proxy config.
|
|
12
|
+
[**reset_relay_proxy_config**](RelayProxyConfigurationsApi.md#reset_relay_proxy_config) | **POST** /account/relay-auto-configs/{id}/reset | Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
# **delete_relay_proxy_config**
|
|
16
|
+
> delete_relay_proxy_config(id)
|
|
17
|
+
|
|
18
|
+
Delete a relay proxy configuration by ID.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
23
|
+
require 'launchdarkly_api'
|
|
24
|
+
# setup authorization
|
|
25
|
+
LaunchDarklyApi.configure do |config|
|
|
26
|
+
# Configure API key authorization: Token
|
|
27
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = LaunchDarklyApi::RelayProxyConfigurationsApi.new
|
|
33
|
+
|
|
34
|
+
id = 'id_example' # String | The relay proxy configuration ID
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
#Delete a relay proxy configuration by ID.
|
|
39
|
+
api_instance.delete_relay_proxy_config(id)
|
|
40
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
41
|
+
puts "Exception when calling RelayProxyConfigurationsApi->delete_relay_proxy_config: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Parameters
|
|
46
|
+
|
|
47
|
+
Name | Type | Description | Notes
|
|
48
|
+
------------- | ------------- | ------------- | -------------
|
|
49
|
+
**id** | **String**| The relay proxy configuration ID |
|
|
50
|
+
|
|
51
|
+
### Return type
|
|
52
|
+
|
|
53
|
+
nil (empty response body)
|
|
54
|
+
|
|
55
|
+
### Authorization
|
|
56
|
+
|
|
57
|
+
[Token](../README.md#Token)
|
|
58
|
+
|
|
59
|
+
### HTTP request headers
|
|
60
|
+
|
|
61
|
+
- **Content-Type**: application/json
|
|
62
|
+
- **Accept**: application/json
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
# **get_relay_proxy_config**
|
|
67
|
+
> RelayProxyConfig get_relay_proxy_config(id)
|
|
68
|
+
|
|
69
|
+
Get a single relay proxy configuration by ID.
|
|
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::RelayProxyConfigurationsApi.new
|
|
84
|
+
|
|
85
|
+
id = 'id_example' # String | The relay proxy configuration ID
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
begin
|
|
89
|
+
#Get a single relay proxy configuration by ID.
|
|
90
|
+
result = api_instance.get_relay_proxy_config(id)
|
|
91
|
+
p result
|
|
92
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
93
|
+
puts "Exception when calling RelayProxyConfigurationsApi->get_relay_proxy_config: #{e}"
|
|
94
|
+
end
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
Name | Type | Description | Notes
|
|
100
|
+
------------- | ------------- | ------------- | -------------
|
|
101
|
+
**id** | **String**| The relay proxy configuration ID |
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
[**RelayProxyConfig**](RelayProxyConfig.md)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[Token](../README.md#Token)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: application/json
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
# **get_relay_proxy_configs**
|
|
119
|
+
> RelayProxyConfigs get_relay_proxy_configs
|
|
120
|
+
|
|
121
|
+
Returns a list of relay proxy configurations in the account.
|
|
122
|
+
|
|
123
|
+
### Example
|
|
124
|
+
```ruby
|
|
125
|
+
# load the gem
|
|
126
|
+
require 'launchdarkly_api'
|
|
127
|
+
# setup authorization
|
|
128
|
+
LaunchDarklyApi.configure do |config|
|
|
129
|
+
# Configure API key authorization: Token
|
|
130
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
131
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
132
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
api_instance = LaunchDarklyApi::RelayProxyConfigurationsApi.new
|
|
136
|
+
|
|
137
|
+
begin
|
|
138
|
+
#Returns a list of relay proxy configurations in the account.
|
|
139
|
+
result = api_instance.get_relay_proxy_configs
|
|
140
|
+
p result
|
|
141
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
142
|
+
puts "Exception when calling RelayProxyConfigurationsApi->get_relay_proxy_configs: #{e}"
|
|
143
|
+
end
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Parameters
|
|
147
|
+
This endpoint does not need any parameter.
|
|
148
|
+
|
|
149
|
+
### Return type
|
|
150
|
+
|
|
151
|
+
[**RelayProxyConfigs**](RelayProxyConfigs.md)
|
|
152
|
+
|
|
153
|
+
### Authorization
|
|
154
|
+
|
|
155
|
+
[Token](../README.md#Token)
|
|
156
|
+
|
|
157
|
+
### HTTP request headers
|
|
158
|
+
|
|
159
|
+
- **Content-Type**: application/json
|
|
160
|
+
- **Accept**: application/json
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
# **patch_relay_proxy_config**
|
|
165
|
+
> RelayProxyConfig patch_relay_proxy_config(idpatch_delta)
|
|
166
|
+
|
|
167
|
+
Modify a relay proxy configuration by ID.
|
|
168
|
+
|
|
169
|
+
### Example
|
|
170
|
+
```ruby
|
|
171
|
+
# load the gem
|
|
172
|
+
require 'launchdarkly_api'
|
|
173
|
+
# setup authorization
|
|
174
|
+
LaunchDarklyApi.configure do |config|
|
|
175
|
+
# Configure API key authorization: Token
|
|
176
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
177
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
178
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
api_instance = LaunchDarklyApi::RelayProxyConfigurationsApi.new
|
|
182
|
+
|
|
183
|
+
id = 'id_example' # String | The relay proxy configuration ID
|
|
184
|
+
|
|
185
|
+
patch_delta = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
begin
|
|
189
|
+
#Modify a relay proxy configuration by ID.
|
|
190
|
+
result = api_instance.patch_relay_proxy_config(idpatch_delta)
|
|
191
|
+
p result
|
|
192
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
193
|
+
puts "Exception when calling RelayProxyConfigurationsApi->patch_relay_proxy_config: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Parameters
|
|
198
|
+
|
|
199
|
+
Name | Type | Description | Notes
|
|
200
|
+
------------- | ------------- | ------------- | -------------
|
|
201
|
+
**id** | **String**| The relay proxy configuration ID |
|
|
202
|
+
**patch_delta** | [**Array<PatchOperation>**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' |
|
|
203
|
+
|
|
204
|
+
### Return type
|
|
205
|
+
|
|
206
|
+
[**RelayProxyConfig**](RelayProxyConfig.md)
|
|
207
|
+
|
|
208
|
+
### Authorization
|
|
209
|
+
|
|
210
|
+
[Token](../README.md#Token)
|
|
211
|
+
|
|
212
|
+
### HTTP request headers
|
|
213
|
+
|
|
214
|
+
- **Content-Type**: application/json
|
|
215
|
+
- **Accept**: application/json
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
# **post_relay_auto_config**
|
|
220
|
+
> RelayProxyConfig post_relay_auto_config(relay_proxy_config_body)
|
|
221
|
+
|
|
222
|
+
Create a new relay proxy config.
|
|
223
|
+
|
|
224
|
+
### Example
|
|
225
|
+
```ruby
|
|
226
|
+
# load the gem
|
|
227
|
+
require 'launchdarkly_api'
|
|
228
|
+
# setup authorization
|
|
229
|
+
LaunchDarklyApi.configure do |config|
|
|
230
|
+
# Configure API key authorization: Token
|
|
231
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
232
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
233
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
api_instance = LaunchDarklyApi::RelayProxyConfigurationsApi.new
|
|
237
|
+
|
|
238
|
+
relay_proxy_config_body = LaunchDarklyApi::RelayProxyConfigBody.new # RelayProxyConfigBody | Create a new relay proxy configuration
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
begin
|
|
242
|
+
#Create a new relay proxy config.
|
|
243
|
+
result = api_instance.post_relay_auto_config(relay_proxy_config_body)
|
|
244
|
+
p result
|
|
245
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
246
|
+
puts "Exception when calling RelayProxyConfigurationsApi->post_relay_auto_config: #{e}"
|
|
247
|
+
end
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Parameters
|
|
251
|
+
|
|
252
|
+
Name | Type | Description | Notes
|
|
253
|
+
------------- | ------------- | ------------- | -------------
|
|
254
|
+
**relay_proxy_config_body** | [**RelayProxyConfigBody**](RelayProxyConfigBody.md)| Create a new relay proxy configuration |
|
|
255
|
+
|
|
256
|
+
### Return type
|
|
257
|
+
|
|
258
|
+
[**RelayProxyConfig**](RelayProxyConfig.md)
|
|
259
|
+
|
|
260
|
+
### Authorization
|
|
261
|
+
|
|
262
|
+
[Token](../README.md#Token)
|
|
263
|
+
|
|
264
|
+
### HTTP request headers
|
|
265
|
+
|
|
266
|
+
- **Content-Type**: application/json
|
|
267
|
+
- **Accept**: application/json
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
# **reset_relay_proxy_config**
|
|
272
|
+
> RelayProxyConfig reset_relay_proxy_config(id, opts)
|
|
273
|
+
|
|
274
|
+
Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
|
|
275
|
+
|
|
276
|
+
### Example
|
|
277
|
+
```ruby
|
|
278
|
+
# load the gem
|
|
279
|
+
require 'launchdarkly_api'
|
|
280
|
+
# setup authorization
|
|
281
|
+
LaunchDarklyApi.configure do |config|
|
|
282
|
+
# Configure API key authorization: Token
|
|
283
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
284
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
285
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
286
|
+
end
|
|
287
|
+
|
|
288
|
+
api_instance = LaunchDarklyApi::RelayProxyConfigurationsApi.new
|
|
289
|
+
|
|
290
|
+
id = 'id_example' # String | The relay proxy configuration ID
|
|
291
|
+
|
|
292
|
+
opts = {
|
|
293
|
+
expiry: 789 # Integer | An expiration time for the old relay proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the relay proxy configuration will expire immediately
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
begin
|
|
297
|
+
#Reset a relay proxy configuration's secret key with an optional expiry time for the old key.
|
|
298
|
+
result = api_instance.reset_relay_proxy_config(id, opts)
|
|
299
|
+
p result
|
|
300
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
301
|
+
puts "Exception when calling RelayProxyConfigurationsApi->reset_relay_proxy_config: #{e}"
|
|
302
|
+
end
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### Parameters
|
|
306
|
+
|
|
307
|
+
Name | Type | Description | Notes
|
|
308
|
+
------------- | ------------- | ------------- | -------------
|
|
309
|
+
**id** | **String**| The relay proxy configuration ID |
|
|
310
|
+
**expiry** | **Integer**| An expiration time for the old relay proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the relay proxy configuration will expire immediately | [optional]
|
|
311
|
+
|
|
312
|
+
### Return type
|
|
313
|
+
|
|
314
|
+
[**RelayProxyConfig**](RelayProxyConfig.md)
|
|
315
|
+
|
|
316
|
+
### Authorization
|
|
317
|
+
|
|
318
|
+
[Token](../README.md#Token)
|
|
319
|
+
|
|
320
|
+
### HTTP request headers
|
|
321
|
+
|
|
322
|
+
- **Content-Type**: application/json
|
|
323
|
+
- **Accept**: application/json
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|