launchdarkly_api 5.3.0 → 7.0.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 +814 -260
- 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 +376 -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 +976 -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/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/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 +409 -1079
- 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/ForbiddenErrorRep.md +20 -0
- data/docs/HunkRep.md +26 -0
- data/docs/IntegrationMetadata.md +24 -0
- data/docs/IntegrationStatus.md +20 -0
- 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/MemberPermissionGrantSummaryRep.md +22 -0
- data/docs/MemberSummaryRep.md +28 -0
- data/docs/MemberTeamSummaryRep.md +22 -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 +26 -0
- data/docs/RateLimitedErrorRep.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 +23 -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/Target.md +15 -4
- data/docs/TargetResourceRep.md +22 -0
- data/docs/TeamCollectionRep.md +22 -0
- data/docs/TeamPatchInput.md +20 -0
- data/docs/TeamPostInput.md +28 -0
- data/docs/TeamRep.md +40 -0
- data/docs/TeamsBetaApi.md +374 -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/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 +359 -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 +923 -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 +504 -1327
- data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -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 +356 -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_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/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/forbidden_error_rep.rb +227 -0
- data/lib/launchdarkly_api/models/hunk_rep.rb +266 -0
- 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/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_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/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 +444 -0
- data/lib/launchdarkly_api/models/metric_post.rb +368 -0
- data/lib/launchdarkly_api/models/metric_rep.rb +493 -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 +275 -0
- data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +227 -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 +77 -33
- 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/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_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/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 +163 -95
- data/spec/api/access_tokens_api_spec.rb +23 -17
- data/spec/api/account_members_api_spec.rb +99 -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 +206 -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 +70 -253
- data/spec/api/feature_flags_beta_api_spec.rb +62 -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 +98 -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_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/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/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_status_spec.rb +40 -0
- 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_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/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 +140 -0
- data/spec/models/metric_post_spec.rb +104 -0
- data/spec/models/metric_rep_spec.rb +170 -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 +58 -0
- data/spec/models/rate_limited_error_rep_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 +11 -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/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_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/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 +953 -576
- data/docs/ApprovalRequest.md +0 -20
- data/docs/ApprovalRequestApplyConfigBody.md +0 -8
- data/docs/ApprovalRequestConfigBody.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/Integration.md +0 -9
- data/docs/IntegrationSubscription.md +0 -16
- data/docs/IntegrationSubscriptionStatus.md +0 -10
- data/docs/Integrations.md +0 -9
- 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/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 -337
- 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_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.rb +0 -195
- 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/integrations.rb +0 -196
- 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/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 -4851
- 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_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 -117
- 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_spec.rb +0 -47
- data/spec/models/integration_subscription__status_spec.rb +0 -53
- data/spec/models/integration_subscription_spec.rb +0 -89
- data/spec/models/integrations_spec.rb +0 -47
- 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/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,605 +1,306 @@
|
|
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_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
|
30
|
-
[**post_flag_config_scheduled_changes**](FeatureFlagsApi.md#post_flag_config_scheduled_changes) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Creates a new scheduled change for a feature flag.
|
31
|
-
[**post_review_approval_request**](FeatureFlagsApi.md#post_review_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/review | Review approval request for a feature flag config
|
32
|
-
|
33
|
-
|
34
|
-
# **copy_feature_flag**
|
35
|
-
> FeatureFlag copy_feature_flag(project_key, feature_flag_key, feature_flag_copy_body)
|
36
|
-
|
37
|
-
Copies the feature flag configuration from one environment to the same feature flag in another environment.
|
38
|
-
|
39
|
-
### Example
|
40
|
-
```ruby
|
41
|
-
# load the gem
|
42
|
-
require 'launchdarkly_api'
|
43
|
-
# setup authorization
|
44
|
-
LaunchDarklyApi.configure do |config|
|
45
|
-
# Configure API key authorization: Token
|
46
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
47
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
48
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
49
|
-
end
|
50
|
-
|
51
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
3
|
+
All URIs are relative to *https://app.launchdarkly.com*
|
52
4
|
|
53
|
-
|
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 |
|
54
18
|
|
55
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
56
19
|
|
57
|
-
|
20
|
+
## copy_feature_flag
|
58
21
|
|
22
|
+
> <FeatureFlag> copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post)
|
59
23
|
|
60
|
-
|
61
|
-
#Copies the feature flag configuration from one environment to the same feature flag in another environment.
|
62
|
-
result = api_instance.copy_feature_flag(project_key, feature_flag_key, feature_flag_copy_body)
|
63
|
-
p result
|
64
|
-
rescue LaunchDarklyApi::ApiError => e
|
65
|
-
puts "Exception when calling FeatureFlagsApi->copy_feature_flag: #{e}"
|
66
|
-
end
|
67
|
-
```
|
24
|
+
Copy feature flag
|
68
25
|
|
69
|
-
|
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.
|
70
27
|
|
71
|
-
|
72
|
-
------------- | ------------- | ------------- | -------------
|
73
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
74
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
75
|
-
**feature_flag_copy_body** | [**FeatureFlagCopyBody**](FeatureFlagCopyBody.md)| Copy feature flag configurations between environments. |
|
28
|
+
### Examples
|
76
29
|
|
77
|
-
### Return type
|
78
|
-
|
79
|
-
[**FeatureFlag**](FeatureFlag.md)
|
80
|
-
|
81
|
-
### Authorization
|
82
|
-
|
83
|
-
[Token](../README.md#Token)
|
84
|
-
|
85
|
-
### HTTP request headers
|
86
|
-
|
87
|
-
- **Content-Type**: application/json
|
88
|
-
- **Accept**: application/json
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
# **delete_approval_request**
|
93
|
-
> delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, , opts)
|
94
|
-
|
95
|
-
Delete an approval request for a feature flag config
|
96
|
-
|
97
|
-
### Example
|
98
30
|
```ruby
|
99
|
-
|
31
|
+
require 'time'
|
100
32
|
require 'launchdarkly_api'
|
101
33
|
# setup authorization
|
102
34
|
LaunchDarklyApi.configure do |config|
|
103
|
-
# Configure API key authorization:
|
104
|
-
config.api_key['
|
35
|
+
# Configure API key authorization: ApiKey
|
36
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
105
37
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
106
|
-
#config.api_key_prefix['
|
38
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
107
39
|
end
|
108
40
|
|
109
41
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
110
|
-
|
111
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
112
|
-
|
113
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
114
|
-
|
42
|
+
proj_key = 'proj_key_example' # String | The project key.
|
115
43
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
116
|
-
|
117
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
118
|
-
|
119
|
-
opts = {
|
120
|
-
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
121
|
-
}
|
44
|
+
flag_copy_config_post = LaunchDarklyApi::FlagCopyConfigPost.new({source: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'}), target: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'})}) # FlagCopyConfigPost |
|
122
45
|
|
123
46
|
begin
|
124
|
-
#
|
125
|
-
api_instance.
|
47
|
+
# Copy feature flag
|
48
|
+
result = api_instance.copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post)
|
49
|
+
p result
|
126
50
|
rescue LaunchDarklyApi::ApiError => e
|
127
|
-
puts "
|
51
|
+
puts "Error when calling FeatureFlagsApi->copy_feature_flag: #{e}"
|
128
52
|
end
|
129
53
|
```
|
130
54
|
|
131
|
-
|
132
|
-
|
133
|
-
Name | Type | Description | Notes
|
134
|
-
------------- | ------------- | ------------- | -------------
|
135
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
136
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
137
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
138
|
-
**approval_request_id** | **String**| The approval request ID |
|
139
|
-
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
140
|
-
|
141
|
-
### Return type
|
142
|
-
|
143
|
-
nil (empty response body)
|
144
|
-
|
145
|
-
### Authorization
|
146
|
-
|
147
|
-
[Token](../README.md#Token)
|
148
|
-
|
149
|
-
### HTTP request headers
|
55
|
+
#### Using the copy_feature_flag_with_http_info variant
|
150
56
|
|
151
|
-
|
152
|
-
- **Accept**: application/json
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
153
58
|
|
59
|
+
> <Array(<FeatureFlag>, Integer, Hash)> copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post)
|
154
60
|
|
155
|
-
|
156
|
-
# **delete_feature_flag**
|
157
|
-
> delete_feature_flag(project_key, feature_flag_key, )
|
158
|
-
|
159
|
-
Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
|
160
|
-
|
161
|
-
### Example
|
162
61
|
```ruby
|
163
|
-
# load the gem
|
164
|
-
require 'launchdarkly_api'
|
165
|
-
# setup authorization
|
166
|
-
LaunchDarklyApi.configure do |config|
|
167
|
-
# Configure API key authorization: Token
|
168
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
169
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
170
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
171
|
-
end
|
172
|
-
|
173
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
174
|
-
|
175
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
176
|
-
|
177
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
178
|
-
|
179
|
-
|
180
62
|
begin
|
181
|
-
#
|
182
|
-
api_instance.
|
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>
|
183
68
|
rescue LaunchDarklyApi::ApiError => e
|
184
|
-
puts "
|
69
|
+
puts "Error when calling FeatureFlagsApi->copy_feature_flag_with_http_info: #{e}"
|
185
70
|
end
|
186
71
|
```
|
187
72
|
|
188
73
|
### Parameters
|
189
74
|
|
190
|
-
Name | Type | Description
|
191
|
-
|
192
|
-
**
|
193
|
-
**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) | | |
|
194
80
|
|
195
81
|
### Return type
|
196
82
|
|
197
|
-
|
83
|
+
[**FeatureFlag**](FeatureFlag.md)
|
198
84
|
|
199
85
|
### Authorization
|
200
86
|
|
201
|
-
[
|
87
|
+
[ApiKey](../README.md#ApiKey)
|
202
88
|
|
203
89
|
### HTTP request headers
|
204
90
|
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
# **delete_flag_config_scheduled_changes**
|
211
|
-
> delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
212
|
-
|
213
|
-
Delete a scheduled change on a feature flag in an environment.
|
214
|
-
|
215
|
-
### Example
|
216
|
-
```ruby
|
217
|
-
# load the gem
|
218
|
-
require 'launchdarkly_api'
|
219
|
-
# setup authorization
|
220
|
-
LaunchDarklyApi.configure do |config|
|
221
|
-
# Configure API key authorization: Token
|
222
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
223
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
224
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
225
|
-
end
|
91
|
+
- **Content-Type**: application/json
|
92
|
+
- **Accept**: application/json
|
226
93
|
|
227
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
228
94
|
|
229
|
-
|
95
|
+
## delete_feature_flag
|
230
96
|
|
231
|
-
|
97
|
+
> delete_feature_flag(proj_key, key)
|
232
98
|
|
233
|
-
|
99
|
+
Delete feature flag
|
234
100
|
|
235
|
-
|
101
|
+
Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
|
236
102
|
|
103
|
+
### Examples
|
237
104
|
|
238
|
-
begin
|
239
|
-
#Delete a scheduled change on a feature flag in an environment.
|
240
|
-
api_instance.delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
241
|
-
rescue LaunchDarklyApi::ApiError => e
|
242
|
-
puts "Exception when calling FeatureFlagsApi->delete_flag_config_scheduled_changes: #{e}"
|
243
|
-
end
|
244
|
-
```
|
245
|
-
|
246
|
-
### Parameters
|
247
|
-
|
248
|
-
Name | Type | Description | Notes
|
249
|
-
------------- | ------------- | ------------- | -------------
|
250
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
251
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
252
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
253
|
-
**scheduled_change_id** | **String**| The id of the scheduled change |
|
254
|
-
|
255
|
-
### Return type
|
256
|
-
|
257
|
-
nil (empty response body)
|
258
|
-
|
259
|
-
### Authorization
|
260
|
-
|
261
|
-
[Token](../README.md#Token)
|
262
|
-
|
263
|
-
### HTTP request headers
|
264
|
-
|
265
|
-
- **Content-Type**: application/json
|
266
|
-
- **Accept**: application/json
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
# **flags_project_key_environment_key_feature_flag_key_dependent_flags_get**
|
271
|
-
> DependentFlagsByEnvironment flags_project_key_environment_key_feature_flag_key_dependent_flags_get(project_key, environment_key, feature_flag_key, )
|
272
|
-
|
273
|
-
Get dependent flags for the flag in the environment specified in path parameters
|
274
|
-
|
275
|
-
### Example
|
276
105
|
```ruby
|
277
|
-
|
106
|
+
require 'time'
|
278
107
|
require 'launchdarkly_api'
|
279
108
|
# setup authorization
|
280
109
|
LaunchDarklyApi.configure do |config|
|
281
|
-
# Configure API key authorization:
|
282
|
-
config.api_key['
|
110
|
+
# Configure API key authorization: ApiKey
|
111
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
283
112
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
284
|
-
#config.api_key_prefix['
|
113
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
285
114
|
end
|
286
115
|
|
287
116
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
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.
|
292
|
-
|
293
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
294
|
-
|
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.
|
295
119
|
|
296
120
|
begin
|
297
|
-
#
|
298
|
-
|
299
|
-
p result
|
121
|
+
# Delete feature flag
|
122
|
+
api_instance.delete_feature_flag(proj_key, key)
|
300
123
|
rescue LaunchDarklyApi::ApiError => e
|
301
|
-
puts "
|
124
|
+
puts "Error when calling FeatureFlagsApi->delete_feature_flag: #{e}"
|
302
125
|
end
|
303
126
|
```
|
304
127
|
|
305
|
-
|
306
|
-
|
307
|
-
Name | Type | Description | Notes
|
308
|
-
------------- | ------------- | ------------- | -------------
|
309
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
310
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
311
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
312
|
-
|
313
|
-
### Return type
|
314
|
-
|
315
|
-
[**DependentFlagsByEnvironment**](DependentFlagsByEnvironment.md)
|
316
|
-
|
317
|
-
### Authorization
|
318
|
-
|
319
|
-
[Token](../README.md#Token)
|
320
|
-
|
321
|
-
### HTTP request headers
|
322
|
-
|
323
|
-
- **Content-Type**: application/json
|
324
|
-
- **Accept**: application/json
|
128
|
+
#### Using the delete_feature_flag_with_http_info variant
|
325
129
|
|
130
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
326
131
|
|
132
|
+
> <Array(nil, Integer, Hash)> delete_feature_flag_with_http_info(proj_key, key)
|
327
133
|
|
328
|
-
# **flags_project_key_feature_flag_key_dependent_flags_get**
|
329
|
-
> MultiEnvironmentDependentFlags flags_project_key_feature_flag_key_dependent_flags_get(project_key, feature_flag_key, )
|
330
|
-
|
331
|
-
Get dependent flags across all environments for the flag specified in the path parameters
|
332
|
-
|
333
|
-
### Example
|
334
134
|
```ruby
|
335
|
-
# load the gem
|
336
|
-
require 'launchdarkly_api'
|
337
|
-
# setup authorization
|
338
|
-
LaunchDarklyApi.configure do |config|
|
339
|
-
# Configure API key authorization: Token
|
340
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
341
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
342
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
343
|
-
end
|
344
|
-
|
345
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
346
|
-
|
347
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
348
|
-
|
349
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
350
|
-
|
351
|
-
|
352
135
|
begin
|
353
|
-
#
|
354
|
-
|
355
|
-
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
|
356
141
|
rescue LaunchDarklyApi::ApiError => e
|
357
|
-
puts "
|
142
|
+
puts "Error when calling FeatureFlagsApi->delete_feature_flag_with_http_info: #{e}"
|
358
143
|
end
|
359
144
|
```
|
360
145
|
|
361
146
|
### Parameters
|
362
147
|
|
363
|
-
Name | Type | Description
|
364
|
-
|
365
|
-
**
|
366
|
-
**
|
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. | |
|
367
152
|
|
368
153
|
### Return type
|
369
154
|
|
370
|
-
|
155
|
+
nil (empty response body)
|
371
156
|
|
372
157
|
### Authorization
|
373
158
|
|
374
|
-
[
|
159
|
+
[ApiKey](../README.md#ApiKey)
|
375
160
|
|
376
161
|
### HTTP request headers
|
377
162
|
|
378
|
-
|
379
|
-
|
163
|
+
- **Content-Type**: Not defined
|
164
|
+
- **Accept**: application/json
|
165
|
+
|
380
166
|
|
167
|
+
## get_expiring_user_targets
|
381
168
|
|
169
|
+
> <ExpiringUserTargetGetResponse> get_expiring_user_targets(proj_key, env_key, flag_key)
|
170
|
+
|
171
|
+
Get expiring user targets for feature flag
|
382
172
|
|
383
|
-
|
384
|
-
> ApprovalRequests get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
173
|
+
Get a list of user targets on a feature flag that are scheduled for removal.
|
385
174
|
|
386
|
-
|
175
|
+
### Examples
|
387
176
|
|
388
|
-
### Example
|
389
177
|
```ruby
|
390
|
-
|
178
|
+
require 'time'
|
391
179
|
require 'launchdarkly_api'
|
392
180
|
# setup authorization
|
393
181
|
LaunchDarklyApi.configure do |config|
|
394
|
-
# Configure API key authorization:
|
395
|
-
config.api_key['
|
182
|
+
# Configure API key authorization: ApiKey
|
183
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
396
184
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
397
|
-
#config.api_key_prefix['
|
185
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
398
186
|
end
|
399
187
|
|
400
188
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
405
|
-
|
406
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
407
|
-
|
408
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
409
|
-
|
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.
|
410
192
|
|
411
193
|
begin
|
412
|
-
#Get
|
413
|
-
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)
|
414
196
|
p result
|
415
197
|
rescue LaunchDarklyApi::ApiError => e
|
416
|
-
puts "
|
198
|
+
puts "Error when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
|
417
199
|
end
|
418
200
|
```
|
419
201
|
|
420
|
-
|
421
|
-
|
422
|
-
Name | Type | Description | Notes
|
423
|
-
------------- | ------------- | ------------- | -------------
|
424
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
425
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
426
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
427
|
-
**approval_request_id** | **String**| The approval request ID |
|
428
|
-
|
429
|
-
### Return type
|
430
|
-
|
431
|
-
[**ApprovalRequests**](ApprovalRequests.md)
|
432
|
-
|
433
|
-
### Authorization
|
434
|
-
|
435
|
-
[Token](../README.md#Token)
|
436
|
-
|
437
|
-
### HTTP request headers
|
438
|
-
|
439
|
-
- **Content-Type**: application/json
|
440
|
-
- **Accept**: application/json
|
441
|
-
|
442
|
-
|
202
|
+
#### Using the get_expiring_user_targets_with_http_info variant
|
443
203
|
|
444
|
-
|
445
|
-
> ApprovalRequests get_approval_requests(project_key, feature_flag_key, environment_key, )
|
204
|
+
This returns an Array which contains the response data, status code and headers.
|
446
205
|
|
447
|
-
|
206
|
+
> <Array(<ExpiringUserTargetGetResponse>, Integer, Hash)> get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key)
|
448
207
|
|
449
|
-
### Example
|
450
208
|
```ruby
|
451
|
-
# load the gem
|
452
|
-
require 'launchdarkly_api'
|
453
|
-
# setup authorization
|
454
|
-
LaunchDarklyApi.configure do |config|
|
455
|
-
# Configure API key authorization: Token
|
456
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
457
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
458
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
459
|
-
end
|
460
|
-
|
461
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
462
|
-
|
463
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
464
|
-
|
465
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
466
|
-
|
467
|
-
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.
|
468
|
-
|
469
|
-
|
470
209
|
begin
|
471
|
-
#Get
|
472
|
-
|
473
|
-
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>
|
474
215
|
rescue LaunchDarklyApi::ApiError => e
|
475
|
-
puts "
|
216
|
+
puts "Error when calling FeatureFlagsApi->get_expiring_user_targets_with_http_info: #{e}"
|
476
217
|
end
|
477
218
|
```
|
478
219
|
|
479
220
|
### Parameters
|
480
221
|
|
481
|
-
Name | Type | Description
|
482
|
-
|
483
|
-
**
|
484
|
-
**
|
485
|
-
**
|
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. | |
|
486
227
|
|
487
228
|
### Return type
|
488
229
|
|
489
|
-
[**
|
230
|
+
[**ExpiringUserTargetGetResponse**](ExpiringUserTargetGetResponse.md)
|
490
231
|
|
491
232
|
### Authorization
|
492
233
|
|
493
|
-
[
|
234
|
+
[ApiKey](../README.md#ApiKey)
|
494
235
|
|
495
236
|
### HTTP request headers
|
496
237
|
|
497
|
-
|
498
|
-
|
238
|
+
- **Content-Type**: Not defined
|
239
|
+
- **Accept**: application/json
|
499
240
|
|
500
241
|
|
242
|
+
## get_feature_flag
|
501
243
|
|
502
|
-
|
503
|
-
> UserTargetingExpirationForFlags get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
244
|
+
> <FeatureFlag> get_feature_flag(proj_key, key, opts)
|
504
245
|
|
505
|
-
Get
|
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
|
506
251
|
|
507
|
-
### Example
|
508
252
|
```ruby
|
509
|
-
|
253
|
+
require 'time'
|
510
254
|
require 'launchdarkly_api'
|
511
255
|
# setup authorization
|
512
256
|
LaunchDarklyApi.configure do |config|
|
513
|
-
# Configure API key authorization:
|
514
|
-
config.api_key['
|
257
|
+
# Configure API key authorization: ApiKey
|
258
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
515
259
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
516
|
-
#config.api_key_prefix['
|
260
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
517
261
|
end
|
518
262
|
|
519
263
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
526
|
-
|
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
|
+
}
|
527
269
|
|
528
270
|
begin
|
529
|
-
#Get
|
530
|
-
result = api_instance.
|
271
|
+
# Get feature flag
|
272
|
+
result = api_instance.get_feature_flag(proj_key, key, opts)
|
531
273
|
p result
|
532
274
|
rescue LaunchDarklyApi::ApiError => e
|
533
|
-
puts "
|
275
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag: #{e}"
|
534
276
|
end
|
535
277
|
```
|
536
278
|
|
537
|
-
|
538
|
-
|
539
|
-
Name | Type | Description | Notes
|
540
|
-
------------- | ------------- | ------------- | -------------
|
541
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
542
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
543
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
544
|
-
|
545
|
-
### Return type
|
546
|
-
|
547
|
-
[**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
|
548
|
-
|
549
|
-
### Authorization
|
550
|
-
|
551
|
-
[Token](../README.md#Token)
|
552
|
-
|
553
|
-
### HTTP request headers
|
554
|
-
|
555
|
-
- **Content-Type**: application/json
|
556
|
-
- **Accept**: application/json
|
279
|
+
#### Using the get_feature_flag_with_http_info variant
|
557
280
|
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
558
282
|
|
283
|
+
> <Array(<FeatureFlag>, Integer, Hash)> get_feature_flag_with_http_info(proj_key, key, opts)
|
559
284
|
|
560
|
-
# **get_feature_flag**
|
561
|
-
> FeatureFlag get_feature_flag(project_key, feature_flag_key, , opts)
|
562
|
-
|
563
|
-
Get a single feature flag by key.
|
564
|
-
|
565
|
-
### Example
|
566
285
|
```ruby
|
567
|
-
# load the gem
|
568
|
-
require 'launchdarkly_api'
|
569
|
-
# setup authorization
|
570
|
-
LaunchDarklyApi.configure do |config|
|
571
|
-
# Configure API key authorization: Token
|
572
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
573
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
574
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
575
|
-
end
|
576
|
-
|
577
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
578
|
-
|
579
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
580
|
-
|
581
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
582
|
-
|
583
|
-
opts = {
|
584
|
-
env: ['env_example'] # Array<String> | By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment.
|
585
|
-
}
|
586
|
-
|
587
286
|
begin
|
588
|
-
#Get
|
589
|
-
|
590
|
-
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>
|
591
292
|
rescue LaunchDarklyApi::ApiError => e
|
592
|
-
puts "
|
293
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_with_http_info: #{e}"
|
593
294
|
end
|
594
295
|
```
|
595
296
|
|
596
297
|
### Parameters
|
597
298
|
|
598
|
-
Name | Type | Description
|
599
|
-
|
600
|
-
**
|
601
|
-
**
|
602
|
-
**env** |
|
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] |
|
603
304
|
|
604
305
|
### Return type
|
605
306
|
|
@@ -607,788 +308,467 @@ Name | Type | Description | Notes
|
|
607
308
|
|
608
309
|
### Authorization
|
609
310
|
|
610
|
-
[
|
311
|
+
[ApiKey](../README.md#ApiKey)
|
611
312
|
|
612
313
|
### HTTP request headers
|
613
314
|
|
614
|
-
|
615
|
-
|
315
|
+
- **Content-Type**: Not defined
|
316
|
+
- **Accept**: application/json
|
616
317
|
|
617
318
|
|
319
|
+
## get_feature_flag_status
|
618
320
|
|
619
|
-
|
620
|
-
|
321
|
+
> <FlagStatusRep> get_feature_flag_status(proj_key, env_key, key)
|
322
|
+
|
323
|
+
Get feature flag status
|
621
324
|
|
622
325
|
Get the status for a particular feature flag.
|
623
326
|
|
624
|
-
###
|
327
|
+
### Examples
|
328
|
+
|
625
329
|
```ruby
|
626
|
-
|
330
|
+
require 'time'
|
627
331
|
require 'launchdarkly_api'
|
628
332
|
# setup authorization
|
629
333
|
LaunchDarklyApi.configure do |config|
|
630
|
-
# Configure API key authorization:
|
631
|
-
config.api_key['
|
334
|
+
# Configure API key authorization: ApiKey
|
335
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
632
336
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
633
|
-
#config.api_key_prefix['
|
337
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
634
338
|
end
|
635
339
|
|
636
340
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
637
|
-
|
638
|
-
|
639
|
-
|
640
|
-
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.
|
641
|
-
|
642
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
643
|
-
|
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
|
644
344
|
|
645
345
|
begin
|
646
|
-
#Get
|
647
|
-
result = api_instance.get_feature_flag_status(
|
346
|
+
# Get feature flag status
|
347
|
+
result = api_instance.get_feature_flag_status(proj_key, env_key, key)
|
648
348
|
p result
|
649
349
|
rescue LaunchDarklyApi::ApiError => e
|
650
|
-
puts "
|
350
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status: #{e}"
|
651
351
|
end
|
652
352
|
```
|
653
353
|
|
654
|
-
|
354
|
+
#### Using the get_feature_flag_status_with_http_info variant
|
655
355
|
|
656
|
-
|
657
|
-
------------- | ------------- | ------------- | -------------
|
658
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
659
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
660
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
356
|
+
This returns an Array which contains the response data, status code and headers.
|
661
357
|
|
662
|
-
|
663
|
-
|
664
|
-
[**FeatureFlagStatus**](FeatureFlagStatus.md)
|
358
|
+
> <Array(<FlagStatusRep>, Integer, Hash)> get_feature_flag_status_with_http_info(proj_key, env_key, key)
|
665
359
|
|
666
|
-
### Authorization
|
667
|
-
|
668
|
-
[Token](../README.md#Token)
|
669
|
-
|
670
|
-
### HTTP request headers
|
671
|
-
|
672
|
-
- **Content-Type**: application/json
|
673
|
-
- **Accept**: application/json
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
# **get_feature_flag_status_across_environments**
|
678
|
-
> FeatureFlagStatusAcrossEnvironments get_feature_flag_status_across_environments(project_key, feature_flag_key, )
|
679
|
-
|
680
|
-
Get the status for a particular feature flag across environments
|
681
|
-
|
682
|
-
### Example
|
683
360
|
```ruby
|
684
|
-
# load the gem
|
685
|
-
require 'launchdarkly_api'
|
686
|
-
# setup authorization
|
687
|
-
LaunchDarklyApi.configure do |config|
|
688
|
-
# Configure API key authorization: Token
|
689
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
690
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
691
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
692
|
-
end
|
693
|
-
|
694
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
695
|
-
|
696
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
697
|
-
|
698
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
699
|
-
|
700
|
-
|
701
361
|
begin
|
702
|
-
#Get
|
703
|
-
|
704
|
-
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>
|
705
367
|
rescue LaunchDarklyApi::ApiError => e
|
706
|
-
puts "
|
368
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_with_http_info: #{e}"
|
707
369
|
end
|
708
370
|
```
|
709
371
|
|
710
372
|
### Parameters
|
711
373
|
|
712
|
-
Name | Type | Description
|
713
|
-
|
714
|
-
**
|
715
|
-
**
|
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 | |
|
716
379
|
|
717
380
|
### Return type
|
718
381
|
|
719
|
-
[**
|
382
|
+
[**FlagStatusRep**](FlagStatusRep.md)
|
720
383
|
|
721
384
|
### Authorization
|
722
385
|
|
723
|
-
[
|
386
|
+
[ApiKey](../README.md#ApiKey)
|
724
387
|
|
725
388
|
### HTTP request headers
|
726
389
|
|
727
|
-
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
# **get_feature_flag_statuses**
|
733
|
-
> FeatureFlagStatuses get_feature_flag_statuses(project_key, environment_key, )
|
734
|
-
|
735
|
-
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.
|
736
|
-
|
737
|
-
### Example
|
738
|
-
```ruby
|
739
|
-
# load the gem
|
740
|
-
require 'launchdarkly_api'
|
741
|
-
# setup authorization
|
742
|
-
LaunchDarklyApi.configure do |config|
|
743
|
-
# Configure API key authorization: Token
|
744
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
745
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
746
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
747
|
-
end
|
748
|
-
|
749
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
750
|
-
|
751
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
752
|
-
|
753
|
-
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.
|
390
|
+
- **Content-Type**: Not defined
|
391
|
+
- **Accept**: application/json
|
754
392
|
|
755
393
|
|
756
|
-
|
757
|
-
#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.
|
758
|
-
result = api_instance.get_feature_flag_statuses(project_key, environment_key, )
|
759
|
-
p result
|
760
|
-
rescue LaunchDarklyApi::ApiError => e
|
761
|
-
puts "Exception when calling FeatureFlagsApi->get_feature_flag_statuses: #{e}"
|
762
|
-
end
|
763
|
-
```
|
394
|
+
## get_feature_flag_status_across_environments
|
764
395
|
|
765
|
-
|
396
|
+
> <FeatureFlagStatusAcrossEnvironments> get_feature_flag_status_across_environments(proj_key, key, opts)
|
766
397
|
|
767
|
-
|
768
|
-
------------- | ------------- | ------------- | -------------
|
769
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
770
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
398
|
+
Get flag status across environments
|
771
399
|
|
772
|
-
|
400
|
+
Get the status for a particular feature flag across environments.
|
773
401
|
|
774
|
-
|
402
|
+
### Examples
|
775
403
|
|
776
|
-
### Authorization
|
777
|
-
|
778
|
-
[Token](../README.md#Token)
|
779
|
-
|
780
|
-
### HTTP request headers
|
781
|
-
|
782
|
-
- **Content-Type**: application/json
|
783
|
-
- **Accept**: application/json
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
# **get_feature_flags**
|
788
|
-
> FeatureFlags get_feature_flags(project_key, , opts)
|
789
|
-
|
790
|
-
Get a list of all features in the given project.
|
791
|
-
|
792
|
-
### Example
|
793
404
|
```ruby
|
794
|
-
|
405
|
+
require 'time'
|
795
406
|
require 'launchdarkly_api'
|
796
407
|
# setup authorization
|
797
408
|
LaunchDarklyApi.configure do |config|
|
798
|
-
# Configure API key authorization:
|
799
|
-
config.api_key['
|
409
|
+
# Configure API key authorization: ApiKey
|
410
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
800
411
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
801
|
-
#config.api_key_prefix['
|
412
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
802
413
|
end
|
803
414
|
|
804
415
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
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.
|
810
|
-
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.
|
811
|
-
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.
|
812
|
-
limit: 8.14, # Float | The number of objects to return. Defaults to -1, which returns everything.
|
813
|
-
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.
|
814
|
-
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value.
|
815
|
-
sort: 'sort_example' # String | A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
|
816
|
-
tag: 'tag_example' # String | Filter by tag. A tag can be used to group flags across projects.
|
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
|
817
420
|
}
|
818
421
|
|
819
422
|
begin
|
820
|
-
#Get
|
821
|
-
result = api_instance.
|
423
|
+
# Get flag status across environments
|
424
|
+
result = api_instance.get_feature_flag_status_across_environments(proj_key, key, opts)
|
822
425
|
p result
|
823
426
|
rescue LaunchDarklyApi::ApiError => e
|
824
|
-
puts "
|
427
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_across_environments: #{e}"
|
825
428
|
end
|
826
429
|
```
|
827
430
|
|
828
|
-
|
829
|
-
|
830
|
-
Name | Type | Description | Notes
|
831
|
-
------------- | ------------- | ------------- | -------------
|
832
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
833
|
-
**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]
|
834
|
-
**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]
|
835
|
-
**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]
|
836
|
-
**limit** | **Float**| The number of objects to return. Defaults to -1, which returns everything. | [optional]
|
837
|
-
**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]
|
838
|
-
**filter** | **String**| A comma-separated list of filters. Each filter is of the form field:value. | [optional]
|
839
|
-
**sort** | **String**| A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order. | [optional]
|
840
|
-
**tag** | **String**| Filter by tag. A tag can be used to group flags across projects. | [optional]
|
841
|
-
|
842
|
-
### Return type
|
843
|
-
|
844
|
-
[**FeatureFlags**](FeatureFlags.md)
|
845
|
-
|
846
|
-
### Authorization
|
847
|
-
|
848
|
-
[Token](../README.md#Token)
|
849
|
-
|
850
|
-
### HTTP request headers
|
851
|
-
|
852
|
-
- **Content-Type**: application/json
|
853
|
-
- **Accept**: application/json
|
431
|
+
#### Using the get_feature_flag_status_across_environments_with_http_info variant
|
854
432
|
|
433
|
+
This returns an Array which contains the response data, status code and headers.
|
855
434
|
|
435
|
+
> <Array(<FeatureFlagStatusAcrossEnvironments>, Integer, Hash)> get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts)
|
856
436
|
|
857
|
-
# **get_flag_config_scheduled_change**
|
858
|
-
> FeatureFlagScheduledChange get_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
859
|
-
|
860
|
-
Get a scheduled change on a feature flag by id.
|
861
|
-
|
862
|
-
### Example
|
863
437
|
```ruby
|
864
|
-
# load the gem
|
865
|
-
require 'launchdarkly_api'
|
866
|
-
# setup authorization
|
867
|
-
LaunchDarklyApi.configure do |config|
|
868
|
-
# Configure API key authorization: Token
|
869
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
870
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
871
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
872
|
-
end
|
873
|
-
|
874
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
875
|
-
|
876
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
877
|
-
|
878
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
879
|
-
|
880
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
881
|
-
|
882
|
-
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
883
|
-
|
884
|
-
|
885
438
|
begin
|
886
|
-
#Get
|
887
|
-
|
888
|
-
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>
|
889
444
|
rescue LaunchDarklyApi::ApiError => e
|
890
|
-
puts "
|
445
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_across_environments_with_http_info: #{e}"
|
891
446
|
end
|
892
447
|
```
|
893
448
|
|
894
449
|
### Parameters
|
895
450
|
|
896
|
-
Name | Type | Description
|
897
|
-
|
898
|
-
**
|
899
|
-
**
|
900
|
-
**
|
901
|
-
**scheduled_change_id** | **String**| The id of the scheduled change |
|
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] |
|
902
456
|
|
903
457
|
### Return type
|
904
458
|
|
905
|
-
[**
|
459
|
+
[**FeatureFlagStatusAcrossEnvironments**](FeatureFlagStatusAcrossEnvironments.md)
|
906
460
|
|
907
461
|
### Authorization
|
908
462
|
|
909
|
-
[
|
463
|
+
[ApiKey](../README.md#ApiKey)
|
910
464
|
|
911
465
|
### HTTP request headers
|
912
466
|
|
913
|
-
|
914
|
-
|
467
|
+
- **Content-Type**: Not defined
|
468
|
+
- **Accept**: application/json
|
469
|
+
|
470
|
+
|
471
|
+
## get_feature_flag_statuses
|
915
472
|
|
473
|
+
> <FeatureFlagStatuses> get_feature_flag_statuses(proj_key, env_key)
|
916
474
|
|
475
|
+
List feature flag statuses
|
917
476
|
|
918
|
-
|
919
|
-
> FeatureFlagScheduledChanges get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, )
|
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
|
920
478
|
|
921
|
-
|
479
|
+
### Examples
|
922
480
|
|
923
|
-
### Example
|
924
481
|
```ruby
|
925
|
-
|
482
|
+
require 'time'
|
926
483
|
require 'launchdarkly_api'
|
927
484
|
# setup authorization
|
928
485
|
LaunchDarklyApi.configure do |config|
|
929
|
-
# Configure API key authorization:
|
930
|
-
config.api_key['
|
486
|
+
# Configure API key authorization: ApiKey
|
487
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
931
488
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
932
|
-
#config.api_key_prefix['
|
489
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
933
490
|
end
|
934
491
|
|
935
492
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
936
|
-
|
937
|
-
|
938
|
-
|
939
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
940
|
-
|
941
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
942
|
-
|
493
|
+
proj_key = 'proj_key_example' # String | The project key
|
494
|
+
env_key = 'env_key_example' # String | Filter configurations by environment
|
943
495
|
|
944
496
|
begin
|
945
|
-
#
|
946
|
-
result = api_instance.
|
497
|
+
# List feature flag statuses
|
498
|
+
result = api_instance.get_feature_flag_statuses(proj_key, env_key)
|
947
499
|
p result
|
948
500
|
rescue LaunchDarklyApi::ApiError => e
|
949
|
-
puts "
|
501
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_statuses: #{e}"
|
950
502
|
end
|
951
503
|
```
|
952
504
|
|
953
|
-
|
954
|
-
|
955
|
-
Name | Type | Description | Notes
|
956
|
-
------------- | ------------- | ------------- | -------------
|
957
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
958
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
959
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
960
|
-
|
961
|
-
### Return type
|
962
|
-
|
963
|
-
[**FeatureFlagScheduledChanges**](FeatureFlagScheduledChanges.md)
|
964
|
-
|
965
|
-
### Authorization
|
966
|
-
|
967
|
-
[Token](../README.md#Token)
|
968
|
-
|
969
|
-
### HTTP request headers
|
505
|
+
#### Using the get_feature_flag_statuses_with_http_info variant
|
970
506
|
|
971
|
-
|
972
|
-
- **Accept**: application/json
|
507
|
+
This returns an Array which contains the response data, status code and headers.
|
973
508
|
|
509
|
+
> <Array(<FeatureFlagStatuses>, Integer, Hash)> get_feature_flag_statuses_with_http_info(proj_key, env_key)
|
974
510
|
|
975
|
-
|
976
|
-
# **get_flag_config_scheduled_changes_conflicts**
|
977
|
-
> FeatureFlagScheduledChangesConflicts get_flag_config_scheduled_changes_conflicts(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body)
|
978
|
-
|
979
|
-
Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
|
980
|
-
|
981
|
-
### Example
|
982
511
|
```ruby
|
983
|
-
# load the gem
|
984
|
-
require 'launchdarkly_api'
|
985
|
-
# setup authorization
|
986
|
-
LaunchDarklyApi.configure do |config|
|
987
|
-
# Configure API key authorization: Token
|
988
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
989
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
990
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
991
|
-
end
|
992
|
-
|
993
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
994
|
-
|
995
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
996
|
-
|
997
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
998
|
-
|
999
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
1000
|
-
|
1001
|
-
flag_config_scheduled_changes_conflicts_body = LaunchDarklyApi::FlagConfigScheduledChangesConflictsBody.new # FlagConfigScheduledChangesConflictsBody | Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag.
|
1002
|
-
|
1003
|
-
|
1004
512
|
begin
|
1005
|
-
#
|
1006
|
-
|
1007
|
-
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>
|
1008
518
|
rescue LaunchDarklyApi::ApiError => e
|
1009
|
-
puts "
|
519
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_statuses_with_http_info: #{e}"
|
1010
520
|
end
|
1011
521
|
```
|
1012
522
|
|
1013
523
|
### Parameters
|
1014
524
|
|
1015
|
-
Name | Type | Description
|
1016
|
-
|
1017
|
-
**
|
1018
|
-
**
|
1019
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1020
|
-
**flag_config_scheduled_changes_conflicts_body** | [**FlagConfigScheduledChangesConflictsBody**](FlagConfigScheduledChangesConflictsBody.md)| Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag. |
|
525
|
+
| Name | Type | Description | Notes |
|
526
|
+
| ---- | ---- | ----------- | ----- |
|
527
|
+
| **proj_key** | **String** | The project key | |
|
528
|
+
| **env_key** | **String** | Filter configurations by environment | |
|
1021
529
|
|
1022
530
|
### Return type
|
1023
531
|
|
1024
|
-
[**
|
532
|
+
[**FeatureFlagStatuses**](FeatureFlagStatuses.md)
|
1025
533
|
|
1026
534
|
### Authorization
|
1027
535
|
|
1028
|
-
[
|
536
|
+
[ApiKey](../README.md#ApiKey)
|
1029
537
|
|
1030
538
|
### HTTP request headers
|
1031
539
|
|
1032
|
-
|
1033
|
-
|
540
|
+
- **Content-Type**: Not defined
|
541
|
+
- **Accept**: application/json
|
1034
542
|
|
1035
543
|
|
544
|
+
## get_feature_flags
|
1036
545
|
|
1037
|
-
|
1038
|
-
> UserTargetingExpirationForFlags patch_expiring_user_targets(project_key, environment_key, feature_flag_key, semantic_patch_with_comment)
|
546
|
+
> <FeatureFlags> get_feature_flags(proj_key, opts)
|
1039
547
|
|
1040
|
-
|
548
|
+
List feature flags
|
549
|
+
|
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
|
1041
553
|
|
1042
|
-
### Example
|
1043
554
|
```ruby
|
1044
|
-
|
555
|
+
require 'time'
|
1045
556
|
require 'launchdarkly_api'
|
1046
557
|
# setup authorization
|
1047
558
|
LaunchDarklyApi.configure do |config|
|
1048
|
-
# Configure API key authorization:
|
1049
|
-
config.api_key['
|
559
|
+
# Configure API key authorization: ApiKey
|
560
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1050
561
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1051
|
-
#config.api_key_prefix['
|
562
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1052
563
|
end
|
1053
564
|
|
1054
565
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1055
|
-
|
1056
|
-
|
1057
|
-
|
1058
|
-
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1063
|
-
|
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
|
+
query: 'query_example', # String | A string that matches against the flags' keys and names. It is not case sensitive
|
573
|
+
archived: true, # Boolean | A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned
|
574
|
+
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
|
575
|
+
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value
|
576
|
+
sort: 'sort_example' # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
|
577
|
+
}
|
1064
578
|
|
1065
579
|
begin
|
1066
|
-
#
|
1067
|
-
result = api_instance.
|
580
|
+
# List feature flags
|
581
|
+
result = api_instance.get_feature_flags(proj_key, opts)
|
1068
582
|
p result
|
1069
583
|
rescue LaunchDarklyApi::ApiError => e
|
1070
|
-
puts "
|
584
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flags: #{e}"
|
1071
585
|
end
|
1072
586
|
```
|
1073
587
|
|
1074
|
-
|
1075
|
-
|
1076
|
-
Name | Type | Description | Notes
|
1077
|
-
------------- | ------------- | ------------- | -------------
|
1078
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1079
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1080
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1081
|
-
**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. |
|
1082
|
-
|
1083
|
-
### Return type
|
1084
|
-
|
1085
|
-
[**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
|
1086
|
-
|
1087
|
-
### Authorization
|
1088
|
-
|
1089
|
-
[Token](../README.md#Token)
|
1090
|
-
|
1091
|
-
### HTTP request headers
|
588
|
+
#### Using the get_feature_flags_with_http_info variant
|
1092
589
|
|
1093
|
-
|
1094
|
-
- **Accept**: application/json
|
590
|
+
This returns an Array which contains the response data, status code and headers.
|
1095
591
|
|
592
|
+
> <Array(<FeatureFlags>, Integer, Hash)> get_feature_flags_with_http_info(proj_key, opts)
|
1096
593
|
|
1097
|
-
|
1098
|
-
# **patch_feature_flag**
|
1099
|
-
> FeatureFlag patch_feature_flag(project_key, feature_flag_key, patch_comment)
|
1100
|
-
|
1101
|
-
Perform a partial update to a feature.
|
1102
|
-
|
1103
|
-
### Example
|
1104
594
|
```ruby
|
1105
|
-
# load the gem
|
1106
|
-
require 'launchdarkly_api'
|
1107
|
-
# setup authorization
|
1108
|
-
LaunchDarklyApi.configure do |config|
|
1109
|
-
# Configure API key authorization: Token
|
1110
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1111
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1112
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1113
|
-
end
|
1114
|
-
|
1115
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1116
|
-
|
1117
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1118
|
-
|
1119
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1120
|
-
|
1121
|
-
patch_comment = LaunchDarklyApi::PatchComment.new # PatchComment | Requires a JSON Patch representation of the desired changes to the project, and an optional comment. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.
|
1122
|
-
|
1123
|
-
|
1124
595
|
begin
|
1125
|
-
#
|
1126
|
-
|
1127
|
-
p
|
596
|
+
# List feature flags
|
597
|
+
data, status_code, headers = api_instance.get_feature_flags_with_http_info(proj_key, opts)
|
598
|
+
p status_code # => 2xx
|
599
|
+
p headers # => { ... }
|
600
|
+
p data # => <FeatureFlags>
|
1128
601
|
rescue LaunchDarklyApi::ApiError => e
|
1129
|
-
puts "
|
602
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flags_with_http_info: #{e}"
|
1130
603
|
end
|
1131
604
|
```
|
1132
605
|
|
1133
606
|
### Parameters
|
1134
607
|
|
1135
|
-
Name | Type | Description
|
1136
|
-
|
1137
|
-
**
|
1138
|
-
**
|
1139
|
-
**
|
608
|
+
| Name | Type | Description | Notes |
|
609
|
+
| ---- | ---- | ----------- | ----- |
|
610
|
+
| **proj_key** | **String** | The project key | |
|
611
|
+
| **env** | **String** | Filter configurations by environment | [optional] |
|
612
|
+
| **tag** | **String** | Filter feature flags by tag | [optional] |
|
613
|
+
| **limit** | **Integer** | The number of feature flags to return. Defaults to -1, which returns all flags | [optional] |
|
614
|
+
| **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] |
|
615
|
+
| **query** | **String** | A string that matches against the flags' keys and names. It is not case sensitive | [optional] |
|
616
|
+
| **archived** | **Boolean** | A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned | [optional] |
|
617
|
+
| **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] |
|
618
|
+
| **filter** | **String** | A comma-separated list of filters. Each filter is of the form field:value | [optional] |
|
619
|
+
| **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order | [optional] |
|
1140
620
|
|
1141
621
|
### Return type
|
1142
622
|
|
1143
|
-
[**
|
623
|
+
[**FeatureFlags**](FeatureFlags.md)
|
1144
624
|
|
1145
625
|
### Authorization
|
1146
626
|
|
1147
|
-
[
|
627
|
+
[ApiKey](../README.md#ApiKey)
|
1148
628
|
|
1149
629
|
### HTTP request headers
|
1150
630
|
|
1151
|
-
|
1152
|
-
|
631
|
+
- **Content-Type**: Not defined
|
632
|
+
- **Accept**: application/json
|
1153
633
|
|
1154
634
|
|
635
|
+
## patch_expiring_user_targets
|
1155
636
|
|
1156
|
-
|
1157
|
-
> FeatureFlagScheduledChange patch_flag_config_scheduled_change(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id)
|
637
|
+
> <ExpiringUserTargetPatchResponse> patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment)
|
1158
638
|
|
1159
|
-
|
639
|
+
Update expiring user targets on feature flag
|
640
|
+
|
641
|
+
Update the list of user targets on a feature flag that are scheduled for removal.
|
642
|
+
|
643
|
+
### Examples
|
1160
644
|
|
1161
|
-
### Example
|
1162
645
|
```ruby
|
1163
|
-
|
646
|
+
require 'time'
|
1164
647
|
require 'launchdarkly_api'
|
1165
648
|
# setup authorization
|
1166
649
|
LaunchDarklyApi.configure do |config|
|
1167
|
-
# Configure API key authorization:
|
1168
|
-
config.api_key['
|
650
|
+
# Configure API key authorization: ApiKey
|
651
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1169
652
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1170
|
-
#config.api_key_prefix['
|
653
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1171
654
|
end
|
1172
655
|
|
1173
656
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
flag_config_scheduled_changes_patch_body = LaunchDarklyApi::FlagConfigScheduledChangesPatchBody.new # FlagConfigScheduledChangesPatchBody | Update scheduled changes on a feature flag.
|
1180
|
-
|
1181
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
1182
|
-
|
1183
|
-
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
1184
|
-
|
657
|
+
proj_key = 'proj_key_example' # String | The project key.
|
658
|
+
env_key = 'env_key_example' # String | The environment key.
|
659
|
+
flag_key = 'flag_key_example' # String | The feature flag key.
|
660
|
+
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})]}) # PatchWithComment |
|
1185
661
|
|
1186
662
|
begin
|
1187
|
-
#
|
1188
|
-
result = api_instance.
|
663
|
+
# Update expiring user targets on feature flag
|
664
|
+
result = api_instance.patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment)
|
1189
665
|
p result
|
1190
666
|
rescue LaunchDarklyApi::ApiError => e
|
1191
|
-
puts "
|
667
|
+
puts "Error when calling FeatureFlagsApi->patch_expiring_user_targets: #{e}"
|
1192
668
|
end
|
1193
669
|
```
|
1194
670
|
|
1195
|
-
|
1196
|
-
|
1197
|
-
Name | Type | Description | Notes
|
1198
|
-
------------- | ------------- | ------------- | -------------
|
1199
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1200
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1201
|
-
**flag_config_scheduled_changes_patch_body** | [**FlagConfigScheduledChangesPatchBody**](FlagConfigScheduledChangesPatchBody.md)| Update scheduled changes on a feature flag. |
|
1202
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1203
|
-
**scheduled_change_id** | **String**| The id of the scheduled change |
|
1204
|
-
|
1205
|
-
### Return type
|
1206
|
-
|
1207
|
-
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
671
|
+
#### Using the patch_expiring_user_targets_with_http_info variant
|
1208
672
|
|
1209
|
-
|
673
|
+
This returns an Array which contains the response data, status code and headers.
|
1210
674
|
|
1211
|
-
|
675
|
+
> <Array(<ExpiringUserTargetPatchResponse>, Integer, Hash)> patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment)
|
1212
676
|
|
1213
|
-
### HTTP request headers
|
1214
|
-
|
1215
|
-
- **Content-Type**: application/json
|
1216
|
-
- **Accept**: application/json
|
1217
|
-
|
1218
|
-
|
1219
|
-
|
1220
|
-
# **post_apply_approval_request**
|
1221
|
-
> ApprovalRequests post_apply_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body)
|
1222
|
-
|
1223
|
-
Apply approval request for a feature flag config
|
1224
|
-
|
1225
|
-
### Example
|
1226
677
|
```ruby
|
1227
|
-
# load the gem
|
1228
|
-
require 'launchdarkly_api'
|
1229
|
-
# setup authorization
|
1230
|
-
LaunchDarklyApi.configure do |config|
|
1231
|
-
# Configure API key authorization: Token
|
1232
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1233
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1234
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1235
|
-
end
|
1236
|
-
|
1237
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1238
|
-
|
1239
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1240
|
-
|
1241
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1242
|
-
|
1243
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
1244
|
-
|
1245
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
1246
|
-
|
1247
|
-
approval_request_apply_config_body = LaunchDarklyApi::ApprovalRequestApplyConfigBody.new # ApprovalRequestApplyConfigBody | Apply an approval request
|
1248
|
-
|
1249
|
-
|
1250
678
|
begin
|
1251
|
-
#
|
1252
|
-
|
1253
|
-
p
|
679
|
+
# Update expiring user targets on feature flag
|
680
|
+
data, status_code, headers = api_instance.patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment)
|
681
|
+
p status_code # => 2xx
|
682
|
+
p headers # => { ... }
|
683
|
+
p data # => <ExpiringUserTargetPatchResponse>
|
1254
684
|
rescue LaunchDarklyApi::ApiError => e
|
1255
|
-
puts "
|
685
|
+
puts "Error when calling FeatureFlagsApi->patch_expiring_user_targets_with_http_info: #{e}"
|
1256
686
|
end
|
1257
687
|
```
|
1258
688
|
|
1259
689
|
### Parameters
|
1260
690
|
|
1261
|
-
Name | Type | Description
|
1262
|
-
|
1263
|
-
**
|
1264
|
-
**
|
1265
|
-
**
|
1266
|
-
**
|
1267
|
-
**approval_request_apply_config_body** | [**ApprovalRequestApplyConfigBody**](ApprovalRequestApplyConfigBody.md)| Apply an approval request |
|
691
|
+
| Name | Type | Description | Notes |
|
692
|
+
| ---- | ---- | ----------- | ----- |
|
693
|
+
| **proj_key** | **String** | The project key. | |
|
694
|
+
| **env_key** | **String** | The environment key. | |
|
695
|
+
| **flag_key** | **String** | The feature flag key. | |
|
696
|
+
| **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
|
1268
697
|
|
1269
698
|
### Return type
|
1270
699
|
|
1271
|
-
[**
|
700
|
+
[**ExpiringUserTargetPatchResponse**](ExpiringUserTargetPatchResponse.md)
|
1272
701
|
|
1273
702
|
### Authorization
|
1274
703
|
|
1275
|
-
[
|
704
|
+
[ApiKey](../README.md#ApiKey)
|
1276
705
|
|
1277
706
|
### HTTP request headers
|
1278
707
|
|
1279
|
-
|
1280
|
-
|
708
|
+
- **Content-Type**: application/json
|
709
|
+
- **Accept**: application/json
|
1281
710
|
|
1282
711
|
|
712
|
+
## patch_feature_flag
|
1283
713
|
|
1284
|
-
|
1285
|
-
> ApprovalRequest post_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, , opts)
|
714
|
+
> <FeatureFlag> patch_feature_flag(proj_key, key, patch_with_comment)
|
1286
715
|
|
1287
|
-
|
716
|
+
Update feature flag
|
717
|
+
|
718
|
+
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](/#section/Updates/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 receive a `400` response as 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](/#section/Updates/Updates-via-JSON-Patch).
|
719
|
+
|
720
|
+
### Examples
|
1288
721
|
|
1289
|
-
### Example
|
1290
722
|
```ruby
|
1291
|
-
|
723
|
+
require 'time'
|
1292
724
|
require 'launchdarkly_api'
|
1293
725
|
# setup authorization
|
1294
726
|
LaunchDarklyApi.configure do |config|
|
1295
|
-
# Configure API key authorization:
|
1296
|
-
config.api_key['
|
727
|
+
# Configure API key authorization: ApiKey
|
728
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1297
729
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1298
|
-
#config.api_key_prefix['
|
730
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1299
731
|
end
|
1300
732
|
|
1301
733
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1302
|
-
|
1303
|
-
|
1304
|
-
|
1305
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1306
|
-
|
1307
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
1308
|
-
|
1309
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
1310
|
-
|
1311
|
-
opts = {
|
1312
|
-
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
1313
|
-
}
|
734
|
+
proj_key = 'proj_key_example' # String | The project key.
|
735
|
+
key = 'key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
736
|
+
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})]}) # PatchWithComment |
|
1314
737
|
|
1315
738
|
begin
|
1316
|
-
#
|
1317
|
-
result = api_instance.
|
739
|
+
# Update feature flag
|
740
|
+
result = api_instance.patch_feature_flag(proj_key, key, patch_with_comment)
|
1318
741
|
p result
|
1319
742
|
rescue LaunchDarklyApi::ApiError => e
|
1320
|
-
puts "
|
743
|
+
puts "Error when calling FeatureFlagsApi->patch_feature_flag: #{e}"
|
1321
744
|
end
|
1322
745
|
```
|
1323
746
|
|
1324
|
-
|
1325
|
-
|
1326
|
-
Name | Type | Description | Notes
|
1327
|
-
------------- | ------------- | ------------- | -------------
|
1328
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1329
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1330
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1331
|
-
**approval_request_id** | **String**| The approval request ID |
|
1332
|
-
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
1333
|
-
|
1334
|
-
### Return type
|
1335
|
-
|
1336
|
-
[**ApprovalRequest**](ApprovalRequest.md)
|
1337
|
-
|
1338
|
-
### Authorization
|
1339
|
-
|
1340
|
-
[Token](../README.md#Token)
|
1341
|
-
|
1342
|
-
### HTTP request headers
|
747
|
+
#### Using the patch_feature_flag_with_http_info variant
|
1343
748
|
|
1344
|
-
|
1345
|
-
- **Accept**: application/json
|
749
|
+
This returns an Array which contains the response data, status code and headers.
|
1346
750
|
|
751
|
+
> <Array(<FeatureFlag>, Integer, Hash)> patch_feature_flag_with_http_info(proj_key, key, patch_with_comment)
|
1347
752
|
|
1348
|
-
|
1349
|
-
# **post_feature_flag**
|
1350
|
-
> FeatureFlag post_feature_flag(project_key, feature_flag_body, opts)
|
1351
|
-
|
1352
|
-
Creates a new feature flag.
|
1353
|
-
|
1354
|
-
### Example
|
1355
753
|
```ruby
|
1356
|
-
# load the gem
|
1357
|
-
require 'launchdarkly_api'
|
1358
|
-
# setup authorization
|
1359
|
-
LaunchDarklyApi.configure do |config|
|
1360
|
-
# Configure API key authorization: Token
|
1361
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1362
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1363
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1364
|
-
end
|
1365
|
-
|
1366
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1367
|
-
|
1368
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1369
|
-
|
1370
|
-
feature_flag_body = LaunchDarklyApi::FeatureFlagBody.new # FeatureFlagBody | Create a new feature flag.
|
1371
|
-
|
1372
|
-
opts = {
|
1373
|
-
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.
|
1374
|
-
}
|
1375
|
-
|
1376
754
|
begin
|
1377
|
-
#
|
1378
|
-
|
1379
|
-
p
|
755
|
+
# Update feature flag
|
756
|
+
data, status_code, headers = api_instance.patch_feature_flag_with_http_info(proj_key, key, patch_with_comment)
|
757
|
+
p status_code # => 2xx
|
758
|
+
p headers # => { ... }
|
759
|
+
p data # => <FeatureFlag>
|
1380
760
|
rescue LaunchDarklyApi::ApiError => e
|
1381
|
-
puts "
|
761
|
+
puts "Error when calling FeatureFlagsApi->patch_feature_flag_with_http_info: #{e}"
|
1382
762
|
end
|
1383
763
|
```
|
1384
764
|
|
1385
765
|
### Parameters
|
1386
766
|
|
1387
|
-
Name | Type | Description
|
1388
|
-
|
1389
|
-
**
|
1390
|
-
**
|
1391
|
-
**
|
767
|
+
| Name | Type | Description | Notes |
|
768
|
+
| ---- | ---- | ----------- | ----- |
|
769
|
+
| **proj_key** | **String** | The project key. | |
|
770
|
+
| **key** | **String** | The feature flag's key. The key identifies the flag in your code. | |
|
771
|
+
| **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
|
1392
772
|
|
1393
773
|
### Return type
|
1394
774
|
|
@@ -1396,137 +776,87 @@ Name | Type | Description | Notes
|
|
1396
776
|
|
1397
777
|
### Authorization
|
1398
778
|
|
1399
|
-
[
|
779
|
+
[ApiKey](../README.md#ApiKey)
|
1400
780
|
|
1401
781
|
### HTTP request headers
|
1402
782
|
|
1403
|
-
|
1404
|
-
|
783
|
+
- **Content-Type**: application/json
|
784
|
+
- **Accept**: application/json
|
1405
785
|
|
1406
786
|
|
787
|
+
## post_feature_flag
|
1407
788
|
|
1408
|
-
|
1409
|
-
> FeatureFlagScheduledChange post_flag_config_scheduled_changes(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, )
|
789
|
+
> <FeatureFlag> post_feature_flag(proj_key, feature_flag_body, opts)
|
1410
790
|
|
1411
|
-
|
791
|
+
Create a feature flag
|
792
|
+
|
793
|
+
Create a feature flag with the given name, key, and variations
|
794
|
+
|
795
|
+
### Examples
|
1412
796
|
|
1413
|
-
### Example
|
1414
797
|
```ruby
|
1415
|
-
|
798
|
+
require 'time'
|
1416
799
|
require 'launchdarkly_api'
|
1417
800
|
# setup authorization
|
1418
801
|
LaunchDarklyApi.configure do |config|
|
1419
|
-
# Configure API key authorization:
|
1420
|
-
config.api_key['
|
802
|
+
# Configure API key authorization: ApiKey
|
803
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1421
804
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1422
|
-
#config.api_key_prefix['
|
805
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1423
806
|
end
|
1424
807
|
|
1425
808
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1426
|
-
|
1427
|
-
|
1428
|
-
|
1429
|
-
|
1430
|
-
|
1431
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1432
|
-
|
1433
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
1434
|
-
|
809
|
+
proj_key = 'proj_key_example' # String | The project key.
|
810
|
+
feature_flag_body = LaunchDarklyApi::FeatureFlagBody.new({name: 'name_example', key: 'key_example'}) # FeatureFlagBody |
|
811
|
+
opts = {
|
812
|
+
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.
|
813
|
+
}
|
1435
814
|
|
1436
815
|
begin
|
1437
|
-
#
|
1438
|
-
result = api_instance.
|
816
|
+
# Create a feature flag
|
817
|
+
result = api_instance.post_feature_flag(proj_key, feature_flag_body, opts)
|
1439
818
|
p result
|
1440
819
|
rescue LaunchDarklyApi::ApiError => e
|
1441
|
-
puts "
|
820
|
+
puts "Error when calling FeatureFlagsApi->post_feature_flag: #{e}"
|
1442
821
|
end
|
1443
822
|
```
|
1444
823
|
|
1445
|
-
|
824
|
+
#### Using the post_feature_flag_with_http_info variant
|
1446
825
|
|
1447
|
-
|
1448
|
-
------------- | ------------- | ------------- | -------------
|
1449
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1450
|
-
**flag_config_scheduled_changes_post_body** | [**FlagConfigScheduledChangesPostBody**](FlagConfigScheduledChangesPostBody.md)| Create scheduled changes on a feature flag. |
|
1451
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1452
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
826
|
+
This returns an Array which contains the response data, status code and headers.
|
1453
827
|
|
1454
|
-
|
828
|
+
> <Array(<FeatureFlag>, Integer, Hash)> post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
|
1455
829
|
|
1456
|
-
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
1457
|
-
|
1458
|
-
### Authorization
|
1459
|
-
|
1460
|
-
[Token](../README.md#Token)
|
1461
|
-
|
1462
|
-
### HTTP request headers
|
1463
|
-
|
1464
|
-
- **Content-Type**: application/json
|
1465
|
-
- **Accept**: application/json
|
1466
|
-
|
1467
|
-
|
1468
|
-
|
1469
|
-
# **post_review_approval_request**
|
1470
|
-
> ApprovalRequests post_review_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body)
|
1471
|
-
|
1472
|
-
Review approval request for a feature flag config
|
1473
|
-
|
1474
|
-
### Example
|
1475
830
|
```ruby
|
1476
|
-
# load the gem
|
1477
|
-
require 'launchdarkly_api'
|
1478
|
-
# setup authorization
|
1479
|
-
LaunchDarklyApi.configure do |config|
|
1480
|
-
# Configure API key authorization: Token
|
1481
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1482
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1483
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1484
|
-
end
|
1485
|
-
|
1486
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1487
|
-
|
1488
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1489
|
-
|
1490
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1491
|
-
|
1492
|
-
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
1493
|
-
|
1494
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
1495
|
-
|
1496
|
-
approval_request_review_config_body = LaunchDarklyApi::ApprovalRequestReviewConfigBody.new # ApprovalRequestReviewConfigBody | Review an approval request
|
1497
|
-
|
1498
|
-
|
1499
831
|
begin
|
1500
|
-
#
|
1501
|
-
|
1502
|
-
p
|
832
|
+
# Create a feature flag
|
833
|
+
data, status_code, headers = api_instance.post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
|
834
|
+
p status_code # => 2xx
|
835
|
+
p headers # => { ... }
|
836
|
+
p data # => <FeatureFlag>
|
1503
837
|
rescue LaunchDarklyApi::ApiError => e
|
1504
|
-
puts "
|
838
|
+
puts "Error when calling FeatureFlagsApi->post_feature_flag_with_http_info: #{e}"
|
1505
839
|
end
|
1506
840
|
```
|
1507
841
|
|
1508
842
|
### Parameters
|
1509
843
|
|
1510
|
-
Name | Type | Description
|
1511
|
-
|
1512
|
-
**
|
1513
|
-
**
|
1514
|
-
**
|
1515
|
-
**approval_request_id** | **String**| The approval request ID |
|
1516
|
-
**approval_request_review_config_body** | [**ApprovalRequestReviewConfigBody**](ApprovalRequestReviewConfigBody.md)| Review an approval request |
|
844
|
+
| Name | Type | Description | Notes |
|
845
|
+
| ---- | ---- | ----------- | ----- |
|
846
|
+
| **proj_key** | **String** | The project key. | |
|
847
|
+
| **feature_flag_body** | [**FeatureFlagBody**](FeatureFlagBody.md) | | |
|
848
|
+
| **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] |
|
1517
849
|
|
1518
850
|
### Return type
|
1519
851
|
|
1520
|
-
[**
|
852
|
+
[**FeatureFlag**](FeatureFlag.md)
|
1521
853
|
|
1522
854
|
### Authorization
|
1523
855
|
|
1524
|
-
[
|
856
|
+
[ApiKey](../README.md#ApiKey)
|
1525
857
|
|
1526
858
|
### HTTP request headers
|
1527
859
|
|
1528
|
-
|
1529
|
-
|
1530
|
-
|
1531
|
-
|
860
|
+
- **Content-Type**: application/json
|
861
|
+
- **Accept**: application/json
|
1532
862
|
|