launchdarkly_api 5.0.3 → 6.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile +3 -1
- data/README.md +304 -249
- 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/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 +975 -0
- data/docs/ConfidenceIntervalRep.md +20 -0
- data/docs/Conflict.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 +25 -8
- data/docs/CustomRolePost.md +24 -0
- data/docs/CustomRolePostData.md +24 -0
- data/docs/CustomRoles.md +15 -4
- data/docs/CustomRolesApi.md +197 -101
- data/docs/DataExportDestinationsApi.md +205 -117
- data/docs/DefaultClientSideAvailabilityPost.md +20 -0
- data/docs/Defaults.md +15 -4
- data/docs/DependentFlag.md +24 -0
- data/docs/DependentFlagEnvironment.md +24 -0
- data/docs/DependentFlagsByEnvironment.md +22 -0
- data/docs/Destination.md +27 -9
- data/docs/DestinationPost.md +24 -0
- data/docs/Destinations.md +15 -4
- data/docs/Environment.md +35 -16
- data/docs/EnvironmentPost.md +29 -11
- data/docs/EnvironmentsApi.md +246 -144
- 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 +28 -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/ExtinctionRep.md +26 -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 +414 -969
- data/docs/FeatureFlagsBetaApi.md +157 -0
- data/docs/FlagConfigApprovalRequestResponse.md +54 -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/HunkRep.md +26 -0
- data/docs/InlineObject.md +26 -0
- data/docs/InlineObject1.md +28 -0
- data/docs/InlineResponse200.md +20 -0
- data/docs/IntegrationMetadata.md +24 -0
- data/docs/IntegrationStatus.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 +45 -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/MetricCollectionRep.md +20 -0
- data/docs/MetricListingRep.md +52 -0
- data/docs/MetricPost.md +40 -0
- data/docs/MetricRep.md +62 -0
- data/docs/MetricsApi.md +376 -0
- data/docs/Modification.md +18 -0
- data/docs/MultiEnvironmentDependentFlag.md +22 -0
- data/docs/MultiEnvironmentDependentFlags.md +22 -0
- data/docs/NewMemberForm.md +28 -0
- data/docs/OtherApi.md +282 -0
- data/docs/ParentResourceRep.md +22 -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/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/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/ReviewResponse.md +26 -0
- data/docs/Rollout.md +19 -4
- data/docs/Rule.md +23 -8
- 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/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/SubjectDataRep.md +22 -0
- data/docs/Target.md +15 -4
- data/docs/TargetResourceRep.md +22 -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/UrlPost.md +24 -0
- data/docs/User.md +25 -13
- data/docs/UserAttributeNamesRep.md +22 -0
- data/docs/UserFlagSetting.md +17 -5
- data/docs/UserFlagSettings.md +15 -4
- data/docs/UserRecord.md +21 -7
- data/docs/UserSegment.md +47 -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 +184 -115
- data/docs/UsersBetaApi.md +81 -0
- data/docs/ValuePut.md +20 -0
- data/docs/Variate.md +24 -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/git_push.sh +12 -10
- data/launchdarkly_api.gemspec +6 -14
- data/lib/launchdarkly_api/api/access_tokens_api.rb +190 -122
- data/lib/launchdarkly_api/api/account_members_api.rb +351 -0
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +598 -0
- data/lib/launchdarkly_api/api/approvals_api.rb +601 -0
- data/lib/launchdarkly_api/api/audit_log_api.rb +72 -51
- data/lib/launchdarkly_api/api/code_references_api.rb +898 -0
- data/lib/launchdarkly_api/api/custom_roles_api.rb +163 -106
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +202 -145
- data/lib/launchdarkly_api/api/environments_api.rb +197 -132
- data/lib/launchdarkly_api/api/experiments_beta_api.rb +188 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +445 -1160
- data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -0
- data/lib/launchdarkly_api/api/metrics_api.rb +369 -0
- data/lib/launchdarkly_api/api/other_api.rb +248 -0
- data/lib/launchdarkly_api/api/projects_api.rb +147 -90
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +195 -127
- data/lib/launchdarkly_api/api/scheduled_changes_api.rb +435 -0
- data/lib/launchdarkly_api/api/segments_api.rb +719 -0
- data/lib/launchdarkly_api/api/user_settings_api.rb +237 -180
- data/lib/launchdarkly_api/api/users_api.rb +180 -138
- data/lib/launchdarkly_api/api/users_beta_api.rb +91 -0
- data/lib/launchdarkly_api/api/webhooks_api.rb +170 -113
- data/lib/launchdarkly_api/api_client.rb +87 -88
- data/lib/launchdarkly_api/api_error.rb +23 -4
- data/lib/launchdarkly_api/configuration.rb +83 -15
- data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +276 -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/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 +241 -0
- data/lib/launchdarkly_api/models/branch_rep.rb +267 -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/confidence_interval_rep.rb +227 -0
- data/lib/launchdarkly_api/models/conflict.rb +230 -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 +281 -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 +101 -34
- data/lib/launchdarkly_api/models/custom_role_post.rb +265 -0
- data/lib/launchdarkly_api/models/custom_role_post_data.rb +265 -0
- data/lib/launchdarkly_api/models/custom_roles.rb +58 -22
- 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 +262 -0
- data/lib/launchdarkly_api/models/dependent_flag_environment.rb +262 -0
- data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +255 -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 +144 -73
- data/lib/launchdarkly_api/models/environment_post.rb +90 -56
- 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 +271 -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 +274 -0
- data/lib/launchdarkly_api/models/extinction_collection_rep.rb +241 -0
- data/lib/launchdarkly_api/models/extinction_rep.rb +279 -0
- data/lib/launchdarkly_api/models/feature_flag.rb +276 -123
- data/lib/launchdarkly_api/models/feature_flag_body.rb +105 -55
- 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 +448 -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/hunk_rep.rb +256 -0
- data/lib/launchdarkly_api/models/inline_object.rb +274 -0
- data/lib/launchdarkly_api/models/inline_object1.rb +276 -0
- data/lib/launchdarkly_api/models/inline_response200.rb +227 -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/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 +213 -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/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/modification.rb +218 -0
- data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +248 -0
- data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +255 -0
- data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
- data/lib/launchdarkly_api/models/parent_resource_rep.rb +239 -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/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/reference_rep.rb +238 -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 +241 -0
- data/lib/launchdarkly_api/models/repository_post.rb +304 -0
- data/lib/launchdarkly_api/models/repository_rep.rb +342 -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_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/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/statement.rb +66 -63
- data/lib/launchdarkly_api/models/statement_post.rb +271 -0
- data/lib/launchdarkly_api/models/statement_post_data.rb +271 -0
- data/lib/launchdarkly_api/models/statement_rep.rb +266 -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/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/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/url_post.rb +279 -0
- data/lib/launchdarkly_api/models/user.rb +97 -96
- 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 +69 -34
- data/lib/launchdarkly_api/models/user_segment.rb +186 -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 +72 -26
- data/lib/launchdarkly_api/models/value_put.rb +229 -0
- data/lib/launchdarkly_api/models/variate.rb +246 -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 +134 -93
- 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 +23 -18
- 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 -228
- 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/user_settings_api_spec.rb +41 -36
- data/spec/api/users_api_spec.rb +33 -29
- data/spec/api/users_beta_api_spec.rb +48 -0
- data/spec/api/webhooks_api_spec.rb +27 -22
- data/spec/api_client_spec.rb +5 -22
- 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/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/confidence_interval_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 +52 -0
- data/spec/models/custom_role_post_spec.rb +52 -0
- data/spec/models/custom_role_spec.rb +14 -15
- data/spec/models/custom_roles_spec.rb +8 -15
- 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 +52 -0
- data/spec/models/dependent_flag_spec.rb +52 -0
- data/spec/models/dependent_flags_by_environment_spec.rb +46 -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 +8 -27
- 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 +64 -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_rep_spec.rb +58 -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 +142 -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/hunk_rep_spec.rb +58 -0
- data/spec/models/inline_object1_spec.rb +64 -0
- data/spec/models/inline_object_spec.rb +58 -0
- data/spec/models/inline_response200_spec.rb +40 -0
- data/spec/models/integration_metadata_spec.rb +52 -0
- data/spec/models/integration_status_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 +44 -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/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/modification_spec.rb +34 -0
- data/spec/models/multi_environment_dependent_flag_spec.rb +46 -0
- data/spec/models/multi_environment_dependent_flags_spec.rb +46 -0
- data/spec/models/new_member_form_spec.rb +64 -0
- data/spec/models/parent_resource_rep_spec.rb +46 -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/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/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 +94 -0
- data/spec/models/resource_access_spec.rb +40 -0
- data/spec/models/resource_id_response_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/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/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/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/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/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_spec.rb +9 -16
- data/spec/models/user_segment_rule_spec.rb +14 -15
- data/spec/models/user_segment_spec.rb +52 -23
- data/spec/models/user_segments_spec.rb +10 -17
- data/spec/models/user_spec.rb +15 -46
- data/spec/models/users_spec.rb +8 -15
- data/spec/models/value_put_spec.rb +40 -0
- data/spec/models/variate_spec.rb +52 -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 +831 -562
- 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/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 -12
- 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/IntegrationLinks.md +0 -8
- 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/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 -260
- 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__links.rb +0 -184
- 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 -4719
- 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/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 -69
- 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__links_spec.rb +0 -41
- 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/FeatureFlagStatus.md
CHANGED
@@ -1,11 +1,22 @@
|
|
1
1
|
# LaunchDarklyApi::FeatureFlagStatus
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | | Name | Description | | --------:| ----------- | | new | the feature flag was created within the last 7 days, and has not been requested yet | | active | the feature flag was requested by your servers or clients within the last 7 days | | inactive | the feature flag was created more than 7 days ago, and hasn't been requested by your servers or clients within the past 7 days | | launched | one variation of the feature flag has been rolled out to all your users for at least 7 days | | [optional]
|
7
|
-
**last_requested** | **String** | | [optional]
|
8
|
-
**default** | **Object** | | [optional]
|
9
|
-
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
10
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Status of the flag | |
|
8
|
+
| **last_requested** | **Time** | Timestamp of last time flag was requested | [optional] |
|
9
|
+
| **default** | **Object** | Default value seen from code | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'launchdarkly_api'
|
15
|
+
|
16
|
+
instance = LaunchDarklyApi::FeatureFlagStatus.new(
|
17
|
+
name: inactive,
|
18
|
+
last_requested: 2020-02-05T18:17:01.514Z,
|
19
|
+
default: null
|
20
|
+
)
|
21
|
+
```
|
11
22
|
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# LaunchDarklyApi::FeatureFlagStatusAcrossEnvironments
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
7
|
-
**key** | **String** | | [optional]
|
8
|
-
**environments** | [**Hash<String, FeatureFlagStatusForQueriedEnvironment>**](FeatureFlagStatusForQueriedEnvironment.md) | | [optional]
|
9
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **environments** | [**Hash<String, FeatureFlagStatus>**](FeatureFlagStatus.md) | Flag status for environment. | [optional] |
|
8
|
+
| **key** | **String** | feature flag key | [optional] |
|
9
|
+
| **_links** | [**Hash<String, Link>**](Link.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'launchdarkly_api'
|
15
|
+
|
16
|
+
instance = LaunchDarklyApi::FeatureFlagStatusAcrossEnvironments.new(
|
17
|
+
environments: {"production":{"lastRequested":"2020-02-05T18:17:01.514Z","name":"inactive"}},
|
18
|
+
key: my-flag,
|
19
|
+
_links: {"parent":{"href":"/api/v2/flag-status","type":"application/json"},"self":{"href":"/api/v2/flag-status/my-project/my-flag","type":"application/json"}}
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|
data/docs/FeatureFlagStatuses.md
CHANGED
@@ -1,9 +1,20 @@
|
|
1
1
|
# LaunchDarklyApi::FeatureFlagStatuses
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
7
|
-
**items** | [**Array<FeatureFlagStatus>**](FeatureFlagStatus.md) | | [optional]
|
8
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_links** | [**Hash<String, Link>**](Link.md) | | |
|
8
|
+
| **items** | [**Array<FlagStatusRep>**](FlagStatusRep.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'launchdarkly_api'
|
14
|
+
|
15
|
+
instance = LaunchDarklyApi::FeatureFlagStatuses.new(
|
16
|
+
_links: {"self":{"href":"/api/v2/flag-statuses/my-project/my-environment","type":"application/json"}},
|
17
|
+
items: null
|
18
|
+
)
|
19
|
+
```
|
9
20
|
|
data/docs/FeatureFlags.md
CHANGED
@@ -1,10 +1,22 @@
|
|
1
1
|
# LaunchDarklyApi::FeatureFlags
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**_links** | [**Links**](Links.md) | | [optional]
|
7
|
-
**items** | [**Array<FeatureFlag>**](FeatureFlag.md) | | [optional]
|
8
|
-
**total_count** | **Float** | | [optional]
|
9
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**Array<FeatureFlag>**](FeatureFlag.md) | | |
|
8
|
+
| **_links** | [**Hash<String, Link>**](Link.md) | | |
|
9
|
+
| **total_count** | **Integer** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'launchdarkly_api'
|
15
|
+
|
16
|
+
instance = LaunchDarklyApi::FeatureFlags.new(
|
17
|
+
items: null,
|
18
|
+
_links: {"self":{"href":"/api/v2/flags/default","type":"application/json"}},
|
19
|
+
total_count: 1
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|
data/docs/FeatureFlagsApi.md
CHANGED
@@ -1,1279 +1,774 @@
|
|
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
|
-
[**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
|
12
|
-
[**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
|
13
|
-
[**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
|
14
|
-
[**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /flags/{projectKey}/{featureFlagKey} | Get a single feature flag by key.
|
15
|
-
[**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get the status for a particular feature flag.
|
16
|
-
[**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
|
17
|
-
[**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.
|
18
|
-
[**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /flags/{projectKey} | Get a list of all features in the given project.
|
19
|
-
[**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.
|
20
|
-
[**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.
|
21
|
-
[**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.
|
22
|
-
[**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
|
23
|
-
[**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
|
24
|
-
[**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.
|
25
|
-
[**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
|
26
|
-
[**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
|
27
|
-
[**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
|
28
|
-
[**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.
|
29
|
-
[**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
|
30
|
-
|
31
|
-
|
32
|
-
# **copy_feature_flag**
|
33
|
-
> FeatureFlag copy_feature_flag(project_key, feature_flag_key, feature_flag_copy_body)
|
34
|
-
|
35
|
-
Copies the feature flag configuration from one environment to the same feature flag in another environment.
|
36
|
-
|
37
|
-
### Example
|
38
|
-
```ruby
|
39
|
-
# load the gem
|
40
|
-
require 'launchdarkly_api'
|
41
|
-
# setup authorization
|
42
|
-
LaunchDarklyApi.configure do |config|
|
43
|
-
# Configure API key authorization: Token
|
44
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
45
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
46
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
47
|
-
end
|
48
|
-
|
49
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
50
|
-
|
51
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
52
|
-
|
53
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
54
|
-
|
55
|
-
feature_flag_copy_body = LaunchDarklyApi::FeatureFlagCopyBody.new # FeatureFlagCopyBody | Copy feature flag configurations between environments.
|
56
|
-
|
57
|
-
|
58
|
-
begin
|
59
|
-
#Copies the feature flag configuration from one environment to the same feature flag in another environment.
|
60
|
-
result = api_instance.copy_feature_flag(project_key, feature_flag_key, feature_flag_copy_body)
|
61
|
-
p result
|
62
|
-
rescue LaunchDarklyApi::ApiError => e
|
63
|
-
puts "Exception when calling FeatureFlagsApi->copy_feature_flag: #{e}"
|
64
|
-
end
|
65
|
-
```
|
66
|
-
|
67
|
-
### Parameters
|
68
|
-
|
69
|
-
Name | Type | Description | Notes
|
70
|
-
------------- | ------------- | ------------- | -------------
|
71
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
72
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
73
|
-
**feature_flag_copy_body** | [**FeatureFlagCopyBody**](FeatureFlagCopyBody.md)| Copy feature flag configurations between environments. |
|
74
|
-
|
75
|
-
### Return type
|
76
|
-
|
77
|
-
[**FeatureFlag**](FeatureFlag.md)
|
78
|
-
|
79
|
-
### Authorization
|
3
|
+
All URIs are relative to *https://app.launchdarkly.com*
|
80
4
|
|
81
|
-
|
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 |
|
82
18
|
|
83
|
-
### HTTP request headers
|
84
19
|
|
85
|
-
|
86
|
-
- **Accept**: application/json
|
20
|
+
## copy_feature_flag
|
87
21
|
|
22
|
+
> <FeatureFlag> copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post)
|
88
23
|
|
24
|
+
Copy feature flag
|
89
25
|
|
90
|
-
|
91
|
-
> delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, , opts)
|
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.
|
92
27
|
|
93
|
-
|
28
|
+
### Examples
|
94
29
|
|
95
|
-
### Example
|
96
30
|
```ruby
|
97
|
-
|
31
|
+
require 'time'
|
98
32
|
require 'launchdarkly_api'
|
99
33
|
# setup authorization
|
100
34
|
LaunchDarklyApi.configure do |config|
|
101
|
-
# Configure API key authorization:
|
102
|
-
config.api_key['
|
35
|
+
# Configure API key authorization: ApiKey
|
36
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
103
37
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
104
|
-
#config.api_key_prefix['
|
38
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
105
39
|
end
|
106
40
|
|
107
41
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
108
|
-
|
109
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
110
|
-
|
111
|
-
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.
|
112
|
-
|
42
|
+
proj_key = 'proj_key_example' # String | The project key.
|
113
43
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
114
|
-
|
115
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
116
|
-
|
117
|
-
opts = {
|
118
|
-
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
119
|
-
}
|
44
|
+
flag_copy_config_post = LaunchDarklyApi::FlagCopyConfigPost.new({source: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'}), target: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'})}) # FlagCopyConfigPost |
|
120
45
|
|
121
46
|
begin
|
122
|
-
#
|
123
|
-
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
|
124
50
|
rescue LaunchDarklyApi::ApiError => e
|
125
|
-
puts "
|
51
|
+
puts "Error when calling FeatureFlagsApi->copy_feature_flag: #{e}"
|
126
52
|
end
|
127
53
|
```
|
128
54
|
|
129
|
-
|
55
|
+
#### Using the copy_feature_flag_with_http_info variant
|
130
56
|
|
131
|
-
|
132
|
-
------------- | ------------- | ------------- | -------------
|
133
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
134
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
135
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
136
|
-
**approval_request_id** | **String**| The approval request ID |
|
137
|
-
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
138
58
|
|
139
|
-
|
59
|
+
> <Array(<FeatureFlag>, Integer, Hash)> copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post)
|
140
60
|
|
141
|
-
nil (empty response body)
|
142
|
-
|
143
|
-
### Authorization
|
144
|
-
|
145
|
-
[Token](../README.md#Token)
|
146
|
-
|
147
|
-
### HTTP request headers
|
148
|
-
|
149
|
-
- **Content-Type**: application/json
|
150
|
-
- **Accept**: application/json
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
# **delete_feature_flag**
|
155
|
-
> delete_feature_flag(project_key, feature_flag_key, )
|
156
|
-
|
157
|
-
Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
|
158
|
-
|
159
|
-
### Example
|
160
61
|
```ruby
|
161
|
-
# load the gem
|
162
|
-
require 'launchdarkly_api'
|
163
|
-
# setup authorization
|
164
|
-
LaunchDarklyApi.configure do |config|
|
165
|
-
# Configure API key authorization: Token
|
166
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
167
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
168
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
169
|
-
end
|
170
|
-
|
171
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
172
|
-
|
173
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
174
|
-
|
175
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
176
|
-
|
177
|
-
|
178
62
|
begin
|
179
|
-
#
|
180
|
-
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>
|
181
68
|
rescue LaunchDarklyApi::ApiError => e
|
182
|
-
puts "
|
69
|
+
puts "Error when calling FeatureFlagsApi->copy_feature_flag_with_http_info: #{e}"
|
183
70
|
end
|
184
71
|
```
|
185
72
|
|
186
73
|
### Parameters
|
187
74
|
|
188
|
-
Name | Type | Description
|
189
|
-
|
190
|
-
**
|
191
|
-
**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) | | |
|
192
80
|
|
193
81
|
### Return type
|
194
82
|
|
195
|
-
|
83
|
+
[**FeatureFlag**](FeatureFlag.md)
|
196
84
|
|
197
85
|
### Authorization
|
198
86
|
|
199
|
-
[
|
87
|
+
[ApiKey](../README.md#ApiKey)
|
200
88
|
|
201
89
|
### HTTP request headers
|
202
90
|
|
203
|
-
|
204
|
-
|
91
|
+
- **Content-Type**: application/json
|
92
|
+
- **Accept**: application/json
|
93
|
+
|
205
94
|
|
95
|
+
## delete_feature_flag
|
206
96
|
|
97
|
+
> delete_feature_flag(proj_key, key)
|
207
98
|
|
208
|
-
|
209
|
-
> delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
99
|
+
Delete feature flag
|
210
100
|
|
211
|
-
Delete a
|
101
|
+
Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
|
102
|
+
|
103
|
+
### Examples
|
212
104
|
|
213
|
-
### Example
|
214
105
|
```ruby
|
215
|
-
|
106
|
+
require 'time'
|
216
107
|
require 'launchdarkly_api'
|
217
108
|
# setup authorization
|
218
109
|
LaunchDarklyApi.configure do |config|
|
219
|
-
# Configure API key authorization:
|
220
|
-
config.api_key['
|
110
|
+
# Configure API key authorization: ApiKey
|
111
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
221
112
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
222
|
-
#config.api_key_prefix['
|
113
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
223
114
|
end
|
224
115
|
|
225
116
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
230
|
-
|
231
|
-
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.
|
232
|
-
|
233
|
-
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
234
|
-
|
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.
|
235
119
|
|
236
120
|
begin
|
237
|
-
#Delete
|
238
|
-
api_instance.
|
121
|
+
# Delete feature flag
|
122
|
+
api_instance.delete_feature_flag(proj_key, key)
|
239
123
|
rescue LaunchDarklyApi::ApiError => e
|
240
|
-
puts "
|
124
|
+
puts "Error when calling FeatureFlagsApi->delete_feature_flag: #{e}"
|
241
125
|
end
|
242
126
|
```
|
243
127
|
|
244
|
-
|
245
|
-
|
246
|
-
Name | Type | Description | Notes
|
247
|
-
------------- | ------------- | ------------- | -------------
|
248
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
249
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
250
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
251
|
-
**scheduled_change_id** | **String**| The id of the scheduled change |
|
252
|
-
|
253
|
-
### Return type
|
254
|
-
|
255
|
-
nil (empty response body)
|
256
|
-
|
257
|
-
### Authorization
|
258
|
-
|
259
|
-
[Token](../README.md#Token)
|
260
|
-
|
261
|
-
### HTTP request headers
|
262
|
-
|
263
|
-
- **Content-Type**: application/json
|
264
|
-
- **Accept**: application/json
|
265
|
-
|
128
|
+
#### Using the delete_feature_flag_with_http_info variant
|
266
129
|
|
130
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
267
131
|
|
268
|
-
|
269
|
-
> ApprovalRequests get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
132
|
+
> <Array(nil, Integer, Hash)> delete_feature_flag_with_http_info(proj_key, key)
|
270
133
|
|
271
|
-
Get a single approval request for a feature flag config
|
272
|
-
|
273
|
-
### Example
|
274
134
|
```ruby
|
275
|
-
# load the gem
|
276
|
-
require 'launchdarkly_api'
|
277
|
-
# setup authorization
|
278
|
-
LaunchDarklyApi.configure do |config|
|
279
|
-
# Configure API key authorization: Token
|
280
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
281
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
282
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
283
|
-
end
|
284
|
-
|
285
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
286
|
-
|
287
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
288
|
-
|
289
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
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
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
294
|
-
|
295
|
-
|
296
135
|
begin
|
297
|
-
#
|
298
|
-
|
299
|
-
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
|
300
141
|
rescue LaunchDarklyApi::ApiError => e
|
301
|
-
puts "
|
142
|
+
puts "Error when calling FeatureFlagsApi->delete_feature_flag_with_http_info: #{e}"
|
302
143
|
end
|
303
144
|
```
|
304
145
|
|
305
146
|
### Parameters
|
306
147
|
|
307
|
-
Name | Type | Description
|
308
|
-
|
309
|
-
**
|
310
|
-
**
|
311
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
312
|
-
**approval_request_id** | **String**| The approval request ID |
|
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. | |
|
313
152
|
|
314
153
|
### Return type
|
315
154
|
|
316
|
-
|
155
|
+
nil (empty response body)
|
317
156
|
|
318
157
|
### Authorization
|
319
158
|
|
320
|
-
[
|
159
|
+
[ApiKey](../README.md#ApiKey)
|
321
160
|
|
322
161
|
### HTTP request headers
|
323
162
|
|
324
|
-
|
325
|
-
|
163
|
+
- **Content-Type**: Not defined
|
164
|
+
- **Accept**: Not defined
|
326
165
|
|
327
166
|
|
167
|
+
## get_expiring_user_targets
|
328
168
|
|
329
|
-
|
330
|
-
> ApprovalRequests get_approval_requests(project_key, feature_flag_key, environment_key, )
|
169
|
+
> <ExpiringUserTargetGetResponse> get_expiring_user_targets(proj_key, env_key, flag_key)
|
331
170
|
|
332
|
-
Get
|
171
|
+
Get expiring user targets for feature flag
|
172
|
+
|
173
|
+
Get a list of user targets on a feature flag that are scheduled for removal.
|
174
|
+
|
175
|
+
### Examples
|
333
176
|
|
334
|
-
### Example
|
335
177
|
```ruby
|
336
|
-
|
178
|
+
require 'time'
|
337
179
|
require 'launchdarkly_api'
|
338
180
|
# setup authorization
|
339
181
|
LaunchDarklyApi.configure do |config|
|
340
|
-
# Configure API key authorization:
|
341
|
-
config.api_key['
|
182
|
+
# Configure API key authorization: ApiKey
|
183
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
342
184
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
343
|
-
#config.api_key_prefix['
|
185
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
344
186
|
end
|
345
187
|
|
346
188
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
351
|
-
|
352
|
-
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.
|
353
|
-
|
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.
|
354
192
|
|
355
193
|
begin
|
356
|
-
#Get
|
357
|
-
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)
|
358
196
|
p result
|
359
197
|
rescue LaunchDarklyApi::ApiError => e
|
360
|
-
puts "
|
198
|
+
puts "Error when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
|
361
199
|
end
|
362
200
|
```
|
363
201
|
|
364
|
-
|
365
|
-
|
366
|
-
Name | Type | Description | Notes
|
367
|
-
------------- | ------------- | ------------- | -------------
|
368
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
369
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
370
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
371
|
-
|
372
|
-
### Return type
|
373
|
-
|
374
|
-
[**ApprovalRequests**](ApprovalRequests.md)
|
375
|
-
|
376
|
-
### Authorization
|
377
|
-
|
378
|
-
[Token](../README.md#Token)
|
379
|
-
|
380
|
-
### HTTP request headers
|
381
|
-
|
382
|
-
- **Content-Type**: application/json
|
383
|
-
- **Accept**: application/json
|
384
|
-
|
202
|
+
#### Using the get_expiring_user_targets_with_http_info variant
|
385
203
|
|
204
|
+
This returns an Array which contains the response data, status code and headers.
|
386
205
|
|
387
|
-
|
388
|
-
> UserTargetingExpirationForFlags get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
206
|
+
> <Array(<ExpiringUserTargetGetResponse>, Integer, Hash)> get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key)
|
389
207
|
|
390
|
-
Get expiring user targets for feature flag
|
391
|
-
|
392
|
-
### Example
|
393
208
|
```ruby
|
394
|
-
# load the gem
|
395
|
-
require 'launchdarkly_api'
|
396
|
-
# setup authorization
|
397
|
-
LaunchDarklyApi.configure do |config|
|
398
|
-
# Configure API key authorization: Token
|
399
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
400
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
401
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
402
|
-
end
|
403
|
-
|
404
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
405
|
-
|
406
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
407
|
-
|
408
|
-
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.
|
409
|
-
|
410
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
411
|
-
|
412
|
-
|
413
209
|
begin
|
414
|
-
#Get expiring user targets for feature flag
|
415
|
-
|
416
|
-
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>
|
417
215
|
rescue LaunchDarklyApi::ApiError => e
|
418
|
-
puts "
|
216
|
+
puts "Error when calling FeatureFlagsApi->get_expiring_user_targets_with_http_info: #{e}"
|
419
217
|
end
|
420
218
|
```
|
421
219
|
|
422
220
|
### Parameters
|
423
221
|
|
424
|
-
Name | Type | Description
|
425
|
-
|
426
|
-
**
|
427
|
-
**
|
428
|
-
**
|
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. | |
|
429
227
|
|
430
228
|
### Return type
|
431
229
|
|
432
|
-
[**
|
230
|
+
[**ExpiringUserTargetGetResponse**](ExpiringUserTargetGetResponse.md)
|
433
231
|
|
434
232
|
### Authorization
|
435
233
|
|
436
|
-
[
|
234
|
+
[ApiKey](../README.md#ApiKey)
|
437
235
|
|
438
236
|
### HTTP request headers
|
439
237
|
|
440
|
-
|
441
|
-
|
238
|
+
- **Content-Type**: Not defined
|
239
|
+
- **Accept**: application/json
|
240
|
+
|
442
241
|
|
242
|
+
## get_feature_flag
|
443
243
|
|
244
|
+
> <FeatureFlag> get_feature_flag(proj_key, key, opts)
|
444
245
|
|
445
|
-
|
446
|
-
> FeatureFlag get_feature_flag(project_key, feature_flag_key, , opts)
|
246
|
+
Get feature flag
|
447
247
|
|
448
|
-
Get a single feature flag by key.
|
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
|
449
251
|
|
450
|
-
### Example
|
451
252
|
```ruby
|
452
|
-
|
253
|
+
require 'time'
|
453
254
|
require 'launchdarkly_api'
|
454
255
|
# setup authorization
|
455
256
|
LaunchDarklyApi.configure do |config|
|
456
|
-
# Configure API key authorization:
|
457
|
-
config.api_key['
|
257
|
+
# Configure API key authorization: ApiKey
|
258
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
458
259
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
459
|
-
#config.api_key_prefix['
|
260
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
460
261
|
end
|
461
262
|
|
462
263
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
opts = {
|
469
|
-
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.
|
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
|
470
268
|
}
|
471
269
|
|
472
270
|
begin
|
473
|
-
#Get
|
474
|
-
result = api_instance.get_feature_flag(
|
271
|
+
# Get feature flag
|
272
|
+
result = api_instance.get_feature_flag(proj_key, key, opts)
|
475
273
|
p result
|
476
274
|
rescue LaunchDarklyApi::ApiError => e
|
477
|
-
puts "
|
275
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag: #{e}"
|
478
276
|
end
|
479
277
|
```
|
480
278
|
|
481
|
-
|
279
|
+
#### Using the get_feature_flag_with_http_info variant
|
482
280
|
|
483
|
-
|
484
|
-
------------- | ------------- | ------------- | -------------
|
485
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
486
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
487
|
-
**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]
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
488
282
|
|
489
|
-
|
283
|
+
> <Array(<FeatureFlag>, Integer, Hash)> get_feature_flag_with_http_info(proj_key, key, opts)
|
490
284
|
|
491
|
-
[**FeatureFlag**](FeatureFlag.md)
|
492
|
-
|
493
|
-
### Authorization
|
494
|
-
|
495
|
-
[Token](../README.md#Token)
|
496
|
-
|
497
|
-
### HTTP request headers
|
498
|
-
|
499
|
-
- **Content-Type**: application/json
|
500
|
-
- **Accept**: application/json
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
# **get_feature_flag_status**
|
505
|
-
> FeatureFlagStatus get_feature_flag_status(project_key, environment_key, feature_flag_key, )
|
506
|
-
|
507
|
-
Get the status for a particular feature flag.
|
508
|
-
|
509
|
-
### Example
|
510
285
|
```ruby
|
511
|
-
# load the gem
|
512
|
-
require 'launchdarkly_api'
|
513
|
-
# setup authorization
|
514
|
-
LaunchDarklyApi.configure do |config|
|
515
|
-
# Configure API key authorization: Token
|
516
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
517
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
518
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
519
|
-
end
|
520
|
-
|
521
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
522
|
-
|
523
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
524
|
-
|
525
|
-
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.
|
526
|
-
|
527
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
528
|
-
|
529
|
-
|
530
286
|
begin
|
531
|
-
#Get
|
532
|
-
|
533
|
-
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>
|
534
292
|
rescue LaunchDarklyApi::ApiError => e
|
535
|
-
puts "
|
293
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_with_http_info: #{e}"
|
536
294
|
end
|
537
295
|
```
|
538
296
|
|
539
297
|
### Parameters
|
540
298
|
|
541
|
-
Name | Type | Description
|
542
|
-
|
543
|
-
**
|
544
|
-
**
|
545
|
-
**
|
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] |
|
546
304
|
|
547
305
|
### Return type
|
548
306
|
|
549
|
-
[**
|
307
|
+
[**FeatureFlag**](FeatureFlag.md)
|
550
308
|
|
551
309
|
### Authorization
|
552
310
|
|
553
|
-
[
|
311
|
+
[ApiKey](../README.md#ApiKey)
|
554
312
|
|
555
313
|
### HTTP request headers
|
556
314
|
|
557
|
-
|
558
|
-
|
315
|
+
- **Content-Type**: Not defined
|
316
|
+
- **Accept**: application/json
|
317
|
+
|
559
318
|
|
319
|
+
## get_feature_flag_status
|
560
320
|
|
321
|
+
> <FlagStatusRep> get_feature_flag_status(proj_key, env_key, key)
|
561
322
|
|
562
|
-
|
563
|
-
> FeatureFlagStatusAcrossEnvironments get_feature_flag_status_across_environments(project_key, feature_flag_key, )
|
323
|
+
Get feature flag status
|
564
324
|
|
565
|
-
Get the status for a particular feature flag
|
325
|
+
Get the status for a particular feature flag.
|
326
|
+
|
327
|
+
### Examples
|
566
328
|
|
567
|
-
### Example
|
568
329
|
```ruby
|
569
|
-
|
330
|
+
require 'time'
|
570
331
|
require 'launchdarkly_api'
|
571
332
|
# setup authorization
|
572
333
|
LaunchDarklyApi.configure do |config|
|
573
|
-
# Configure API key authorization:
|
574
|
-
config.api_key['
|
334
|
+
# Configure API key authorization: ApiKey
|
335
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
575
336
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
576
|
-
#config.api_key_prefix['
|
337
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
577
338
|
end
|
578
339
|
|
579
340
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
584
|
-
|
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
|
585
344
|
|
586
345
|
begin
|
587
|
-
#Get
|
588
|
-
result = api_instance.
|
346
|
+
# Get feature flag status
|
347
|
+
result = api_instance.get_feature_flag_status(proj_key, env_key, key)
|
589
348
|
p result
|
590
349
|
rescue LaunchDarklyApi::ApiError => e
|
591
|
-
puts "
|
350
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status: #{e}"
|
592
351
|
end
|
593
352
|
```
|
594
353
|
|
595
|
-
|
354
|
+
#### Using the get_feature_flag_status_with_http_info variant
|
596
355
|
|
597
|
-
|
598
|
-
------------- | ------------- | ------------- | -------------
|
599
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
600
|
-
**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.
|
601
357
|
|
602
|
-
|
358
|
+
> <Array(<FlagStatusRep>, Integer, Hash)> get_feature_flag_status_with_http_info(proj_key, env_key, key)
|
603
359
|
|
604
|
-
[**FeatureFlagStatusAcrossEnvironments**](FeatureFlagStatusAcrossEnvironments.md)
|
605
|
-
|
606
|
-
### Authorization
|
607
|
-
|
608
|
-
[Token](../README.md#Token)
|
609
|
-
|
610
|
-
### HTTP request headers
|
611
|
-
|
612
|
-
- **Content-Type**: application/json
|
613
|
-
- **Accept**: application/json
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
# **get_feature_flag_statuses**
|
618
|
-
> FeatureFlagStatuses get_feature_flag_statuses(project_key, environment_key, )
|
619
|
-
|
620
|
-
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.
|
621
|
-
|
622
|
-
### Example
|
623
360
|
```ruby
|
624
|
-
# load the gem
|
625
|
-
require 'launchdarkly_api'
|
626
|
-
# setup authorization
|
627
|
-
LaunchDarklyApi.configure do |config|
|
628
|
-
# Configure API key authorization: Token
|
629
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
630
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
631
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
632
|
-
end
|
633
|
-
|
634
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
635
|
-
|
636
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
637
|
-
|
638
|
-
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.
|
639
|
-
|
640
|
-
|
641
361
|
begin
|
642
|
-
#Get
|
643
|
-
|
644
|
-
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>
|
645
367
|
rescue LaunchDarklyApi::ApiError => e
|
646
|
-
puts "
|
368
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_with_http_info: #{e}"
|
647
369
|
end
|
648
370
|
```
|
649
371
|
|
650
372
|
### Parameters
|
651
373
|
|
652
|
-
Name | Type | Description
|
653
|
-
|
654
|
-
**
|
655
|
-
**
|
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 | |
|
656
379
|
|
657
380
|
### Return type
|
658
381
|
|
659
|
-
[**
|
382
|
+
[**FlagStatusRep**](FlagStatusRep.md)
|
660
383
|
|
661
384
|
### Authorization
|
662
385
|
|
663
|
-
[
|
386
|
+
[ApiKey](../README.md#ApiKey)
|
664
387
|
|
665
388
|
### HTTP request headers
|
666
389
|
|
667
|
-
|
668
|
-
|
390
|
+
- **Content-Type**: Not defined
|
391
|
+
- **Accept**: application/json
|
392
|
+
|
669
393
|
|
394
|
+
## get_feature_flag_status_across_environments
|
670
395
|
|
396
|
+
> <FeatureFlagStatusAcrossEnvironments> get_feature_flag_status_across_environments(proj_key, key, opts)
|
671
397
|
|
672
|
-
|
673
|
-
> FeatureFlags get_feature_flags(project_key, , opts)
|
398
|
+
Get flag status across environments
|
674
399
|
|
675
|
-
Get
|
400
|
+
Get the status for a particular feature flag across environments.
|
401
|
+
|
402
|
+
### Examples
|
676
403
|
|
677
|
-
### Example
|
678
404
|
```ruby
|
679
|
-
|
405
|
+
require 'time'
|
680
406
|
require 'launchdarkly_api'
|
681
407
|
# setup authorization
|
682
408
|
LaunchDarklyApi.configure do |config|
|
683
|
-
# Configure API key authorization:
|
684
|
-
config.api_key['
|
409
|
+
# Configure API key authorization: ApiKey
|
410
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
685
411
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
686
|
-
#config.api_key_prefix['
|
412
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
687
413
|
end
|
688
414
|
|
689
415
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
690
|
-
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
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.
|
695
|
-
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.
|
696
|
-
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.
|
697
|
-
limit: 8.14, # Float | The number of objects to return. Defaults to -1, which returns everything.
|
698
|
-
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.
|
699
|
-
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value.
|
700
|
-
sort: 'sort_example' # String | A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
|
701
|
-
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
|
702
420
|
}
|
703
421
|
|
704
422
|
begin
|
705
|
-
#Get
|
706
|
-
result = api_instance.
|
423
|
+
# Get flag status across environments
|
424
|
+
result = api_instance.get_feature_flag_status_across_environments(proj_key, key, opts)
|
707
425
|
p result
|
708
426
|
rescue LaunchDarklyApi::ApiError => e
|
709
|
-
puts "
|
427
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_across_environments: #{e}"
|
710
428
|
end
|
711
429
|
```
|
712
430
|
|
713
|
-
|
714
|
-
|
715
|
-
Name | Type | Description | Notes
|
716
|
-
------------- | ------------- | ------------- | -------------
|
717
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
718
|
-
**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]
|
719
|
-
**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]
|
720
|
-
**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]
|
721
|
-
**limit** | **Float**| The number of objects to return. Defaults to -1, which returns everything. | [optional]
|
722
|
-
**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]
|
723
|
-
**filter** | **String**| A comma-separated list of filters. Each filter is of the form field:value. | [optional]
|
724
|
-
**sort** | **String**| A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order. | [optional]
|
725
|
-
**tag** | **String**| Filter by tag. A tag can be used to group flags across projects. | [optional]
|
431
|
+
#### Using the get_feature_flag_status_across_environments_with_http_info variant
|
726
432
|
|
727
|
-
|
433
|
+
This returns an Array which contains the response data, status code and headers.
|
728
434
|
|
729
|
-
|
435
|
+
> <Array(<FeatureFlagStatusAcrossEnvironments>, Integer, Hash)> get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts)
|
730
436
|
|
731
|
-
### Authorization
|
732
|
-
|
733
|
-
[Token](../README.md#Token)
|
734
|
-
|
735
|
-
### HTTP request headers
|
736
|
-
|
737
|
-
- **Content-Type**: application/json
|
738
|
-
- **Accept**: application/json
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
# **get_flag_config_scheduled_change**
|
743
|
-
> FeatureFlagScheduledChange get_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
744
|
-
|
745
|
-
Get a scheduled change on a feature flag by id.
|
746
|
-
|
747
|
-
### Example
|
748
437
|
```ruby
|
749
|
-
# load the gem
|
750
|
-
require 'launchdarkly_api'
|
751
|
-
# setup authorization
|
752
|
-
LaunchDarklyApi.configure do |config|
|
753
|
-
# Configure API key authorization: Token
|
754
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
755
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
756
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
757
|
-
end
|
758
|
-
|
759
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
760
|
-
|
761
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
762
|
-
|
763
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
764
|
-
|
765
|
-
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.
|
766
|
-
|
767
|
-
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
768
|
-
|
769
|
-
|
770
438
|
begin
|
771
|
-
#Get
|
772
|
-
|
773
|
-
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>
|
774
444
|
rescue LaunchDarklyApi::ApiError => e
|
775
|
-
puts "
|
445
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_across_environments_with_http_info: #{e}"
|
776
446
|
end
|
777
447
|
```
|
778
448
|
|
779
449
|
### Parameters
|
780
450
|
|
781
|
-
Name | Type | Description
|
782
|
-
|
783
|
-
**
|
784
|
-
**
|
785
|
-
**
|
786
|
-
**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] |
|
787
456
|
|
788
457
|
### Return type
|
789
458
|
|
790
|
-
[**
|
459
|
+
[**FeatureFlagStatusAcrossEnvironments**](FeatureFlagStatusAcrossEnvironments.md)
|
791
460
|
|
792
461
|
### Authorization
|
793
462
|
|
794
|
-
[
|
463
|
+
[ApiKey](../README.md#ApiKey)
|
795
464
|
|
796
465
|
### HTTP request headers
|
797
466
|
|
798
|
-
|
799
|
-
|
467
|
+
- **Content-Type**: Not defined
|
468
|
+
- **Accept**: application/json
|
469
|
+
|
800
470
|
|
471
|
+
## get_feature_flag_statuses
|
801
472
|
|
473
|
+
> <FeatureFlagStatuses> get_feature_flag_statuses(proj_key, env_key)
|
802
474
|
|
803
|
-
|
804
|
-
> FeatureFlagScheduledChanges get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, )
|
475
|
+
List feature flag statuses
|
805
476
|
|
806
|
-
Get
|
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
|
478
|
+
|
479
|
+
### Examples
|
807
480
|
|
808
|
-
### Example
|
809
481
|
```ruby
|
810
|
-
|
482
|
+
require 'time'
|
811
483
|
require 'launchdarkly_api'
|
812
484
|
# setup authorization
|
813
485
|
LaunchDarklyApi.configure do |config|
|
814
|
-
# Configure API key authorization:
|
815
|
-
config.api_key['
|
486
|
+
# Configure API key authorization: ApiKey
|
487
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
816
488
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
817
|
-
#config.api_key_prefix['
|
489
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
818
490
|
end
|
819
491
|
|
820
492
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
825
|
-
|
826
|
-
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.
|
827
|
-
|
493
|
+
proj_key = 'proj_key_example' # String | The project key
|
494
|
+
env_key = 'env_key_example' # String | Filter configurations by environment
|
828
495
|
|
829
496
|
begin
|
830
|
-
#
|
831
|
-
result = api_instance.
|
497
|
+
# List feature flag statuses
|
498
|
+
result = api_instance.get_feature_flag_statuses(proj_key, env_key)
|
832
499
|
p result
|
833
500
|
rescue LaunchDarklyApi::ApiError => e
|
834
|
-
puts "
|
501
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_statuses: #{e}"
|
835
502
|
end
|
836
503
|
```
|
837
504
|
|
838
|
-
|
839
|
-
|
840
|
-
Name | Type | Description | Notes
|
841
|
-
------------- | ------------- | ------------- | -------------
|
842
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
843
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
844
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
845
|
-
|
846
|
-
### Return type
|
505
|
+
#### Using the get_feature_flag_statuses_with_http_info variant
|
847
506
|
|
848
|
-
|
507
|
+
This returns an Array which contains the response data, status code and headers.
|
849
508
|
|
850
|
-
|
851
|
-
|
852
|
-
[Token](../README.md#Token)
|
853
|
-
|
854
|
-
### HTTP request headers
|
509
|
+
> <Array(<FeatureFlagStatuses>, Integer, Hash)> get_feature_flag_statuses_with_http_info(proj_key, env_key)
|
855
510
|
|
856
|
-
- **Content-Type**: application/json
|
857
|
-
- **Accept**: application/json
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
# **get_flag_config_scheduled_changes_conflicts**
|
862
|
-
> FeatureFlagScheduledChangesConflicts get_flag_config_scheduled_changes_conflicts(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body)
|
863
|
-
|
864
|
-
Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
|
865
|
-
|
866
|
-
### Example
|
867
511
|
```ruby
|
868
|
-
# load the gem
|
869
|
-
require 'launchdarkly_api'
|
870
|
-
# setup authorization
|
871
|
-
LaunchDarklyApi.configure do |config|
|
872
|
-
# Configure API key authorization: Token
|
873
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
874
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
875
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
876
|
-
end
|
877
|
-
|
878
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
879
|
-
|
880
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
881
|
-
|
882
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
883
|
-
|
884
|
-
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.
|
885
|
-
|
886
|
-
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.
|
887
|
-
|
888
|
-
|
889
512
|
begin
|
890
|
-
#
|
891
|
-
|
892
|
-
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>
|
893
518
|
rescue LaunchDarklyApi::ApiError => e
|
894
|
-
puts "
|
519
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flag_statuses_with_http_info: #{e}"
|
895
520
|
end
|
896
521
|
```
|
897
522
|
|
898
523
|
### Parameters
|
899
524
|
|
900
|
-
Name | Type | Description
|
901
|
-
|
902
|
-
**
|
903
|
-
**
|
904
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
905
|
-
**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 | |
|
906
529
|
|
907
530
|
### Return type
|
908
531
|
|
909
|
-
[**
|
532
|
+
[**FeatureFlagStatuses**](FeatureFlagStatuses.md)
|
910
533
|
|
911
534
|
### Authorization
|
912
535
|
|
913
|
-
[
|
536
|
+
[ApiKey](../README.md#ApiKey)
|
914
537
|
|
915
538
|
### HTTP request headers
|
916
539
|
|
917
|
-
|
918
|
-
|
540
|
+
- **Content-Type**: Not defined
|
541
|
+
- **Accept**: application/json
|
542
|
+
|
919
543
|
|
544
|
+
## get_feature_flags
|
920
545
|
|
546
|
+
> <FeatureFlags> get_feature_flags(proj_key, opts)
|
921
547
|
|
922
|
-
|
923
|
-
> UserTargetingExpirationForFlags patch_expiring_user_targets(project_key, environment_key, feature_flag_key, semantic_patch_with_comment)
|
548
|
+
List feature flags
|
924
549
|
|
925
|
-
|
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
|
926
553
|
|
927
|
-
### Example
|
928
554
|
```ruby
|
929
|
-
|
555
|
+
require 'time'
|
930
556
|
require 'launchdarkly_api'
|
931
557
|
# setup authorization
|
932
558
|
LaunchDarklyApi.configure do |config|
|
933
|
-
# Configure API key authorization:
|
934
|
-
config.api_key['
|
559
|
+
# Configure API key authorization: ApiKey
|
560
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
935
561
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
936
|
-
#config.api_key_prefix['
|
562
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
937
563
|
end
|
938
564
|
|
939
565
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
940
|
-
|
941
|
-
|
942
|
-
|
943
|
-
|
944
|
-
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
|
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
|
+
}
|
949
578
|
|
950
579
|
begin
|
951
|
-
#
|
952
|
-
result = api_instance.
|
580
|
+
# List feature flags
|
581
|
+
result = api_instance.get_feature_flags(proj_key, opts)
|
953
582
|
p result
|
954
583
|
rescue LaunchDarklyApi::ApiError => e
|
955
|
-
puts "
|
584
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flags: #{e}"
|
956
585
|
end
|
957
586
|
```
|
958
587
|
|
959
|
-
|
960
|
-
|
961
|
-
Name | Type | Description | Notes
|
962
|
-
------------- | ------------- | ------------- | -------------
|
963
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
964
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
965
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
966
|
-
**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. |
|
967
|
-
|
968
|
-
### Return type
|
969
|
-
|
970
|
-
[**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
|
971
|
-
|
972
|
-
### Authorization
|
973
|
-
|
974
|
-
[Token](../README.md#Token)
|
975
|
-
|
976
|
-
### HTTP request headers
|
588
|
+
#### Using the get_feature_flags_with_http_info variant
|
977
589
|
|
978
|
-
|
979
|
-
- **Accept**: application/json
|
590
|
+
This returns an Array which contains the response data, status code and headers.
|
980
591
|
|
592
|
+
> <Array(<FeatureFlags>, Integer, Hash)> get_feature_flags_with_http_info(proj_key, opts)
|
981
593
|
|
982
|
-
|
983
|
-
# **patch_feature_flag**
|
984
|
-
> FeatureFlag patch_feature_flag(project_key, feature_flag_key, patch_comment)
|
985
|
-
|
986
|
-
Perform a partial update to a feature.
|
987
|
-
|
988
|
-
### Example
|
989
594
|
```ruby
|
990
|
-
# load the gem
|
991
|
-
require 'launchdarkly_api'
|
992
|
-
# setup authorization
|
993
|
-
LaunchDarklyApi.configure do |config|
|
994
|
-
# Configure API key authorization: Token
|
995
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
996
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
997
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
998
|
-
end
|
999
|
-
|
1000
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1001
|
-
|
1002
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1003
|
-
|
1004
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1005
|
-
|
1006
|
-
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.
|
1007
|
-
|
1008
|
-
|
1009
595
|
begin
|
1010
|
-
#
|
1011
|
-
|
1012
|
-
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>
|
1013
601
|
rescue LaunchDarklyApi::ApiError => e
|
1014
|
-
puts "
|
602
|
+
puts "Error when calling FeatureFlagsApi->get_feature_flags_with_http_info: #{e}"
|
1015
603
|
end
|
1016
604
|
```
|
1017
605
|
|
1018
606
|
### Parameters
|
1019
607
|
|
1020
|
-
Name | Type | Description
|
1021
|
-
|
1022
|
-
**
|
1023
|
-
**
|
1024
|
-
**
|
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] |
|
1025
620
|
|
1026
621
|
### Return type
|
1027
622
|
|
1028
|
-
[**
|
623
|
+
[**FeatureFlags**](FeatureFlags.md)
|
1029
624
|
|
1030
625
|
### Authorization
|
1031
626
|
|
1032
|
-
[
|
627
|
+
[ApiKey](../README.md#ApiKey)
|
1033
628
|
|
1034
629
|
### HTTP request headers
|
1035
630
|
|
1036
|
-
|
1037
|
-
|
631
|
+
- **Content-Type**: Not defined
|
632
|
+
- **Accept**: application/json
|
633
|
+
|
1038
634
|
|
635
|
+
## patch_expiring_user_targets
|
1039
636
|
|
637
|
+
> <ExpiringUserTargetPatchResponse> patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment)
|
1040
638
|
|
1041
|
-
|
1042
|
-
> FeatureFlagScheduledChange patch_flag_config_scheduled_change(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id)
|
639
|
+
Update expiring user targets on feature flag
|
1043
640
|
|
1044
|
-
|
641
|
+
Update the list of user targets on a feature flag that are scheduled for removal.
|
642
|
+
|
643
|
+
### Examples
|
1045
644
|
|
1046
|
-
### Example
|
1047
645
|
```ruby
|
1048
|
-
|
646
|
+
require 'time'
|
1049
647
|
require 'launchdarkly_api'
|
1050
648
|
# setup authorization
|
1051
649
|
LaunchDarklyApi.configure do |config|
|
1052
|
-
# Configure API key authorization:
|
1053
|
-
config.api_key['
|
650
|
+
# Configure API key authorization: ApiKey
|
651
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1054
652
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1055
|
-
#config.api_key_prefix['
|
653
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1056
654
|
end
|
1057
655
|
|
1058
656
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1059
|
-
|
1060
|
-
|
1061
|
-
|
1062
|
-
|
1063
|
-
|
1064
|
-
flag_config_scheduled_changes_patch_body = LaunchDarklyApi::FlagConfigScheduledChangesPatchBody.new # FlagConfigScheduledChangesPatchBody | Update scheduled changes on a feature flag.
|
1065
|
-
|
1066
|
-
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.
|
1067
|
-
|
1068
|
-
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
1069
|
-
|
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 |
|
1070
661
|
|
1071
662
|
begin
|
1072
|
-
#
|
1073
|
-
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)
|
1074
665
|
p result
|
1075
666
|
rescue LaunchDarklyApi::ApiError => e
|
1076
|
-
puts "
|
667
|
+
puts "Error when calling FeatureFlagsApi->patch_expiring_user_targets: #{e}"
|
1077
668
|
end
|
1078
669
|
```
|
1079
670
|
|
1080
|
-
|
1081
|
-
|
1082
|
-
Name | Type | Description | Notes
|
1083
|
-
------------- | ------------- | ------------- | -------------
|
1084
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1085
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1086
|
-
**flag_config_scheduled_changes_patch_body** | [**FlagConfigScheduledChangesPatchBody**](FlagConfigScheduledChangesPatchBody.md)| Update scheduled changes on a feature flag. |
|
1087
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1088
|
-
**scheduled_change_id** | **String**| The id of the scheduled change |
|
1089
|
-
|
1090
|
-
### Return type
|
1091
|
-
|
1092
|
-
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
1093
|
-
|
1094
|
-
### Authorization
|
1095
|
-
|
1096
|
-
[Token](../README.md#Token)
|
1097
|
-
|
1098
|
-
### HTTP request headers
|
1099
|
-
|
1100
|
-
- **Content-Type**: application/json
|
1101
|
-
- **Accept**: application/json
|
1102
|
-
|
671
|
+
#### Using the patch_expiring_user_targets_with_http_info variant
|
1103
672
|
|
673
|
+
This returns an Array which contains the response data, status code and headers.
|
1104
674
|
|
1105
|
-
|
1106
|
-
> ApprovalRequests post_apply_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body)
|
675
|
+
> <Array(<ExpiringUserTargetPatchResponse>, Integer, Hash)> patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment)
|
1107
676
|
|
1108
|
-
Apply approval request for a feature flag config
|
1109
|
-
|
1110
|
-
### Example
|
1111
677
|
```ruby
|
1112
|
-
# load the gem
|
1113
|
-
require 'launchdarkly_api'
|
1114
|
-
# setup authorization
|
1115
|
-
LaunchDarklyApi.configure do |config|
|
1116
|
-
# Configure API key authorization: Token
|
1117
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1118
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1119
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1120
|
-
end
|
1121
|
-
|
1122
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1123
|
-
|
1124
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1125
|
-
|
1126
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1127
|
-
|
1128
|
-
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.
|
1129
|
-
|
1130
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
1131
|
-
|
1132
|
-
approval_request_apply_config_body = LaunchDarklyApi::ApprovalRequestApplyConfigBody.new # ApprovalRequestApplyConfigBody | Apply an approval request
|
1133
|
-
|
1134
|
-
|
1135
678
|
begin
|
1136
|
-
#
|
1137
|
-
|
1138
|
-
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>
|
1139
684
|
rescue LaunchDarklyApi::ApiError => e
|
1140
|
-
puts "
|
685
|
+
puts "Error when calling FeatureFlagsApi->patch_expiring_user_targets_with_http_info: #{e}"
|
1141
686
|
end
|
1142
687
|
```
|
1143
688
|
|
1144
689
|
### Parameters
|
1145
690
|
|
1146
|
-
Name | Type | Description
|
1147
|
-
|
1148
|
-
**
|
1149
|
-
**
|
1150
|
-
**
|
1151
|
-
**
|
1152
|
-
**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) | | |
|
1153
697
|
|
1154
698
|
### Return type
|
1155
699
|
|
1156
|
-
[**
|
700
|
+
[**ExpiringUserTargetPatchResponse**](ExpiringUserTargetPatchResponse.md)
|
1157
701
|
|
1158
702
|
### Authorization
|
1159
703
|
|
1160
|
-
[
|
704
|
+
[ApiKey](../README.md#ApiKey)
|
1161
705
|
|
1162
706
|
### HTTP request headers
|
1163
707
|
|
1164
|
-
|
1165
|
-
|
708
|
+
- **Content-Type**: application/json
|
709
|
+
- **Accept**: application/json
|
1166
710
|
|
1167
711
|
|
712
|
+
## patch_feature_flag
|
1168
713
|
|
1169
|
-
|
1170
|
-
> 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)
|
1171
715
|
|
1172
|
-
|
716
|
+
Update feature flag
|
717
|
+
|
718
|
+
Perform a partial update to a feature
|
719
|
+
|
720
|
+
### Examples
|
1173
721
|
|
1174
|
-
### Example
|
1175
722
|
```ruby
|
1176
|
-
|
723
|
+
require 'time'
|
1177
724
|
require 'launchdarkly_api'
|
1178
725
|
# setup authorization
|
1179
726
|
LaunchDarklyApi.configure do |config|
|
1180
|
-
# Configure API key authorization:
|
1181
|
-
config.api_key['
|
727
|
+
# Configure API key authorization: ApiKey
|
728
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1182
729
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1183
|
-
#config.api_key_prefix['
|
730
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1184
731
|
end
|
1185
732
|
|
1186
733
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1187
|
-
|
1188
|
-
|
1189
|
-
|
1190
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1191
|
-
|
1192
|
-
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.
|
1193
|
-
|
1194
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
1195
|
-
|
1196
|
-
opts = {
|
1197
|
-
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
1198
|
-
}
|
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 |
|
1199
737
|
|
1200
738
|
begin
|
1201
|
-
#
|
1202
|
-
result = api_instance.
|
739
|
+
# Update feature flag
|
740
|
+
result = api_instance.patch_feature_flag(proj_key, key, patch_with_comment)
|
1203
741
|
p result
|
1204
742
|
rescue LaunchDarklyApi::ApiError => e
|
1205
|
-
puts "
|
743
|
+
puts "Error when calling FeatureFlagsApi->patch_feature_flag: #{e}"
|
1206
744
|
end
|
1207
745
|
```
|
1208
746
|
|
1209
|
-
|
747
|
+
#### Using the patch_feature_flag_with_http_info variant
|
1210
748
|
|
1211
|
-
|
1212
|
-
------------- | ------------- | ------------- | -------------
|
1213
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1214
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1215
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1216
|
-
**approval_request_id** | **String**| The approval request ID |
|
1217
|
-
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
749
|
+
This returns an Array which contains the response data, status code and headers.
|
1218
750
|
|
1219
|
-
|
1220
|
-
|
1221
|
-
[**ApprovalRequest**](ApprovalRequest.md)
|
1222
|
-
|
1223
|
-
### Authorization
|
1224
|
-
|
1225
|
-
[Token](../README.md#Token)
|
1226
|
-
|
1227
|
-
### HTTP request headers
|
751
|
+
> <Array(<FeatureFlag>, Integer, Hash)> patch_feature_flag_with_http_info(proj_key, key, patch_with_comment)
|
1228
752
|
|
1229
|
-
- **Content-Type**: application/json
|
1230
|
-
- **Accept**: application/json
|
1231
|
-
|
1232
|
-
|
1233
|
-
|
1234
|
-
# **post_feature_flag**
|
1235
|
-
> FeatureFlag post_feature_flag(project_key, feature_flag_body, opts)
|
1236
|
-
|
1237
|
-
Creates a new feature flag.
|
1238
|
-
|
1239
|
-
### Example
|
1240
753
|
```ruby
|
1241
|
-
# load the gem
|
1242
|
-
require 'launchdarkly_api'
|
1243
|
-
# setup authorization
|
1244
|
-
LaunchDarklyApi.configure do |config|
|
1245
|
-
# Configure API key authorization: Token
|
1246
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1247
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1248
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1249
|
-
end
|
1250
|
-
|
1251
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1252
|
-
|
1253
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1254
|
-
|
1255
|
-
feature_flag_body = LaunchDarklyApi::FeatureFlagBody.new # FeatureFlagBody | Create a new feature flag.
|
1256
|
-
|
1257
|
-
opts = {
|
1258
|
-
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.
|
1259
|
-
}
|
1260
|
-
|
1261
754
|
begin
|
1262
|
-
#
|
1263
|
-
|
1264
|
-
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>
|
1265
760
|
rescue LaunchDarklyApi::ApiError => e
|
1266
|
-
puts "
|
761
|
+
puts "Error when calling FeatureFlagsApi->patch_feature_flag_with_http_info: #{e}"
|
1267
762
|
end
|
1268
763
|
```
|
1269
764
|
|
1270
765
|
### Parameters
|
1271
766
|
|
1272
|
-
Name | Type | Description
|
1273
|
-
|
1274
|
-
**
|
1275
|
-
**
|
1276
|
-
**
|
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) | | |
|
1277
772
|
|
1278
773
|
### Return type
|
1279
774
|
|
@@ -1281,137 +776,87 @@ Name | Type | Description | Notes
|
|
1281
776
|
|
1282
777
|
### Authorization
|
1283
778
|
|
1284
|
-
[
|
779
|
+
[ApiKey](../README.md#ApiKey)
|
1285
780
|
|
1286
781
|
### HTTP request headers
|
1287
782
|
|
1288
|
-
|
1289
|
-
|
783
|
+
- **Content-Type**: application/json
|
784
|
+
- **Accept**: application/json
|
785
|
+
|
786
|
+
|
787
|
+
## post_feature_flag
|
1290
788
|
|
789
|
+
> <FeatureFlag> post_feature_flag(proj_key, feature_flag_body, opts)
|
1291
790
|
|
791
|
+
Create a feature flag
|
1292
792
|
|
1293
|
-
|
1294
|
-
> FeatureFlagScheduledChange post_flag_config_scheduled_changes(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, )
|
793
|
+
Create a feature flag with the given name, key, and variations
|
1295
794
|
|
1296
|
-
|
795
|
+
### Examples
|
1297
796
|
|
1298
|
-
### Example
|
1299
797
|
```ruby
|
1300
|
-
|
798
|
+
require 'time'
|
1301
799
|
require 'launchdarkly_api'
|
1302
800
|
# setup authorization
|
1303
801
|
LaunchDarklyApi.configure do |config|
|
1304
|
-
# Configure API key authorization:
|
1305
|
-
config.api_key['
|
802
|
+
# Configure API key authorization: ApiKey
|
803
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
1306
804
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1307
|
-
#config.api_key_prefix['
|
805
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
1308
806
|
end
|
1309
807
|
|
1310
808
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1311
|
-
|
1312
|
-
|
1313
|
-
|
1314
|
-
|
1315
|
-
|
1316
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1317
|
-
|
1318
|
-
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.
|
1319
|
-
|
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
|
+
}
|
1320
814
|
|
1321
815
|
begin
|
1322
|
-
#
|
1323
|
-
result = api_instance.
|
816
|
+
# Create a feature flag
|
817
|
+
result = api_instance.post_feature_flag(proj_key, feature_flag_body, opts)
|
1324
818
|
p result
|
1325
819
|
rescue LaunchDarklyApi::ApiError => e
|
1326
|
-
puts "
|
820
|
+
puts "Error when calling FeatureFlagsApi->post_feature_flag: #{e}"
|
1327
821
|
end
|
1328
822
|
```
|
1329
823
|
|
1330
|
-
|
1331
|
-
|
1332
|
-
Name | Type | Description | Notes
|
1333
|
-
------------- | ------------- | ------------- | -------------
|
1334
|
-
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
1335
|
-
**flag_config_scheduled_changes_post_body** | [**FlagConfigScheduledChangesPostBody**](FlagConfigScheduledChangesPostBody.md)| Create scheduled changes on a feature flag. |
|
1336
|
-
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
1337
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
1338
|
-
|
1339
|
-
### Return type
|
1340
|
-
|
1341
|
-
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
824
|
+
#### Using the post_feature_flag_with_http_info variant
|
1342
825
|
|
1343
|
-
|
826
|
+
This returns an Array which contains the response data, status code and headers.
|
1344
827
|
|
1345
|
-
|
828
|
+
> <Array(<FeatureFlag>, Integer, Hash)> post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
|
1346
829
|
|
1347
|
-
### HTTP request headers
|
1348
|
-
|
1349
|
-
- **Content-Type**: application/json
|
1350
|
-
- **Accept**: application/json
|
1351
|
-
|
1352
|
-
|
1353
|
-
|
1354
|
-
# **post_review_approval_request**
|
1355
|
-
> ApprovalRequests post_review_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body)
|
1356
|
-
|
1357
|
-
Review approval request for a feature flag config
|
1358
|
-
|
1359
|
-
### Example
|
1360
830
|
```ruby
|
1361
|
-
# load the gem
|
1362
|
-
require 'launchdarkly_api'
|
1363
|
-
# setup authorization
|
1364
|
-
LaunchDarklyApi.configure do |config|
|
1365
|
-
# Configure API key authorization: Token
|
1366
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
1367
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1368
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1369
|
-
end
|
1370
|
-
|
1371
|
-
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
1372
|
-
|
1373
|
-
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
1374
|
-
|
1375
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
1376
|
-
|
1377
|
-
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.
|
1378
|
-
|
1379
|
-
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
1380
|
-
|
1381
|
-
approval_request_review_config_body = LaunchDarklyApi::ApprovalRequestReviewConfigBody.new # ApprovalRequestReviewConfigBody | Review an approval request
|
1382
|
-
|
1383
|
-
|
1384
831
|
begin
|
1385
|
-
#
|
1386
|
-
|
1387
|
-
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>
|
1388
837
|
rescue LaunchDarklyApi::ApiError => e
|
1389
|
-
puts "
|
838
|
+
puts "Error when calling FeatureFlagsApi->post_feature_flag_with_http_info: #{e}"
|
1390
839
|
end
|
1391
840
|
```
|
1392
841
|
|
1393
842
|
### Parameters
|
1394
843
|
|
1395
|
-
Name | Type | Description
|
1396
|
-
|
1397
|
-
**
|
1398
|
-
**
|
1399
|
-
**
|
1400
|
-
**approval_request_id** | **String**| The approval request ID |
|
1401
|
-
**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] |
|
1402
849
|
|
1403
850
|
### Return type
|
1404
851
|
|
1405
|
-
[**
|
852
|
+
[**FeatureFlag**](FeatureFlag.md)
|
1406
853
|
|
1407
854
|
### Authorization
|
1408
855
|
|
1409
|
-
[
|
856
|
+
[ApiKey](../README.md#ApiKey)
|
1410
857
|
|
1411
858
|
### HTTP request headers
|
1412
859
|
|
1413
|
-
|
1414
|
-
|
1415
|
-
|
1416
|
-
|
860
|
+
- **Content-Type**: application/json
|
861
|
+
- **Accept**: application/json
|
1417
862
|
|