launchdarkly_api 4.0.0 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +246 -226
- data/docs/ApprovalRequest.md +20 -0
- data/docs/{FeatureFlagApprovalRequestApplyConfigBody.md → ApprovalRequestApplyConfigBody.md} +1 -1
- data/docs/{FeatureFlagApprovalRequestConfigBody.md → ApprovalRequestConfigBody.md} +3 -1
- data/docs/{FeatureFlagApprovalRequestReview.md → ApprovalRequestReview.md} +2 -2
- data/docs/{FeatureFlagApprovalRequestReviewConfigBody.md → ApprovalRequestReviewConfigBody.md} +1 -1
- data/docs/{FeatureFlagApprovalRequestReviewStatus.md → ApprovalRequestReviewStatus.md} +1 -1
- data/docs/{FeatureFlagApprovalRequests.md → ApprovalRequests.md} +2 -2
- data/docs/{UnboundedSegmentTargetChanges.md → BigSegmentTargetChanges.md} +1 -1
- data/docs/BigSegmentTargetsBody.md +9 -0
- data/docs/DependentFlag.md +11 -0
- data/docs/DependentFlagEnvironment.md +11 -0
- data/docs/DependentFlagEnvironmentLinks.md +9 -0
- data/docs/{IntegrationLinks.md → DependentFlagLinks.md} +1 -1
- data/docs/DependentFlagsByEnvironment.md +10 -0
- data/docs/DependentFlagsLinks.md +9 -0
- data/docs/FeatureFlagStatus.md +1 -1
- data/docs/FeatureFlagStatusAcrossEnvironments.md +1 -1
- data/docs/FeatureFlagStatusLinks.md +9 -0
- data/docs/FeatureFlagStatuses.md +1 -1
- data/docs/FeatureFlagsApi.md +577 -91
- data/docs/FlagConfigScheduledChangesConflictsBody.md +9 -0
- data/docs/FlagConfigScheduledChangesPatchBody.md +9 -0
- data/docs/FlagConfigScheduledChangesPostBody.md +10 -0
- data/docs/Integration.md +1 -1
- data/docs/Member.md +2 -0
- data/docs/MemberLastSeenMetadata.md +8 -0
- data/docs/MultiEnvironmentDependentFlag.md +12 -0
- data/docs/MultiEnvironmentDependentFlags.md +10 -0
- data/docs/UserSegment.md +1 -1
- data/docs/UserSegmentBody.md +1 -1
- data/docs/UserSegmentsApi.md +9 -9
- data/docs/UsersApi.md +2 -2
- data/launchdarkly_api.gemspec +3 -2
- data/lib/launchdarkly_api.rb +24 -12
- data/lib/launchdarkly_api/api/access_tokens_api.rb +2 -2
- data/lib/launchdarkly_api/api/audit_log_api.rb +2 -2
- data/lib/launchdarkly_api/api/custom_roles_api.rb +2 -2
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +2 -2
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +2 -2
- data/lib/launchdarkly_api/api/environments_api.rb +2 -2
- data/lib/launchdarkly_api/api/feature_flags_api.rb +702 -161
- data/lib/launchdarkly_api/api/integrations_api.rb +2 -2
- data/lib/launchdarkly_api/api/projects_api.rb +2 -2
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +2 -2
- data/lib/launchdarkly_api/api/root_api.rb +2 -2
- data/lib/launchdarkly_api/api/team_members_api.rb +2 -2
- data/lib/launchdarkly_api/api/user_segments_api.rb +19 -19
- data/lib/launchdarkly_api/api/user_settings_api.rb +2 -2
- data/lib/launchdarkly_api/api/users_api.rb +5 -5
- data/lib/launchdarkly_api/api/webhooks_api.rb +2 -2
- data/lib/launchdarkly_api/api_client.rb +7 -5
- data/lib/launchdarkly_api/api_error.rb +2 -2
- data/lib/launchdarkly_api/configuration.rb +4 -4
- data/lib/launchdarkly_api/models/{feature_flag_approval_request.rb → approval_request.rb} +34 -13
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_apply_config_body.rb → approval_request_apply_config_body.rb} +5 -4
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_config_body.rb → approval_request_config_body.rb} +29 -8
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_review.rb → approval_request_review.rb} +6 -5
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_review_config_body.rb → approval_request_review_config_body.rb} +5 -4
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_review_status.rb → approval_request_review_status.rb} +5 -5
- data/lib/launchdarkly_api/models/{feature_flag_approval_requests.rb → approval_requests.rb} +6 -5
- data/lib/launchdarkly_api/models/audit_log_entries.rb +4 -3
- data/lib/launchdarkly_api/models/audit_log_entry.rb +4 -3
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +4 -3
- data/lib/launchdarkly_api/models/{unbounded_segment_target_changes.rb → big_segment_target_changes.rb} +5 -4
- data/lib/launchdarkly_api/models/{unbounded_segment_targets_body.rb → big_segment_targets_body.rb} +7 -6
- data/lib/launchdarkly_api/models/clause.rb +4 -3
- data/lib/launchdarkly_api/models/client_side_availability.rb +4 -3
- data/lib/launchdarkly_api/models/copy_actions.rb +2 -2
- data/lib/launchdarkly_api/models/custom_property.rb +4 -3
- data/lib/launchdarkly_api/models/custom_property_values.rb +4 -3
- data/lib/launchdarkly_api/models/custom_role.rb +4 -3
- data/lib/launchdarkly_api/models/custom_role_body.rb +4 -3
- data/lib/launchdarkly_api/models/custom_roles.rb +4 -3
- data/lib/launchdarkly_api/models/defaults.rb +4 -3
- data/lib/launchdarkly_api/models/dependent_flag.rb +211 -0
- data/lib/launchdarkly_api/models/{integration__links.rb → dependent_flag__links.rb} +5 -4
- data/lib/launchdarkly_api/models/dependent_flag_environment.rb +211 -0
- data/lib/launchdarkly_api/models/dependent_flag_environment__links.rb +193 -0
- data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +204 -0
- data/lib/launchdarkly_api/models/dependent_flags_links.rb +193 -0
- data/lib/launchdarkly_api/models/destination.rb +4 -3
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +4 -3
- data/lib/launchdarkly_api/models/destination_body.rb +4 -3
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +4 -3
- data/lib/launchdarkly_api/models/destination_m_particle.rb +4 -3
- data/lib/launchdarkly_api/models/destination_segment.rb +4 -3
- data/lib/launchdarkly_api/models/destinations.rb +4 -3
- data/lib/launchdarkly_api/models/environment.rb +4 -3
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +4 -3
- data/lib/launchdarkly_api/models/environment_post.rb +4 -3
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +4 -3
- data/lib/launchdarkly_api/models/events.rb +4 -3
- data/lib/launchdarkly_api/models/fallthrough.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_body.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_config.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_status.rb +5 -4
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +5 -4
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_status_links.rb +193 -0
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +5 -4
- data/lib/launchdarkly_api/models/feature_flags.rb +4 -3
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +194 -0
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +194 -0
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +204 -0
- data/lib/launchdarkly_api/models/flag_list_item.rb +4 -3
- data/lib/launchdarkly_api/models/hierarchical_links.rb +4 -3
- data/lib/launchdarkly_api/models/id.rb +4 -3
- data/lib/launchdarkly_api/models/integration.rb +5 -4
- data/lib/launchdarkly_api/models/integration_subscription.rb +4 -3
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +4 -3
- data/lib/launchdarkly_api/models/integrations.rb +4 -3
- data/lib/launchdarkly_api/models/link.rb +4 -3
- data/lib/launchdarkly_api/models/links.rb +4 -3
- data/lib/launchdarkly_api/models/ma_uby_category.rb +4 -3
- data/lib/launchdarkly_api/models/mau.rb +4 -3
- data/lib/launchdarkly_api/models/mau_metadata.rb +4 -3
- data/lib/launchdarkly_api/models/member.rb +27 -7
- data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +185 -0
- data/lib/launchdarkly_api/models/members.rb +4 -3
- data/lib/launchdarkly_api/models/members_body.rb +4 -3
- data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +222 -0
- data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +204 -0
- data/lib/launchdarkly_api/models/patch_comment.rb +4 -3
- data/lib/launchdarkly_api/models/patch_operation.rb +4 -3
- data/lib/launchdarkly_api/models/policy.rb +4 -3
- data/lib/launchdarkly_api/models/prerequisite.rb +4 -3
- data/lib/launchdarkly_api/models/project.rb +4 -3
- data/lib/launchdarkly_api/models/project_body.rb +4 -3
- data/lib/launchdarkly_api/models/projects.rb +4 -3
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +4 -3
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +4 -3
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +4 -3
- data/lib/launchdarkly_api/models/role.rb +2 -2
- data/lib/launchdarkly_api/models/rollout.rb +4 -3
- data/lib/launchdarkly_api/models/rule.rb +4 -3
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +4 -3
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +4 -3
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +4 -3
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +4 -3
- data/lib/launchdarkly_api/models/site.rb +4 -3
- data/lib/launchdarkly_api/models/statement.rb +4 -3
- data/lib/launchdarkly_api/models/stream.rb +4 -3
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +4 -3
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +4 -3
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +4 -3
- data/lib/launchdarkly_api/models/stream_links.rb +4 -3
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +4 -3
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +4 -3
- data/lib/launchdarkly_api/models/stream_usage_error.rb +4 -3
- data/lib/launchdarkly_api/models/stream_usage_links.rb +4 -3
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +4 -3
- data/lib/launchdarkly_api/models/stream_usage_series.rb +4 -3
- data/lib/launchdarkly_api/models/streams.rb +4 -3
- data/lib/launchdarkly_api/models/subscription_body.rb +4 -3
- data/lib/launchdarkly_api/models/target.rb +4 -3
- data/lib/launchdarkly_api/models/token.rb +4 -3
- data/lib/launchdarkly_api/models/token_body.rb +4 -3
- data/lib/launchdarkly_api/models/tokens.rb +4 -3
- data/lib/launchdarkly_api/models/usage.rb +4 -3
- data/lib/launchdarkly_api/models/usage_error.rb +4 -3
- data/lib/launchdarkly_api/models/usage_links.rb +4 -3
- data/lib/launchdarkly_api/models/user.rb +4 -3
- data/lib/launchdarkly_api/models/user_flag_setting.rb +4 -3
- data/lib/launchdarkly_api/models/user_flag_settings.rb +4 -3
- data/lib/launchdarkly_api/models/user_record.rb +4 -3
- data/lib/launchdarkly_api/models/user_segment.rb +5 -4
- data/lib/launchdarkly_api/models/user_segment_body.rb +5 -4
- data/lib/launchdarkly_api/models/user_segment_rule.rb +4 -3
- data/lib/launchdarkly_api/models/user_segments.rb +4 -3
- data/lib/launchdarkly_api/models/user_settings_body.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +4 -3
- data/lib/launchdarkly_api/models/users.rb +4 -3
- data/lib/launchdarkly_api/models/variation.rb +4 -3
- data/lib/launchdarkly_api/models/webhook.rb +4 -3
- data/lib/launchdarkly_api/models/webhook_body.rb +4 -3
- data/lib/launchdarkly_api/models/webhooks.rb +4 -3
- data/lib/launchdarkly_api/models/weighted_variation.rb +4 -3
- data/lib/launchdarkly_api/version.rb +3 -3
- data/openapi.yml +413 -91
- data/spec/api/access_tokens_api_spec.rb +2 -2
- data/spec/api/audit_log_api_spec.rb +2 -2
- data/spec/api/custom_roles_api_spec.rb +2 -2
- data/spec/api/customer_metrics_api_spec.rb +2 -2
- data/spec/api/data_export_destinations_api_spec.rb +2 -2
- data/spec/api/environments_api_spec.rb +2 -2
- data/spec/api/feature_flags_api_spec.rb +153 -44
- data/spec/api/integrations_api_spec.rb +2 -2
- data/spec/api/projects_api_spec.rb +2 -2
- data/spec/api/relay_proxy_configurations_api_spec.rb +2 -2
- data/spec/api/root_api_spec.rb +2 -2
- data/spec/api/team_members_api_spec.rb +2 -2
- data/spec/api/user_segments_api_spec.rb +6 -6
- data/spec/api/user_settings_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +3 -3
- data/spec/api/webhooks_api_spec.rb +2 -2
- data/spec/api_client_spec.rb +19 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/{feature_flag_approval_request_apply_config_body_spec.rb → approval_request_apply_config_body_spec.rb} +8 -8
- data/spec/models/approval_request_config_body_spec.rb +71 -0
- data/spec/models/{feature_flag_approval_request_review_config_body_spec.rb → approval_request_review_config_body_spec.rb} +8 -8
- data/spec/models/{feature_flag_approval_request_review_spec.rb → approval_request_review_spec.rb} +8 -8
- data/spec/models/approval_request_review_status_spec.rb +35 -0
- data/spec/models/{feature_flag_approval_request_spec.rb → approval_request_spec.rb} +21 -9
- data/spec/models/{feature_flag_approval_requests_spec.rb → approval_requests_spec.rb} +8 -8
- data/spec/models/audit_log_entries_spec.rb +2 -2
- data/spec/models/audit_log_entry_spec.rb +2 -2
- data/spec/models/audit_log_entry_target_spec.rb +2 -2
- data/spec/models/{unbounded_segment_target_changes_spec.rb → big_segment_target_changes_spec.rb} +8 -8
- data/spec/models/{unbounded_segment_targets_body_spec.rb → big_segment_targets_body_spec.rb} +8 -8
- data/spec/models/clause_spec.rb +2 -2
- data/spec/models/client_side_availability_spec.rb +2 -2
- data/spec/models/copy_actions_spec.rb +2 -2
- data/spec/models/custom_property_spec.rb +2 -2
- data/spec/models/custom_property_values_spec.rb +2 -2
- data/spec/models/custom_role_body_spec.rb +2 -2
- data/spec/models/custom_role_spec.rb +2 -2
- data/spec/models/custom_roles_spec.rb +2 -2
- data/spec/models/defaults_spec.rb +2 -2
- data/spec/models/{integration__links_spec.rb → dependent_flag__links_spec.rb} +8 -8
- data/spec/models/dependent_flag_environment__links_spec.rb +47 -0
- data/spec/models/{feature_flag_approval_request_config_body_spec.rb → dependent_flag_environment_spec.rb} +12 -12
- data/spec/models/dependent_flag_spec.rb +59 -0
- data/spec/models/dependent_flags_by_environment_spec.rb +53 -0
- data/spec/models/dependent_flags_links_spec.rb +47 -0
- data/spec/models/destination_amazon_kinesis_spec.rb +2 -2
- data/spec/models/destination_body_spec.rb +2 -2
- data/spec/models/destination_google_pub_sub_spec.rb +2 -2
- data/spec/models/destination_m_particle_spec.rb +2 -2
- data/spec/models/destination_segment_spec.rb +2 -2
- data/spec/models/destination_spec.rb +2 -2
- data/spec/models/destinations_spec.rb +2 -2
- data/spec/models/environment_approval_settings_spec.rb +2 -2
- data/spec/models/environment_post_spec.rb +2 -2
- data/spec/models/environment_spec.rb +2 -2
- data/spec/models/evaluation_usage_error_spec.rb +2 -2
- data/spec/models/events_spec.rb +2 -2
- data/spec/models/fallthrough_spec.rb +2 -2
- data/spec/models/feature_flag_body_spec.rb +2 -2
- data/spec/models/feature_flag_config_spec.rb +2 -2
- data/spec/models/feature_flag_copy_body_spec.rb +2 -2
- data/spec/models/feature_flag_copy_object_spec.rb +2 -2
- data/spec/models/feature_flag_scheduled_change_spec.rb +2 -2
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +2 -2
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +2 -2
- data/spec/models/feature_flag_scheduled_changes_spec.rb +2 -2
- data/spec/models/feature_flag_spec.rb +2 -2
- data/spec/models/feature_flag_status_across_environments_spec.rb +2 -2
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +2 -2
- data/spec/models/feature_flag_status_links_spec.rb +47 -0
- data/spec/models/feature_flag_status_spec.rb +2 -2
- data/spec/models/feature_flag_statuses_spec.rb +2 -2
- data/spec/models/feature_flags_spec.rb +2 -2
- data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +47 -0
- data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +47 -0
- data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +53 -0
- data/spec/models/flag_list_item_spec.rb +2 -2
- data/spec/models/hierarchical_links_spec.rb +2 -2
- data/spec/models/id_spec.rb +2 -2
- data/spec/models/integration_spec.rb +2 -2
- data/spec/models/integration_subscription__status_spec.rb +2 -2
- data/spec/models/integration_subscription_spec.rb +2 -2
- data/spec/models/integrations_spec.rb +2 -2
- data/spec/models/link_spec.rb +2 -2
- data/spec/models/links_spec.rb +2 -2
- data/spec/models/ma_uby_category_spec.rb +2 -2
- data/spec/models/mau_metadata_spec.rb +2 -2
- data/spec/models/mau_spec.rb +2 -2
- data/spec/models/member__last_seen_metadata_spec.rb +41 -0
- data/spec/models/member_spec.rb +14 -2
- data/spec/models/members_body_spec.rb +2 -2
- data/spec/models/members_spec.rb +2 -2
- data/spec/models/multi_environment_dependent_flag_spec.rb +65 -0
- data/spec/models/multi_environment_dependent_flags_spec.rb +53 -0
- data/spec/models/patch_comment_spec.rb +2 -2
- data/spec/models/patch_operation_spec.rb +2 -2
- data/spec/models/policy_spec.rb +2 -2
- data/spec/models/prerequisite_spec.rb +2 -2
- data/spec/models/project_body_spec.rb +2 -2
- data/spec/models/project_spec.rb +2 -2
- data/spec/models/projects_spec.rb +2 -2
- data/spec/models/relay_proxy_config_body_spec.rb +2 -2
- data/spec/models/relay_proxy_config_spec.rb +2 -2
- data/spec/models/relay_proxy_configs_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/rollout_spec.rb +2 -2
- data/spec/models/rule_spec.rb +2 -2
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +2 -2
- data/spec/models/semantic_patch_instruction_inner_spec.rb +2 -2
- data/spec/models/semantic_patch_instruction_spec.rb +2 -2
- data/spec/models/semantic_patch_operation_spec.rb +2 -2
- data/spec/models/site_spec.rb +2 -2
- data/spec/models/statement_spec.rb +2 -2
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +2 -2
- data/spec/models/stream_by_sdk_links_spec.rb +2 -2
- data/spec/models/stream_by_sdk_spec.rb +2 -2
- data/spec/models/stream_links_spec.rb +2 -2
- data/spec/models/stream_sdk_version_data_spec.rb +2 -2
- data/spec/models/stream_sdk_version_spec.rb +2 -2
- data/spec/models/stream_spec.rb +2 -2
- data/spec/models/stream_usage_error_spec.rb +2 -2
- data/spec/models/stream_usage_links_spec.rb +2 -2
- data/spec/models/stream_usage_metadata_spec.rb +2 -2
- data/spec/models/stream_usage_series_spec.rb +2 -2
- data/spec/models/streams_spec.rb +2 -2
- data/spec/models/subscription_body_spec.rb +2 -2
- data/spec/models/target_spec.rb +2 -2
- data/spec/models/token_body_spec.rb +2 -2
- data/spec/models/token_spec.rb +2 -2
- data/spec/models/tokens_spec.rb +2 -2
- data/spec/models/usage_error_spec.rb +2 -2
- data/spec/models/usage_links_spec.rb +2 -2
- data/spec/models/usage_spec.rb +2 -2
- data/spec/models/user_flag_setting_spec.rb +2 -2
- data/spec/models/user_flag_settings_spec.rb +2 -2
- data/spec/models/user_record_spec.rb +2 -2
- data/spec/models/user_segment_body_spec.rb +2 -2
- data/spec/models/user_segment_rule_spec.rb +2 -2
- data/spec/models/user_segment_spec.rb +2 -2
- data/spec/models/user_segments_spec.rb +2 -2
- data/spec/models/user_settings_body_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +2 -2
- data/spec/models/users_spec.rb +2 -2
- data/spec/models/variation_spec.rb +2 -2
- data/spec/models/webhook_body_spec.rb +2 -2
- data/spec/models/webhook_spec.rb +2 -2
- data/spec/models/webhooks_spec.rb +2 -2
- data/spec/models/weighted_variation_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +218 -150
- data/docs/FeatureFlagApprovalRequest.md +0 -18
- data/docs/UnboundedSegmentTargetsBody.md +0 -9
- data/spec/models/feature_flag_approval_request_review_status_spec.rb +0 -35
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LaunchDarklyApi::ApprovalRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_id** | [**Id**](Id.md) | | [optional]
|
|
7
|
+
**_version** | **Integer** | | [optional]
|
|
8
|
+
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was requested | [optional]
|
|
9
|
+
**requestor_id** | **String** | The id of the member that requested the change | [optional]
|
|
10
|
+
**review_status** | [**ApprovalRequestReviewStatus**](ApprovalRequestReviewStatus.md) | | [optional]
|
|
11
|
+
**status** | **String** | | Name | Description | | ---------:| ----------- | | pending | the approval request has not been applied yet | | completed | the approval request has been applied successfully | | scheduled | the approval request for a scheduled change has been applied successfully | | failed | the approval request has been applied but the changes were not applied successfully | | [optional]
|
|
12
|
+
**applied_by_member_id** | **String** | The id of the member that applied the approval request | [optional]
|
|
13
|
+
**applied_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was applied | [optional]
|
|
14
|
+
**all_reviews** | [**Array<ApprovalRequestReview>**](ApprovalRequestReview.md) | | [optional]
|
|
15
|
+
**notify_member_ids** | **Array<String>** | | [optional]
|
|
16
|
+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | | [optional]
|
|
17
|
+
**execution_date** | **Integer** | Timestamp for when instructions will be executed | [optional]
|
|
18
|
+
**operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional]
|
|
19
|
+
|
|
20
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# LaunchDarklyApi::
|
|
1
|
+
# LaunchDarklyApi::ApprovalRequestConfigBody
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
@@ -7,5 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | |
|
|
8
8
|
**notify_member_ids** | **Array<String>** | |
|
|
9
9
|
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
|
10
|
+
**execution_date** | **Integer** | Timestamp for when instructions will be executed | [optional]
|
|
11
|
+
**operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional]
|
|
10
12
|
|
|
11
13
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# LaunchDarklyApi::
|
|
1
|
+
# LaunchDarklyApi::ApprovalRequestReview
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was reviewed | [optional]
|
|
7
|
-
**kind** | [**
|
|
7
|
+
**kind** | [**ApprovalRequestReviewStatus**](ApprovalRequestReviewStatus.md) | | [optional]
|
|
8
8
|
**member_id** | [**Id**](Id.md) | | [optional]
|
|
9
9
|
**_id** | [**Id**](Id.md) | | [optional]
|
|
10
10
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
# LaunchDarklyApi::
|
|
1
|
+
# LaunchDarklyApi::ApprovalRequests
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**_links** | [**Links**](Links.md) | | [optional]
|
|
7
|
-
**items** | [**Array<
|
|
7
|
+
**items** | [**Array<ApprovalRequest>**](ApprovalRequest.md) | | [optional]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::BigSegmentTargetsBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**included** | [**BigSegmentTargetChanges**](BigSegmentTargetChanges.md) | | [optional]
|
|
7
|
+
**excluded** | [**BigSegmentTargetChanges**](BigSegmentTargetChanges.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# LaunchDarklyApi::DependentFlag
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | | [optional]
|
|
7
|
+
**key** | **String** | | [optional]
|
|
8
|
+
**_links** | [**DependentFlagLinks**](DependentFlagLinks.md) | | [optional]
|
|
9
|
+
**_site** | [**Site**](Site.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# LaunchDarklyApi::DependentFlagEnvironment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | | [optional]
|
|
7
|
+
**key** | **String** | | [optional]
|
|
8
|
+
**_links** | [**DependentFlagEnvironmentLinks**](DependentFlagEnvironmentLinks.md) | | [optional]
|
|
9
|
+
**_site** | [**Site**](Site.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::DependentFlagEnvironmentLinks
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_self** | [**Link**](Link.md) | | [optional]
|
|
7
|
+
**flag_link** | [**Link**](Link.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# LaunchDarklyApi::DependentFlagsByEnvironment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**items** | [**Array<DependentFlag>**](DependentFlag.md) | | [optional]
|
|
7
|
+
**_links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) | | [optional]
|
|
8
|
+
**_site** | [**Site**](Site.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/FeatureFlagStatus.md
CHANGED
|
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**name** | **String** | | Name | Description | | --------:| ----------- | | new | the feature flag was created within the last 7 days, and has not been requested yet | | active | the feature flag was requested by your servers or clients within the last 7 days | | inactive | the feature flag was created more than 7 days ago, and hasn't been requested by your servers or clients within the past 7 days | | launched | one variation of the feature flag has been rolled out to all your users for at least 7 days | | [optional]
|
|
7
7
|
**last_requested** | **String** | | [optional]
|
|
8
8
|
**default** | **Object** | | [optional]
|
|
9
|
-
**_links** | [**
|
|
9
|
+
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**_links** | [**
|
|
6
|
+
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
|
7
7
|
**key** | **String** | | [optional]
|
|
8
8
|
**environments** | [**Hash<String, FeatureFlagStatusForQueriedEnvironment>**](FeatureFlagStatusForQueriedEnvironment.md) | | [optional]
|
|
9
9
|
|
data/docs/FeatureFlagStatuses.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**_links** | [**
|
|
6
|
+
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
|
7
7
|
**items** | [**Array<FeatureFlagStatus>**](FeatureFlagStatus.md) | | [optional]
|
|
8
8
|
|
|
9
9
|
|
data/docs/FeatureFlagsApi.md
CHANGED
|
@@ -5,22 +5,30 @@ All URIs are relative to *https://app.launchdarkly.com/api/v2*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**copy_feature_flag**](FeatureFlagsApi.md#copy_feature_flag) | **POST** /flags/{projectKey}/{featureFlagKey}/copy | Copies the feature flag configuration from one environment to the same feature flag in another environment.
|
|
8
|
+
[**delete_approval_request**](FeatureFlagsApi.md#delete_approval_request) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Delete an approval request for a feature flag config
|
|
8
9
|
[**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /flags/{projectKey}/{featureFlagKey} | Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
|
|
9
|
-
[**
|
|
10
|
+
[**delete_flag_config_scheduled_changes**](FeatureFlagsApi.md#delete_flag_config_scheduled_changes) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Delete a scheduled change on a feature flag in an environment.
|
|
11
|
+
[**flags_project_key_environment_key_feature_flag_key_dependent_flags_get**](FeatureFlagsApi.md#flags_project_key_environment_key_feature_flag_key_dependent_flags_get) | **GET** /flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags | Get dependent flags for the flag in the environment specified in path parameters
|
|
12
|
+
[**flags_project_key_feature_flag_key_dependent_flags_get**](FeatureFlagsApi.md#flags_project_key_feature_flag_key_dependent_flags_get) | **GET** /flags/{projectKey}/{featureFlagKey}/dependent-flags | Get dependent flags across all environments for the flag specified in the path parameters
|
|
13
|
+
[**get_approval_request**](FeatureFlagsApi.md#get_approval_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Get a single approval request for a feature flag config
|
|
14
|
+
[**get_approval_requests**](FeatureFlagsApi.md#get_approval_requests) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag config
|
|
10
15
|
[**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag
|
|
11
16
|
[**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /flags/{projectKey}/{featureFlagKey} | Get a single feature flag by key.
|
|
12
|
-
[**get_feature_flag_approval_request**](FeatureFlagsApi.md#get_feature_flag_approval_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId} | Get a single approval request for a feature flag
|
|
13
|
-
[**get_feature_flag_approval_requests**](FeatureFlagsApi.md#get_feature_flag_approval_requests) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag
|
|
14
17
|
[**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get the status for a particular feature flag.
|
|
15
18
|
[**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /flag-status/{projectKey}/{featureFlagKey} | Get the status for a particular feature flag across environments
|
|
16
19
|
[**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /flag-statuses/{projectKey}/{environmentKey} | Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
|
|
17
20
|
[**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /flags/{projectKey} | Get a list of all features in the given project.
|
|
21
|
+
[**get_flag_config_scheduled_change**](FeatureFlagsApi.md#get_flag_config_scheduled_change) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Get a scheduled change on a feature flag by id.
|
|
22
|
+
[**get_flag_config_scheduled_changes**](FeatureFlagsApi.md#get_flag_config_scheduled_changes) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Get all scheduled workflows for a feature flag by key.
|
|
23
|
+
[**get_flag_config_scheduled_changes_conflicts**](FeatureFlagsApi.md#get_flag_config_scheduled_changes_conflicts) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes-conflicts | Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
|
|
18
24
|
[**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on feature flag
|
|
19
25
|
[**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
|
|
20
|
-
[**
|
|
26
|
+
[**patch_flag_config_scheduled_change**](FeatureFlagsApi.md#patch_flag_config_scheduled_change) | **PATCH** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Updates an existing scheduled-change on a feature flag in an environment.
|
|
27
|
+
[**post_apply_approval_request**](FeatureFlagsApi.md#post_apply_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/apply | Apply approval request for a feature flag config
|
|
28
|
+
[**post_approval_request**](FeatureFlagsApi.md#post_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Create an approval request for a feature flag config
|
|
21
29
|
[**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
|
|
22
|
-
[**
|
|
23
|
-
[**
|
|
30
|
+
[**post_flag_config_scheduled_changes**](FeatureFlagsApi.md#post_flag_config_scheduled_changes) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Creates a new scheduled change for a feature flag.
|
|
31
|
+
[**post_review_approval_request**](FeatureFlagsApi.md#post_review_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/review | Review approval request for a feature flag config
|
|
24
32
|
|
|
25
33
|
|
|
26
34
|
# **copy_feature_flag**
|
|
@@ -81,6 +89,70 @@ Name | Type | Description | Notes
|
|
|
81
89
|
|
|
82
90
|
|
|
83
91
|
|
|
92
|
+
# **delete_approval_request**
|
|
93
|
+
> delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, , opts)
|
|
94
|
+
|
|
95
|
+
Delete an approval request for a feature flag config
|
|
96
|
+
|
|
97
|
+
### Example
|
|
98
|
+
```ruby
|
|
99
|
+
# load the gem
|
|
100
|
+
require 'launchdarkly_api'
|
|
101
|
+
# setup authorization
|
|
102
|
+
LaunchDarklyApi.configure do |config|
|
|
103
|
+
# Configure API key authorization: Token
|
|
104
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
105
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
106
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
110
|
+
|
|
111
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
112
|
+
|
|
113
|
+
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.
|
|
114
|
+
|
|
115
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
116
|
+
|
|
117
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
118
|
+
|
|
119
|
+
opts = {
|
|
120
|
+
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
begin
|
|
124
|
+
#Delete an approval request for a feature flag config
|
|
125
|
+
api_instance.delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, , opts)
|
|
126
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
127
|
+
puts "Exception when calling FeatureFlagsApi->delete_approval_request: #{e}"
|
|
128
|
+
end
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
Name | Type | Description | Notes
|
|
134
|
+
------------- | ------------- | ------------- | -------------
|
|
135
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
136
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
137
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
138
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
139
|
+
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
nil (empty response body)
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
[Token](../README.md#Token)
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: application/json
|
|
152
|
+
- **Accept**: application/json
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
84
156
|
# **delete_feature_flag**
|
|
85
157
|
> delete_feature_flag(project_key, feature_flag_key, )
|
|
86
158
|
|
|
@@ -135,10 +207,10 @@ nil (empty response body)
|
|
|
135
207
|
|
|
136
208
|
|
|
137
209
|
|
|
138
|
-
# **
|
|
139
|
-
>
|
|
210
|
+
# **delete_flag_config_scheduled_changes**
|
|
211
|
+
> delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
|
140
212
|
|
|
141
|
-
Delete
|
|
213
|
+
Delete a scheduled change on a feature flag in an environment.
|
|
142
214
|
|
|
143
215
|
### Example
|
|
144
216
|
```ruby
|
|
@@ -156,21 +228,18 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
|
156
228
|
|
|
157
229
|
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
158
230
|
|
|
159
|
-
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.
|
|
160
|
-
|
|
161
231
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
162
232
|
|
|
163
|
-
|
|
233
|
+
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.
|
|
234
|
+
|
|
235
|
+
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
|
164
236
|
|
|
165
|
-
opts = {
|
|
166
|
-
feature_flag_approval_request_config_body: LaunchDarklyApi::FeatureFlagApprovalRequestConfigBody.new # FeatureFlagApprovalRequestConfigBody | Create a new feature flag approval request
|
|
167
|
-
}
|
|
168
237
|
|
|
169
238
|
begin
|
|
170
|
-
#Delete
|
|
171
|
-
api_instance.
|
|
239
|
+
#Delete a scheduled change on a feature flag in an environment.
|
|
240
|
+
api_instance.delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
|
172
241
|
rescue LaunchDarklyApi::ApiError => e
|
|
173
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
242
|
+
puts "Exception when calling FeatureFlagsApi->delete_flag_config_scheduled_changes: #{e}"
|
|
174
243
|
end
|
|
175
244
|
```
|
|
176
245
|
|
|
@@ -179,10 +248,9 @@ end
|
|
|
179
248
|
Name | Type | Description | Notes
|
|
180
249
|
------------- | ------------- | ------------- | -------------
|
|
181
250
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
182
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
183
251
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
184
|
-
**
|
|
185
|
-
**
|
|
252
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
253
|
+
**scheduled_change_id** | **String**| The id of the scheduled change |
|
|
186
254
|
|
|
187
255
|
### Return type
|
|
188
256
|
|
|
@@ -199,10 +267,10 @@ nil (empty response body)
|
|
|
199
267
|
|
|
200
268
|
|
|
201
269
|
|
|
202
|
-
# **
|
|
203
|
-
>
|
|
270
|
+
# **flags_project_key_environment_key_feature_flag_key_dependent_flags_get**
|
|
271
|
+
> DependentFlagsByEnvironment flags_project_key_environment_key_feature_flag_key_dependent_flags_get(project_key, environment_key, feature_flag_key, )
|
|
204
272
|
|
|
205
|
-
Get
|
|
273
|
+
Get dependent flags for the flag in the environment specified in path parameters
|
|
206
274
|
|
|
207
275
|
### Example
|
|
208
276
|
```ruby
|
|
@@ -226,11 +294,11 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
|
226
294
|
|
|
227
295
|
|
|
228
296
|
begin
|
|
229
|
-
#Get
|
|
230
|
-
result = api_instance.
|
|
297
|
+
#Get dependent flags for the flag in the environment specified in path parameters
|
|
298
|
+
result = api_instance.flags_project_key_environment_key_feature_flag_key_dependent_flags_get(project_key, environment_key, feature_flag_key, )
|
|
231
299
|
p result
|
|
232
300
|
rescue LaunchDarklyApi::ApiError => e
|
|
233
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
301
|
+
puts "Exception when calling FeatureFlagsApi->flags_project_key_environment_key_feature_flag_key_dependent_flags_get: #{e}"
|
|
234
302
|
end
|
|
235
303
|
```
|
|
236
304
|
|
|
@@ -244,7 +312,7 @@ Name | Type | Description | Notes
|
|
|
244
312
|
|
|
245
313
|
### Return type
|
|
246
314
|
|
|
247
|
-
[**
|
|
315
|
+
[**DependentFlagsByEnvironment**](DependentFlagsByEnvironment.md)
|
|
248
316
|
|
|
249
317
|
### Authorization
|
|
250
318
|
|
|
@@ -257,10 +325,10 @@ Name | Type | Description | Notes
|
|
|
257
325
|
|
|
258
326
|
|
|
259
327
|
|
|
260
|
-
# **
|
|
261
|
-
>
|
|
328
|
+
# **flags_project_key_feature_flag_key_dependent_flags_get**
|
|
329
|
+
> MultiEnvironmentDependentFlags flags_project_key_feature_flag_key_dependent_flags_get(project_key, feature_flag_key, )
|
|
262
330
|
|
|
263
|
-
Get
|
|
331
|
+
Get dependent flags across all environments for the flag specified in the path parameters
|
|
264
332
|
|
|
265
333
|
### Example
|
|
266
334
|
```ruby
|
|
@@ -280,16 +348,13 @@ project_key = 'project_key_example' # String | The project key, used to tie the
|
|
|
280
348
|
|
|
281
349
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
282
350
|
|
|
283
|
-
opts = {
|
|
284
|
-
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.
|
|
285
|
-
}
|
|
286
351
|
|
|
287
352
|
begin
|
|
288
|
-
#Get
|
|
289
|
-
result = api_instance.
|
|
353
|
+
#Get dependent flags across all environments for the flag specified in the path parameters
|
|
354
|
+
result = api_instance.flags_project_key_feature_flag_key_dependent_flags_get(project_key, feature_flag_key, )
|
|
290
355
|
p result
|
|
291
356
|
rescue LaunchDarklyApi::ApiError => e
|
|
292
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
357
|
+
puts "Exception when calling FeatureFlagsApi->flags_project_key_feature_flag_key_dependent_flags_get: #{e}"
|
|
293
358
|
end
|
|
294
359
|
```
|
|
295
360
|
|
|
@@ -299,11 +364,10 @@ Name | Type | Description | Notes
|
|
|
299
364
|
------------- | ------------- | ------------- | -------------
|
|
300
365
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
301
366
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
302
|
-
**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]
|
|
303
367
|
|
|
304
368
|
### Return type
|
|
305
369
|
|
|
306
|
-
[**
|
|
370
|
+
[**MultiEnvironmentDependentFlags**](MultiEnvironmentDependentFlags.md)
|
|
307
371
|
|
|
308
372
|
### Authorization
|
|
309
373
|
|
|
@@ -316,10 +380,10 @@ Name | Type | Description | Notes
|
|
|
316
380
|
|
|
317
381
|
|
|
318
382
|
|
|
319
|
-
# **
|
|
320
|
-
>
|
|
383
|
+
# **get_approval_request**
|
|
384
|
+
> ApprovalRequests get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
|
321
385
|
|
|
322
|
-
Get a single approval request for a feature flag
|
|
386
|
+
Get a single approval request for a feature flag config
|
|
323
387
|
|
|
324
388
|
### Example
|
|
325
389
|
```ruby
|
|
@@ -341,15 +405,15 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
|
341
405
|
|
|
342
406
|
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.
|
|
343
407
|
|
|
344
|
-
|
|
408
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
345
409
|
|
|
346
410
|
|
|
347
411
|
begin
|
|
348
|
-
#Get a single approval request for a feature flag
|
|
349
|
-
result = api_instance.
|
|
412
|
+
#Get a single approval request for a feature flag config
|
|
413
|
+
result = api_instance.get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
|
350
414
|
p result
|
|
351
415
|
rescue LaunchDarklyApi::ApiError => e
|
|
352
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
416
|
+
puts "Exception when calling FeatureFlagsApi->get_approval_request: #{e}"
|
|
353
417
|
end
|
|
354
418
|
```
|
|
355
419
|
|
|
@@ -360,11 +424,11 @@ Name | Type | Description | Notes
|
|
|
360
424
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
361
425
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
362
426
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
363
|
-
**
|
|
427
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
364
428
|
|
|
365
429
|
### Return type
|
|
366
430
|
|
|
367
|
-
[**
|
|
431
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
|
368
432
|
|
|
369
433
|
### Authorization
|
|
370
434
|
|
|
@@ -377,10 +441,10 @@ Name | Type | Description | Notes
|
|
|
377
441
|
|
|
378
442
|
|
|
379
443
|
|
|
380
|
-
# **
|
|
381
|
-
>
|
|
444
|
+
# **get_approval_requests**
|
|
445
|
+
> ApprovalRequests get_approval_requests(project_key, feature_flag_key, environment_key, )
|
|
382
446
|
|
|
383
|
-
Get all approval requests for a feature flag
|
|
447
|
+
Get all approval requests for a feature flag config
|
|
384
448
|
|
|
385
449
|
### Example
|
|
386
450
|
```ruby
|
|
@@ -404,11 +468,11 @@ environment_key = 'environment_key_example' # String | The environment key, used
|
|
|
404
468
|
|
|
405
469
|
|
|
406
470
|
begin
|
|
407
|
-
#Get all approval requests for a feature flag
|
|
408
|
-
result = api_instance.
|
|
471
|
+
#Get all approval requests for a feature flag config
|
|
472
|
+
result = api_instance.get_approval_requests(project_key, feature_flag_key, environment_key, )
|
|
409
473
|
p result
|
|
410
474
|
rescue LaunchDarklyApi::ApiError => e
|
|
411
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
475
|
+
puts "Exception when calling FeatureFlagsApi->get_approval_requests: #{e}"
|
|
412
476
|
end
|
|
413
477
|
```
|
|
414
478
|
|
|
@@ -422,7 +486,124 @@ Name | Type | Description | Notes
|
|
|
422
486
|
|
|
423
487
|
### Return type
|
|
424
488
|
|
|
425
|
-
[**
|
|
489
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
|
490
|
+
|
|
491
|
+
### Authorization
|
|
492
|
+
|
|
493
|
+
[Token](../README.md#Token)
|
|
494
|
+
|
|
495
|
+
### HTTP request headers
|
|
496
|
+
|
|
497
|
+
- **Content-Type**: application/json
|
|
498
|
+
- **Accept**: application/json
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
# **get_expiring_user_targets**
|
|
503
|
+
> UserTargetingExpirationForFlags get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
|
504
|
+
|
|
505
|
+
Get expiring user targets for feature flag
|
|
506
|
+
|
|
507
|
+
### Example
|
|
508
|
+
```ruby
|
|
509
|
+
# load the gem
|
|
510
|
+
require 'launchdarkly_api'
|
|
511
|
+
# setup authorization
|
|
512
|
+
LaunchDarklyApi.configure do |config|
|
|
513
|
+
# Configure API key authorization: Token
|
|
514
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
515
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
516
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
517
|
+
end
|
|
518
|
+
|
|
519
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
520
|
+
|
|
521
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
522
|
+
|
|
523
|
+
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.
|
|
524
|
+
|
|
525
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
begin
|
|
529
|
+
#Get expiring user targets for feature flag
|
|
530
|
+
result = api_instance.get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
|
531
|
+
p result
|
|
532
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
533
|
+
puts "Exception when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
|
|
534
|
+
end
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
### Parameters
|
|
538
|
+
|
|
539
|
+
Name | Type | Description | Notes
|
|
540
|
+
------------- | ------------- | ------------- | -------------
|
|
541
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
542
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
543
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
544
|
+
|
|
545
|
+
### Return type
|
|
546
|
+
|
|
547
|
+
[**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
|
|
548
|
+
|
|
549
|
+
### Authorization
|
|
550
|
+
|
|
551
|
+
[Token](../README.md#Token)
|
|
552
|
+
|
|
553
|
+
### HTTP request headers
|
|
554
|
+
|
|
555
|
+
- **Content-Type**: application/json
|
|
556
|
+
- **Accept**: application/json
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
# **get_feature_flag**
|
|
561
|
+
> FeatureFlag get_feature_flag(project_key, feature_flag_key, , opts)
|
|
562
|
+
|
|
563
|
+
Get a single feature flag by key.
|
|
564
|
+
|
|
565
|
+
### Example
|
|
566
|
+
```ruby
|
|
567
|
+
# load the gem
|
|
568
|
+
require 'launchdarkly_api'
|
|
569
|
+
# setup authorization
|
|
570
|
+
LaunchDarklyApi.configure do |config|
|
|
571
|
+
# Configure API key authorization: Token
|
|
572
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
573
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
574
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
575
|
+
end
|
|
576
|
+
|
|
577
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
578
|
+
|
|
579
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
580
|
+
|
|
581
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
582
|
+
|
|
583
|
+
opts = {
|
|
584
|
+
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.
|
|
585
|
+
}
|
|
586
|
+
|
|
587
|
+
begin
|
|
588
|
+
#Get a single feature flag by key.
|
|
589
|
+
result = api_instance.get_feature_flag(project_key, feature_flag_key, , opts)
|
|
590
|
+
p result
|
|
591
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
592
|
+
puts "Exception when calling FeatureFlagsApi->get_feature_flag: #{e}"
|
|
593
|
+
end
|
|
594
|
+
```
|
|
595
|
+
|
|
596
|
+
### Parameters
|
|
597
|
+
|
|
598
|
+
Name | Type | Description | Notes
|
|
599
|
+
------------- | ------------- | ------------- | -------------
|
|
600
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
601
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
602
|
+
**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]
|
|
603
|
+
|
|
604
|
+
### Return type
|
|
605
|
+
|
|
606
|
+
[**FeatureFlag**](FeatureFlag.md)
|
|
426
607
|
|
|
427
608
|
### Authorization
|
|
428
609
|
|
|
@@ -673,6 +854,186 @@ Name | Type | Description | Notes
|
|
|
673
854
|
|
|
674
855
|
|
|
675
856
|
|
|
857
|
+
# **get_flag_config_scheduled_change**
|
|
858
|
+
> FeatureFlagScheduledChange get_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
|
859
|
+
|
|
860
|
+
Get a scheduled change on a feature flag by id.
|
|
861
|
+
|
|
862
|
+
### Example
|
|
863
|
+
```ruby
|
|
864
|
+
# load the gem
|
|
865
|
+
require 'launchdarkly_api'
|
|
866
|
+
# setup authorization
|
|
867
|
+
LaunchDarklyApi.configure do |config|
|
|
868
|
+
# Configure API key authorization: Token
|
|
869
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
870
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
871
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
872
|
+
end
|
|
873
|
+
|
|
874
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
875
|
+
|
|
876
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
877
|
+
|
|
878
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
879
|
+
|
|
880
|
+
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.
|
|
881
|
+
|
|
882
|
+
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
begin
|
|
886
|
+
#Get a scheduled change on a feature flag by id.
|
|
887
|
+
result = api_instance.get_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
|
888
|
+
p result
|
|
889
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
890
|
+
puts "Exception when calling FeatureFlagsApi->get_flag_config_scheduled_change: #{e}"
|
|
891
|
+
end
|
|
892
|
+
```
|
|
893
|
+
|
|
894
|
+
### Parameters
|
|
895
|
+
|
|
896
|
+
Name | Type | Description | Notes
|
|
897
|
+
------------- | ------------- | ------------- | -------------
|
|
898
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
899
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
900
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
901
|
+
**scheduled_change_id** | **String**| The id of the scheduled change |
|
|
902
|
+
|
|
903
|
+
### Return type
|
|
904
|
+
|
|
905
|
+
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
|
906
|
+
|
|
907
|
+
### Authorization
|
|
908
|
+
|
|
909
|
+
[Token](../README.md#Token)
|
|
910
|
+
|
|
911
|
+
### HTTP request headers
|
|
912
|
+
|
|
913
|
+
- **Content-Type**: application/json
|
|
914
|
+
- **Accept**: application/json
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
# **get_flag_config_scheduled_changes**
|
|
919
|
+
> FeatureFlagScheduledChanges get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, )
|
|
920
|
+
|
|
921
|
+
Get all scheduled workflows for a feature flag by key.
|
|
922
|
+
|
|
923
|
+
### Example
|
|
924
|
+
```ruby
|
|
925
|
+
# load the gem
|
|
926
|
+
require 'launchdarkly_api'
|
|
927
|
+
# setup authorization
|
|
928
|
+
LaunchDarklyApi.configure do |config|
|
|
929
|
+
# Configure API key authorization: Token
|
|
930
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
931
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
932
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
933
|
+
end
|
|
934
|
+
|
|
935
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
936
|
+
|
|
937
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
938
|
+
|
|
939
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
940
|
+
|
|
941
|
+
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.
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
begin
|
|
945
|
+
#Get all scheduled workflows for a feature flag by key.
|
|
946
|
+
result = api_instance.get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, )
|
|
947
|
+
p result
|
|
948
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
949
|
+
puts "Exception when calling FeatureFlagsApi->get_flag_config_scheduled_changes: #{e}"
|
|
950
|
+
end
|
|
951
|
+
```
|
|
952
|
+
|
|
953
|
+
### Parameters
|
|
954
|
+
|
|
955
|
+
Name | Type | Description | Notes
|
|
956
|
+
------------- | ------------- | ------------- | -------------
|
|
957
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
958
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
959
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
960
|
+
|
|
961
|
+
### Return type
|
|
962
|
+
|
|
963
|
+
[**FeatureFlagScheduledChanges**](FeatureFlagScheduledChanges.md)
|
|
964
|
+
|
|
965
|
+
### Authorization
|
|
966
|
+
|
|
967
|
+
[Token](../README.md#Token)
|
|
968
|
+
|
|
969
|
+
### HTTP request headers
|
|
970
|
+
|
|
971
|
+
- **Content-Type**: application/json
|
|
972
|
+
- **Accept**: application/json
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
# **get_flag_config_scheduled_changes_conflicts**
|
|
977
|
+
> FeatureFlagScheduledChangesConflicts get_flag_config_scheduled_changes_conflicts(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body)
|
|
978
|
+
|
|
979
|
+
Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
|
|
980
|
+
|
|
981
|
+
### Example
|
|
982
|
+
```ruby
|
|
983
|
+
# load the gem
|
|
984
|
+
require 'launchdarkly_api'
|
|
985
|
+
# setup authorization
|
|
986
|
+
LaunchDarklyApi.configure do |config|
|
|
987
|
+
# Configure API key authorization: Token
|
|
988
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
989
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
990
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
991
|
+
end
|
|
992
|
+
|
|
993
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
994
|
+
|
|
995
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
996
|
+
|
|
997
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
998
|
+
|
|
999
|
+
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.
|
|
1000
|
+
|
|
1001
|
+
flag_config_scheduled_changes_conflicts_body = LaunchDarklyApi::FlagConfigScheduledChangesConflictsBody.new # FlagConfigScheduledChangesConflictsBody | Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag.
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
begin
|
|
1005
|
+
#Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
|
|
1006
|
+
result = api_instance.get_flag_config_scheduled_changes_conflicts(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body)
|
|
1007
|
+
p result
|
|
1008
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
1009
|
+
puts "Exception when calling FeatureFlagsApi->get_flag_config_scheduled_changes_conflicts: #{e}"
|
|
1010
|
+
end
|
|
1011
|
+
```
|
|
1012
|
+
|
|
1013
|
+
### Parameters
|
|
1014
|
+
|
|
1015
|
+
Name | Type | Description | Notes
|
|
1016
|
+
------------- | ------------- | ------------- | -------------
|
|
1017
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1018
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
1019
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
1020
|
+
**flag_config_scheduled_changes_conflicts_body** | [**FlagConfigScheduledChangesConflictsBody**](FlagConfigScheduledChangesConflictsBody.md)| Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag. |
|
|
1021
|
+
|
|
1022
|
+
### Return type
|
|
1023
|
+
|
|
1024
|
+
[**FeatureFlagScheduledChangesConflicts**](FeatureFlagScheduledChangesConflicts.md)
|
|
1025
|
+
|
|
1026
|
+
### Authorization
|
|
1027
|
+
|
|
1028
|
+
[Token](../README.md#Token)
|
|
1029
|
+
|
|
1030
|
+
### HTTP request headers
|
|
1031
|
+
|
|
1032
|
+
- **Content-Type**: application/json
|
|
1033
|
+
- **Accept**: application/json
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
|
|
676
1037
|
# **patch_expiring_user_targets**
|
|
677
1038
|
> UserTargetingExpirationForFlags patch_expiring_user_targets(project_key, environment_key, feature_flag_key, semantic_patch_with_comment)
|
|
678
1039
|
|
|
@@ -792,10 +1153,74 @@ Name | Type | Description | Notes
|
|
|
792
1153
|
|
|
793
1154
|
|
|
794
1155
|
|
|
795
|
-
# **
|
|
796
|
-
>
|
|
1156
|
+
# **patch_flag_config_scheduled_change**
|
|
1157
|
+
> FeatureFlagScheduledChange patch_flag_config_scheduled_change(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id)
|
|
1158
|
+
|
|
1159
|
+
Updates an existing scheduled-change on a feature flag in an environment.
|
|
1160
|
+
|
|
1161
|
+
### Example
|
|
1162
|
+
```ruby
|
|
1163
|
+
# load the gem
|
|
1164
|
+
require 'launchdarkly_api'
|
|
1165
|
+
# setup authorization
|
|
1166
|
+
LaunchDarklyApi.configure do |config|
|
|
1167
|
+
# Configure API key authorization: Token
|
|
1168
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1169
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1170
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1171
|
+
end
|
|
1172
|
+
|
|
1173
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
1174
|
+
|
|
1175
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
1176
|
+
|
|
1177
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
1178
|
+
|
|
1179
|
+
flag_config_scheduled_changes_patch_body = LaunchDarklyApi::FlagConfigScheduledChangesPatchBody.new # FlagConfigScheduledChangesPatchBody | Update scheduled changes on a feature flag.
|
|
1180
|
+
|
|
1181
|
+
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.
|
|
1182
|
+
|
|
1183
|
+
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
begin
|
|
1187
|
+
#Updates an existing scheduled-change on a feature flag in an environment.
|
|
1188
|
+
result = api_instance.patch_flag_config_scheduled_change(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id)
|
|
1189
|
+
p result
|
|
1190
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
1191
|
+
puts "Exception when calling FeatureFlagsApi->patch_flag_config_scheduled_change: #{e}"
|
|
1192
|
+
end
|
|
1193
|
+
```
|
|
1194
|
+
|
|
1195
|
+
### Parameters
|
|
1196
|
+
|
|
1197
|
+
Name | Type | Description | Notes
|
|
1198
|
+
------------- | ------------- | ------------- | -------------
|
|
1199
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1200
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
1201
|
+
**flag_config_scheduled_changes_patch_body** | [**FlagConfigScheduledChangesPatchBody**](FlagConfigScheduledChangesPatchBody.md)| Update scheduled changes on a feature flag. |
|
|
1202
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
1203
|
+
**scheduled_change_id** | **String**| The id of the scheduled change |
|
|
1204
|
+
|
|
1205
|
+
### Return type
|
|
1206
|
+
|
|
1207
|
+
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
|
1208
|
+
|
|
1209
|
+
### Authorization
|
|
1210
|
+
|
|
1211
|
+
[Token](../README.md#Token)
|
|
1212
|
+
|
|
1213
|
+
### HTTP request headers
|
|
1214
|
+
|
|
1215
|
+
- **Content-Type**: application/json
|
|
1216
|
+
- **Accept**: application/json
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
# **post_apply_approval_request**
|
|
1221
|
+
> ApprovalRequests post_apply_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body)
|
|
797
1222
|
|
|
798
|
-
Apply approval request for a feature flag
|
|
1223
|
+
Apply approval request for a feature flag config
|
|
799
1224
|
|
|
800
1225
|
### Example
|
|
801
1226
|
```ruby
|
|
@@ -817,17 +1242,17 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
|
817
1242
|
|
|
818
1243
|
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.
|
|
819
1244
|
|
|
820
|
-
|
|
1245
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
821
1246
|
|
|
822
|
-
|
|
1247
|
+
approval_request_apply_config_body = LaunchDarklyApi::ApprovalRequestApplyConfigBody.new # ApprovalRequestApplyConfigBody | Apply an approval request
|
|
823
1248
|
|
|
824
1249
|
|
|
825
1250
|
begin
|
|
826
|
-
#Apply approval request for a feature flag
|
|
827
|
-
result = api_instance.
|
|
1251
|
+
#Apply approval request for a feature flag config
|
|
1252
|
+
result = api_instance.post_apply_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body)
|
|
828
1253
|
p result
|
|
829
1254
|
rescue LaunchDarklyApi::ApiError => e
|
|
830
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
1255
|
+
puts "Exception when calling FeatureFlagsApi->post_apply_approval_request: #{e}"
|
|
831
1256
|
end
|
|
832
1257
|
```
|
|
833
1258
|
|
|
@@ -838,12 +1263,77 @@ Name | Type | Description | Notes
|
|
|
838
1263
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
839
1264
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
840
1265
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
841
|
-
**
|
|
842
|
-
**
|
|
1266
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
1267
|
+
**approval_request_apply_config_body** | [**ApprovalRequestApplyConfigBody**](ApprovalRequestApplyConfigBody.md)| Apply an approval request |
|
|
843
1268
|
|
|
844
1269
|
### Return type
|
|
845
1270
|
|
|
846
|
-
[**
|
|
1271
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
|
1272
|
+
|
|
1273
|
+
### Authorization
|
|
1274
|
+
|
|
1275
|
+
[Token](../README.md#Token)
|
|
1276
|
+
|
|
1277
|
+
### HTTP request headers
|
|
1278
|
+
|
|
1279
|
+
- **Content-Type**: application/json
|
|
1280
|
+
- **Accept**: application/json
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
# **post_approval_request**
|
|
1285
|
+
> ApprovalRequest post_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, , opts)
|
|
1286
|
+
|
|
1287
|
+
Create an approval request for a feature flag config
|
|
1288
|
+
|
|
1289
|
+
### Example
|
|
1290
|
+
```ruby
|
|
1291
|
+
# load the gem
|
|
1292
|
+
require 'launchdarkly_api'
|
|
1293
|
+
# setup authorization
|
|
1294
|
+
LaunchDarklyApi.configure do |config|
|
|
1295
|
+
# Configure API key authorization: Token
|
|
1296
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1297
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1298
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1299
|
+
end
|
|
1300
|
+
|
|
1301
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
1302
|
+
|
|
1303
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
1304
|
+
|
|
1305
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
1306
|
+
|
|
1307
|
+
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.
|
|
1308
|
+
|
|
1309
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
1310
|
+
|
|
1311
|
+
opts = {
|
|
1312
|
+
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
|
1313
|
+
}
|
|
1314
|
+
|
|
1315
|
+
begin
|
|
1316
|
+
#Create an approval request for a feature flag config
|
|
1317
|
+
result = api_instance.post_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, , opts)
|
|
1318
|
+
p result
|
|
1319
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
1320
|
+
puts "Exception when calling FeatureFlagsApi->post_approval_request: #{e}"
|
|
1321
|
+
end
|
|
1322
|
+
```
|
|
1323
|
+
|
|
1324
|
+
### Parameters
|
|
1325
|
+
|
|
1326
|
+
Name | Type | Description | Notes
|
|
1327
|
+
------------- | ------------- | ------------- | -------------
|
|
1328
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1329
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
1330
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
1331
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
1332
|
+
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
|
1333
|
+
|
|
1334
|
+
### Return type
|
|
1335
|
+
|
|
1336
|
+
[**ApprovalRequest**](ApprovalRequest.md)
|
|
847
1337
|
|
|
848
1338
|
### Authorization
|
|
849
1339
|
|
|
@@ -915,10 +1405,10 @@ Name | Type | Description | Notes
|
|
|
915
1405
|
|
|
916
1406
|
|
|
917
1407
|
|
|
918
|
-
# **
|
|
919
|
-
>
|
|
1408
|
+
# **post_flag_config_scheduled_changes**
|
|
1409
|
+
> FeatureFlagScheduledChange post_flag_config_scheduled_changes(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, )
|
|
920
1410
|
|
|
921
|
-
|
|
1411
|
+
Creates a new scheduled change for a feature flag.
|
|
922
1412
|
|
|
923
1413
|
### Example
|
|
924
1414
|
```ruby
|
|
@@ -936,22 +1426,19 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
|
936
1426
|
|
|
937
1427
|
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
938
1428
|
|
|
1429
|
+
flag_config_scheduled_changes_post_body = LaunchDarklyApi::FlagConfigScheduledChangesPostBody.new # FlagConfigScheduledChangesPostBody | Create scheduled changes on a feature flag.
|
|
1430
|
+
|
|
939
1431
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
940
1432
|
|
|
941
1433
|
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.
|
|
942
1434
|
|
|
943
|
-
feature_flag_approval_request_id = 'feature_flag_approval_request_id_example' # String | The feature flag approval request ID
|
|
944
|
-
|
|
945
|
-
opts = {
|
|
946
|
-
feature_flag_approval_request_config_body: LaunchDarklyApi::FeatureFlagApprovalRequestConfigBody.new # FeatureFlagApprovalRequestConfigBody | Create a new feature flag approval request
|
|
947
|
-
}
|
|
948
1435
|
|
|
949
1436
|
begin
|
|
950
|
-
#
|
|
951
|
-
result = api_instance.
|
|
1437
|
+
#Creates a new scheduled change for a feature flag.
|
|
1438
|
+
result = api_instance.post_flag_config_scheduled_changes(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, )
|
|
952
1439
|
p result
|
|
953
1440
|
rescue LaunchDarklyApi::ApiError => e
|
|
954
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
1441
|
+
puts "Exception when calling FeatureFlagsApi->post_flag_config_scheduled_changes: #{e}"
|
|
955
1442
|
end
|
|
956
1443
|
```
|
|
957
1444
|
|
|
@@ -960,14 +1447,13 @@ end
|
|
|
960
1447
|
Name | Type | Description | Notes
|
|
961
1448
|
------------- | ------------- | ------------- | -------------
|
|
962
1449
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1450
|
+
**flag_config_scheduled_changes_post_body** | [**FlagConfigScheduledChangesPostBody**](FlagConfigScheduledChangesPostBody.md)| Create scheduled changes on a feature flag. |
|
|
963
1451
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
964
1452
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
965
|
-
**feature_flag_approval_request_id** | **String**| The feature flag approval request ID |
|
|
966
|
-
**feature_flag_approval_request_config_body** | [**FeatureFlagApprovalRequestConfigBody**](FeatureFlagApprovalRequestConfigBody.md)| Create a new feature flag approval request | [optional]
|
|
967
1453
|
|
|
968
1454
|
### Return type
|
|
969
1455
|
|
|
970
|
-
[**
|
|
1456
|
+
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
|
971
1457
|
|
|
972
1458
|
### Authorization
|
|
973
1459
|
|
|
@@ -980,10 +1466,10 @@ Name | Type | Description | Notes
|
|
|
980
1466
|
|
|
981
1467
|
|
|
982
1468
|
|
|
983
|
-
# **
|
|
984
|
-
>
|
|
1469
|
+
# **post_review_approval_request**
|
|
1470
|
+
> ApprovalRequests post_review_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body)
|
|
985
1471
|
|
|
986
|
-
Review approval request for a feature flag
|
|
1472
|
+
Review approval request for a feature flag config
|
|
987
1473
|
|
|
988
1474
|
### Example
|
|
989
1475
|
```ruby
|
|
@@ -1005,17 +1491,17 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
|
1005
1491
|
|
|
1006
1492
|
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.
|
|
1007
1493
|
|
|
1008
|
-
|
|
1494
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
1009
1495
|
|
|
1010
|
-
|
|
1496
|
+
approval_request_review_config_body = LaunchDarklyApi::ApprovalRequestReviewConfigBody.new # ApprovalRequestReviewConfigBody | Review an approval request
|
|
1011
1497
|
|
|
1012
1498
|
|
|
1013
1499
|
begin
|
|
1014
|
-
#Review approval request for a feature flag
|
|
1015
|
-
result = api_instance.
|
|
1500
|
+
#Review approval request for a feature flag config
|
|
1501
|
+
result = api_instance.post_review_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body)
|
|
1016
1502
|
p result
|
|
1017
1503
|
rescue LaunchDarklyApi::ApiError => e
|
|
1018
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
1504
|
+
puts "Exception when calling FeatureFlagsApi->post_review_approval_request: #{e}"
|
|
1019
1505
|
end
|
|
1020
1506
|
```
|
|
1021
1507
|
|
|
@@ -1026,12 +1512,12 @@ Name | Type | Description | Notes
|
|
|
1026
1512
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1027
1513
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
1028
1514
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
1029
|
-
**
|
|
1030
|
-
**
|
|
1515
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
1516
|
+
**approval_request_review_config_body** | [**ApprovalRequestReviewConfigBody**](ApprovalRequestReviewConfigBody.md)| Review an approval request |
|
|
1031
1517
|
|
|
1032
1518
|
### Return type
|
|
1033
1519
|
|
|
1034
|
-
[**
|
|
1520
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
|
1035
1521
|
|
|
1036
1522
|
### Authorization
|
|
1037
1523
|
|