launchdarkly_api 3.5.0 → 3.9.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 +223 -178
- data/docs/AccessTokensApi.md +3 -3
- data/docs/EnvironmentsApi.md +120 -0
- data/docs/FeatureFlagChangeRequest.md +19 -0
- data/docs/FeatureFlagChangeRequestApplyConfigBody.md +8 -0
- data/docs/FeatureFlagChangeRequestConfigBody.md +11 -0
- data/docs/FeatureFlagChangeRequestReview.md +11 -0
- data/docs/FeatureFlagChangeRequestReviewConfigBody.md +9 -0
- data/docs/FeatureFlagChangeRequestReviewStatus.md +7 -0
- data/docs/FeatureFlagChangeRequests.md +9 -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 +313 -0
- data/docs/HierarchicalLinks.md +9 -0
- data/docs/Integration.md +9 -0
- data/docs/IntegrationLinks.md +8 -0
- data/docs/IntegrationSubscription.md +16 -0
- data/docs/IntegrationSubscriptionStatus.md +10 -0
- data/docs/Integrations.md +9 -0
- data/docs/IntegrationsApi.md +334 -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/Rule.md +1 -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/SubscriptionBody.md +12 -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 +29 -2
- data/lib/launchdarkly_api/api/access_tokens_api.rb +3 -3
- 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 +351 -1
- data/lib/launchdarkly_api/api/integrations_api.rb +358 -0
- 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 +1 -1
- 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_change_request.rb +325 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_apply_config_body.rb +184 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_config_body.rb +229 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_review.rb +211 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_review_config_body.rb +233 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_review_status.rb +31 -0
- data/lib/launchdarkly_api/models/feature_flag_change_requests.rb +194 -0
- 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/hierarchical_links.rb +192 -0
- data/lib/launchdarkly_api/models/id.rb +1 -1
- data/lib/launchdarkly_api/models/integration.rb +194 -0
- data/lib/launchdarkly_api/models/integration__links.rb +183 -0
- data/lib/launchdarkly_api/models/integration_subscription.rb +264 -0
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +202 -0
- data/lib/launchdarkly_api/models/integrations.rb +195 -0
- 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 +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/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 +14 -5
- 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/subscription_body.rb +237 -0
- data/lib/launchdarkly_api/models/target.rb +1 -1
- data/lib/launchdarkly_api/models/token.rb +1 -1
- data/lib/launchdarkly_api/models/token_body.rb +1 -1
- data/lib/launchdarkly_api/models/tokens.rb +1 -1
- 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 +891 -16
- data/spec/api/access_tokens_api_spec.rb +2 -2
- 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 +71 -1
- data/spec/api/integrations_api_spec.rb +105 -0
- 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 +1 -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_change_request_apply_config_body_spec.rb +41 -0
- data/spec/models/feature_flag_change_request_config_body_spec.rb +59 -0
- data/spec/models/feature_flag_change_request_review_config_body_spec.rb +51 -0
- data/spec/models/feature_flag_change_request_review_spec.rb +59 -0
- data/spec/models/feature_flag_change_request_review_status_spec.rb +35 -0
- data/spec/models/feature_flag_change_request_spec.rb +111 -0
- data/spec/models/feature_flag_change_requests_spec.rb +47 -0
- 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 +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 +1 -1
- data/spec/models/flag_list_item_spec.rb +1 -1
- data/spec/models/hierarchical_links_spec.rb +47 -0
- data/spec/models/id_spec.rb +1 -1
- data/spec/models/integration__links_spec.rb +41 -0
- data/spec/models/integration_spec.rb +47 -0
- data/spec/models/integration_subscription__status_spec.rb +53 -0
- data/spec/models/integration_subscription_spec.rb +89 -0
- data/spec/models/integrations_spec.rb +47 -0
- 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 +1 -1
- data/spec/models/project_spec.rb +1 -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 +7 -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/subscription_body_spec.rb +65 -0
- data/spec/models/target_spec.rb +1 -1
- data/spec/models/token_body_spec.rb +1 -1
- data/spec/models/token_spec.rb +1 -1
- data/spec/models/tokens_spec.rb +1 -1
- 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 +205 -97
data/docs/Integration.md
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::Integration
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_links** | [**IntegrationLinks**](IntegrationLinks.md) | | [optional]
|
|
7
|
+
**items** | [**Array<IntegrationSubscription>**](IntegrationSubscription.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# LaunchDarklyApi::IntegrationSubscription
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_links** | [**HierarchicalLinks**](HierarchicalLinks.md) | | [optional]
|
|
7
|
+
**_id** | [**Id**](Id.md) | | [optional]
|
|
8
|
+
**kind** | **String** | The type of integration associated with this configuration. | [optional]
|
|
9
|
+
**name** | **String** | The user-defined name associated with this configuration. | [optional]
|
|
10
|
+
**config** | **Object** | A key-value mapping of configuration fields. | [optional]
|
|
11
|
+
**statements** | [**Array<Statement>**](Statement.md) | | [optional]
|
|
12
|
+
**on** | **BOOLEAN** | Whether or not the integration is currently active. | [optional]
|
|
13
|
+
**tags** | **Array<String>** | An array of tags for this integration configuration. | [optional]
|
|
14
|
+
**_status** | [**IntegrationSubscriptionStatus**](IntegrationSubscriptionStatus.md) | | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# LaunchDarklyApi::IntegrationSubscriptionStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**success_count** | **Integer** | | [optional]
|
|
7
|
+
**last_success** | **Integer** | A unix epoch time in milliseconds specifying the last time this integration was successfully used. | [optional]
|
|
8
|
+
**error_count** | **Integer** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::Integrations
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_links** | **Object** | A mapping of integration types to their respective API endpoints. | [optional]
|
|
7
|
+
**items** | [**Array<IntegrationSubscription>**](IntegrationSubscription.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,334 @@
|
|
|
1
|
+
# LaunchDarklyApi::IntegrationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://app.launchdarkly.com/api/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**delete_integration_subscription**](IntegrationsApi.md#delete_integration_subscription) | **DELETE** /integrations/{integrationKey}/{integrationId} | Delete an integration subscription by ID.
|
|
8
|
+
[**get_integration_subscription**](IntegrationsApi.md#get_integration_subscription) | **GET** /integrations/{integrationKey}/{integrationId} | Get a single integration subscription by ID.
|
|
9
|
+
[**get_integration_subscriptions**](IntegrationsApi.md#get_integration_subscriptions) | **GET** /integrations/{integrationKey} | Get a list of all configured integrations of a given kind.
|
|
10
|
+
[**get_integrations**](IntegrationsApi.md#get_integrations) | **GET** /integrations | Get a list of all configured audit log event integrations associated with this account.
|
|
11
|
+
[**patch_integration_subscription**](IntegrationsApi.md#patch_integration_subscription) | **PATCH** /integrations/{integrationKey}/{integrationId} | Modify an integration subscription by ID.
|
|
12
|
+
[**post_integration_subscription**](IntegrationsApi.md#post_integration_subscription) | **POST** /integrations/{integrationKey} | Create a new integration subscription of a given kind.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
# **delete_integration_subscription**
|
|
16
|
+
> delete_integration_subscription(integration_key, integration_id, )
|
|
17
|
+
|
|
18
|
+
Delete an integration subscription 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::IntegrationsApi.new
|
|
33
|
+
|
|
34
|
+
integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
|
|
35
|
+
|
|
36
|
+
integration_id = 'integration_id_example' # String | The integration ID.
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
#Delete an integration subscription by ID.
|
|
41
|
+
api_instance.delete_integration_subscription(integration_key, integration_id, )
|
|
42
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
43
|
+
puts "Exception when calling IntegrationsApi->delete_integration_subscription: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
Name | Type | Description | Notes
|
|
50
|
+
------------- | ------------- | ------------- | -------------
|
|
51
|
+
**integration_key** | **String**| The key used to specify the integration kind. |
|
|
52
|
+
**integration_id** | **String**| The integration ID. |
|
|
53
|
+
|
|
54
|
+
### Return type
|
|
55
|
+
|
|
56
|
+
nil (empty response body)
|
|
57
|
+
|
|
58
|
+
### Authorization
|
|
59
|
+
|
|
60
|
+
[Token](../README.md#Token)
|
|
61
|
+
|
|
62
|
+
### HTTP request headers
|
|
63
|
+
|
|
64
|
+
- **Content-Type**: application/json
|
|
65
|
+
- **Accept**: application/json
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
# **get_integration_subscription**
|
|
70
|
+
> IntegrationSubscription get_integration_subscription(integration_key, integration_id, )
|
|
71
|
+
|
|
72
|
+
Get a single integration subscription by ID.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
```ruby
|
|
76
|
+
# load the gem
|
|
77
|
+
require 'launchdarkly_api'
|
|
78
|
+
# setup authorization
|
|
79
|
+
LaunchDarklyApi.configure do |config|
|
|
80
|
+
# Configure API key authorization: Token
|
|
81
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
82
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
83
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
api_instance = LaunchDarklyApi::IntegrationsApi.new
|
|
87
|
+
|
|
88
|
+
integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
|
|
89
|
+
|
|
90
|
+
integration_id = 'integration_id_example' # String | The integration ID.
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
begin
|
|
94
|
+
#Get a single integration subscription by ID.
|
|
95
|
+
result = api_instance.get_integration_subscription(integration_key, integration_id, )
|
|
96
|
+
p result
|
|
97
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
98
|
+
puts "Exception when calling IntegrationsApi->get_integration_subscription: #{e}"
|
|
99
|
+
end
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Parameters
|
|
103
|
+
|
|
104
|
+
Name | Type | Description | Notes
|
|
105
|
+
------------- | ------------- | ------------- | -------------
|
|
106
|
+
**integration_key** | **String**| The key used to specify the integration kind. |
|
|
107
|
+
**integration_id** | **String**| The integration ID. |
|
|
108
|
+
|
|
109
|
+
### Return type
|
|
110
|
+
|
|
111
|
+
[**IntegrationSubscription**](IntegrationSubscription.md)
|
|
112
|
+
|
|
113
|
+
### Authorization
|
|
114
|
+
|
|
115
|
+
[Token](../README.md#Token)
|
|
116
|
+
|
|
117
|
+
### HTTP request headers
|
|
118
|
+
|
|
119
|
+
- **Content-Type**: application/json
|
|
120
|
+
- **Accept**: application/json
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
# **get_integration_subscriptions**
|
|
125
|
+
> Integration get_integration_subscriptions(integration_key, )
|
|
126
|
+
|
|
127
|
+
Get a list of all configured integrations of a given kind.
|
|
128
|
+
|
|
129
|
+
### Example
|
|
130
|
+
```ruby
|
|
131
|
+
# load the gem
|
|
132
|
+
require 'launchdarkly_api'
|
|
133
|
+
# setup authorization
|
|
134
|
+
LaunchDarklyApi.configure do |config|
|
|
135
|
+
# Configure API key authorization: Token
|
|
136
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
137
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
138
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
api_instance = LaunchDarklyApi::IntegrationsApi.new
|
|
142
|
+
|
|
143
|
+
integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
begin
|
|
147
|
+
#Get a list of all configured integrations of a given kind.
|
|
148
|
+
result = api_instance.get_integration_subscriptions(integration_key, )
|
|
149
|
+
p result
|
|
150
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
151
|
+
puts "Exception when calling IntegrationsApi->get_integration_subscriptions: #{e}"
|
|
152
|
+
end
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
Name | Type | Description | Notes
|
|
158
|
+
------------- | ------------- | ------------- | -------------
|
|
159
|
+
**integration_key** | **String**| The key used to specify the integration kind. |
|
|
160
|
+
|
|
161
|
+
### Return type
|
|
162
|
+
|
|
163
|
+
[**Integration**](Integration.md)
|
|
164
|
+
|
|
165
|
+
### Authorization
|
|
166
|
+
|
|
167
|
+
[Token](../README.md#Token)
|
|
168
|
+
|
|
169
|
+
### HTTP request headers
|
|
170
|
+
|
|
171
|
+
- **Content-Type**: application/json
|
|
172
|
+
- **Accept**: application/json
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
# **get_integrations**
|
|
177
|
+
> Integrations get_integrations
|
|
178
|
+
|
|
179
|
+
Get a list of all configured audit log event integrations associated with this account.
|
|
180
|
+
|
|
181
|
+
### Example
|
|
182
|
+
```ruby
|
|
183
|
+
# load the gem
|
|
184
|
+
require 'launchdarkly_api'
|
|
185
|
+
# setup authorization
|
|
186
|
+
LaunchDarklyApi.configure do |config|
|
|
187
|
+
# Configure API key authorization: Token
|
|
188
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
189
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
190
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
api_instance = LaunchDarklyApi::IntegrationsApi.new
|
|
194
|
+
|
|
195
|
+
begin
|
|
196
|
+
#Get a list of all configured audit log event integrations associated with this account.
|
|
197
|
+
result = api_instance.get_integrations
|
|
198
|
+
p result
|
|
199
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
200
|
+
puts "Exception when calling IntegrationsApi->get_integrations: #{e}"
|
|
201
|
+
end
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Parameters
|
|
205
|
+
This endpoint does not need any parameter.
|
|
206
|
+
|
|
207
|
+
### Return type
|
|
208
|
+
|
|
209
|
+
[**Integrations**](Integrations.md)
|
|
210
|
+
|
|
211
|
+
### Authorization
|
|
212
|
+
|
|
213
|
+
[Token](../README.md#Token)
|
|
214
|
+
|
|
215
|
+
### HTTP request headers
|
|
216
|
+
|
|
217
|
+
- **Content-Type**: application/json
|
|
218
|
+
- **Accept**: application/json
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
# **patch_integration_subscription**
|
|
223
|
+
> IntegrationSubscription patch_integration_subscription(integration_key, integration_id, patch_delta)
|
|
224
|
+
|
|
225
|
+
Modify an integration subscription by ID.
|
|
226
|
+
|
|
227
|
+
### Example
|
|
228
|
+
```ruby
|
|
229
|
+
# load the gem
|
|
230
|
+
require 'launchdarkly_api'
|
|
231
|
+
# setup authorization
|
|
232
|
+
LaunchDarklyApi.configure do |config|
|
|
233
|
+
# Configure API key authorization: Token
|
|
234
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
235
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
236
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
237
|
+
end
|
|
238
|
+
|
|
239
|
+
api_instance = LaunchDarklyApi::IntegrationsApi.new
|
|
240
|
+
|
|
241
|
+
integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
|
|
242
|
+
|
|
243
|
+
integration_id = 'integration_id_example' # String | The integration ID.
|
|
244
|
+
|
|
245
|
+
patch_delta = [LaunchDarklyApi::PatchOperation.new] # Array<PatchOperation> | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
begin
|
|
249
|
+
#Modify an integration subscription by ID.
|
|
250
|
+
result = api_instance.patch_integration_subscription(integration_key, integration_id, patch_delta)
|
|
251
|
+
p result
|
|
252
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
253
|
+
puts "Exception when calling IntegrationsApi->patch_integration_subscription: #{e}"
|
|
254
|
+
end
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
### Parameters
|
|
258
|
+
|
|
259
|
+
Name | Type | Description | Notes
|
|
260
|
+
------------- | ------------- | ------------- | -------------
|
|
261
|
+
**integration_key** | **String**| The key used to specify the integration kind. |
|
|
262
|
+
**integration_id** | **String**| The integration ID. |
|
|
263
|
+
**patch_delta** | [**Array<PatchOperation>**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' |
|
|
264
|
+
|
|
265
|
+
### Return type
|
|
266
|
+
|
|
267
|
+
[**IntegrationSubscription**](IntegrationSubscription.md)
|
|
268
|
+
|
|
269
|
+
### Authorization
|
|
270
|
+
|
|
271
|
+
[Token](../README.md#Token)
|
|
272
|
+
|
|
273
|
+
### HTTP request headers
|
|
274
|
+
|
|
275
|
+
- **Content-Type**: application/json
|
|
276
|
+
- **Accept**: application/json
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
# **post_integration_subscription**
|
|
281
|
+
> IntegrationSubscription post_integration_subscription(integration_key, subscription_body)
|
|
282
|
+
|
|
283
|
+
Create a new integration subscription of a given kind.
|
|
284
|
+
|
|
285
|
+
### Example
|
|
286
|
+
```ruby
|
|
287
|
+
# load the gem
|
|
288
|
+
require 'launchdarkly_api'
|
|
289
|
+
# setup authorization
|
|
290
|
+
LaunchDarklyApi.configure do |config|
|
|
291
|
+
# Configure API key authorization: Token
|
|
292
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
293
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
294
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
api_instance = LaunchDarklyApi::IntegrationsApi.new
|
|
298
|
+
|
|
299
|
+
integration_key = 'integration_key_example' # String | The key used to specify the integration kind.
|
|
300
|
+
|
|
301
|
+
subscription_body = LaunchDarklyApi::SubscriptionBody.new # SubscriptionBody | Create a new integration subscription.
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
begin
|
|
305
|
+
#Create a new integration subscription of a given kind.
|
|
306
|
+
result = api_instance.post_integration_subscription(integration_key, subscription_body)
|
|
307
|
+
p result
|
|
308
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
309
|
+
puts "Exception when calling IntegrationsApi->post_integration_subscription: #{e}"
|
|
310
|
+
end
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
### Parameters
|
|
314
|
+
|
|
315
|
+
Name | Type | Description | Notes
|
|
316
|
+
------------- | ------------- | ------------- | -------------
|
|
317
|
+
**integration_key** | **String**| The key used to specify the integration kind. |
|
|
318
|
+
**subscription_body** | [**SubscriptionBody**](SubscriptionBody.md)| Create a new integration subscription. |
|
|
319
|
+
|
|
320
|
+
### Return type
|
|
321
|
+
|
|
322
|
+
[**IntegrationSubscription**](IntegrationSubscription.md)
|
|
323
|
+
|
|
324
|
+
### Authorization
|
|
325
|
+
|
|
326
|
+
[Token](../README.md#Token)
|
|
327
|
+
|
|
328
|
+
### HTTP request headers
|
|
329
|
+
|
|
330
|
+
- **Content-Type**: application/json
|
|
331
|
+
- **Accept**: application/json
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
@@ -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
|
+
|