launchdarkly_api 5.4.0 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/README.md +841 -263
- data/Rakefile +2 -0
- data/docs/AccessDeniedReasonRep.md +28 -0
- data/docs/AccessDeniedRep.md +20 -0
- data/docs/AccessRep.md +18 -0
- data/docs/AccessTokenPost.md +30 -0
- data/docs/AccessTokensApi.md +239 -126
- data/docs/AccountMembersApi.md +450 -0
- data/docs/AccountUsageBetaApi.md +647 -0
- data/docs/ActionInputRep.md +18 -0
- data/docs/ActionOutputRep.md +20 -0
- data/docs/ApprovalConditionInputRep.md +20 -0
- data/docs/ApprovalConditionOutputRep.md +26 -0
- data/docs/ApprovalSettings.md +32 -0
- data/docs/ApprovalsApi.md +554 -0
- data/docs/AuditLogApi.md +93 -55
- data/docs/AuditLogEntryListingRep.md +52 -0
- data/docs/AuditLogEntryListingRepCollection.md +20 -0
- data/docs/AuditLogEntryRep.md +64 -0
- data/docs/AuthorizedAppDataRep.md +26 -0
- data/docs/BigSegmentTarget.md +22 -0
- data/docs/BranchCollectionRep.md +20 -0
- data/docs/BranchRep.md +28 -0
- data/docs/Clause.md +21 -7
- data/docs/ClientSideAvailability.md +15 -4
- data/docs/ClientSideAvailabilityPost.md +20 -0
- data/docs/CodeReferencesApi.md +980 -0
- data/docs/ConditionBaseOutputRep.md +22 -0
- data/docs/ConditionInputRep.md +26 -0
- data/docs/ConditionOutputRep.md +34 -0
- data/docs/ConfidenceIntervalRep.md +20 -0
- data/docs/Conflict.md +20 -0
- data/docs/ConflictOutputRep.md +20 -0
- data/docs/CopiedFromEnv.md +20 -0
- data/docs/CreateCopyFlagConfigApprovalRequestRequest.md +28 -0
- data/docs/CreateFlagConfigApprovalRequestRequest.md +30 -0
- data/docs/CustomProperty.md +15 -4
- data/docs/CustomRole.md +27 -8
- data/docs/CustomRolePost.md +26 -0
- data/docs/CustomRolePostData.md +26 -0
- data/docs/CustomRoles.md +15 -4
- data/docs/CustomRolesApi.md +196 -100
- data/docs/CustomRolesRep.md +24 -0
- data/docs/CustomWorkflowInputRep.md +24 -0
- data/docs/CustomWorkflowMeta.md +20 -0
- data/docs/CustomWorkflowOutputRep.md +38 -0
- data/docs/CustomWorkflowStageMeta.md +20 -0
- data/docs/CustomWorkflowsListingOutputRep.md +18 -0
- data/docs/DataExportDestinationsApi.md +205 -117
- data/docs/DefaultClientSideAvailabilityPost.md +20 -0
- data/docs/Defaults.md +15 -4
- data/docs/DependentFlag.md +19 -6
- data/docs/DependentFlagEnvironment.md +19 -6
- data/docs/DependentFlagsByEnvironment.md +17 -5
- data/docs/DerivedAttribute.md +20 -0
- data/docs/Destination.md +27 -9
- data/docs/DestinationPost.md +24 -0
- data/docs/Destinations.md +15 -4
- data/docs/Environment.md +39 -16
- data/docs/EnvironmentPost.md +29 -11
- data/docs/EnvironmentsApi.md +246 -144
- data/docs/ExecutionOutputRep.md +18 -0
- data/docs/ExpandedTeamRep.md +44 -0
- data/docs/ExperimentAllocationRep.md +20 -0
- data/docs/ExperimentEnabledPeriodRep.md +20 -0
- data/docs/ExperimentEnvironmentSettingRep.md +22 -0
- data/docs/ExperimentInfoRep.md +20 -0
- data/docs/ExperimentMetadataRep.md +18 -0
- data/docs/ExperimentRep.md +24 -0
- data/docs/ExperimentResultsRep.md +30 -0
- data/docs/ExperimentStatsRep.md +24 -0
- data/docs/ExperimentTimeSeriesSlice.md +20 -0
- data/docs/ExperimentTimeSeriesVariationSlice.md +32 -0
- data/docs/ExperimentTotalsRep.md +32 -0
- data/docs/ExperimentsBetaApi.md +168 -0
- data/docs/ExpiringUserTargetError.md +20 -0
- data/docs/ExpiringUserTargetGetResponse.md +20 -0
- data/docs/ExpiringUserTargetItem.md +30 -0
- data/docs/ExpiringUserTargetPatchResponse.md +28 -0
- data/docs/Extinction.md +26 -0
- data/docs/ExtinctionCollectionRep.md +20 -0
- data/docs/FeatureFlag.md +55 -22
- data/docs/FeatureFlagBody.md +33 -11
- data/docs/FeatureFlagConfig.md +47 -17
- data/docs/FeatureFlagScheduledChange.md +27 -6
- data/docs/FeatureFlagScheduledChanges.md +15 -4
- data/docs/FeatureFlagStatus.md +17 -6
- data/docs/FeatureFlagStatusAcrossEnvironments.md +17 -5
- data/docs/FeatureFlagStatuses.md +15 -4
- data/docs/FeatureFlags.md +17 -5
- data/docs/FeatureFlagsApi.md +449 -1184
- data/docs/FeatureFlagsBetaApi.md +157 -0
- data/docs/FlagConfigApprovalRequestResponse.md +56 -0
- data/docs/FlagConfigApprovalRequestsResponse.md +20 -0
- data/docs/FlagCopyConfigEnvironment.md +20 -0
- data/docs/FlagCopyConfigPost.md +26 -0
- data/docs/FlagGlobalAttributesRep.md +58 -0
- data/docs/FlagListingRep.md +24 -0
- data/docs/FlagScheduledChangesInput.md +20 -0
- data/docs/FlagStatusRep.md +24 -0
- data/docs/FlagSummary.md +18 -0
- data/docs/FlagTriggerInput.md +20 -0
- data/docs/FlagTriggersApi.md +396 -0
- data/docs/ForbiddenErrorRep.md +20 -0
- data/docs/HunkRep.md +26 -0
- data/docs/Integration.md +35 -4
- data/docs/IntegrationAuditLogSubscriptionsApi.md +376 -0
- data/docs/IntegrationMetadata.md +24 -0
- data/docs/IntegrationStatus.md +20 -0
- data/docs/IntegrationStatusRep.md +22 -0
- data/docs/IntegrationSubscriptionStatusRep.md +26 -0
- data/docs/Integrations.md +17 -4
- data/docs/InvalidRequestErrorRep.md +20 -0
- data/docs/IpList.md +20 -0
- data/docs/LastSeenMetadata.md +18 -0
- data/docs/Link.md +15 -4
- data/docs/Member.md +47 -14
- data/docs/MemberDataRep.md +26 -0
- data/docs/MemberImportItemRep.md +22 -0
- data/docs/MemberPermissionGrantSummaryRep.md +22 -0
- data/docs/MemberSummaryRep.md +28 -0
- data/docs/MemberTeamSummaryRep.md +22 -0
- data/docs/MemberTeamsFormPost.md +18 -0
- data/docs/Members.md +17 -5
- data/docs/MethodNotAllowedErrorRep.md +20 -0
- data/docs/MetricCollectionRep.md +20 -0
- data/docs/MetricListingRep.md +52 -0
- data/docs/MetricPost.md +40 -0
- data/docs/MetricRep.md +62 -0
- data/docs/MetricSeen.md +20 -0
- data/docs/MetricsApi.md +376 -0
- data/docs/Modification.md +18 -0
- data/docs/MultiEnvironmentDependentFlag.md +17 -7
- data/docs/MultiEnvironmentDependentFlags.md +17 -5
- data/docs/NewMemberForm.md +28 -0
- data/docs/NotFoundErrorRep.md +20 -0
- data/docs/OtherApi.md +282 -0
- data/docs/ParentResourceRep.md +22 -0
- data/docs/PatchFailedErrorRep.md +20 -0
- data/docs/PatchOperation.md +17 -5
- data/docs/PatchSegmentInstruction.md +26 -0
- data/docs/PatchSegmentRequest.md +20 -0
- data/docs/PatchWithComment.md +20 -0
- data/docs/PermissionGrantInput.md +22 -0
- data/docs/PermissionGrantRep.md +24 -0
- data/docs/PostApprovalRequestApplyRequest.md +18 -0
- data/docs/PostApprovalRequestReviewRequest.md +20 -0
- data/docs/PostFlagScheduledChangesInput.md +22 -0
- data/docs/Prerequisite.md +15 -4
- data/docs/Project.md +27 -10
- data/docs/ProjectListingRep.md +30 -0
- data/docs/ProjectPost.md +28 -0
- data/docs/Projects.md +15 -4
- data/docs/ProjectsApi.md +196 -100
- data/docs/PubNubDetailRep.md +20 -0
- data/docs/PutBranch.md +28 -0
- data/docs/RateLimitedErrorRep.md +20 -0
- data/docs/RecentTriggerBody.md +20 -0
- data/docs/ReferenceRep.md +22 -0
- data/docs/RelayAutoConfigCollectionRep.md +18 -0
- data/docs/RelayAutoConfigPost.md +20 -0
- data/docs/RelayAutoConfigRep.md +34 -0
- data/docs/RelayProxyConfigurationsApi.md +244 -129
- data/docs/RepositoryCollectionRep.md +20 -0
- data/docs/RepositoryPost.md +28 -0
- data/docs/RepositoryRep.md +38 -0
- data/docs/ResourceAccess.md +20 -0
- data/docs/ResourceIDResponse.md +26 -0
- data/docs/ReviewOutputRep.md +26 -0
- data/docs/ReviewResponse.md +26 -0
- data/docs/Rollout.md +19 -4
- data/docs/Rule.md +25 -8
- data/docs/ScheduleConditionInputRep.md +20 -0
- data/docs/ScheduleConditionOutputRep.md +18 -0
- data/docs/ScheduledChangesApi.md +404 -0
- data/docs/SdkListRep.md +20 -0
- data/docs/SdkVersionListRep.md +20 -0
- data/docs/SdkVersionRep.md +20 -0
- data/docs/SegmentBody.md +26 -0
- data/docs/SegmentMetadata.md +28 -0
- data/docs/SegmentUserList.md +20 -0
- data/docs/SegmentUserState.md +20 -0
- data/docs/SegmentsApi.md +695 -0
- data/docs/SeriesListRep.md +22 -0
- data/docs/SourceFlag.md +20 -0
- data/docs/StageInputRep.md +22 -0
- data/docs/StageOutputRep.md +26 -0
- data/docs/Statement.md +21 -7
- data/docs/StatementPost.md +26 -0
- data/docs/StatementPostData.md +26 -0
- data/docs/StatementRep.md +26 -0
- data/docs/StatisticCollectionRep.md +20 -0
- data/docs/StatisticRep.md +30 -0
- data/docs/StatisticsRoot.md +20 -0
- data/docs/StatusConflictErrorRep.md +20 -0
- data/docs/SubjectDataRep.md +22 -0
- data/docs/SubscriptionPost.md +30 -0
- data/docs/Target.md +15 -4
- data/docs/TargetResourceRep.md +22 -0
- data/docs/TeamCollectionRep.md +22 -0
- data/docs/TeamImportsRep.md +18 -0
- data/docs/TeamPatchInput.md +20 -0
- data/docs/TeamPostInput.md +28 -0
- data/docs/TeamRep.md +40 -0
- data/docs/TeamsBetaApi.md +450 -0
- data/docs/TitleRep.md +32 -0
- data/docs/Token.md +43 -17
- data/docs/TokenDataRep.md +26 -0
- data/docs/Tokens.md +15 -4
- data/docs/TriggerPost.md +22 -0
- data/docs/TriggerWorkflowCollectionRep.md +20 -0
- data/docs/TriggerWorkflowRep.md +42 -0
- data/docs/UnauthorizedErrorRep.md +20 -0
- data/docs/UrlPost.md +24 -0
- data/docs/User.md +37 -13
- data/docs/UserAttributeNamesRep.md +22 -0
- data/docs/UserFlagSetting.md +17 -5
- data/docs/UserFlagSettings.md +15 -4
- data/docs/UserRecord.md +25 -7
- data/docs/UserRecordRep.md +26 -0
- data/docs/UserSegment.md +49 -14
- data/docs/UserSegmentRule.md +19 -5
- data/docs/UserSegments.md +15 -4
- data/docs/UserSettingsApi.md +217 -137
- data/docs/Users.md +17 -5
- data/docs/UsersApi.md +187 -114
- data/docs/UsersBetaApi.md +81 -0
- data/docs/ValuePut.md +20 -0
- data/docs/Variation.md +19 -6
- data/docs/VariationOrRolloutRep.md +20 -0
- data/docs/VariationSummary.md +30 -0
- data/docs/VersionsRep.md +24 -0
- data/docs/Webhook.md +29 -10
- data/docs/WebhookPost.md +30 -0
- data/docs/Webhooks.md +15 -4
- data/docs/WebhooksApi.md +199 -103
- data/docs/WeightedVariation.md +17 -4
- data/docs/WorkflowsBetaApi.md +316 -0
- data/git_push.sh +13 -11
- data/launchdarkly_api.gemspec +8 -16
- data/lib/launchdarkly_api/api/access_tokens_api.rb +198 -122
- data/lib/launchdarkly_api/api/account_members_api.rb +433 -0
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +598 -0
- data/lib/launchdarkly_api/api/approvals_api.rb +615 -0
- data/lib/launchdarkly_api/api/audit_log_api.rb +72 -51
- data/lib/launchdarkly_api/api/code_references_api.rb +929 -0
- data/lib/launchdarkly_api/api/custom_roles_api.rb +170 -105
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +210 -145
- data/lib/launchdarkly_api/api/environments_api.rb +205 -132
- data/lib/launchdarkly_api/api/experiments_beta_api.rb +190 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +501 -1393
- data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -0
- data/lib/launchdarkly_api/api/flag_triggers_api.rb +437 -0
- data/lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb +377 -0
- data/lib/launchdarkly_api/api/metrics_api.rb +377 -0
- data/lib/launchdarkly_api/api/other_api.rb +248 -0
- data/lib/launchdarkly_api/api/projects_api.rb +155 -90
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +203 -127
- data/lib/launchdarkly_api/api/scheduled_changes_api.rb +443 -0
- data/lib/launchdarkly_api/api/segments_api.rb +735 -0
- data/lib/launchdarkly_api/api/teams_beta_api.rb +427 -0
- data/lib/launchdarkly_api/api/user_settings_api.rb +245 -180
- data/lib/launchdarkly_api/api/users_api.rb +185 -135
- data/lib/launchdarkly_api/api/users_beta_api.rb +91 -0
- data/lib/launchdarkly_api/api/webhooks_api.rb +178 -113
- data/lib/launchdarkly_api/api/workflows_beta_api.rb +345 -0
- data/lib/launchdarkly_api/api_client.rb +90 -91
- data/lib/launchdarkly_api/api_error.rb +23 -4
- data/lib/launchdarkly_api/configuration.rb +85 -16
- data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +280 -0
- data/lib/launchdarkly_api/models/access_denied_rep.rb +237 -0
- data/lib/launchdarkly_api/models/access_rep.rb +225 -0
- data/lib/launchdarkly_api/models/access_token_post.rb +317 -0
- data/lib/launchdarkly_api/models/action_input_rep.rb +219 -0
- data/lib/launchdarkly_api/models/action_output_rep.rb +239 -0
- data/lib/launchdarkly_api/models/approval_condition_input_rep.rb +229 -0
- data/lib/launchdarkly_api/models/approval_condition_output_rep.rb +278 -0
- data/lib/launchdarkly_api/models/approval_settings.rb +331 -0
- data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +420 -0
- data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +241 -0
- data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +481 -0
- data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/big_segment_target.rb +254 -0
- data/lib/launchdarkly_api/models/branch_collection_rep.rb +242 -0
- data/lib/launchdarkly_api/models/branch_rep.rb +291 -0
- data/lib/launchdarkly_api/models/clause.rb +78 -24
- data/lib/launchdarkly_api/models/client_side_availability.rb +65 -33
- data/lib/launchdarkly_api/models/client_side_availability_post.rb +237 -0
- data/lib/launchdarkly_api/models/condition_base_output_rep.rb +246 -0
- data/lib/launchdarkly_api/models/condition_input_rep.rb +256 -0
- data/lib/launchdarkly_api/models/condition_output_rep.rb +324 -0
- data/lib/launchdarkly_api/models/confidence_interval_rep.rb +227 -0
- data/lib/launchdarkly_api/models/conflict.rb +230 -0
- data/lib/launchdarkly_api/models/conflict_output_rep.rb +237 -0
- data/lib/launchdarkly_api/models/copied_from_env.rb +233 -0
- data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +286 -0
- data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +297 -0
- data/lib/launchdarkly_api/models/custom_property.rb +59 -23
- data/lib/launchdarkly_api/models/custom_role.rb +125 -49
- data/lib/launchdarkly_api/models/custom_role_post.rb +274 -0
- data/lib/launchdarkly_api/models/custom_role_post_data.rb +274 -0
- data/lib/launchdarkly_api/models/custom_roles.rb +58 -22
- data/lib/launchdarkly_api/models/custom_roles_rep.rb +247 -0
- data/lib/launchdarkly_api/models/custom_workflow_input_rep.rb +252 -0
- data/lib/launchdarkly_api/models/custom_workflow_meta.rb +227 -0
- data/lib/launchdarkly_api/models/custom_workflow_output_rep.rb +354 -0
- data/lib/launchdarkly_api/models/custom_workflow_stage_meta.rb +227 -0
- data/lib/launchdarkly_api/models/custom_workflows_listing_output_rep.rb +225 -0
- data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +237 -0
- data/lib/launchdarkly_api/models/defaults.rb +56 -25
- data/lib/launchdarkly_api/models/dependent_flag.rb +76 -25
- data/lib/launchdarkly_api/models/dependent_flag_environment.rb +76 -25
- data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +75 -24
- data/lib/launchdarkly_api/models/derived_attribute.rb +228 -0
- data/lib/launchdarkly_api/models/destination.rb +88 -47
- data/lib/launchdarkly_api/models/destination_post.rb +281 -0
- data/lib/launchdarkly_api/models/destinations.rb +58 -22
- data/lib/launchdarkly_api/models/environment.rb +167 -68
- data/lib/launchdarkly_api/models/environment_post.rb +90 -56
- data/lib/launchdarkly_api/models/execution_output_rep.rb +223 -0
- data/lib/launchdarkly_api/models/expanded_team_rep.rb +349 -0
- data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +237 -0
- data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +227 -0
- data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +238 -0
- data/lib/launchdarkly_api/models/experiment_info_rep.rb +239 -0
- data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +219 -0
- data/lib/launchdarkly_api/models/experiment_rep.rb +249 -0
- data/lib/launchdarkly_api/models/experiment_results_rep.rb +280 -0
- data/lib/launchdarkly_api/models/experiment_stats_rep.rb +245 -0
- data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +229 -0
- data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +281 -0
- data/lib/launchdarkly_api/models/experiment_totals_rep.rb +281 -0
- data/lib/launchdarkly_api/models/expiring_user_target_error.rb +237 -0
- data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +236 -0
- data/lib/launchdarkly_api/models/expiring_user_target_item.rb +300 -0
- data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +274 -0
- data/lib/launchdarkly_api/models/extinction.rb +283 -0
- data/lib/launchdarkly_api/models/extinction_collection_rep.rb +242 -0
- data/lib/launchdarkly_api/models/feature_flag.rb +276 -123
- data/lib/launchdarkly_api/models/feature_flag_body.rb +104 -54
- data/lib/launchdarkly_api/models/feature_flag_config.rb +184 -55
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +142 -38
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +73 -32
- data/lib/launchdarkly_api/models/feature_flag_status.rb +70 -71
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +71 -33
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +64 -23
- data/lib/launchdarkly_api/models/feature_flags.rb +78 -32
- data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +457 -0
- data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +242 -0
- data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +232 -0
- data/lib/launchdarkly_api/models/flag_copy_config_post.rb +290 -0
- data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +514 -0
- data/lib/launchdarkly_api/models/flag_listing_rep.rb +257 -0
- data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +234 -0
- data/lib/launchdarkly_api/models/flag_status_rep.rb +256 -0
- data/lib/launchdarkly_api/models/flag_summary.rb +223 -0
- data/lib/launchdarkly_api/models/flag_trigger_input.rb +230 -0
- data/lib/launchdarkly_api/models/forbidden_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/hunk_rep.rb +266 -0
- data/lib/launchdarkly_api/models/integration.rb +159 -29
- data/lib/launchdarkly_api/models/integration_metadata.rb +265 -0
- data/lib/launchdarkly_api/models/integration_status.rb +237 -0
- data/lib/launchdarkly_api/models/integration_status_rep.rb +236 -0
- data/lib/launchdarkly_api/models/integration_subscription_status_rep.rb +256 -0
- data/lib/launchdarkly_api/models/integrations.rb +71 -27
- data/lib/launchdarkly_api/models/invalid_request_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/ip_list.rb +241 -0
- data/lib/launchdarkly_api/models/last_seen_metadata.rb +219 -0
- data/lib/launchdarkly_api/models/link.rb +54 -20
- data/lib/launchdarkly_api/models/member.rb +227 -67
- data/lib/launchdarkly_api/models/member_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/member_import_item_rep.rb +246 -0
- data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +253 -0
- data/lib/launchdarkly_api/models/member_summary_rep.rb +285 -0
- data/lib/launchdarkly_api/models/member_team_summary_rep.rb +253 -0
- data/lib/launchdarkly_api/models/member_teams_form_post.rb +226 -0
- data/lib/launchdarkly_api/models/members.rb +78 -32
- data/lib/launchdarkly_api/models/method_not_allowed_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/metric_collection_rep.rb +231 -0
- data/lib/launchdarkly_api/models/metric_listing_rep.rb +456 -0
- data/lib/launchdarkly_api/models/metric_post.rb +380 -0
- data/lib/launchdarkly_api/models/metric_rep.rb +505 -0
- data/lib/launchdarkly_api/models/metric_seen.rb +227 -0
- data/lib/launchdarkly_api/models/modification.rb +218 -0
- data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +69 -43
- data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +75 -24
- data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
- data/lib/launchdarkly_api/models/not_found_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/parent_resource_rep.rb +239 -0
- data/lib/launchdarkly_api/models/patch_failed_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/patch_operation.rb +59 -26
- data/lib/launchdarkly_api/models/patch_segment_instruction.rb +273 -0
- data/lib/launchdarkly_api/models/patch_segment_request.rb +236 -0
- data/lib/launchdarkly_api/models/patch_with_comment.rb +234 -0
- data/lib/launchdarkly_api/models/permission_grant_input.rb +240 -0
- data/lib/launchdarkly_api/models/permission_grant_rep.rb +249 -0
- data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +218 -0
- data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +227 -0
- data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +248 -0
- data/lib/launchdarkly_api/models/prerequisite.rb +64 -20
- data/lib/launchdarkly_api/models/project.rb +120 -50
- data/lib/launchdarkly_api/models/project_listing_rep.rb +306 -0
- data/lib/launchdarkly_api/models/project_post.rb +281 -0
- data/lib/launchdarkly_api/models/projects.rb +70 -22
- data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +227 -0
- data/lib/launchdarkly_api/models/put_branch.rb +284 -0
- data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/recent_trigger_body.rb +229 -0
- data/lib/launchdarkly_api/models/reference_rep.rb +250 -0
- data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +225 -0
- data/lib/launchdarkly_api/models/relay_auto_config_post.rb +240 -0
- data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +327 -0
- data/lib/launchdarkly_api/models/repository_collection_rep.rb +242 -0
- data/lib/launchdarkly_api/models/repository_post.rb +306 -0
- data/lib/launchdarkly_api/models/repository_rep.rb +385 -0
- data/lib/launchdarkly_api/models/resource_access.rb +228 -0
- data/lib/launchdarkly_api/models/resource_id_response.rb +254 -0
- data/lib/launchdarkly_api/models/review_output_rep.rb +264 -0
- data/lib/launchdarkly_api/models/review_response.rb +302 -0
- data/lib/launchdarkly_api/models/rollout.rb +89 -32
- data/lib/launchdarkly_api/models/rule.rb +89 -36
- data/lib/launchdarkly_api/models/schedule_condition_input_rep.rb +227 -0
- data/lib/launchdarkly_api/models/schedule_condition_output_rep.rb +218 -0
- data/lib/launchdarkly_api/models/sdk_list_rep.rb +241 -0
- data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +241 -0
- data/lib/launchdarkly_api/models/sdk_version_rep.rb +237 -0
- data/lib/launchdarkly_api/models/segment_body.rb +270 -0
- data/lib/launchdarkly_api/models/segment_metadata.rb +263 -0
- data/lib/launchdarkly_api/models/segment_user_list.rb +231 -0
- data/lib/launchdarkly_api/models/segment_user_state.rb +227 -0
- data/lib/launchdarkly_api/models/series_list_rep.rb +257 -0
- data/lib/launchdarkly_api/models/source_flag.rb +233 -0
- data/lib/launchdarkly_api/models/stage_input_rep.rb +238 -0
- data/lib/launchdarkly_api/models/stage_output_rep.rb +276 -0
- data/lib/launchdarkly_api/models/statement.rb +68 -61
- data/lib/launchdarkly_api/models/statement_post.rb +281 -0
- data/lib/launchdarkly_api/models/statement_post_data.rb +281 -0
- data/lib/launchdarkly_api/models/statement_rep.rb +271 -0
- data/lib/launchdarkly_api/models/statistic_collection_rep.rb +241 -0
- data/lib/launchdarkly_api/models/statistic_rep.rb +309 -0
- data/lib/launchdarkly_api/models/statistics_root.rb +229 -0
- data/lib/launchdarkly_api/models/status_conflict_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/subject_data_rep.rb +238 -0
- data/lib/launchdarkly_api/models/subscription_post.rb +293 -0
- data/lib/launchdarkly_api/models/target.rb +64 -20
- data/lib/launchdarkly_api/models/target_resource_rep.rb +240 -0
- data/lib/launchdarkly_api/models/team_collection_rep.rb +240 -0
- data/lib/launchdarkly_api/models/team_imports_rep.rb +220 -0
- data/lib/launchdarkly_api/models/team_patch_input.rb +229 -0
- data/lib/launchdarkly_api/models/team_post_input.rb +285 -0
- data/lib/launchdarkly_api/models/team_rep.rb +327 -0
- data/lib/launchdarkly_api/models/title_rep.rb +281 -0
- data/lib/launchdarkly_api/models/token.rb +159 -93
- data/lib/launchdarkly_api/models/token_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/tokens.rb +68 -32
- data/lib/launchdarkly_api/models/trigger_post.rb +245 -0
- data/lib/launchdarkly_api/models/trigger_workflow_collection_rep.rb +231 -0
- data/lib/launchdarkly_api/models/trigger_workflow_rep.rb +332 -0
- data/lib/launchdarkly_api/models/unauthorized_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/url_post.rb +279 -0
- data/lib/launchdarkly_api/models/user.rb +95 -37
- data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +245 -0
- data/lib/launchdarkly_api/models/user_flag_setting.rb +68 -27
- data/lib/launchdarkly_api/models/user_flag_settings.rb +78 -32
- data/lib/launchdarkly_api/models/user_record.rb +89 -34
- data/lib/launchdarkly_api/models/user_record_rep.rb +255 -0
- data/lib/launchdarkly_api/models/user_segment.rb +195 -69
- data/lib/launchdarkly_api/models/user_segment_rule.rb +71 -23
- data/lib/launchdarkly_api/models/user_segments.rb +78 -32
- data/lib/launchdarkly_api/models/users.rb +71 -25
- data/lib/launchdarkly_api/models/value_put.rb +229 -0
- data/lib/launchdarkly_api/models/variation.rb +70 -38
- data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +227 -0
- data/lib/launchdarkly_api/models/variation_summary.rb +287 -0
- data/lib/launchdarkly_api/models/versions_rep.rb +262 -0
- data/lib/launchdarkly_api/models/webhook.rb +120 -55
- data/lib/launchdarkly_api/models/webhook_post.rb +297 -0
- data/lib/launchdarkly_api/models/webhooks.rb +68 -22
- data/lib/launchdarkly_api/models/weighted_variation.rb +77 -24
- data/lib/launchdarkly_api/version.rb +5 -5
- data/lib/launchdarkly_api.rb +178 -95
- data/spec/api/access_tokens_api_spec.rb +23 -17
- data/spec/api/account_members_api_spec.rb +112 -0
- data/spec/api/account_usage_beta_api_spec.rb +156 -0
- data/spec/api/approvals_api_spec.rb +141 -0
- data/spec/api/audit_log_api_spec.rb +19 -17
- data/spec/api/code_references_api_spec.rb +208 -0
- data/spec/api/custom_roles_api_spec.rb +22 -17
- data/spec/api/data_export_destinations_api_spec.rb +30 -25
- data/spec/api/environments_api_spec.rb +31 -26
- data/spec/api/experiments_beta_api_spec.rb +67 -0
- data/spec/api/feature_flags_api_spec.rb +69 -267
- data/spec/api/feature_flags_beta_api_spec.rb +62 -0
- data/spec/api/flag_triggers_api_spec.rb +110 -0
- data/spec/api/integration_audit_log_subscriptions_api_spec.rb +100 -0
- data/spec/api/metrics_api_spec.rb +100 -0
- data/spec/api/other_api_spec.rb +79 -0
- data/spec/api/projects_api_spec.rb +22 -17
- data/spec/api/relay_proxy_configurations_api_spec.rb +37 -31
- data/spec/api/scheduled_changes_api_spec.rb +112 -0
- data/spec/api/segments_api_spec.rb +164 -0
- data/spec/api/teams_beta_api_spec.rb +111 -0
- data/spec/api/user_settings_api_spec.rb +41 -36
- data/spec/api/users_api_spec.rb +34 -28
- data/spec/api/users_beta_api_spec.rb +48 -0
- data/spec/api/webhooks_api_spec.rb +27 -22
- data/spec/api/workflows_beta_api_spec.rb +94 -0
- data/spec/api_client_spec.rb +7 -24
- data/spec/configuration_spec.rb +7 -7
- data/spec/models/access_denied_reason_rep_spec.rb +64 -0
- data/spec/models/access_denied_rep_spec.rb +40 -0
- data/spec/models/access_rep_spec.rb +34 -0
- data/spec/models/access_token_post_spec.rb +74 -0
- data/spec/models/action_input_rep_spec.rb +34 -0
- data/spec/models/action_output_rep_spec.rb +40 -0
- data/spec/models/approval_condition_input_rep_spec.rb +40 -0
- data/spec/models/approval_condition_output_rep_spec.rb +58 -0
- data/spec/models/approval_settings_spec.rb +76 -0
- data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +40 -0
- data/spec/models/audit_log_entry_listing_rep_spec.rb +136 -0
- data/spec/models/audit_log_entry_rep_spec.rb +172 -0
- data/spec/models/authorized_app_data_rep_spec.rb +58 -0
- data/spec/models/big_segment_target_spec.rb +46 -0
- data/spec/models/branch_collection_rep_spec.rb +40 -0
- data/spec/models/branch_rep_spec.rb +64 -0
- data/spec/models/clause_spec.rb +8 -15
- data/spec/models/client_side_availability_post_spec.rb +40 -0
- data/spec/models/client_side_availability_spec.rb +10 -17
- data/spec/models/condition_base_output_rep_spec.rb +46 -0
- data/spec/models/condition_input_rep_spec.rb +58 -0
- data/spec/models/condition_output_rep_spec.rb +82 -0
- data/spec/models/confidence_interval_rep_spec.rb +40 -0
- data/spec/models/conflict_output_rep_spec.rb +40 -0
- data/spec/models/conflict_spec.rb +40 -0
- data/spec/models/copied_from_env_spec.rb +40 -0
- data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +64 -0
- data/spec/models/create_flag_config_approval_request_request_spec.rb +70 -0
- data/spec/models/custom_property_spec.rb +8 -15
- data/spec/models/custom_role_post_data_spec.rb +58 -0
- data/spec/models/custom_role_post_spec.rb +58 -0
- data/spec/models/custom_role_spec.rb +24 -19
- data/spec/models/custom_roles_rep_spec.rb +52 -0
- data/spec/models/custom_roles_spec.rb +8 -15
- data/spec/models/custom_workflow_input_rep_spec.rb +52 -0
- data/spec/models/custom_workflow_meta_spec.rb +40 -0
- data/spec/models/custom_workflow_output_rep_spec.rb +94 -0
- data/spec/models/custom_workflow_stage_meta_spec.rb +40 -0
- data/spec/models/custom_workflows_listing_output_rep_spec.rb +34 -0
- data/spec/models/default_client_side_availability_post_spec.rb +40 -0
- data/spec/models/defaults_spec.rb +8 -15
- data/spec/models/dependent_flag_environment_spec.rb +8 -15
- data/spec/models/dependent_flag_spec.rb +8 -15
- data/spec/models/dependent_flags_by_environment_spec.rb +8 -15
- data/spec/models/derived_attribute_spec.rb +40 -0
- data/spec/models/destination_post_spec.rb +56 -0
- data/spec/models/destination_spec.rb +19 -20
- data/spec/models/destinations_spec.rb +8 -15
- data/spec/models/environment_post_spec.rb +10 -17
- data/spec/models/environment_spec.rb +11 -18
- data/spec/models/execution_output_rep_spec.rb +34 -0
- data/spec/models/expanded_team_rep_spec.rb +112 -0
- data/spec/models/experiment_allocation_rep_spec.rb +40 -0
- data/spec/models/experiment_enabled_period_rep_spec.rb +40 -0
- data/spec/models/experiment_environment_setting_rep_spec.rb +46 -0
- data/spec/models/experiment_info_rep_spec.rb +40 -0
- data/spec/models/experiment_metadata_rep_spec.rb +34 -0
- data/spec/models/experiment_rep_spec.rb +52 -0
- data/spec/models/experiment_results_rep_spec.rb +70 -0
- data/spec/models/experiment_stats_rep_spec.rb +52 -0
- data/spec/models/experiment_time_series_slice_spec.rb +40 -0
- data/spec/models/experiment_time_series_variation_slice_spec.rb +76 -0
- data/spec/models/experiment_totals_rep_spec.rb +76 -0
- data/spec/models/expiring_user_target_error_spec.rb +40 -0
- data/spec/models/expiring_user_target_get_response_spec.rb +40 -0
- data/spec/models/expiring_user_target_item_spec.rb +70 -0
- data/spec/models/expiring_user_target_patch_response_spec.rb +64 -0
- data/spec/models/extinction_collection_rep_spec.rb +40 -0
- data/spec/models/extinction_spec.rb +58 -0
- data/spec/models/feature_flag_body_spec.rb +24 -19
- data/spec/models/feature_flag_config_spec.rb +28 -17
- data/spec/models/feature_flag_scheduled_change_spec.rb +34 -17
- data/spec/models/feature_flag_scheduled_changes_spec.rb +10 -17
- data/spec/models/feature_flag_spec.rb +39 -30
- data/spec/models/feature_flag_status_across_environments_spec.rb +10 -17
- data/spec/models/feature_flag_status_spec.rb +8 -25
- data/spec/models/feature_flag_statuses_spec.rb +8 -15
- data/spec/models/feature_flags_spec.rb +10 -17
- data/spec/models/flag_config_approval_request_response_spec.rb +148 -0
- data/spec/models/flag_config_approval_requests_response_spec.rb +40 -0
- data/spec/models/flag_copy_config_environment_spec.rb +40 -0
- data/spec/models/flag_copy_config_post_spec.rb +66 -0
- data/spec/models/flag_global_attributes_rep_spec.rb +158 -0
- data/spec/models/flag_listing_rep_spec.rb +52 -0
- data/spec/models/flag_scheduled_changes_input_spec.rb +40 -0
- data/spec/models/flag_status_rep_spec.rb +52 -0
- data/spec/models/flag_summary_spec.rb +34 -0
- data/spec/models/flag_trigger_input_spec.rb +40 -0
- data/spec/models/forbidden_error_rep_spec.rb +40 -0
- data/spec/models/hunk_rep_spec.rb +58 -0
- data/spec/models/integration_metadata_spec.rb +52 -0
- data/spec/models/integration_spec.rb +69 -16
- data/spec/models/integration_status_rep_spec.rb +46 -0
- data/spec/models/integration_status_spec.rb +40 -0
- data/spec/models/integration_subscription_status_rep_spec.rb +58 -0
- data/spec/models/integrations_spec.rb +14 -15
- data/spec/models/invalid_request_error_rep_spec.rb +40 -0
- data/spec/models/ip_list_spec.rb +40 -0
- data/spec/models/last_seen_metadata_spec.rb +34 -0
- data/spec/models/link_spec.rb +8 -15
- data/spec/models/member_data_rep_spec.rb +58 -0
- data/spec/models/member_import_item_rep_spec.rb +46 -0
- data/spec/models/member_permission_grant_summary_rep_spec.rb +46 -0
- data/spec/models/member_spec.rb +50 -21
- data/spec/models/member_summary_rep_spec.rb +64 -0
- data/spec/models/member_team_summary_rep_spec.rb +46 -0
- data/spec/models/member_teams_form_post_spec.rb +34 -0
- data/spec/models/members_spec.rb +10 -17
- data/spec/models/method_not_allowed_error_rep_spec.rb +40 -0
- data/spec/models/metric_collection_rep_spec.rb +40 -0
- data/spec/models/metric_listing_rep_spec.rb +144 -0
- data/spec/models/metric_post_spec.rb +108 -0
- data/spec/models/metric_rep_spec.rb +174 -0
- data/spec/models/metric_seen_spec.rb +40 -0
- data/spec/models/modification_spec.rb +34 -0
- data/spec/models/multi_environment_dependent_flag_spec.rb +8 -27
- data/spec/models/multi_environment_dependent_flags_spec.rb +8 -15
- data/spec/models/new_member_form_spec.rb +64 -0
- data/spec/models/not_found_error_rep_spec.rb +40 -0
- data/spec/models/parent_resource_rep_spec.rb +46 -0
- data/spec/models/patch_failed_error_rep_spec.rb +40 -0
- data/spec/models/patch_operation_spec.rb +8 -15
- data/spec/models/patch_segment_instruction_spec.rb +58 -0
- data/spec/models/patch_segment_request_spec.rb +40 -0
- data/spec/models/patch_with_comment_spec.rb +40 -0
- data/spec/models/permission_grant_input_spec.rb +46 -0
- data/spec/models/permission_grant_rep_spec.rb +52 -0
- data/spec/models/post_approval_request_apply_request_spec.rb +34 -0
- data/spec/models/post_approval_request_review_request_spec.rb +40 -0
- data/spec/models/post_flag_scheduled_changes_input_spec.rb +46 -0
- data/spec/models/prerequisite_spec.rb +8 -15
- data/spec/models/project_listing_rep_spec.rb +70 -0
- data/spec/models/project_post_spec.rb +64 -0
- data/spec/models/project_spec.rb +12 -19
- data/spec/models/projects_spec.rb +8 -15
- data/spec/models/pub_nub_detail_rep_spec.rb +40 -0
- data/spec/models/put_branch_spec.rb +64 -0
- data/spec/models/rate_limited_error_rep_spec.rb +40 -0
- data/spec/models/recent_trigger_body_spec.rb +40 -0
- data/spec/models/reference_rep_spec.rb +46 -0
- data/spec/models/relay_auto_config_collection_rep_spec.rb +34 -0
- data/spec/models/relay_auto_config_post_spec.rb +40 -0
- data/spec/models/relay_auto_config_rep_spec.rb +82 -0
- data/spec/models/repository_collection_rep_spec.rb +40 -0
- data/spec/models/repository_post_spec.rb +68 -0
- data/spec/models/repository_rep_spec.rb +98 -0
- data/spec/models/resource_access_spec.rb +40 -0
- data/spec/models/resource_id_response_spec.rb +58 -0
- data/spec/models/review_output_rep_spec.rb +58 -0
- data/spec/models/review_response_spec.rb +62 -0
- data/spec/models/rollout_spec.rb +22 -17
- data/spec/models/rule_spec.rb +17 -18
- data/spec/models/schedule_condition_input_rep_spec.rb +40 -0
- data/spec/models/schedule_condition_output_rep_spec.rb +34 -0
- data/spec/models/sdk_list_rep_spec.rb +40 -0
- data/spec/models/sdk_version_list_rep_spec.rb +40 -0
- data/spec/models/sdk_version_rep_spec.rb +40 -0
- data/spec/models/segment_body_spec.rb +58 -0
- data/spec/models/segment_metadata_spec.rb +64 -0
- data/spec/models/segment_user_list_spec.rb +40 -0
- data/spec/models/segment_user_state_spec.rb +40 -0
- data/spec/models/series_list_rep_spec.rb +46 -0
- data/spec/models/source_flag_spec.rb +40 -0
- data/spec/models/stage_input_rep_spec.rb +46 -0
- data/spec/models/stage_output_rep_spec.rb +58 -0
- data/spec/models/statement_post_data_spec.rb +58 -0
- data/spec/models/statement_post_spec.rb +58 -0
- data/spec/models/statement_rep_spec.rb +58 -0
- data/spec/models/statement_spec.rb +8 -19
- data/spec/models/statistic_collection_rep_spec.rb +40 -0
- data/spec/models/statistic_rep_spec.rb +70 -0
- data/spec/models/statistics_root_spec.rb +40 -0
- data/spec/models/status_conflict_error_rep_spec.rb +40 -0
- data/spec/models/subject_data_rep_spec.rb +46 -0
- data/spec/models/subscription_post_spec.rb +70 -0
- data/spec/models/target_resource_rep_spec.rb +46 -0
- data/spec/models/target_spec.rb +8 -15
- data/spec/models/team_collection_rep_spec.rb +46 -0
- data/spec/models/team_imports_rep_spec.rb +34 -0
- data/spec/models/team_patch_input_spec.rb +40 -0
- data/spec/models/team_post_input_spec.rb +64 -0
- data/spec/models/team_rep_spec.rb +100 -0
- data/spec/models/title_rep_spec.rb +76 -0
- data/spec/models/token_data_rep_spec.rb +58 -0
- data/spec/models/token_spec.rb +27 -28
- data/spec/models/tokens_spec.rb +10 -17
- data/spec/models/trigger_post_spec.rb +46 -0
- data/spec/models/trigger_workflow_collection_rep_spec.rb +40 -0
- data/spec/models/trigger_workflow_rep_spec.rb +106 -0
- data/spec/models/unauthorized_error_rep_spec.rb +40 -0
- data/spec/models/url_post_spec.rb +56 -0
- data/spec/models/user_attribute_names_rep_spec.rb +46 -0
- data/spec/models/user_flag_setting_spec.rb +8 -15
- data/spec/models/user_flag_settings_spec.rb +10 -17
- data/spec/models/user_record_rep_spec.rb +58 -0
- data/spec/models/user_record_spec.rb +21 -16
- data/spec/models/user_segment_rule_spec.rb +14 -15
- data/spec/models/user_segment_spec.rb +58 -23
- data/spec/models/user_segments_spec.rb +10 -17
- data/spec/models/user_spec.rb +20 -15
- data/spec/models/users_spec.rb +8 -15
- data/spec/models/value_put_spec.rb +40 -0
- data/spec/models/variation_or_rollout_rep_spec.rb +40 -0
- data/spec/models/variation_spec.rb +10 -17
- data/spec/models/variation_summary_spec.rb +70 -0
- data/spec/models/versions_rep_spec.rb +52 -0
- data/spec/models/webhook_post_spec.rb +70 -0
- data/spec/models/webhook_spec.rb +18 -19
- data/spec/models/webhooks_spec.rb +8 -15
- data/spec/models/weighted_variation_spec.rb +14 -15
- data/spec/spec_helper.rb +4 -4
- metadata +1015 -578
- data/docs/ApprovalRequest.md +0 -21
- data/docs/ApprovalRequestApplyConfigBody.md +0 -8
- data/docs/ApprovalRequestConfigBody.md +0 -13
- data/docs/ApprovalRequestFlagConfigCopyBody.md +0 -13
- data/docs/ApprovalRequestReview.md +0 -11
- data/docs/ApprovalRequestReviewConfigBody.md +0 -9
- data/docs/ApprovalRequestReviewStatus.md +0 -7
- data/docs/ApprovalRequests.md +0 -9
- data/docs/AuditLogEntries.md +0 -9
- data/docs/AuditLogEntry.md +0 -19
- data/docs/AuditLogEntryTarget.md +0 -10
- data/docs/BigSegmentTargetChanges.md +0 -9
- data/docs/BigSegmentTargetsBody.md +0 -9
- data/docs/CopyActions.md +0 -7
- data/docs/CustomPropertyValues.md +0 -7
- data/docs/CustomRoleBody.md +0 -11
- data/docs/CustomerMetricsApi.md +0 -511
- data/docs/DependentFlagEnvironmentLinks.md +0 -9
- data/docs/DependentFlagLinks.md +0 -8
- data/docs/DependentFlagsLinks.md +0 -9
- data/docs/DestinationAmazonKinesis.md +0 -10
- data/docs/DestinationBody.md +0 -11
- data/docs/DestinationGooglePubSub.md +0 -9
- data/docs/DestinationMParticle.md +0 -11
- data/docs/DestinationSegment.md +0 -8
- data/docs/EnvironmentApprovalSettings.md +0 -13
- data/docs/EvaluationUsageError.md +0 -9
- data/docs/Events.md +0 -8
- data/docs/Fallthrough.md +0 -9
- data/docs/FeatureFlagCopyBody.md +0 -12
- data/docs/FeatureFlagCopyObject.md +0 -9
- data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
- data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
- data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
- data/docs/FeatureFlagStatusLinks.md +0 -9
- data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
- data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
- data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
- data/docs/FlagListItem.md +0 -11
- data/docs/HierarchicalLinks.md +0 -9
- data/docs/Id.md +0 -7
- data/docs/IntegrationSubscription.md +0 -16
- data/docs/IntegrationSubscriptionStatus.md +0 -10
- data/docs/IntegrationsApi.md +0 -334
- data/docs/Links.md +0 -9
- data/docs/MAU.md +0 -10
- data/docs/MAUMetadata.md +0 -7
- data/docs/MAUbyCategory.md +0 -10
- data/docs/MemberLastSeenMetadata.md +0 -8
- data/docs/MembersBody.md +0 -13
- data/docs/PatchComment.md +0 -9
- data/docs/Policy.md +0 -12
- data/docs/ProjectBody.md +0 -13
- data/docs/RelayProxyConfig.md +0 -15
- data/docs/RelayProxyConfigBody.md +0 -9
- data/docs/RelayProxyConfigs.md +0 -8
- data/docs/Role.md +0 -7
- data/docs/RootApi.md +0 -56
- data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
- data/docs/SemanticPatchInstruction.md +0 -7
- data/docs/SemanticPatchInstructionInner.md +0 -8
- data/docs/SemanticPatchOperation.md +0 -9
- data/docs/Site.md +0 -9
- data/docs/Source.md +0 -9
- data/docs/Stream.md +0 -10
- data/docs/StreamBySDK.md +0 -10
- data/docs/StreamBySDKLinks.md +0 -9
- data/docs/StreamBySDKLinksMetadata.md +0 -10
- data/docs/StreamLinks.md +0 -10
- data/docs/StreamSDKVersion.md +0 -9
- data/docs/StreamSDKVersionData.md +0 -9
- data/docs/StreamUsageError.md +0 -9
- data/docs/StreamUsageLinks.md +0 -10
- data/docs/StreamUsageMetadata.md +0 -10
- data/docs/StreamUsageSeries.md +0 -9
- data/docs/Streams.md +0 -8
- data/docs/SubscriptionBody.md +0 -12
- data/docs/TeamMembersApi.md +0 -329
- data/docs/TokenBody.md +0 -13
- data/docs/Usage.md +0 -9
- data/docs/UsageError.md +0 -8
- data/docs/UsageLinks.md +0 -10
- data/docs/UserSegmentBody.md +0 -12
- data/docs/UserSegmentsApi.md +0 -488
- data/docs/UserSettingsBody.md +0 -8
- data/docs/UserTargetingExpirationForFlag.md +0 -14
- data/docs/UserTargetingExpirationForFlags.md +0 -9
- data/docs/UserTargetingExpirationForSegment.md +0 -14
- data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
- data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
- data/docs/WebhookBody.md +0 -14
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
- data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
- data/lib/launchdarkly_api/api/root_api.rb +0 -69
- data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
- data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
- data/lib/launchdarkly_api/models/approval_request.rb +0 -346
- data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
- data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
- data/lib/launchdarkly_api/models/approval_request_flag_config_copy_body.rb +0 -254
- data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
- data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
- data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
- data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
- data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
- data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
- data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
- data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
- data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
- data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
- data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
- data/lib/launchdarkly_api/models/dependent_flag__links.rb +0 -184
- data/lib/launchdarkly_api/models/dependent_flag_environment__links.rb +0 -193
- data/lib/launchdarkly_api/models/dependent_flags_links.rb +0 -193
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
- data/lib/launchdarkly_api/models/destination_body.rb +0 -264
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
- data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
- data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -272
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
- data/lib/launchdarkly_api/models/events.rb +0 -184
- data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
- data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
- data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
- data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
- data/lib/launchdarkly_api/models/id.rb +0 -176
- data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
- data/lib/launchdarkly_api/models/links.rb +0 -193
- data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
- data/lib/launchdarkly_api/models/mau.rb +0 -206
- data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
- data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
- data/lib/launchdarkly_api/models/members_body.rb +0 -238
- data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
- data/lib/launchdarkly_api/models/policy.rb +0 -231
- data/lib/launchdarkly_api/models/project_body.rb +0 -243
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
- data/lib/launchdarkly_api/models/role.rb +0 -32
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
- data/lib/launchdarkly_api/models/site.rb +0 -193
- data/lib/launchdarkly_api/models/source.rb +0 -195
- data/lib/launchdarkly_api/models/stream.rb +0 -206
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
- data/lib/launchdarkly_api/models/stream_links.rb +0 -205
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
- data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
- data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
- data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
- data/lib/launchdarkly_api/models/streams.rb +0 -184
- data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
- data/lib/launchdarkly_api/models/token_body.rb +0 -238
- data/lib/launchdarkly_api/models/usage.rb +0 -195
- data/lib/launchdarkly_api/models/usage_error.rb +0 -184
- data/lib/launchdarkly_api/models/usage_links.rb +0 -205
- data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
- data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
- data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
- data/openapi.yml +0 -4922
- data/spec/api/customer_metrics_api_spec.rb +0 -141
- data/spec/api/integrations_api_spec.rb +0 -105
- data/spec/api/root_api_spec.rb +0 -45
- data/spec/api/team_members_api_spec.rb +0 -104
- data/spec/api/user_segments_api_spec.rb +0 -142
- data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
- data/spec/models/approval_request_config_body_spec.rb +0 -71
- data/spec/models/approval_request_flag_config_copy_body_spec.rb +0 -71
- data/spec/models/approval_request_review_config_body_spec.rb +0 -51
- data/spec/models/approval_request_review_spec.rb +0 -59
- data/spec/models/approval_request_review_status_spec.rb +0 -35
- data/spec/models/approval_request_spec.rb +0 -123
- data/spec/models/approval_requests_spec.rb +0 -47
- data/spec/models/audit_log_entries_spec.rb +0 -47
- data/spec/models/audit_log_entry_spec.rb +0 -107
- data/spec/models/audit_log_entry_target_spec.rb +0 -53
- data/spec/models/big_segment_target_changes_spec.rb +0 -47
- data/spec/models/big_segment_targets_body_spec.rb +0 -47
- data/spec/models/copy_actions_spec.rb +0 -35
- data/spec/models/custom_property_values_spec.rb +0 -35
- data/spec/models/custom_role_body_spec.rb +0 -59
- data/spec/models/dependent_flag__links_spec.rb +0 -41
- data/spec/models/dependent_flag_environment__links_spec.rb +0 -47
- data/spec/models/dependent_flags_links_spec.rb +0 -47
- data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
- data/spec/models/destination_body_spec.rb +0 -63
- data/spec/models/destination_google_pub_sub_spec.rb +0 -47
- data/spec/models/destination_m_particle_spec.rb +0 -59
- data/spec/models/destination_segment_spec.rb +0 -41
- data/spec/models/environment_approval_settings_spec.rb +0 -75
- data/spec/models/evaluation_usage_error_spec.rb +0 -47
- data/spec/models/events_spec.rb +0 -41
- data/spec/models/fallthrough_spec.rb +0 -47
- data/spec/models/feature_flag_copy_body_spec.rb +0 -65
- data/spec/models/feature_flag_copy_object_spec.rb +0 -47
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
- data/spec/models/feature_flag_status_links_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
- data/spec/models/flag_list_item_spec.rb +0 -59
- data/spec/models/hierarchical_links_spec.rb +0 -47
- data/spec/models/id_spec.rb +0 -35
- data/spec/models/integration_subscription__status_spec.rb +0 -53
- data/spec/models/integration_subscription_spec.rb +0 -89
- data/spec/models/links_spec.rb +0 -47
- data/spec/models/ma_uby_category_spec.rb +0 -53
- data/spec/models/mau_metadata_spec.rb +0 -35
- data/spec/models/mau_spec.rb +0 -53
- data/spec/models/member__last_seen_metadata_spec.rb +0 -41
- data/spec/models/members_body_spec.rb +0 -71
- data/spec/models/patch_comment_spec.rb +0 -47
- data/spec/models/policy_spec.rb +0 -65
- data/spec/models/project_body_spec.rb +0 -71
- data/spec/models/relay_proxy_config_body_spec.rb +0 -47
- data/spec/models/relay_proxy_config_spec.rb +0 -83
- data/spec/models/relay_proxy_configs_spec.rb +0 -41
- data/spec/models/role_spec.rb +0 -35
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +0 -47
- data/spec/models/semantic_patch_instruction_inner_spec.rb +0 -41
- data/spec/models/semantic_patch_instruction_spec.rb +0 -35
- data/spec/models/semantic_patch_operation_spec.rb +0 -47
- data/spec/models/site_spec.rb +0 -47
- data/spec/models/source_spec.rb +0 -47
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
- data/spec/models/stream_by_sdk_links_spec.rb +0 -47
- data/spec/models/stream_by_sdk_spec.rb +0 -53
- data/spec/models/stream_links_spec.rb +0 -53
- data/spec/models/stream_sdk_version_data_spec.rb +0 -47
- data/spec/models/stream_sdk_version_spec.rb +0 -47
- data/spec/models/stream_spec.rb +0 -53
- data/spec/models/stream_usage_error_spec.rb +0 -47
- data/spec/models/stream_usage_links_spec.rb +0 -53
- data/spec/models/stream_usage_metadata_spec.rb +0 -53
- data/spec/models/stream_usage_series_spec.rb +0 -47
- data/spec/models/streams_spec.rb +0 -41
- data/spec/models/subscription_body_spec.rb +0 -65
- data/spec/models/token_body_spec.rb +0 -71
- data/spec/models/usage_error_spec.rb +0 -41
- data/spec/models/usage_links_spec.rb +0 -53
- data/spec/models/usage_spec.rb +0 -47
- data/spec/models/user_segment_body_spec.rb +0 -65
- data/spec/models/user_settings_body_spec.rb +0 -41
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
- data/spec/models/webhook_body_spec.rb +0 -77
data/docs/FeatureFlagsApi.md
CHANGED
@@ -1,1457 +1,772 @@
|
|
1
1
|
# LaunchDarklyApi::FeatureFlagsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://app.launchdarkly.com
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
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
|
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.
|
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
|
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
|
16
|
-
[**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /flags/{projectKey}/{featureFlagKey} | Get a single feature flag by key.
|
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.
|
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
|
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.
|
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.
|
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
|
25
|
-
[**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
|
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
|
29
|
-
[**post_approval_request_flag_copy**](FeatureFlagsApi.md#post_approval_request_flag_copy) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy | Create an approval request to copy feature flag config
|
30
|
-
[**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
|
31
|
-
[**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.
|
32
|
-
[**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
|
33
|
-
|
34
|
-
|
35
|
-
# **copy_feature_flag**
|
36
|
-
> FeatureFlag copy_feature_flag(project_key, feature_flag_key, feature_flag_copy_body)
|
37
|
-
|
38
|
-
Copies the feature flag configuration from one environment to the same feature flag in another environment.
|
39
|
-
|
40
|
-
### Example
|
41
|
-
```ruby
|
42
|
-
# load the gem
|
43
|
-
require 'launchdarkly_api'
|
44
|
-
# setup authorization
|
45
|
-
LaunchDarklyApi.configure do |config|
|
46
|
-
# Configure API key authorization: Token
|
47
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
48
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
49
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
50
|
-
end
|
51
|
-
|
52
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
53
|
-
|
54
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
55
|
-
|
56
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
57
|
-
|
58
|
-
feature_flag_copy_body = LaunchDarklyApi::FeatureFlagCopyBody.new # FeatureFlagCopyBody | Copy feature flag configurations between environments.
|
59
|
-
|
60
|
-
|
61
|
-
begin
|
62
|
-
#Copies the feature flag configuration from one environment to the same feature flag in another environment.
|
63
|
-
result = api_instance.copy_feature_flag(project_key, feature_flag_key, feature_flag_copy_body)
|
64
|
-
p result
|
65
|
-
rescue LaunchDarklyApi::ApiError => e
|
66
|
-
puts "Exception when calling FeatureFlagsApi->copy_feature_flag: #{e}"
|
67
|
-
end
|
68
|
-
```
|
69
|
-
|
70
|
-
### Parameters
|
71
|
-
|
72
|
-
Name | Type | Description | Notes
|
73
|
-
------------- | ------------- | ------------- | -------------
|
74
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
75
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
76
|
-
**feature_flag_copy_body** | [**FeatureFlagCopyBody**](FeatureFlagCopyBody.md)| Copy feature flag configurations between environments. |
|
77
|
-
|
78
|
-
### Return type
|
79
|
-
|
80
|
-
[**FeatureFlag**](FeatureFlag.md)
|
81
|
-
|
82
|
-
### Authorization
|
83
|
-
|
84
|
-
[Token](../README.md#Token)
|
85
|
-
|
86
|
-
### HTTP request headers
|
87
|
-
|
88
|
-
- **Content-Type**: application/json
|
89
|
-
- **Accept**: application/json
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
# **delete_approval_request**
|
94
|
-
> delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, , opts)
|
95
|
-
|
96
|
-
Delete an approval request for a feature flag config
|
97
|
-
|
98
|
-
### Example
|
99
|
-
```ruby
|
100
|
-
# load the gem
|
101
|
-
require 'launchdarkly_api'
|
102
|
-
# setup authorization
|
103
|
-
LaunchDarklyApi.configure do |config|
|
104
|
-
# Configure API key authorization: Token
|
105
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
106
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
107
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
108
|
-
end
|
109
|
-
|
110
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
111
|
-
|
112
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
113
|
-
|
114
|
-
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.
|
115
|
-
|
116
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
117
|
-
|
118
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
119
|
-
|
120
|
-
opts = {
|
121
|
-
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
122
|
-
}
|
123
|
-
|
124
|
-
begin
|
125
|
-
#Delete an approval request for a feature flag config
|
126
|
-
api_instance.delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, , opts)
|
127
|
-
rescue LaunchDarklyApi::ApiError => e
|
128
|
-
puts "Exception when calling FeatureFlagsApi->delete_approval_request: #{e}"
|
129
|
-
end
|
130
|
-
```
|
131
|
-
|
132
|
-
### Parameters
|
133
|
-
|
134
|
-
Name | Type | Description | Notes
|
135
|
-
------------- | ------------- | ------------- | -------------
|
136
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
137
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
138
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
139
|
-
**approval_request_id** | **String**| The approval request ID |
|
140
|
-
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
141
|
-
|
142
|
-
### Return type
|
143
|
-
|
144
|
-
nil (empty response body)
|
145
|
-
|
146
|
-
### Authorization
|
147
|
-
|
148
|
-
[Token](../README.md#Token)
|
149
|
-
|
150
|
-
### HTTP request headers
|
151
|
-
|
152
|
-
- **Content-Type**: application/json
|
153
|
-
- **Accept**: application/json
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
# **delete_feature_flag**
|
158
|
-
> delete_feature_flag(project_key, feature_flag_key, )
|
159
|
-
|
160
|
-
Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
|
161
|
-
|
162
|
-
### Example
|
163
|
-
```ruby
|
164
|
-
# load the gem
|
165
|
-
require 'launchdarkly_api'
|
166
|
-
# setup authorization
|
167
|
-
LaunchDarklyApi.configure do |config|
|
168
|
-
# Configure API key authorization: Token
|
169
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
170
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
171
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
172
|
-
end
|
173
|
-
|
174
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
175
|
-
|
176
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
177
|
-
|
178
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
179
|
-
|
180
|
-
|
181
|
-
begin
|
182
|
-
#Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
|
183
|
-
api_instance.delete_feature_flag(project_key, feature_flag_key, )
|
184
|
-
rescue LaunchDarklyApi::ApiError => e
|
185
|
-
puts "Exception when calling FeatureFlagsApi->delete_feature_flag: #{e}"
|
186
|
-
end
|
187
|
-
```
|
188
|
-
|
189
|
-
### Parameters
|
190
|
-
|
191
|
-
Name | Type | Description | Notes
|
192
|
-
------------- | ------------- | ------------- | -------------
|
193
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
194
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
195
|
-
|
196
|
-
### Return type
|
197
|
-
|
198
|
-
nil (empty response body)
|
199
|
-
|
200
|
-
### Authorization
|
201
|
-
|
202
|
-
[Token](../README.md#Token)
|
203
|
-
|
204
|
-
### HTTP request headers
|
205
|
-
|
206
|
-
- **Content-Type**: application/json
|
207
|
-
- **Accept**: application/json
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
# **delete_flag_config_scheduled_changes**
|
212
|
-
> delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
213
|
-
|
214
|
-
Delete a scheduled change on a feature flag in an environment.
|
215
|
-
|
216
|
-
### Example
|
217
|
-
```ruby
|
218
|
-
# load the gem
|
219
|
-
require 'launchdarkly_api'
|
220
|
-
# setup authorization
|
221
|
-
LaunchDarklyApi.configure do |config|
|
222
|
-
# Configure API key authorization: Token
|
223
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
224
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
225
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
226
|
-
end
|
227
|
-
|
228
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
229
|
-
|
230
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
231
|
-
|
232
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
233
|
-
|
234
|
-
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.
|
235
|
-
|
236
|
-
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
237
|
-
|
238
|
-
|
239
|
-
begin
|
240
|
-
#Delete a scheduled change on a feature flag in an environment.
|
241
|
-
api_instance.delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
242
|
-
rescue LaunchDarklyApi::ApiError => e
|
243
|
-
puts "Exception when calling FeatureFlagsApi->delete_flag_config_scheduled_changes: #{e}"
|
244
|
-
end
|
245
|
-
```
|
246
|
-
|
247
|
-
### Parameters
|
248
|
-
|
249
|
-
Name | Type | Description | Notes
|
250
|
-
------------- | ------------- | ------------- | -------------
|
251
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
252
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
253
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
254
|
-
**scheduled_change_id** | **String**| The id of the scheduled change |
|
255
|
-
|
256
|
-
### Return type
|
257
|
-
|
258
|
-
nil (empty response body)
|
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
|
-
# **flags_project_key_environment_key_feature_flag_key_dependent_flags_get**
|
272
|
-
> DependentFlagsByEnvironment flags_project_key_environment_key_feature_flag_key_dependent_flags_get(project_key, environment_key, feature_flag_key, )
|
273
|
-
|
274
|
-
Get dependent flags for the flag in the environment specified in path parameters
|
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::FeatureFlagsApi.new
|
289
|
-
|
290
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
291
|
-
|
292
|
-
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.
|
293
|
-
|
294
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
295
|
-
|
296
|
-
|
297
|
-
begin
|
298
|
-
#Get dependent flags for the flag in the environment specified in path parameters
|
299
|
-
result = api_instance.flags_project_key_environment_key_feature_flag_key_dependent_flags_get(project_key, environment_key, feature_flag_key, )
|
300
|
-
p result
|
301
|
-
rescue LaunchDarklyApi::ApiError => e
|
302
|
-
puts "Exception when calling FeatureFlagsApi->flags_project_key_environment_key_feature_flag_key_dependent_flags_get: #{e}"
|
303
|
-
end
|
304
|
-
```
|
305
|
-
|
306
|
-
### Parameters
|
307
|
-
|
308
|
-
Name | Type | Description | Notes
|
309
|
-
------------- | ------------- | ------------- | -------------
|
310
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
311
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
312
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
313
|
-
|
314
|
-
### Return type
|
315
|
-
|
316
|
-
[**DependentFlagsByEnvironment**](DependentFlagsByEnvironment.md)
|
317
|
-
|
318
|
-
### Authorization
|
319
|
-
|
320
|
-
[Token](../README.md#Token)
|
321
|
-
|
322
|
-
### HTTP request headers
|
323
|
-
|
324
|
-
- **Content-Type**: application/json
|
325
|
-
- **Accept**: application/json
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
# **flags_project_key_feature_flag_key_dependent_flags_get**
|
330
|
-
> MultiEnvironmentDependentFlags flags_project_key_feature_flag_key_dependent_flags_get(project_key, feature_flag_key, )
|
331
|
-
|
332
|
-
Get dependent flags across all environments for the flag specified in the path parameters
|
333
|
-
|
334
|
-
### Example
|
335
|
-
```ruby
|
336
|
-
# load the gem
|
337
|
-
require 'launchdarkly_api'
|
338
|
-
# setup authorization
|
339
|
-
LaunchDarklyApi.configure do |config|
|
340
|
-
# Configure API key authorization: Token
|
341
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
342
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
343
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
344
|
-
end
|
345
|
-
|
346
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
347
|
-
|
348
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
349
|
-
|
350
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
351
|
-
|
352
|
-
|
353
|
-
begin
|
354
|
-
#Get dependent flags across all environments for the flag specified in the path parameters
|
355
|
-
result = api_instance.flags_project_key_feature_flag_key_dependent_flags_get(project_key, feature_flag_key, )
|
356
|
-
p result
|
357
|
-
rescue LaunchDarklyApi::ApiError => e
|
358
|
-
puts "Exception when calling FeatureFlagsApi->flags_project_key_feature_flag_key_dependent_flags_get: #{e}"
|
359
|
-
end
|
360
|
-
```
|
361
|
-
|
362
|
-
### Parameters
|
363
|
-
|
364
|
-
Name | Type | Description | Notes
|
365
|
-
------------- | ------------- | ------------- | -------------
|
366
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
367
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
368
|
-
|
369
|
-
### Return type
|
370
|
-
|
371
|
-
[**MultiEnvironmentDependentFlags**](MultiEnvironmentDependentFlags.md)
|
372
|
-
|
373
|
-
### Authorization
|
374
|
-
|
375
|
-
[Token](../README.md#Token)
|
376
|
-
|
377
|
-
### HTTP request headers
|
378
|
-
|
379
|
-
- **Content-Type**: application/json
|
380
|
-
- **Accept**: application/json
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
# **get_approval_request**
|
385
|
-
> ApprovalRequest get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
386
|
-
|
387
|
-
Get a single approval request for a feature flag config
|
388
|
-
|
389
|
-
### Example
|
390
|
-
```ruby
|
391
|
-
# load the gem
|
392
|
-
require 'launchdarkly_api'
|
393
|
-
# setup authorization
|
394
|
-
LaunchDarklyApi.configure do |config|
|
395
|
-
# Configure API key authorization: Token
|
396
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
397
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
398
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
399
|
-
end
|
400
|
-
|
401
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
402
|
-
|
403
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
404
|
-
|
405
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
406
|
-
|
407
|
-
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.
|
408
|
-
|
409
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
410
|
-
|
411
|
-
|
412
|
-
begin
|
413
|
-
#Get a single approval request for a feature flag config
|
414
|
-
result = api_instance.get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
415
|
-
p result
|
416
|
-
rescue LaunchDarklyApi::ApiError => e
|
417
|
-
puts "Exception when calling FeatureFlagsApi->get_approval_request: #{e}"
|
418
|
-
end
|
419
|
-
```
|
420
|
-
|
421
|
-
### Parameters
|
422
|
-
|
423
|
-
Name | Type | Description | Notes
|
424
|
-
------------- | ------------- | ------------- | -------------
|
425
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
426
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
427
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
428
|
-
**approval_request_id** | **String**| The approval request ID |
|
429
|
-
|
430
|
-
### Return type
|
431
|
-
|
432
|
-
[**ApprovalRequest**](ApprovalRequest.md)
|
433
|
-
|
434
|
-
### Authorization
|
435
|
-
|
436
|
-
[Token](../README.md#Token)
|
437
|
-
|
438
|
-
### HTTP request headers
|
439
|
-
|
440
|
-
- **Content-Type**: application/json
|
441
|
-
- **Accept**: application/json
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
# **get_approval_requests**
|
446
|
-
> ApprovalRequests get_approval_requests(project_key, feature_flag_key, environment_key, )
|
447
|
-
|
448
|
-
Get all approval requests for a feature flag config
|
449
|
-
|
450
|
-
### Example
|
451
|
-
```ruby
|
452
|
-
# load the gem
|
453
|
-
require 'launchdarkly_api'
|
454
|
-
# setup authorization
|
455
|
-
LaunchDarklyApi.configure do |config|
|
456
|
-
# Configure API key authorization: Token
|
457
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
458
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
459
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
460
|
-
end
|
461
|
-
|
462
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
463
|
-
|
464
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
465
|
-
|
466
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
467
|
-
|
468
|
-
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.
|
469
|
-
|
470
|
-
|
471
|
-
begin
|
472
|
-
#Get all approval requests for a feature flag config
|
473
|
-
result = api_instance.get_approval_requests(project_key, feature_flag_key, environment_key, )
|
474
|
-
p result
|
475
|
-
rescue LaunchDarklyApi::ApiError => e
|
476
|
-
puts "Exception when calling FeatureFlagsApi->get_approval_requests: #{e}"
|
477
|
-
end
|
478
|
-
```
|
479
|
-
|
480
|
-
### Parameters
|
481
|
-
|
482
|
-
Name | Type | Description | Notes
|
483
|
-
------------- | ------------- | ------------- | -------------
|
484
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
485
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
486
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
487
|
-
|
488
|
-
### Return type
|
489
|
-
|
490
|
-
[**ApprovalRequests**](ApprovalRequests.md)
|
491
|
-
|
492
|
-
### Authorization
|
493
|
-
|
494
|
-
[Token](../README.md#Token)
|
495
|
-
|
496
|
-
### HTTP request headers
|
497
|
-
|
498
|
-
- **Content-Type**: application/json
|
499
|
-
- **Accept**: application/json
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
# **get_expiring_user_targets**
|
504
|
-
> UserTargetingExpirationForFlags get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
505
|
-
|
506
|
-
Get expiring user targets for feature flag
|
507
|
-
|
508
|
-
### Example
|
509
|
-
```ruby
|
510
|
-
# load the gem
|
511
|
-
require 'launchdarkly_api'
|
512
|
-
# setup authorization
|
513
|
-
LaunchDarklyApi.configure do |config|
|
514
|
-
# Configure API key authorization: Token
|
515
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
516
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
517
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
518
|
-
end
|
519
|
-
|
520
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
521
|
-
|
522
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
523
|
-
|
524
|
-
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.
|
525
|
-
|
526
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
527
|
-
|
528
|
-
|
529
|
-
begin
|
530
|
-
#Get expiring user targets for feature flag
|
531
|
-
result = api_instance.get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
532
|
-
p result
|
533
|
-
rescue LaunchDarklyApi::ApiError => e
|
534
|
-
puts "Exception when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
|
535
|
-
end
|
536
|
-
```
|
537
|
-
|
538
|
-
### Parameters
|
539
|
-
|
540
|
-
Name | Type | Description | Notes
|
541
|
-
------------- | ------------- | ------------- | -------------
|
542
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
543
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
544
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
545
|
-
|
546
|
-
### Return type
|
547
|
-
|
548
|
-
[**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
|
549
|
-
|
550
|
-
### Authorization
|
551
|
-
|
552
|
-
[Token](../README.md#Token)
|
553
|
-
|
554
|
-
### HTTP request headers
|
555
|
-
|
556
|
-
- **Content-Type**: application/json
|
557
|
-
- **Accept**: application/json
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
# **get_feature_flag**
|
562
|
-
> FeatureFlag get_feature_flag(project_key, feature_flag_key, , opts)
|
563
|
-
|
564
|
-
Get a single feature flag by key.
|
565
|
-
|
566
|
-
### Example
|
567
|
-
```ruby
|
568
|
-
# load the gem
|
569
|
-
require 'launchdarkly_api'
|
570
|
-
# setup authorization
|
571
|
-
LaunchDarklyApi.configure do |config|
|
572
|
-
# Configure API key authorization: Token
|
573
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
574
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
575
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
576
|
-
end
|
577
|
-
|
578
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
579
|
-
|
580
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
581
|
-
|
582
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
583
|
-
|
584
|
-
opts = {
|
585
|
-
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.
|
586
|
-
}
|
587
|
-
|
588
|
-
begin
|
589
|
-
#Get a single feature flag by key.
|
590
|
-
result = api_instance.get_feature_flag(project_key, feature_flag_key, , opts)
|
591
|
-
p result
|
592
|
-
rescue LaunchDarklyApi::ApiError => e
|
593
|
-
puts "Exception when calling FeatureFlagsApi->get_feature_flag: #{e}"
|
594
|
-
end
|
595
|
-
```
|
596
|
-
|
597
|
-
### Parameters
|
598
|
-
|
599
|
-
Name | Type | Description | Notes
|
600
|
-
------------- | ------------- | ------------- | -------------
|
601
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
602
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
603
|
-
**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]
|
604
|
-
|
605
|
-
### Return type
|
606
|
-
|
607
|
-
[**FeatureFlag**](FeatureFlag.md)
|
608
|
-
|
609
|
-
### Authorization
|
3
|
+
All URIs are relative to *https://app.launchdarkly.com*
|
610
4
|
|
611
|
-
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**copy_feature_flag**](FeatureFlagsApi.md#copy_feature_flag) | **POST** /api/v2/flags/{projKey}/{featureFlagKey}/copy | Copy feature flag |
|
8
|
+
| [**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /api/v2/flags/{projKey}/{key} | Delete feature flag |
|
9
|
+
| [**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey} | Get expiring user targets for feature flag |
|
10
|
+
| [**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /api/v2/flags/{projKey}/{key} | Get feature flag |
|
11
|
+
| [**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /api/v2/flag-statuses/{projKey}/{envKey}/{key} | Get feature flag status |
|
12
|
+
| [**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /api/v2/flag-status/{projKey}/{key} | Get flag status across environments |
|
13
|
+
| [**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /api/v2/flag-statuses/{projKey}/{envKey} | List feature flag statuses |
|
14
|
+
| [**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /api/v2/flags/{projKey} | List feature flags |
|
15
|
+
| [**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey} | Update expiring user targets on feature flag |
|
16
|
+
| [**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /api/v2/flags/{projKey}/{key} | Update feature flag |
|
17
|
+
| [**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /api/v2/flags/{projKey} | Create a feature flag |
|
612
18
|
|
613
|
-
### HTTP request headers
|
614
19
|
|
615
|
-
|
616
|
-
- **Accept**: application/json
|
20
|
+
## copy_feature_flag
|
617
21
|
|
22
|
+
> <FeatureFlag> copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post)
|
618
23
|
|
24
|
+
Copy feature flag
|
619
25
|
|
620
|
-
|
621
|
-
> FeatureFlagStatus get_feature_flag_status(project_key, environment_key, feature_flag_key, )
|
26
|
+
The includedActions and excludedActions define the parts of the flag configuration that are copied or not copied. By default, the entire flag configuration is copied. You can have either `includedActions` or `excludedActions` but not both. Valid `includedActions` and `excludedActions` include: - `updateOn` - `updatePrerequisites` - `updateTargets` - `updateRules` - `updateFallthrough` - `updateOffVariation` The `source` and `target` must be JSON objects if using curl, specifying the environment key and (optional) current flag configuration version in that environment. For example: ```json { \"key\": \"production\", \"currentVersion\": 3 } ``` If target is specified as above, the API will test to ensure that the current flag version in the `production` environment is `3`, and reject attempts to copy settings to `production` otherwise. You can use this to enforce optimistic locking on copy attempts.
|
622
27
|
|
623
|
-
|
28
|
+
### Examples
|
624
29
|
|
625
|
-
### Example
|
626
30
|
```ruby
|
627
|
-
|
31
|
+
require 'time'
|
628
32
|
require 'launchdarkly_api'
|
629
33
|
# setup authorization
|
630
34
|
LaunchDarklyApi.configure do |config|
|
631
|
-
# Configure API key authorization:
|
632
|
-
config.api_key['
|
35
|
+
# Configure API key authorization: ApiKey
|
36
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
633
37
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
634
|
-
#config.api_key_prefix['
|
38
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
635
39
|
end
|
636
40
|
|
637
41
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
638
|
-
|
639
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
640
|
-
|
641
|
-
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.
|
642
|
-
|
42
|
+
proj_key = 'proj_key_example' # String | The project key.
|
643
43
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
644
|
-
|
44
|
+
flag_copy_config_post = LaunchDarklyApi::FlagCopyConfigPost.new({source: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'}), target: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'})}) # FlagCopyConfigPost |
|
645
45
|
|
646
46
|
begin
|
647
|
-
#
|
648
|
-
result = api_instance.
|
47
|
+
# Copy feature flag
|
48
|
+
result = api_instance.copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post)
|
649
49
|
p result
|
650
50
|
rescue LaunchDarklyApi::ApiError => e
|
651
|
-
puts "
|
51
|
+
puts "Error when calling FeatureFlagsApi->copy_feature_flag: #{e}"
|
652
52
|
end
|
653
53
|
```
|
654
54
|
|
655
|
-
|
656
|
-
|
657
|
-
Name | Type | Description | Notes
|
658
|
-
------------- | ------------- | ------------- | -------------
|
659
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
660
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
661
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
662
|
-
|
663
|
-
### Return type
|
664
|
-
|
665
|
-
[**FeatureFlagStatus**](FeatureFlagStatus.md)
|
666
|
-
|
667
|
-
### Authorization
|
668
|
-
|
669
|
-
[Token](../README.md#Token)
|
670
|
-
|
671
|
-
### HTTP request headers
|
672
|
-
|
673
|
-
- **Content-Type**: application/json
|
674
|
-
- **Accept**: application/json
|
675
|
-
|
676
|
-
|
55
|
+
#### Using the copy_feature_flag_with_http_info variant
|
677
56
|
|
678
|
-
|
679
|
-
> FeatureFlagStatusAcrossEnvironments get_feature_flag_status_across_environments(project_key, feature_flag_key, )
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
680
58
|
|
681
|
-
|
59
|
+
> <Array(<FeatureFlag>, Integer, Hash)> copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post)
|
682
60
|
|
683
|
-
### Example
|
684
61
|
```ruby
|
685
|
-
# load the gem
|
686
|
-
require 'launchdarkly_api'
|
687
|
-
# setup authorization
|
688
|
-
LaunchDarklyApi.configure do |config|
|
689
|
-
# Configure API key authorization: Token
|
690
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
691
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
692
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
693
|
-
end
|
694
|
-
|
695
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
696
|
-
|
697
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
698
|
-
|
699
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
700
|
-
|
701
|
-
|
702
62
|
begin
|
703
|
-
#
|
704
|
-
|
705
|
-
p
|
63
|
+
# Copy feature flag
|
64
|
+
data, status_code, headers = api_instance.copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post)
|
65
|
+
p status_code # => 2xx
|
66
|
+
p headers # => { ... }
|
67
|
+
p data # => <FeatureFlag>
|
706
68
|
rescue LaunchDarklyApi::ApiError => e
|
707
|
-
puts "
|
69
|
+
puts "Error when calling FeatureFlagsApi->copy_feature_flag_with_http_info: #{e}"
|
708
70
|
end
|
709
71
|
```
|
710
72
|
|
711
73
|
### Parameters
|
712
74
|
|
713
|
-
Name | Type | Description
|
714
|
-
|
715
|
-
**
|
716
|
-
**feature_flag_key** | **String
|
75
|
+
| Name | Type | Description | Notes |
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
77
|
+
| **proj_key** | **String** | The project key. | |
|
78
|
+
| **feature_flag_key** | **String** | The feature flag's key. The key identifies the flag in your code. | |
|
79
|
+
| **flag_copy_config_post** | [**FlagCopyConfigPost**](FlagCopyConfigPost.md) | | |
|
717
80
|
|
718
81
|
### Return type
|
719
82
|
|
720
|
-
[**
|
83
|
+
[**FeatureFlag**](FeatureFlag.md)
|
721
84
|
|
722
85
|
### Authorization
|
723
86
|
|
724
|
-
[
|
87
|
+
[ApiKey](../README.md#ApiKey)
|
725
88
|
|
726
89
|
### HTTP request headers
|
727
90
|
|
728
|
-
|
729
|
-
|
91
|
+
- **Content-Type**: application/json
|
92
|
+
- **Accept**: application/json
|
93
|
+
|
730
94
|
|
95
|
+
## delete_feature_flag
|
731
96
|
|
97
|
+
> delete_feature_flag(proj_key, key)
|
732
98
|
|
733
|
-
|
734
|
-
> FeatureFlagStatuses get_feature_flag_statuses(project_key, environment_key, )
|
99
|
+
Delete feature flag
|
735
100
|
|
736
|
-
|
101
|
+
Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
|
102
|
+
|
103
|
+
### Examples
|
737
104
|
|
738
|
-
### Example
|
739
105
|
```ruby
|
740
|
-
|
106
|
+
require 'time'
|
741
107
|
require 'launchdarkly_api'
|
742
108
|
# setup authorization
|
743
109
|
LaunchDarklyApi.configure do |config|
|
744
|
-
# Configure API key authorization:
|
745
|
-
config.api_key['
|
110
|
+
# Configure API key authorization: ApiKey
|
111
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
746
112
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
747
|
-
#config.api_key_prefix['
|
113
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
748
114
|
end
|
749
115
|
|
750
116
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
751
|
-
|
752
|
-
|
753
|
-
|
754
|
-
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.
|
755
|
-
|
117
|
+
proj_key = 'proj_key_example' # String | The project key.
|
118
|
+
key = 'key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
756
119
|
|
757
120
|
begin
|
758
|
-
#
|
759
|
-
|
760
|
-
p result
|
121
|
+
# Delete feature flag
|
122
|
+
api_instance.delete_feature_flag(proj_key, key)
|
761
123
|
rescue LaunchDarklyApi::ApiError => e
|
762
|
-
puts "
|
124
|
+
puts "Error when calling FeatureFlagsApi->delete_feature_flag: #{e}"
|
763
125
|
end
|
764
126
|
```
|
765
127
|
|
766
|
-
|
767
|
-
|
768
|
-
Name | Type | Description | Notes
|
769
|
-
------------- | ------------- | ------------- | -------------
|
770
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
771
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
772
|
-
|
773
|
-
### Return type
|
774
|
-
|
775
|
-
[**FeatureFlagStatuses**](FeatureFlagStatuses.md)
|
776
|
-
|
777
|
-
### Authorization
|
778
|
-
|
779
|
-
[Token](../README.md#Token)
|
780
|
-
|
781
|
-
### HTTP request headers
|
128
|
+
#### Using the delete_feature_flag_with_http_info variant
|
782
129
|
|
783
|
-
|
784
|
-
- **Accept**: application/json
|
130
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
785
131
|
|
132
|
+
> <Array(nil, Integer, Hash)> delete_feature_flag_with_http_info(proj_key, key)
|
786
133
|
|
787
|
-
|
788
|
-
# **get_feature_flags**
|
789
|
-
> FeatureFlags get_feature_flags(project_key, , opts)
|
790
|
-
|
791
|
-
Get a list of all features in the given project.
|
792
|
-
|
793
|
-
### Example
|
794
134
|
```ruby
|
795
|
-
# load the gem
|
796
|
-
require 'launchdarkly_api'
|
797
|
-
# setup authorization
|
798
|
-
LaunchDarklyApi.configure do |config|
|
799
|
-
# Configure API key authorization: Token
|
800
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
801
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
802
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
803
|
-
end
|
804
|
-
|
805
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
806
|
-
|
807
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
808
|
-
|
809
|
-
opts = {
|
810
|
-
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.
|
811
|
-
summary: true, # BOOLEAN | By default in api version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned.
|
812
|
-
archived: true, # BOOLEAN | When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags.
|
813
|
-
limit: 8.14, # Float | The number of objects to return. Defaults to -1, which returns everything.
|
814
|
-
offset: 8.14, # Float | Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
|
815
|
-
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value.
|
816
|
-
sort: 'sort_example' # String | A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
|
817
|
-
tag: 'tag_example' # String | Filter by tag. A tag can be used to group flags across projects.
|
818
|
-
}
|
819
|
-
|
820
135
|
begin
|
821
|
-
#
|
822
|
-
|
823
|
-
p
|
136
|
+
# Delete feature flag
|
137
|
+
data, status_code, headers = api_instance.delete_feature_flag_with_http_info(proj_key, key)
|
138
|
+
p status_code # => 2xx
|
139
|
+
p headers # => { ... }
|
140
|
+
p data # => nil
|
824
141
|
rescue LaunchDarklyApi::ApiError => e
|
825
|
-
puts "
|
142
|
+
puts "Error when calling FeatureFlagsApi->delete_feature_flag_with_http_info: #{e}"
|
826
143
|
end
|
827
144
|
```
|
828
145
|
|
829
146
|
### Parameters
|
830
147
|
|
831
|
-
Name | Type | Description
|
832
|
-
|
833
|
-
**
|
834
|
-
**
|
835
|
-
**summary** | **BOOLEAN**| By default in api version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned. | [optional]
|
836
|
-
**archived** | **BOOLEAN**| When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags. | [optional]
|
837
|
-
**limit** | **Float**| The number of objects to return. Defaults to -1, which returns everything. | [optional]
|
838
|
-
**offset** | **Float**| Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items. | [optional]
|
839
|
-
**filter** | **String**| A comma-separated list of filters. Each filter is of the form field:value. | [optional]
|
840
|
-
**sort** | **String**| A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order. | [optional]
|
841
|
-
**tag** | **String**| Filter by tag. A tag can be used to group flags across projects. | [optional]
|
148
|
+
| Name | Type | Description | Notes |
|
149
|
+
| ---- | ---- | ----------- | ----- |
|
150
|
+
| **proj_key** | **String** | The project key. | |
|
151
|
+
| **key** | **String** | The feature flag's key. The key identifies the flag in your code. | |
|
842
152
|
|
843
153
|
### Return type
|
844
154
|
|
845
|
-
|
155
|
+
nil (empty response body)
|
846
156
|
|
847
157
|
### Authorization
|
848
158
|
|
849
|
-
[
|
159
|
+
[ApiKey](../README.md#ApiKey)
|
850
160
|
|
851
161
|
### HTTP request headers
|
852
162
|
|
853
|
-
|
854
|
-
|
163
|
+
- **Content-Type**: Not defined
|
164
|
+
- **Accept**: application/json
|
855
165
|
|
856
166
|
|
167
|
+
## get_expiring_user_targets
|
857
168
|
|
858
|
-
|
859
|
-
> FeatureFlagScheduledChange get_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
169
|
+
> <ExpiringUserTargetGetResponse> get_expiring_user_targets(proj_key, env_key, flag_key)
|
860
170
|
|
861
|
-
Get
|
171
|
+
Get expiring user targets for feature flag
|
172
|
+
|
173
|
+
Get a list of user targets on a feature flag that are scheduled for removal.
|
174
|
+
|
175
|
+
### Examples
|
862
176
|
|
863
|
-
### Example
|
864
177
|
```ruby
|
865
|
-
|
178
|
+
require 'time'
|
866
179
|
require 'launchdarkly_api'
|
867
180
|
# setup authorization
|
868
181
|
LaunchDarklyApi.configure do |config|
|
869
|
-
# Configure API key authorization:
|
870
|
-
config.api_key['
|
182
|
+
# Configure API key authorization: ApiKey
|
183
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
871
184
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
872
|
-
#config.api_key_prefix['
|
185
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
873
186
|
end
|
874
187
|
|
875
188
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
876
|
-
|
877
|
-
|
878
|
-
|
879
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
880
|
-
|
881
|
-
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.
|
882
|
-
|
883
|
-
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
884
|
-
|
189
|
+
proj_key = 'proj_key_example' # String | The project key.
|
190
|
+
env_key = 'env_key_example' # String | The environment key.
|
191
|
+
flag_key = 'flag_key_example' # String | The feature flag key.
|
885
192
|
|
886
193
|
begin
|
887
|
-
#Get
|
888
|
-
result = api_instance.
|
194
|
+
# Get expiring user targets for feature flag
|
195
|
+
result = api_instance.get_expiring_user_targets(proj_key, env_key, flag_key)
|
889
196
|
p result
|
890
197
|
rescue LaunchDarklyApi::ApiError => e
|
891
|
-
puts "
|
198
|
+
puts "Error when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
|
892
199
|
end
|
893
200
|
```
|
894
201
|
|
895
|
-
|
896
|
-
|
897
|
-
Name | Type | Description | Notes
|
898
|
-
------------- | ------------- | ------------- | -------------
|
899
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
900
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
901
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
902
|
-
**scheduled_change_id** | **String**| The id of the scheduled change |
|
903
|
-
|
904
|
-
### Return type
|
905
|
-
|
906
|
-
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
907
|
-
|
908
|
-
### Authorization
|
909
|
-
|
910
|
-
[Token](../README.md#Token)
|
911
|
-
|
912
|
-
### HTTP request headers
|
913
|
-
|
914
|
-
- **Content-Type**: application/json
|
915
|
-
- **Accept**: application/json
|
202
|
+
#### Using the get_expiring_user_targets_with_http_info variant
|
916
203
|
|
204
|
+
This returns an Array which contains the response data, status code and headers.
|
917
205
|
|
206
|
+
> <Array(<ExpiringUserTargetGetResponse>, Integer, Hash)> get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key)
|
918
207
|
|
919
|
-
# **get_flag_config_scheduled_changes**
|
920
|
-
> FeatureFlagScheduledChanges get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, )
|
921
|
-
|
922
|
-
Get all scheduled workflows for a feature flag by key.
|
923
|
-
|
924
|
-
### Example
|
925
208
|
```ruby
|
926
|
-
# load the gem
|
927
|
-
require 'launchdarkly_api'
|
928
|
-
# setup authorization
|
929
|
-
LaunchDarklyApi.configure do |config|
|
930
|
-
# Configure API key authorization: Token
|
931
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
932
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
933
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
934
|
-
end
|
935
|
-
|
936
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
937
|
-
|
938
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
939
|
-
|
940
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
941
|
-
|
942
|
-
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.
|
943
|
-
|
944
|
-
|
945
209
|
begin
|
946
|
-
#Get
|
947
|
-
|
948
|
-
p
|
210
|
+
# Get expiring user targets for feature flag
|
211
|
+
data, status_code, headers = api_instance.get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key)
|
212
|
+
p status_code # => 2xx
|
213
|
+
p headers # => { ... }
|
214
|
+
p data # => <ExpiringUserTargetGetResponse>
|
949
215
|
rescue LaunchDarklyApi::ApiError => e
|
950
|
-
puts "
|
216
|
+
puts "Error when calling FeatureFlagsApi->get_expiring_user_targets_with_http_info: #{e}"
|
951
217
|
end
|
952
218
|
```
|
953
219
|
|
954
220
|
### Parameters
|
955
221
|
|
956
|
-
Name | Type | Description
|
957
|
-
|
958
|
-
**
|
959
|
-
**
|
960
|
-
**
|
222
|
+
| Name | Type | Description | Notes |
|
223
|
+
| ---- | ---- | ----------- | ----- |
|
224
|
+
| **proj_key** | **String** | The project key. | |
|
225
|
+
| **env_key** | **String** | The environment key. | |
|
226
|
+
| **flag_key** | **String** | The feature flag key. | |
|
961
227
|
|
962
228
|
### Return type
|
963
229
|
|
964
|
-
[**
|
230
|
+
[**ExpiringUserTargetGetResponse**](ExpiringUserTargetGetResponse.md)
|
965
231
|
|
966
232
|
### Authorization
|
967
233
|
|
968
|
-
[
|
234
|
+
[ApiKey](../README.md#ApiKey)
|
969
235
|
|
970
236
|
### HTTP request headers
|
971
237
|
|
972
|
-
|
973
|
-
|
238
|
+
- **Content-Type**: Not defined
|
239
|
+
- **Accept**: application/json
|
974
240
|
|
975
241
|
|
242
|
+
## get_feature_flag
|
976
243
|
|
977
|
-
|
978
|
-
> FeatureFlagScheduledChangesConflicts get_flag_config_scheduled_changes_conflicts(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body)
|
244
|
+
> <FeatureFlag> get_feature_flag(proj_key, key, opts)
|
979
245
|
|
980
|
-
|
246
|
+
Get feature flag
|
247
|
+
|
248
|
+
Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment.
|
249
|
+
|
250
|
+
### Examples
|
981
251
|
|
982
|
-
### Example
|
983
252
|
```ruby
|
984
|
-
|
253
|
+
require 'time'
|
985
254
|
require 'launchdarkly_api'
|
986
255
|
# setup authorization
|
987
256
|
LaunchDarklyApi.configure do |config|
|
988
|
-
# Configure API key authorization:
|
989
|
-
config.api_key['
|
257
|
+
# Configure API key authorization: ApiKey
|
258
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
990
259
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
991
|
-
#config.api_key_prefix['
|
260
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
992
261
|
end
|
993
262
|
|
994
263
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
264
|
+
proj_key = 'proj_key_example' # String | The project key
|
265
|
+
key = 'key_example' # String | The feature flag key
|
266
|
+
opts = {
|
267
|
+
env: 'env_example' # String | Filter configurations by environment
|
268
|
+
}
|
995
269
|
|
996
|
-
|
997
|
-
|
998
|
-
|
270
|
+
begin
|
271
|
+
# Get feature flag
|
272
|
+
result = api_instance.get_feature_flag(proj_key, key, opts)
|
273
|
+
p result
|
274
|
+
rescue LaunchDarklyApi::ApiError => e
|
275
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag: #{e}"
|
276
|
+
end
|
277
|
+
```
|
999
278
|
|
1000
|
-
|
279
|
+
#### Using the get_feature_flag_with_http_info variant
|
1001
280
|
|
1002
|
-
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
1003
282
|
|
283
|
+
> <Array(<FeatureFlag>, Integer, Hash)> get_feature_flag_with_http_info(proj_key, key, opts)
|
1004
284
|
|
285
|
+
```ruby
|
1005
286
|
begin
|
1006
|
-
#
|
1007
|
-
|
1008
|
-
p
|
287
|
+
# Get feature flag
|
288
|
+
data, status_code, headers = api_instance.get_feature_flag_with_http_info(proj_key, key, opts)
|
289
|
+
p status_code # => 2xx
|
290
|
+
p headers # => { ... }
|
291
|
+
p data # => <FeatureFlag>
|
1009
292
|
rescue LaunchDarklyApi::ApiError => e
|
1010
|
-
puts "
|
293
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_with_http_info: #{e}"
|
1011
294
|
end
|
1012
295
|
```
|
1013
296
|
|
1014
297
|
### Parameters
|
1015
298
|
|
1016
|
-
Name | Type | Description
|
1017
|
-
|
1018
|
-
**
|
1019
|
-
**
|
1020
|
-
**
|
1021
|
-
**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. |
|
299
|
+
| Name | Type | Description | Notes |
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
301
|
+
| **proj_key** | **String** | The project key | |
|
302
|
+
| **key** | **String** | The feature flag key | |
|
303
|
+
| **env** | **String** | Filter configurations by environment | [optional] |
|
1022
304
|
|
1023
305
|
### Return type
|
1024
306
|
|
1025
|
-
[**
|
307
|
+
[**FeatureFlag**](FeatureFlag.md)
|
1026
308
|
|
1027
309
|
### Authorization
|
1028
310
|
|
1029
|
-
[
|
311
|
+
[ApiKey](../README.md#ApiKey)
|
1030
312
|
|
1031
313
|
### HTTP request headers
|
1032
314
|
|
1033
|
-
|
1034
|
-
|
315
|
+
- **Content-Type**: Not defined
|
316
|
+
- **Accept**: application/json
|
317
|
+
|
1035
318
|
|
319
|
+
## get_feature_flag_status
|
1036
320
|
|
321
|
+
> <FlagStatusRep> get_feature_flag_status(proj_key, env_key, key)
|
1037
322
|
|
1038
|
-
|
1039
|
-
|
323
|
+
Get feature flag status
|
324
|
+
|
325
|
+
Get the status for a particular feature flag.
|
1040
326
|
|
1041
|
-
|
327
|
+
### Examples
|
1042
328
|
|
1043
|
-
### Example
|
1044
329
|
```ruby
|
1045
|
-
|
330
|
+
require 'time'
|
1046
331
|
require 'launchdarkly_api'
|
1047
332
|
# setup authorization
|
1048
333
|
LaunchDarklyApi.configure do |config|
|
1049
|
-
# Configure API key authorization:
|
1050
|
-
config.api_key['
|
334
|
+
# Configure API key authorization: ApiKey
|
335
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1051
336
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1052
|
-
#config.api_key_prefix['
|
337
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1053
338
|
end
|
1054
339
|
|
1055
340
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
341
|
+
proj_key = 'proj_key_example' # String | The project key
|
342
|
+
env_key = 'env_key_example' # String | The environment key
|
343
|
+
key = 'key_example' # String | The feature flag key
|
1056
344
|
|
1057
|
-
|
1058
|
-
|
1059
|
-
|
345
|
+
begin
|
346
|
+
# Get feature flag status
|
347
|
+
result = api_instance.get_feature_flag_status(proj_key, env_key, key)
|
348
|
+
p result
|
349
|
+
rescue LaunchDarklyApi::ApiError => e
|
350
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status: #{e}"
|
351
|
+
end
|
352
|
+
```
|
1060
353
|
|
1061
|
-
|
354
|
+
#### Using the get_feature_flag_status_with_http_info variant
|
1062
355
|
|
1063
|
-
|
356
|
+
This returns an Array which contains the response data, status code and headers.
|
1064
357
|
|
358
|
+
> <Array(<FlagStatusRep>, Integer, Hash)> get_feature_flag_status_with_http_info(proj_key, env_key, key)
|
1065
359
|
|
360
|
+
```ruby
|
1066
361
|
begin
|
1067
|
-
#
|
1068
|
-
|
1069
|
-
p
|
362
|
+
# Get feature flag status
|
363
|
+
data, status_code, headers = api_instance.get_feature_flag_status_with_http_info(proj_key, env_key, key)
|
364
|
+
p status_code # => 2xx
|
365
|
+
p headers # => { ... }
|
366
|
+
p data # => <FlagStatusRep>
|
1070
367
|
rescue LaunchDarklyApi::ApiError => e
|
1071
|
-
puts "
|
368
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_with_http_info: #{e}"
|
1072
369
|
end
|
1073
370
|
```
|
1074
371
|
|
1075
372
|
### Parameters
|
1076
373
|
|
1077
|
-
Name | Type | Description
|
1078
|
-
|
1079
|
-
**
|
1080
|
-
**
|
1081
|
-
**
|
1082
|
-
**semantic_patch_with_comment** | **Object**| Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. |
|
374
|
+
| Name | Type | Description | Notes |
|
375
|
+
| ---- | ---- | ----------- | ----- |
|
376
|
+
| **proj_key** | **String** | The project key | |
|
377
|
+
| **env_key** | **String** | The environment key | |
|
378
|
+
| **key** | **String** | The feature flag key | |
|
1083
379
|
|
1084
380
|
### Return type
|
1085
381
|
|
1086
|
-
[**
|
382
|
+
[**FlagStatusRep**](FlagStatusRep.md)
|
1087
383
|
|
1088
384
|
### Authorization
|
1089
385
|
|
1090
|
-
[
|
386
|
+
[ApiKey](../README.md#ApiKey)
|
1091
387
|
|
1092
388
|
### HTTP request headers
|
1093
389
|
|
1094
|
-
|
1095
|
-
|
390
|
+
- **Content-Type**: Not defined
|
391
|
+
- **Accept**: application/json
|
392
|
+
|
1096
393
|
|
394
|
+
## get_feature_flag_status_across_environments
|
1097
395
|
|
396
|
+
> <FeatureFlagStatusAcrossEnvironments> get_feature_flag_status_across_environments(proj_key, key, opts)
|
1098
397
|
|
1099
|
-
|
1100
|
-
> FeatureFlag patch_feature_flag(project_key, feature_flag_key, patch_comment)
|
398
|
+
Get flag status across environments
|
1101
399
|
|
1102
|
-
|
400
|
+
Get the status for a particular feature flag across environments.
|
401
|
+
|
402
|
+
### Examples
|
1103
403
|
|
1104
|
-
### Example
|
1105
404
|
```ruby
|
1106
|
-
|
405
|
+
require 'time'
|
1107
406
|
require 'launchdarkly_api'
|
1108
407
|
# setup authorization
|
1109
408
|
LaunchDarklyApi.configure do |config|
|
1110
|
-
# Configure API key authorization:
|
1111
|
-
config.api_key['
|
409
|
+
# Configure API key authorization: ApiKey
|
410
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1112
411
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1113
|
-
#config.api_key_prefix['
|
412
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1114
413
|
end
|
1115
414
|
|
1116
415
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
416
|
+
proj_key = 'proj_key_example' # String | The project key
|
417
|
+
key = 'key_example' # String | The feature flag key
|
418
|
+
opts = {
|
419
|
+
env: 'env_example' # String | Optional environment filter
|
420
|
+
}
|
1117
421
|
|
1118
|
-
|
422
|
+
begin
|
423
|
+
# Get flag status across environments
|
424
|
+
result = api_instance.get_feature_flag_status_across_environments(proj_key, key, opts)
|
425
|
+
p result
|
426
|
+
rescue LaunchDarklyApi::ApiError => e
|
427
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_across_environments: #{e}"
|
428
|
+
end
|
429
|
+
```
|
1119
430
|
|
1120
|
-
|
431
|
+
#### Using the get_feature_flag_status_across_environments_with_http_info variant
|
1121
432
|
|
1122
|
-
|
433
|
+
This returns an Array which contains the response data, status code and headers.
|
1123
434
|
|
435
|
+
> <Array(<FeatureFlagStatusAcrossEnvironments>, Integer, Hash)> get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts)
|
1124
436
|
|
437
|
+
```ruby
|
1125
438
|
begin
|
1126
|
-
#
|
1127
|
-
|
1128
|
-
p
|
439
|
+
# Get flag status across environments
|
440
|
+
data, status_code, headers = api_instance.get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts)
|
441
|
+
p status_code # => 2xx
|
442
|
+
p headers # => { ... }
|
443
|
+
p data # => <FeatureFlagStatusAcrossEnvironments>
|
1129
444
|
rescue LaunchDarklyApi::ApiError => e
|
1130
|
-
puts "
|
445
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_across_environments_with_http_info: #{e}"
|
1131
446
|
end
|
1132
447
|
```
|
1133
448
|
|
1134
449
|
### Parameters
|
1135
450
|
|
1136
|
-
Name | Type | Description
|
1137
|
-
|
1138
|
-
**
|
1139
|
-
**
|
1140
|
-
**
|
451
|
+
| Name | Type | Description | Notes |
|
452
|
+
| ---- | ---- | ----------- | ----- |
|
453
|
+
| **proj_key** | **String** | The project key | |
|
454
|
+
| **key** | **String** | The feature flag key | |
|
455
|
+
| **env** | **String** | Optional environment filter | [optional] |
|
1141
456
|
|
1142
457
|
### Return type
|
1143
458
|
|
1144
|
-
[**
|
459
|
+
[**FeatureFlagStatusAcrossEnvironments**](FeatureFlagStatusAcrossEnvironments.md)
|
1145
460
|
|
1146
461
|
### Authorization
|
1147
462
|
|
1148
|
-
[
|
463
|
+
[ApiKey](../README.md#ApiKey)
|
1149
464
|
|
1150
465
|
### HTTP request headers
|
1151
466
|
|
1152
|
-
|
1153
|
-
|
467
|
+
- **Content-Type**: Not defined
|
468
|
+
- **Accept**: application/json
|
469
|
+
|
470
|
+
|
471
|
+
## get_feature_flag_statuses
|
1154
472
|
|
473
|
+
> <FeatureFlagStatuses> get_feature_flag_statuses(proj_key, env_key)
|
1155
474
|
|
475
|
+
List feature flag statuses
|
1156
476
|
|
1157
|
-
|
1158
|
-
> FeatureFlagScheduledChange patch_flag_config_scheduled_change(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id)
|
477
|
+
Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - `new`: the feature flag was created within the last seven days, and has not been requested yet - `active`: the feature flag was requested by your servers or clients within the last seven days - `inactive`: the feature flag was created more than seven days ago, and hasn't been requested by your servers or clients within the past seven days - `launched`: one variation of the feature flag has been rolled out to all your users for at least 7 days
|
1159
478
|
|
1160
|
-
|
479
|
+
### Examples
|
1161
480
|
|
1162
|
-
### Example
|
1163
481
|
```ruby
|
1164
|
-
|
482
|
+
require 'time'
|
1165
483
|
require 'launchdarkly_api'
|
1166
484
|
# setup authorization
|
1167
485
|
LaunchDarklyApi.configure do |config|
|
1168
|
-
# Configure API key authorization:
|
1169
|
-
config.api_key['
|
486
|
+
# Configure API key authorization: ApiKey
|
487
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1170
488
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1171
|
-
#config.api_key_prefix['
|
489
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1172
490
|
end
|
1173
491
|
|
1174
492
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
493
|
+
proj_key = 'proj_key_example' # String | The project key
|
494
|
+
env_key = 'env_key_example' # String | Filter configurations by environment
|
1175
495
|
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1180
|
-
|
496
|
+
begin
|
497
|
+
# List feature flag statuses
|
498
|
+
result = api_instance.get_feature_flag_statuses(proj_key, env_key)
|
499
|
+
p result
|
500
|
+
rescue LaunchDarklyApi::ApiError => e
|
501
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_statuses: #{e}"
|
502
|
+
end
|
503
|
+
```
|
1181
504
|
|
1182
|
-
|
505
|
+
#### Using the get_feature_flag_statuses_with_http_info variant
|
1183
506
|
|
1184
|
-
|
507
|
+
This returns an Array which contains the response data, status code and headers.
|
1185
508
|
|
509
|
+
> <Array(<FeatureFlagStatuses>, Integer, Hash)> get_feature_flag_statuses_with_http_info(proj_key, env_key)
|
1186
510
|
|
511
|
+
```ruby
|
1187
512
|
begin
|
1188
|
-
#
|
1189
|
-
|
1190
|
-
p
|
513
|
+
# List feature flag statuses
|
514
|
+
data, status_code, headers = api_instance.get_feature_flag_statuses_with_http_info(proj_key, env_key)
|
515
|
+
p status_code # => 2xx
|
516
|
+
p headers # => { ... }
|
517
|
+
p data # => <FeatureFlagStatuses>
|
1191
518
|
rescue LaunchDarklyApi::ApiError => e
|
1192
|
-
puts "
|
519
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_statuses_with_http_info: #{e}"
|
1193
520
|
end
|
1194
521
|
```
|
1195
522
|
|
1196
523
|
### Parameters
|
1197
524
|
|
1198
|
-
Name | Type | Description
|
1199
|
-
|
1200
|
-
**
|
1201
|
-
**
|
1202
|
-
**flag_config_scheduled_changes_patch_body** | [**FlagConfigScheduledChangesPatchBody**](FlagConfigScheduledChangesPatchBody.md)| Update scheduled changes on a feature flag. |
|
1203
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1204
|
-
**scheduled_change_id** | **String**| The id of the scheduled change |
|
525
|
+
| Name | Type | Description | Notes |
|
526
|
+
| ---- | ---- | ----------- | ----- |
|
527
|
+
| **proj_key** | **String** | The project key | |
|
528
|
+
| **env_key** | **String** | Filter configurations by environment | |
|
1205
529
|
|
1206
530
|
### Return type
|
1207
531
|
|
1208
|
-
[**
|
532
|
+
[**FeatureFlagStatuses**](FeatureFlagStatuses.md)
|
1209
533
|
|
1210
534
|
### Authorization
|
1211
535
|
|
1212
|
-
[
|
536
|
+
[ApiKey](../README.md#ApiKey)
|
1213
537
|
|
1214
538
|
### HTTP request headers
|
1215
539
|
|
1216
|
-
|
1217
|
-
|
540
|
+
- **Content-Type**: Not defined
|
541
|
+
- **Accept**: application/json
|
542
|
+
|
1218
543
|
|
544
|
+
## get_feature_flags
|
1219
545
|
|
546
|
+
> <FeatureFlags> get_feature_flags(proj_key, opts)
|
1220
547
|
|
1221
|
-
|
1222
|
-
> ApprovalRequest post_apply_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body)
|
548
|
+
List feature flags
|
1223
549
|
|
1224
|
-
|
550
|
+
Get a list of all features in the given project. By default, each feature includes configurations for each environment. You can filter environments with the env query parameter. For example, setting `env=production` restricts the returned configurations to just your production environment. You can also filter feature flags by tag with the tag query parameter. We support the following fields for filters: - `query` is a string that matches against the flags' keys and names. It is not case sensitive. - `archived` is a boolean to filter the list to archived flags. When this is absent, only unarchived flags are returned. - `type` is a string allowing filtering to `temporary` or `permanent` flags. - `status` is a string allowing filtering to `new`, `inactive`, `active`, or `launched` flags in the specified environment. This filter also requires a `filterEnv` field to be set to a valid environment. For example: `filter=status:active,filterEnv:production`. - `tags` is a + separated list of tags. It filters the list to members who have all of the tags in the list. - `hasExperiment` is a boolean with values of true or false and returns any flags that have an attached metric. - `hasDataExport` is a boolean with values of true or false and returns any flags that are currently exporting data in the specified environment. This includes flags that are exporting data via Experimentation. This filter also requires a `filterEnv` field to be set to a valid environment key. e.g. `filter=hasExperiment:true,filterEnv:production` - `evaluated` is an object that contains a key of `after` and a value in Unix time in milliseconds. This returns all flags that have been evaluated since the time you specify in the environment provided. This filter also requires a `filterEnv` field to be set to a valid environment. For example: `filter=evaluated:{\"after\": 1590768455282},filterEnv:production`. - `filterEnv` is a string with the key of a valid environment. The filterEnv field is used for filters that are environment specific. If there are multiple environment specific filters you should only declare this parameter once. For example: `filter=evaluated:{\"after\": 1590768455282},filterEnv:production,status:active`. An example filter is `query:abc,tags:foo+bar`. This matches flags with the string `abc` in their key or name, ignoring case, which also have the tags `foo` and `bar`. By default, this returns all flags. You can page through the list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links will not be present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page.
|
551
|
+
|
552
|
+
### Examples
|
1225
553
|
|
1226
|
-
### Example
|
1227
554
|
```ruby
|
1228
|
-
|
555
|
+
require 'time'
|
1229
556
|
require 'launchdarkly_api'
|
1230
557
|
# setup authorization
|
1231
558
|
LaunchDarklyApi.configure do |config|
|
1232
|
-
# Configure API key authorization:
|
1233
|
-
config.api_key['
|
559
|
+
# Configure API key authorization: ApiKey
|
560
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1234
561
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1235
|
-
#config.api_key_prefix['
|
562
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1236
563
|
end
|
1237
564
|
|
1238
565
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
566
|
+
proj_key = 'proj_key_example' # String | The project key
|
567
|
+
opts = {
|
568
|
+
env: 'env_example', # String | Filter configurations by environment
|
569
|
+
tag: 'tag_example', # String | Filter feature flags by tag
|
570
|
+
limit: 789, # Integer | The number of feature flags to return. Defaults to -1, which returns all flags
|
571
|
+
offset: 789, # Integer | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next limit items
|
572
|
+
archived: true, # Boolean | A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned
|
573
|
+
summary: true, # Boolean | By default in API version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned
|
574
|
+
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value
|
575
|
+
sort: 'sort_example' # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
|
576
|
+
}
|
1239
577
|
|
1240
|
-
|
1241
|
-
|
1242
|
-
|
1243
|
-
|
1244
|
-
|
578
|
+
begin
|
579
|
+
# List feature flags
|
580
|
+
result = api_instance.get_feature_flags(proj_key, opts)
|
581
|
+
p result
|
582
|
+
rescue LaunchDarklyApi::ApiError => e
|
583
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flags: #{e}"
|
584
|
+
end
|
585
|
+
```
|
1245
586
|
|
1246
|
-
|
587
|
+
#### Using the get_feature_flags_with_http_info variant
|
1247
588
|
|
1248
|
-
|
589
|
+
This returns an Array which contains the response data, status code and headers.
|
1249
590
|
|
591
|
+
> <Array(<FeatureFlags>, Integer, Hash)> get_feature_flags_with_http_info(proj_key, opts)
|
1250
592
|
|
593
|
+
```ruby
|
1251
594
|
begin
|
1252
|
-
#
|
1253
|
-
|
1254
|
-
p
|
595
|
+
# List feature flags
|
596
|
+
data, status_code, headers = api_instance.get_feature_flags_with_http_info(proj_key, opts)
|
597
|
+
p status_code # => 2xx
|
598
|
+
p headers # => { ... }
|
599
|
+
p data # => <FeatureFlags>
|
1255
600
|
rescue LaunchDarklyApi::ApiError => e
|
1256
|
-
puts "
|
601
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flags_with_http_info: #{e}"
|
1257
602
|
end
|
1258
603
|
```
|
1259
604
|
|
1260
605
|
### Parameters
|
1261
606
|
|
1262
|
-
Name | Type | Description
|
1263
|
-
|
1264
|
-
**
|
1265
|
-
**
|
1266
|
-
**
|
1267
|
-
**
|
1268
|
-
**
|
607
|
+
| Name | Type | Description | Notes |
|
608
|
+
| ---- | ---- | ----------- | ----- |
|
609
|
+
| **proj_key** | **String** | The project key | |
|
610
|
+
| **env** | **String** | Filter configurations by environment | [optional] |
|
611
|
+
| **tag** | **String** | Filter feature flags by tag | [optional] |
|
612
|
+
| **limit** | **Integer** | The number of feature flags to return. Defaults to -1, which returns all flags | [optional] |
|
613
|
+
| **offset** | **Integer** | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next limit items | [optional] |
|
614
|
+
| **archived** | **Boolean** | A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned | [optional] |
|
615
|
+
| **summary** | **Boolean** | By default in API version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned | [optional] |
|
616
|
+
| **filter** | **String** | A comma-separated list of filters. Each filter is of the form field:value | [optional] |
|
617
|
+
| **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order | [optional] |
|
1269
618
|
|
1270
619
|
### Return type
|
1271
620
|
|
1272
|
-
[**
|
621
|
+
[**FeatureFlags**](FeatureFlags.md)
|
1273
622
|
|
1274
623
|
### Authorization
|
1275
624
|
|
1276
|
-
[
|
625
|
+
[ApiKey](../README.md#ApiKey)
|
1277
626
|
|
1278
627
|
### HTTP request headers
|
1279
628
|
|
1280
|
-
|
1281
|
-
|
629
|
+
- **Content-Type**: Not defined
|
630
|
+
- **Accept**: application/json
|
631
|
+
|
1282
632
|
|
633
|
+
## patch_expiring_user_targets
|
1283
634
|
|
635
|
+
> <ExpiringUserTargetPatchResponse> patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment)
|
1284
636
|
|
1285
|
-
|
1286
|
-
> ApprovalRequest post_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, , opts)
|
637
|
+
Update expiring user targets on feature flag
|
1287
638
|
|
1288
|
-
|
639
|
+
Update the list of user targets on a feature flag that are scheduled for removal.
|
640
|
+
|
641
|
+
### Examples
|
1289
642
|
|
1290
|
-
### Example
|
1291
643
|
```ruby
|
1292
|
-
|
644
|
+
require 'time'
|
1293
645
|
require 'launchdarkly_api'
|
1294
646
|
# setup authorization
|
1295
647
|
LaunchDarklyApi.configure do |config|
|
1296
|
-
# Configure API key authorization:
|
1297
|
-
config.api_key['
|
648
|
+
# Configure API key authorization: ApiKey
|
649
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1298
650
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1299
|
-
#config.api_key_prefix['
|
651
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1300
652
|
end
|
1301
653
|
|
1302
654
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
655
|
+
proj_key = 'proj_key_example' # String | The project key.
|
656
|
+
env_key = 'env_key_example' # String | The environment key.
|
657
|
+
flag_key = 'flag_key_example' # String | The feature flag key.
|
658
|
+
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})]}) # PatchWithComment |
|
1303
659
|
|
1304
|
-
|
1305
|
-
|
1306
|
-
|
660
|
+
begin
|
661
|
+
# Update expiring user targets on feature flag
|
662
|
+
result = api_instance.patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment)
|
663
|
+
p result
|
664
|
+
rescue LaunchDarklyApi::ApiError => e
|
665
|
+
puts "Error when calling FeatureFlagsApi->patch_expiring_user_targets: #{e}"
|
666
|
+
end
|
667
|
+
```
|
1307
668
|
|
1308
|
-
|
669
|
+
#### Using the patch_expiring_user_targets_with_http_info variant
|
1309
670
|
|
1310
|
-
|
671
|
+
This returns an Array which contains the response data, status code and headers.
|
1311
672
|
|
1312
|
-
|
1313
|
-
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
1314
|
-
}
|
673
|
+
> <Array(<ExpiringUserTargetPatchResponse>, Integer, Hash)> patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment)
|
1315
674
|
|
675
|
+
```ruby
|
1316
676
|
begin
|
1317
|
-
#
|
1318
|
-
|
1319
|
-
p
|
677
|
+
# Update expiring user targets on feature flag
|
678
|
+
data, status_code, headers = api_instance.patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment)
|
679
|
+
p status_code # => 2xx
|
680
|
+
p headers # => { ... }
|
681
|
+
p data # => <ExpiringUserTargetPatchResponse>
|
1320
682
|
rescue LaunchDarklyApi::ApiError => e
|
1321
|
-
puts "
|
683
|
+
puts "Error when calling FeatureFlagsApi->patch_expiring_user_targets_with_http_info: #{e}"
|
1322
684
|
end
|
1323
685
|
```
|
1324
686
|
|
1325
687
|
### Parameters
|
1326
688
|
|
1327
|
-
Name | Type | Description
|
1328
|
-
|
1329
|
-
**
|
1330
|
-
**
|
1331
|
-
**
|
1332
|
-
**
|
1333
|
-
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
689
|
+
| Name | Type | Description | Notes |
|
690
|
+
| ---- | ---- | ----------- | ----- |
|
691
|
+
| **proj_key** | **String** | The project key. | |
|
692
|
+
| **env_key** | **String** | The environment key. | |
|
693
|
+
| **flag_key** | **String** | The feature flag key. | |
|
694
|
+
| **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
|
1334
695
|
|
1335
696
|
### Return type
|
1336
697
|
|
1337
|
-
[**
|
698
|
+
[**ExpiringUserTargetPatchResponse**](ExpiringUserTargetPatchResponse.md)
|
1338
699
|
|
1339
700
|
### Authorization
|
1340
701
|
|
1341
|
-
[
|
702
|
+
[ApiKey](../README.md#ApiKey)
|
1342
703
|
|
1343
704
|
### HTTP request headers
|
1344
705
|
|
1345
|
-
|
1346
|
-
|
706
|
+
- **Content-Type**: application/json
|
707
|
+
- **Accept**: application/json
|
708
|
+
|
1347
709
|
|
710
|
+
## patch_feature_flag
|
1348
711
|
|
712
|
+
> <FeatureFlag> patch_feature_flag(proj_key, key, patch_with_comment)
|
1349
713
|
|
1350
|
-
|
1351
|
-
> ApprovalRequest post_approval_request_flag_copy(project_key, feature_flag_key, environment_key, , opts)
|
714
|
+
Update feature flag
|
1352
715
|
|
1353
|
-
Create an approval request to copy feature flag config
|
716
|
+
Perform a partial update to a feature flag. ## Using JSON Patches on a feature flag When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: ```json { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ``` If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` ## Using semantic patches on a feature flag To use a [semantic patch](/reference#updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you will receive a `400` response because your semantic patch will be interpreted as a JSON patch. Use this header: ``` Content-Type: application/json; domain-model=launchdarkly.semanticpatch ``` The body of a semantic patch request takes the following three properties: 1. comment `string`: (Optional) A description of the update. 1. environmentKey `string`: (Required) The key of the LaunchDarkly environment. 1. instructions `array`: (Required) The action or list of actions to be performed by the update. Each update action in the list must be an object/hash table with a `kind` property, although depending on the action, other properties may be necessary. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, `removeUserTargets` does nothing when the targets have already been removed). They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn't correspond to a variation on the flag or a rule ID that doesn't belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions. ### Instructions #### `turnFlagOn` Sets the flag's targeting state to on. #### `turnFlagOff` Sets the flag's targeting state to off. #### `addUserTargets` Adds the user keys in `values` to the individual user targets for the variation specified by `variationId`. Returns an error if this causes the same user key to be targeted in multiple variations. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `removeUserTargets` Removes the user keys in `values` to the individual user targets for the variation specified by `variationId`. Does nothing if the user keys are not targeted. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `replaceUserTargets` Completely replaces the existing set of user targeting. All variations must be provided. Example: ```json { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"variation-1\", \"values\": [\"blah\", \"foo\", \"bar\"] }, { \"variationId\": \"variation-2\", \"values\": [\"abc\", \"def\"] } ] } ``` ##### Parameters - `targets`: a list of user targeting #### `clearUserTargets` Removes all individual user targets from the variation specified by `variationId` ##### Parameters - `variationId`: ID of a variation on the flag #### `addPrerequisite` Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag. ##### Parameters - `key`: flag key of another flag - `variationId`: ID of a variation of the flag with key `key` #### `removePrerequisite` Removes the prerequisite indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite #### `updatePrerequisite` Changes the prerequisite with flag key `key` to the variation indicated by `variationId`. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite - `variationId`: ID of a variation of the flag with key `key` #### `replacePrerequisites` Completely replaces the existing set of prerequisites for a given flag. Example: ```json { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"flag-key\", \"variationId\": \"variation-1\" }, { \"key\": \"another-flag\", \"variationId\": \"variation-2\" } ] } ``` ##### Parameters - `prerequisites`: a list of prerequisites #### `addRule` Adds a new rule to the flag with the given `clauses` which serves the variation indicated by `variationId` or the percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. If `beforeRuleId` is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list. ##### Parameters - `clauses`: Array of clauses (see `addClauses`) - `beforeRuleId`: Optional ID of a rule in the flag - `variationId`: ID of a variation of the flag - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `removeRule` Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag #### `replaceRules` Completely replaces the existing rules for a given flag. Example: ```json { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"variation-1\", \"description\": \"myRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ``` ##### Parameters - `rules`: a list of rules #### `addClauses` Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauses`: Array of clause objects, with `attribute` (string), `op` (string), and `values` (array of strings, numbers, or dates) properties. #### `removeClauses` Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. #### Parameters - `ruleId`: ID of a rule in the flag - `clauseIds`: Array of IDs of clauses in the rule #### `updateClause` Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `clause`: Clause object #### `addValuesToClause` Adds `values` to the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `values`: Array of strings #### `removeValuesFromClause` Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters `ruleId`: ID of a rule in the flag `clauseId`: ID of a clause in that rule `values`: Array of strings #### `reorderRules` Rearranges the rules to match the order given in `ruleIds`. Will return an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag #### `updateRuleVariationOrRollout` Updates what the rule indicated by `ruleId` serves if its clauses evaluate to true. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters - `ruleId`: ID of a rule in the flag - `variationId`: ID of a variation of the flag or - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `updateFallthroughVariationOrRollout` Updates the flag's fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters `variationId`: ID of a variation of the flag or `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) `rolloutBucketBy`: Optional user attribute #### `updateOffVariation` Updates the variation served when the flag's targeting is off to the variation indicated by `variationId`. ##### Parameters `variationId`: ID of a variation of the flag ### Example ```json { \"environmentKey\": \"production\", \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"turnFlagOff\" }, { \"kind\": \"addUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId\", \"userId2\"] }, { \"kind\": \"removeUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId3\", \"userId4\"] }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": null }, { \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } ], \"variationId\": null, \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": \"key\" }, { \"kind\": \"removeRule\", \"ruleId\": \"99f12464-a429-40fc-86cc-b27612188955\" }, { \"kind\": \"reorderRules\", \"ruleIds\": [\"2f72974e-de68-4243-8dd3-739582147a1f\", \"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"addClauses\", \"ruleId\": \"1134\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"in\", \"negate\": false, \"values\": [\"test@test.com\"] } ] }, { \"kind\": \"removeClauses\", \"ruleId\": \"1242529\", \"clauseIds\": [\"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"updateClause\", \"ruleId\": \"2f72974e-de68-4243-8dd3-739582147a1f\", \"clauseId\": \"309845\", \"clause\": { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } }, { \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"2342\", \"rolloutWeights\": null, \"rolloutBucketBy\": null }, { \"kind\": \"updateOffVariation\", \"variationId\": \"3242453\" }, { \"kind\": \"addPrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"updatePrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"removePrerequisite\", \"key\": \"flagKey\" } ] } ``` ## Using JSON patches on a feature flag If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch).
|
717
|
+
|
718
|
+
### Examples
|
1354
719
|
|
1355
|
-
### Example
|
1356
720
|
```ruby
|
1357
|
-
|
721
|
+
require 'time'
|
1358
722
|
require 'launchdarkly_api'
|
1359
723
|
# setup authorization
|
1360
724
|
LaunchDarklyApi.configure do |config|
|
1361
|
-
# Configure API key authorization:
|
1362
|
-
config.api_key['
|
725
|
+
# Configure API key authorization: ApiKey
|
726
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1363
727
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1364
|
-
#config.api_key_prefix['
|
728
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1365
729
|
end
|
1366
730
|
|
1367
731
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1368
|
-
|
1369
|
-
|
1370
|
-
|
1371
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1372
|
-
|
1373
|
-
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.
|
1374
|
-
|
1375
|
-
opts = {
|
1376
|
-
approval_request_flag_config_copy_body: LaunchDarklyApi::ApprovalRequestFlagConfigCopyBody.new # ApprovalRequestFlagConfigCopyBody | Create a new approval request
|
1377
|
-
}
|
732
|
+
proj_key = 'proj_key_example' # String | The project key.
|
733
|
+
key = 'key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
734
|
+
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})]}) # PatchWithComment |
|
1378
735
|
|
1379
736
|
begin
|
1380
|
-
#
|
1381
|
-
result = api_instance.
|
737
|
+
# Update feature flag
|
738
|
+
result = api_instance.patch_feature_flag(proj_key, key, patch_with_comment)
|
1382
739
|
p result
|
1383
740
|
rescue LaunchDarklyApi::ApiError => e
|
1384
|
-
puts "
|
741
|
+
puts "Error when calling FeatureFlagsApi->patch_feature_flag: #{e}"
|
1385
742
|
end
|
1386
743
|
```
|
1387
744
|
|
1388
|
-
|
1389
|
-
|
1390
|
-
Name | Type | Description | Notes
|
1391
|
-
------------- | ------------- | ------------- | -------------
|
1392
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1393
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1394
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1395
|
-
**approval_request_flag_config_copy_body** | [**ApprovalRequestFlagConfigCopyBody**](ApprovalRequestFlagConfigCopyBody.md)| Create a new approval request | [optional]
|
1396
|
-
|
1397
|
-
### Return type
|
1398
|
-
|
1399
|
-
[**ApprovalRequest**](ApprovalRequest.md)
|
1400
|
-
|
1401
|
-
### Authorization
|
1402
|
-
|
1403
|
-
[Token](../README.md#Token)
|
1404
|
-
|
1405
|
-
### HTTP request headers
|
1406
|
-
|
1407
|
-
- **Content-Type**: application/json
|
1408
|
-
- **Accept**: application/json
|
745
|
+
#### Using the patch_feature_flag_with_http_info variant
|
1409
746
|
|
747
|
+
This returns an Array which contains the response data, status code and headers.
|
1410
748
|
|
749
|
+
> <Array(<FeatureFlag>, Integer, Hash)> patch_feature_flag_with_http_info(proj_key, key, patch_with_comment)
|
1411
750
|
|
1412
|
-
# **post_feature_flag**
|
1413
|
-
> FeatureFlag post_feature_flag(project_key, feature_flag_body, opts)
|
1414
|
-
|
1415
|
-
Creates a new feature flag.
|
1416
|
-
|
1417
|
-
### Example
|
1418
751
|
```ruby
|
1419
|
-
# load the gem
|
1420
|
-
require 'launchdarkly_api'
|
1421
|
-
# setup authorization
|
1422
|
-
LaunchDarklyApi.configure do |config|
|
1423
|
-
# Configure API key authorization: Token
|
1424
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1425
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1426
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1427
|
-
end
|
1428
|
-
|
1429
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1430
|
-
|
1431
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1432
|
-
|
1433
|
-
feature_flag_body = LaunchDarklyApi::FeatureFlagBody.new # FeatureFlagBody | Create a new feature flag.
|
1434
|
-
|
1435
|
-
opts = {
|
1436
|
-
clone: 'clone_example' # String | The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting clone=flagKey will copy the full targeting configuration for all environments (including on/off state) from the original flag to the new flag.
|
1437
|
-
}
|
1438
|
-
|
1439
752
|
begin
|
1440
|
-
#
|
1441
|
-
|
1442
|
-
p
|
753
|
+
# Update feature flag
|
754
|
+
data, status_code, headers = api_instance.patch_feature_flag_with_http_info(proj_key, key, patch_with_comment)
|
755
|
+
p status_code # => 2xx
|
756
|
+
p headers # => { ... }
|
757
|
+
p data # => <FeatureFlag>
|
1443
758
|
rescue LaunchDarklyApi::ApiError => e
|
1444
|
-
puts "
|
759
|
+
puts "Error when calling FeatureFlagsApi->patch_feature_flag_with_http_info: #{e}"
|
1445
760
|
end
|
1446
761
|
```
|
1447
762
|
|
1448
763
|
### Parameters
|
1449
764
|
|
1450
|
-
Name | Type | Description
|
1451
|
-
|
1452
|
-
**
|
1453
|
-
**
|
1454
|
-
**
|
765
|
+
| Name | Type | Description | Notes |
|
766
|
+
| ---- | ---- | ----------- | ----- |
|
767
|
+
| **proj_key** | **String** | The project key. | |
|
768
|
+
| **key** | **String** | The feature flag's key. The key identifies the flag in your code. | |
|
769
|
+
| **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
|
1455
770
|
|
1456
771
|
### Return type
|
1457
772
|
|
@@ -1459,137 +774,87 @@ Name | Type | Description | Notes
|
|
1459
774
|
|
1460
775
|
### Authorization
|
1461
776
|
|
1462
|
-
[
|
777
|
+
[ApiKey](../README.md#ApiKey)
|
1463
778
|
|
1464
779
|
### HTTP request headers
|
1465
780
|
|
1466
|
-
|
1467
|
-
|
781
|
+
- **Content-Type**: application/json
|
782
|
+
- **Accept**: application/json
|
783
|
+
|
1468
784
|
|
785
|
+
## post_feature_flag
|
1469
786
|
|
787
|
+
> <FeatureFlag> post_feature_flag(proj_key, feature_flag_body, opts)
|
1470
788
|
|
1471
|
-
|
1472
|
-
> FeatureFlagScheduledChange post_flag_config_scheduled_changes(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, )
|
789
|
+
Create a feature flag
|
1473
790
|
|
1474
|
-
|
791
|
+
Create a feature flag with the given name, key, and variations
|
792
|
+
|
793
|
+
### Examples
|
1475
794
|
|
1476
|
-
### Example
|
1477
795
|
```ruby
|
1478
|
-
|
796
|
+
require 'time'
|
1479
797
|
require 'launchdarkly_api'
|
1480
798
|
# setup authorization
|
1481
799
|
LaunchDarklyApi.configure do |config|
|
1482
|
-
# Configure API key authorization:
|
1483
|
-
config.api_key['
|
800
|
+
# Configure API key authorization: ApiKey
|
801
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1484
802
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1485
|
-
#config.api_key_prefix['
|
803
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1486
804
|
end
|
1487
805
|
|
1488
806
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1489
|
-
|
1490
|
-
|
1491
|
-
|
1492
|
-
|
1493
|
-
|
1494
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1495
|
-
|
1496
|
-
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.
|
1497
|
-
|
807
|
+
proj_key = 'proj_key_example' # String | The project key.
|
808
|
+
feature_flag_body = LaunchDarklyApi::FeatureFlagBody.new({name: 'name_example', key: 'key_example'}) # FeatureFlagBody |
|
809
|
+
opts = {
|
810
|
+
clone: 'clone_example' # String | The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag.
|
811
|
+
}
|
1498
812
|
|
1499
813
|
begin
|
1500
|
-
#
|
1501
|
-
result = api_instance.
|
814
|
+
# Create a feature flag
|
815
|
+
result = api_instance.post_feature_flag(proj_key, feature_flag_body, opts)
|
1502
816
|
p result
|
1503
817
|
rescue LaunchDarklyApi::ApiError => e
|
1504
|
-
puts "
|
818
|
+
puts "Error when calling FeatureFlagsApi->post_feature_flag: #{e}"
|
1505
819
|
end
|
1506
820
|
```
|
1507
821
|
|
1508
|
-
|
1509
|
-
|
1510
|
-
Name | Type | Description | Notes
|
1511
|
-
------------- | ------------- | ------------- | -------------
|
1512
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1513
|
-
**flag_config_scheduled_changes_post_body** | [**FlagConfigScheduledChangesPostBody**](FlagConfigScheduledChangesPostBody.md)| Create scheduled changes on a feature flag. |
|
1514
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1515
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1516
|
-
|
1517
|
-
### Return type
|
1518
|
-
|
1519
|
-
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
1520
|
-
|
1521
|
-
### Authorization
|
1522
|
-
|
1523
|
-
[Token](../README.md#Token)
|
1524
|
-
|
1525
|
-
### HTTP request headers
|
1526
|
-
|
1527
|
-
- **Content-Type**: application/json
|
1528
|
-
- **Accept**: application/json
|
1529
|
-
|
822
|
+
#### Using the post_feature_flag_with_http_info variant
|
1530
823
|
|
824
|
+
This returns an Array which contains the response data, status code and headers.
|
1531
825
|
|
1532
|
-
|
1533
|
-
> ApprovalRequest post_review_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body)
|
826
|
+
> <Array(<FeatureFlag>, Integer, Hash)> post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
|
1534
827
|
|
1535
|
-
Review approval request for a feature flag config
|
1536
|
-
|
1537
|
-
### Example
|
1538
828
|
```ruby
|
1539
|
-
# load the gem
|
1540
|
-
require 'launchdarkly_api'
|
1541
|
-
# setup authorization
|
1542
|
-
LaunchDarklyApi.configure do |config|
|
1543
|
-
# Configure API key authorization: Token
|
1544
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1545
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1546
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1547
|
-
end
|
1548
|
-
|
1549
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1550
|
-
|
1551
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1552
|
-
|
1553
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1554
|
-
|
1555
|
-
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.
|
1556
|
-
|
1557
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
1558
|
-
|
1559
|
-
approval_request_review_config_body = LaunchDarklyApi::ApprovalRequestReviewConfigBody.new # ApprovalRequestReviewConfigBody | Review an approval request
|
1560
|
-
|
1561
|
-
|
1562
829
|
begin
|
1563
|
-
#
|
1564
|
-
|
1565
|
-
p
|
830
|
+
# Create a feature flag
|
831
|
+
data, status_code, headers = api_instance.post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
|
832
|
+
p status_code # => 2xx
|
833
|
+
p headers # => { ... }
|
834
|
+
p data # => <FeatureFlag>
|
1566
835
|
rescue LaunchDarklyApi::ApiError => e
|
1567
|
-
puts "
|
836
|
+
puts "Error when calling FeatureFlagsApi->post_feature_flag_with_http_info: #{e}"
|
1568
837
|
end
|
1569
838
|
```
|
1570
839
|
|
1571
840
|
### Parameters
|
1572
841
|
|
1573
|
-
Name | Type | Description
|
1574
|
-
|
1575
|
-
**
|
1576
|
-
**
|
1577
|
-
**
|
1578
|
-
**approval_request_id** | **String**| The approval request ID |
|
1579
|
-
**approval_request_review_config_body** | [**ApprovalRequestReviewConfigBody**](ApprovalRequestReviewConfigBody.md)| Review an approval request |
|
842
|
+
| Name | Type | Description | Notes |
|
843
|
+
| ---- | ---- | ----------- | ----- |
|
844
|
+
| **proj_key** | **String** | The project key. | |
|
845
|
+
| **feature_flag_body** | [**FeatureFlagBody**](FeatureFlagBody.md) | | |
|
846
|
+
| **clone** | **String** | The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag. | [optional] |
|
1580
847
|
|
1581
848
|
### Return type
|
1582
849
|
|
1583
|
-
[**
|
850
|
+
[**FeatureFlag**](FeatureFlag.md)
|
1584
851
|
|
1585
852
|
### Authorization
|
1586
853
|
|
1587
|
-
[
|
854
|
+
[ApiKey](../README.md#ApiKey)
|
1588
855
|
|
1589
856
|
### HTTP request headers
|
1590
857
|
|
1591
|
-
|
1592
|
-
|
1593
|
-
|
1594
|
-
|
858
|
+
- **Content-Type**: application/json
|
859
|
+
- **Accept**: application/json
|
1595
860
|
|