launchdarkly_api 5.4.0 → 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 -261
- 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 +19 -6
- data/docs/DependentFlagEnvironment.md +19 -6
- data/docs/DependentFlagsByEnvironment.md +17 -5
- 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 +451 -1184
- 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 +17 -7
- data/docs/MultiEnvironmentDependentFlags.md +17 -5
- 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 +487 -1390
- 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 +76 -25
- data/lib/launchdarkly_api/models/dependent_flag_environment.rb +76 -25
- data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +75 -24
- data/lib/launchdarkly_api/models/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 +69 -43
- data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +75 -24
- data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
- data/lib/launchdarkly_api/models/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 +129 -97
- 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 -267
- 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 +8 -15
- data/spec/models/dependent_flag_spec.rb +8 -15
- data/spec/models/dependent_flags_by_environment_spec.rb +8 -15
- data/spec/models/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 +8 -27
- data/spec/models/multi_environment_dependent_flags_spec.rb +8 -15
- data/spec/models/new_member_form_spec.rb +64 -0
- data/spec/models/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 +815 -582
- data/docs/ApprovalRequest.md +0 -21
- data/docs/ApprovalRequestApplyConfigBody.md +0 -8
- data/docs/ApprovalRequestConfigBody.md +0 -13
- data/docs/ApprovalRequestFlagConfigCopyBody.md +0 -13
- data/docs/ApprovalRequestReview.md +0 -11
- data/docs/ApprovalRequestReviewConfigBody.md +0 -9
- data/docs/ApprovalRequestReviewStatus.md +0 -7
- data/docs/ApprovalRequests.md +0 -9
- data/docs/AuditLogEntries.md +0 -9
- data/docs/AuditLogEntry.md +0 -19
- data/docs/AuditLogEntryTarget.md +0 -10
- data/docs/BigSegmentTargetChanges.md +0 -9
- data/docs/BigSegmentTargetsBody.md +0 -9
- data/docs/CopyActions.md +0 -7
- data/docs/CustomPropertyValues.md +0 -7
- data/docs/CustomRoleBody.md +0 -11
- data/docs/CustomerMetricsApi.md +0 -511
- data/docs/DependentFlagEnvironmentLinks.md +0 -9
- data/docs/DependentFlagLinks.md +0 -8
- data/docs/DependentFlagsLinks.md +0 -9
- data/docs/DestinationAmazonKinesis.md +0 -10
- data/docs/DestinationBody.md +0 -11
- data/docs/DestinationGooglePubSub.md +0 -9
- data/docs/DestinationMParticle.md +0 -11
- data/docs/DestinationSegment.md +0 -8
- data/docs/EnvironmentApprovalSettings.md +0 -13
- data/docs/EvaluationUsageError.md +0 -9
- data/docs/Events.md +0 -8
- data/docs/Fallthrough.md +0 -9
- data/docs/FeatureFlagCopyBody.md +0 -12
- data/docs/FeatureFlagCopyObject.md +0 -9
- data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
- data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
- data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
- data/docs/FeatureFlagStatusLinks.md +0 -9
- data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
- data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
- data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
- data/docs/FlagListItem.md +0 -11
- data/docs/HierarchicalLinks.md +0 -9
- data/docs/Id.md +0 -7
- data/docs/Integration.md +0 -9
- data/docs/IntegrationSubscription.md +0 -16
- data/docs/IntegrationSubscriptionStatus.md +0 -10
- data/docs/Integrations.md +0 -9
- data/docs/IntegrationsApi.md +0 -334
- data/docs/Links.md +0 -9
- data/docs/MAU.md +0 -10
- data/docs/MAUMetadata.md +0 -7
- data/docs/MAUbyCategory.md +0 -10
- data/docs/MemberLastSeenMetadata.md +0 -8
- data/docs/MembersBody.md +0 -13
- data/docs/PatchComment.md +0 -9
- data/docs/Policy.md +0 -12
- data/docs/ProjectBody.md +0 -13
- data/docs/RelayProxyConfig.md +0 -15
- data/docs/RelayProxyConfigBody.md +0 -9
- data/docs/RelayProxyConfigs.md +0 -8
- data/docs/Role.md +0 -7
- data/docs/RootApi.md +0 -56
- data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
- data/docs/SemanticPatchInstruction.md +0 -7
- data/docs/SemanticPatchInstructionInner.md +0 -8
- data/docs/SemanticPatchOperation.md +0 -9
- data/docs/Site.md +0 -9
- data/docs/Source.md +0 -9
- data/docs/Stream.md +0 -10
- data/docs/StreamBySDK.md +0 -10
- data/docs/StreamBySDKLinks.md +0 -9
- data/docs/StreamBySDKLinksMetadata.md +0 -10
- data/docs/StreamLinks.md +0 -10
- data/docs/StreamSDKVersion.md +0 -9
- data/docs/StreamSDKVersionData.md +0 -9
- data/docs/StreamUsageError.md +0 -9
- data/docs/StreamUsageLinks.md +0 -10
- data/docs/StreamUsageMetadata.md +0 -10
- data/docs/StreamUsageSeries.md +0 -9
- data/docs/Streams.md +0 -8
- data/docs/SubscriptionBody.md +0 -12
- data/docs/TeamMembersApi.md +0 -329
- data/docs/TokenBody.md +0 -13
- data/docs/Usage.md +0 -9
- data/docs/UsageError.md +0 -8
- data/docs/UsageLinks.md +0 -10
- data/docs/UserSegmentBody.md +0 -12
- data/docs/UserSegmentsApi.md +0 -488
- data/docs/UserSettingsBody.md +0 -8
- data/docs/UserTargetingExpirationForFlag.md +0 -14
- data/docs/UserTargetingExpirationForFlags.md +0 -9
- data/docs/UserTargetingExpirationForSegment.md +0 -14
- data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
- data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
- data/docs/WebhookBody.md +0 -14
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
- data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
- data/lib/launchdarkly_api/api/root_api.rb +0 -69
- data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
- data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
- data/lib/launchdarkly_api/models/approval_request.rb +0 -346
- data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
- data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
- data/lib/launchdarkly_api/models/approval_request_flag_config_copy_body.rb +0 -254
- data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
- data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
- data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
- data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
- data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
- data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
- data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
- data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
- data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
- data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
- data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
- data/lib/launchdarkly_api/models/dependent_flag__links.rb +0 -184
- data/lib/launchdarkly_api/models/dependent_flag_environment__links.rb +0 -193
- data/lib/launchdarkly_api/models/dependent_flags_links.rb +0 -193
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
- data/lib/launchdarkly_api/models/destination_body.rb +0 -264
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
- data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
- data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -272
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
- data/lib/launchdarkly_api/models/events.rb +0 -184
- data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
- data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
- data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
- data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
- data/lib/launchdarkly_api/models/id.rb +0 -176
- data/lib/launchdarkly_api/models/integration.rb +0 -195
- data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
- data/lib/launchdarkly_api/models/integrations.rb +0 -196
- data/lib/launchdarkly_api/models/links.rb +0 -193
- data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
- data/lib/launchdarkly_api/models/mau.rb +0 -206
- data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
- data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
- data/lib/launchdarkly_api/models/members_body.rb +0 -238
- data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
- data/lib/launchdarkly_api/models/policy.rb +0 -231
- data/lib/launchdarkly_api/models/project_body.rb +0 -243
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
- data/lib/launchdarkly_api/models/role.rb +0 -32
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
- data/lib/launchdarkly_api/models/site.rb +0 -193
- data/lib/launchdarkly_api/models/source.rb +0 -195
- data/lib/launchdarkly_api/models/stream.rb +0 -206
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
- data/lib/launchdarkly_api/models/stream_links.rb +0 -205
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
- data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
- data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
- data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
- data/lib/launchdarkly_api/models/streams.rb +0 -184
- data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
- data/lib/launchdarkly_api/models/token_body.rb +0 -238
- data/lib/launchdarkly_api/models/usage.rb +0 -195
- data/lib/launchdarkly_api/models/usage_error.rb +0 -184
- data/lib/launchdarkly_api/models/usage_links.rb +0 -205
- data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
- data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
- data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
- data/openapi.yml +0 -4922
- data/spec/api/customer_metrics_api_spec.rb +0 -141
- data/spec/api/integrations_api_spec.rb +0 -105
- data/spec/api/root_api_spec.rb +0 -45
- data/spec/api/team_members_api_spec.rb +0 -104
- data/spec/api/user_segments_api_spec.rb +0 -142
- data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
- data/spec/models/approval_request_config_body_spec.rb +0 -71
- data/spec/models/approval_request_flag_config_copy_body_spec.rb +0 -71
- data/spec/models/approval_request_review_config_body_spec.rb +0 -51
- data/spec/models/approval_request_review_spec.rb +0 -59
- data/spec/models/approval_request_review_status_spec.rb +0 -35
- data/spec/models/approval_request_spec.rb +0 -123
- data/spec/models/approval_requests_spec.rb +0 -47
- data/spec/models/audit_log_entries_spec.rb +0 -47
- data/spec/models/audit_log_entry_spec.rb +0 -107
- data/spec/models/audit_log_entry_target_spec.rb +0 -53
- data/spec/models/big_segment_target_changes_spec.rb +0 -47
- data/spec/models/big_segment_targets_body_spec.rb +0 -47
- data/spec/models/copy_actions_spec.rb +0 -35
- data/spec/models/custom_property_values_spec.rb +0 -35
- data/spec/models/custom_role_body_spec.rb +0 -59
- data/spec/models/dependent_flag__links_spec.rb +0 -41
- data/spec/models/dependent_flag_environment__links_spec.rb +0 -47
- data/spec/models/dependent_flags_links_spec.rb +0 -47
- data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
- data/spec/models/destination_body_spec.rb +0 -63
- data/spec/models/destination_google_pub_sub_spec.rb +0 -47
- data/spec/models/destination_m_particle_spec.rb +0 -59
- data/spec/models/destination_segment_spec.rb +0 -41
- data/spec/models/environment_approval_settings_spec.rb +0 -75
- data/spec/models/evaluation_usage_error_spec.rb +0 -47
- data/spec/models/events_spec.rb +0 -41
- data/spec/models/fallthrough_spec.rb +0 -47
- data/spec/models/feature_flag_copy_body_spec.rb +0 -65
- data/spec/models/feature_flag_copy_object_spec.rb +0 -47
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
- data/spec/models/feature_flag_status_links_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
- data/spec/models/flag_list_item_spec.rb +0 -59
- data/spec/models/hierarchical_links_spec.rb +0 -47
- data/spec/models/id_spec.rb +0 -35
- data/spec/models/integration_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/source_spec.rb +0 -47
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
- data/spec/models/stream_by_sdk_links_spec.rb +0 -47
- data/spec/models/stream_by_sdk_spec.rb +0 -53
- data/spec/models/stream_links_spec.rb +0 -53
- data/spec/models/stream_sdk_version_data_spec.rb +0 -47
- data/spec/models/stream_sdk_version_spec.rb +0 -47
- data/spec/models/stream_spec.rb +0 -53
- data/spec/models/stream_usage_error_spec.rb +0 -47
- data/spec/models/stream_usage_links_spec.rb +0 -53
- data/spec/models/stream_usage_metadata_spec.rb +0 -53
- data/spec/models/stream_usage_series_spec.rb +0 -47
- data/spec/models/streams_spec.rb +0 -41
- data/spec/models/subscription_body_spec.rb +0 -65
- data/spec/models/token_body_spec.rb +0 -71
- data/spec/models/usage_error_spec.rb +0 -41
- data/spec/models/usage_links_spec.rb +0 -53
- data/spec/models/usage_spec.rb +0 -47
- data/spec/models/user_segment_body_spec.rb +0 -65
- data/spec/models/user_settings_body_spec.rb +0 -41
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
- data/spec/models/webhook_body_spec.rb +0 -77
@@ -0,0 +1,376 @@
|
|
1
|
+
# LaunchDarklyApi::AccountMembersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://app.launchdarkly.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**delete_member**](AccountMembersApi.md#delete_member) | **DELETE** /api/v2/members/{id} | Delete account member |
|
8
|
+
| [**get_member**](AccountMembersApi.md#get_member) | **GET** /api/v2/members/{id} | Get account member |
|
9
|
+
| [**get_members**](AccountMembersApi.md#get_members) | **GET** /api/v2/members | List account members |
|
10
|
+
| [**patch_member**](AccountMembersApi.md#patch_member) | **PATCH** /api/v2/members/{id} | Modify an account member |
|
11
|
+
| [**post_members**](AccountMembersApi.md#post_members) | **POST** /api/v2/members | Invite new members |
|
12
|
+
|
13
|
+
|
14
|
+
## delete_member
|
15
|
+
|
16
|
+
> delete_member(id)
|
17
|
+
|
18
|
+
Delete account member
|
19
|
+
|
20
|
+
Delete a single account member by ID
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'launchdarkly_api'
|
27
|
+
# setup authorization
|
28
|
+
LaunchDarklyApi.configure do |config|
|
29
|
+
# Configure API key authorization: ApiKey
|
30
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = LaunchDarklyApi::AccountMembersApi.new
|
36
|
+
id = 'id_example' # String | The member ID
|
37
|
+
|
38
|
+
begin
|
39
|
+
# Delete account member
|
40
|
+
api_instance.delete_member(id)
|
41
|
+
rescue LaunchDarklyApi::ApiError => e
|
42
|
+
puts "Error when calling AccountMembersApi->delete_member: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
#### Using the delete_member_with_http_info variant
|
47
|
+
|
48
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
49
|
+
|
50
|
+
> <Array(nil, Integer, Hash)> delete_member_with_http_info(id)
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
begin
|
54
|
+
# Delete account member
|
55
|
+
data, status_code, headers = api_instance.delete_member_with_http_info(id)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => nil
|
59
|
+
rescue LaunchDarklyApi::ApiError => e
|
60
|
+
puts "Error when calling AccountMembersApi->delete_member_with_http_info: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **id** | **String** | The member ID | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
nil (empty response body)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
[ApiKey](../README.md#ApiKey)
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: Not defined
|
81
|
+
- **Accept**: Not defined
|
82
|
+
|
83
|
+
|
84
|
+
## get_member
|
85
|
+
|
86
|
+
> <Member> get_member(id)
|
87
|
+
|
88
|
+
Get account member
|
89
|
+
|
90
|
+
Get a single account member by ID
|
91
|
+
|
92
|
+
### Examples
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require 'time'
|
96
|
+
require 'launchdarkly_api'
|
97
|
+
# setup authorization
|
98
|
+
LaunchDarklyApi.configure do |config|
|
99
|
+
# Configure API key authorization: ApiKey
|
100
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
102
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = LaunchDarklyApi::AccountMembersApi.new
|
106
|
+
id = 'id_example' # String | The member ID
|
107
|
+
|
108
|
+
begin
|
109
|
+
# Get account member
|
110
|
+
result = api_instance.get_member(id)
|
111
|
+
p result
|
112
|
+
rescue LaunchDarklyApi::ApiError => e
|
113
|
+
puts "Error when calling AccountMembersApi->get_member: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
#### Using the get_member_with_http_info variant
|
118
|
+
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
120
|
+
|
121
|
+
> <Array(<Member>, Integer, Hash)> get_member_with_http_info(id)
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
begin
|
125
|
+
# Get account member
|
126
|
+
data, status_code, headers = api_instance.get_member_with_http_info(id)
|
127
|
+
p status_code # => 2xx
|
128
|
+
p headers # => { ... }
|
129
|
+
p data # => <Member>
|
130
|
+
rescue LaunchDarklyApi::ApiError => e
|
131
|
+
puts "Error when calling AccountMembersApi->get_member_with_http_info: #{e}"
|
132
|
+
end
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
| Name | Type | Description | Notes |
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
139
|
+
| **id** | **String** | The member ID | |
|
140
|
+
|
141
|
+
### Return type
|
142
|
+
|
143
|
+
[**Member**](Member.md)
|
144
|
+
|
145
|
+
### Authorization
|
146
|
+
|
147
|
+
[ApiKey](../README.md#ApiKey)
|
148
|
+
|
149
|
+
### HTTP request headers
|
150
|
+
|
151
|
+
- **Content-Type**: Not defined
|
152
|
+
- **Accept**: application/json
|
153
|
+
|
154
|
+
|
155
|
+
## get_members
|
156
|
+
|
157
|
+
> <Members> get_members(opts)
|
158
|
+
|
159
|
+
List account members
|
160
|
+
|
161
|
+
Return a list of account members. By default, this returns the first 20 members. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links are not 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. ### Filtering members LaunchDarkly supports three fields for filters: `query`, `role`, and `lastSeen`: - `query` is a string that matches against the members' emails and names. It is not case sensitive. - `role` is a `|` separated list of roles and custom roles. It filters the list to members who have any of the roles in the list. For the purposes of this filtering, `Owner` counts as `Admin`. - `lastSeen` is a JSON object in one of the following formats: - `{\"never\": true}` - Members that have never been active, such as those who have not accepted their invitation to LaunchDarkly, or have not logged in after being provisioned via SCIM. - `{\"noData\": true}` - Members that have not been active since LaunchDarkly began recording last seen timestamps. - `{\"before\": 1608672063611}` - Members that have not been active since the provided value, which should be a timestamp in Unix epoch milliseconds. For example, the filter `query:abc,role:admin|customrole` matches members with the string `abc` in their email or name, ignoring case, who also are either an an `Owner` or `Admin` or have the custom role `customrole`. ### Sorting members LaunchDarkly supports two fields for sorting: `displayName` and `lastSeen`: - `displayName` sorts by first + last name, using the member's email if no name is set. - `lastSeen` sorts by the `_lastSeen` property. LaunchDarkly considers members that have never been seen or have no data the oldest.
|
162
|
+
|
163
|
+
### Examples
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
require 'time'
|
167
|
+
require 'launchdarkly_api'
|
168
|
+
# setup authorization
|
169
|
+
LaunchDarklyApi.configure do |config|
|
170
|
+
# Configure API key authorization: ApiKey
|
171
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
172
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
173
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
174
|
+
end
|
175
|
+
|
176
|
+
api_instance = LaunchDarklyApi::AccountMembersApi.new
|
177
|
+
opts = {
|
178
|
+
limit: 789, # Integer | The number of members to return in the response. Defaults to 20.
|
179
|
+
offset: 789, # Integer | Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first ten items and then return the next `limit` items.
|
180
|
+
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained below.
|
181
|
+
sort: 'sort_example' # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order.
|
182
|
+
}
|
183
|
+
|
184
|
+
begin
|
185
|
+
# List account members
|
186
|
+
result = api_instance.get_members(opts)
|
187
|
+
p result
|
188
|
+
rescue LaunchDarklyApi::ApiError => e
|
189
|
+
puts "Error when calling AccountMembersApi->get_members: #{e}"
|
190
|
+
end
|
191
|
+
```
|
192
|
+
|
193
|
+
#### Using the get_members_with_http_info variant
|
194
|
+
|
195
|
+
This returns an Array which contains the response data, status code and headers.
|
196
|
+
|
197
|
+
> <Array(<Members>, Integer, Hash)> get_members_with_http_info(opts)
|
198
|
+
|
199
|
+
```ruby
|
200
|
+
begin
|
201
|
+
# List account members
|
202
|
+
data, status_code, headers = api_instance.get_members_with_http_info(opts)
|
203
|
+
p status_code # => 2xx
|
204
|
+
p headers # => { ... }
|
205
|
+
p data # => <Members>
|
206
|
+
rescue LaunchDarklyApi::ApiError => e
|
207
|
+
puts "Error when calling AccountMembersApi->get_members_with_http_info: #{e}"
|
208
|
+
end
|
209
|
+
```
|
210
|
+
|
211
|
+
### Parameters
|
212
|
+
|
213
|
+
| Name | Type | Description | Notes |
|
214
|
+
| ---- | ---- | ----------- | ----- |
|
215
|
+
| **limit** | **Integer** | The number of members to return in the response. Defaults to 20. | [optional] |
|
216
|
+
| **offset** | **Integer** | Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first ten items and then return the next `limit` items. | [optional] |
|
217
|
+
| **filter** | **String** | A comma-separated list of filters. Each filter is of the form `field:value`. Supported fields are explained below. | [optional] |
|
218
|
+
| **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. | [optional] |
|
219
|
+
|
220
|
+
### Return type
|
221
|
+
|
222
|
+
[**Members**](Members.md)
|
223
|
+
|
224
|
+
### Authorization
|
225
|
+
|
226
|
+
[ApiKey](../README.md#ApiKey)
|
227
|
+
|
228
|
+
### HTTP request headers
|
229
|
+
|
230
|
+
- **Content-Type**: Not defined
|
231
|
+
- **Accept**: application/json
|
232
|
+
|
233
|
+
|
234
|
+
## patch_member
|
235
|
+
|
236
|
+
> <Member> patch_member(id, patch_operation)
|
237
|
+
|
238
|
+
Modify an account member
|
239
|
+
|
240
|
+
Update a single account member. The request should be a valid JSON Patch document describing the changes to be made to the member.
|
241
|
+
|
242
|
+
### Examples
|
243
|
+
|
244
|
+
```ruby
|
245
|
+
require 'time'
|
246
|
+
require 'launchdarkly_api'
|
247
|
+
# setup authorization
|
248
|
+
LaunchDarklyApi.configure do |config|
|
249
|
+
# Configure API key authorization: ApiKey
|
250
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
251
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
252
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
253
|
+
end
|
254
|
+
|
255
|
+
api_instance = LaunchDarklyApi::AccountMembersApi.new
|
256
|
+
id = 'id_example' # String | The member ID
|
257
|
+
patch_operation = [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})] # Array<PatchOperation> |
|
258
|
+
|
259
|
+
begin
|
260
|
+
# Modify an account member
|
261
|
+
result = api_instance.patch_member(id, patch_operation)
|
262
|
+
p result
|
263
|
+
rescue LaunchDarklyApi::ApiError => e
|
264
|
+
puts "Error when calling AccountMembersApi->patch_member: #{e}"
|
265
|
+
end
|
266
|
+
```
|
267
|
+
|
268
|
+
#### Using the patch_member_with_http_info variant
|
269
|
+
|
270
|
+
This returns an Array which contains the response data, status code and headers.
|
271
|
+
|
272
|
+
> <Array(<Member>, Integer, Hash)> patch_member_with_http_info(id, patch_operation)
|
273
|
+
|
274
|
+
```ruby
|
275
|
+
begin
|
276
|
+
# Modify an account member
|
277
|
+
data, status_code, headers = api_instance.patch_member_with_http_info(id, patch_operation)
|
278
|
+
p status_code # => 2xx
|
279
|
+
p headers # => { ... }
|
280
|
+
p data # => <Member>
|
281
|
+
rescue LaunchDarklyApi::ApiError => e
|
282
|
+
puts "Error when calling AccountMembersApi->patch_member_with_http_info: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
| Name | Type | Description | Notes |
|
289
|
+
| ---- | ---- | ----------- | ----- |
|
290
|
+
| **id** | **String** | The member ID | |
|
291
|
+
| **patch_operation** | [**Array<PatchOperation>**](PatchOperation.md) | | |
|
292
|
+
|
293
|
+
### Return type
|
294
|
+
|
295
|
+
[**Member**](Member.md)
|
296
|
+
|
297
|
+
### Authorization
|
298
|
+
|
299
|
+
[ApiKey](../README.md#ApiKey)
|
300
|
+
|
301
|
+
### HTTP request headers
|
302
|
+
|
303
|
+
- **Content-Type**: application/json
|
304
|
+
- **Accept**: application/json
|
305
|
+
|
306
|
+
|
307
|
+
## post_members
|
308
|
+
|
309
|
+
> <Members> post_members(inline_object1)
|
310
|
+
|
311
|
+
Invite new members
|
312
|
+
|
313
|
+
> ### Full use of this API resource is only available to accounts with paid subscriptions > > The ability to bulk invite members is a paid feature. Single members may be invited if not on a paid plan. Invite one or more new members to join an account. Each member is sent an invitation. Members with \"admin\" or \"owner\" roles may create new members, as well as anyone with a \"createMember\" permission for \"member/\\*\". If a member cannot be invited, the entire request is rejected and no members are invited from that request. Each member _must_ have an `email` field and either a `role` or a `customRoles` field. If any of the fields are not populated correctly, the request is rejected with the reason specified in the \"message\" field of the response. _No more than 50 members may be created per request._ A request may also fail because of conflicts with existing members. These conflicts are reported using the additional `code` and `invalid_emails` response fields with the following possible values for `code`: - **email_already_exists_in_account**: A member with this email address already exists in this account. - **email_taken_in_different_account**: A member with this email address exists in another account. - **duplicate_email**s: This request contains two or more members with the same email address. A request that fails for one of the above reasons returns an HTTP response code of 400 (Bad Request).
|
314
|
+
|
315
|
+
### Examples
|
316
|
+
|
317
|
+
```ruby
|
318
|
+
require 'time'
|
319
|
+
require 'launchdarkly_api'
|
320
|
+
# setup authorization
|
321
|
+
LaunchDarklyApi.configure do |config|
|
322
|
+
# Configure API key authorization: ApiKey
|
323
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
324
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
325
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
326
|
+
end
|
327
|
+
|
328
|
+
api_instance = LaunchDarklyApi::AccountMembersApi.new
|
329
|
+
inline_object1 = [LaunchDarklyApi::InlineObject1.new({email: 'email_example'})] # Array<InlineObject1> |
|
330
|
+
|
331
|
+
begin
|
332
|
+
# Invite new members
|
333
|
+
result = api_instance.post_members(inline_object1)
|
334
|
+
p result
|
335
|
+
rescue LaunchDarklyApi::ApiError => e
|
336
|
+
puts "Error when calling AccountMembersApi->post_members: #{e}"
|
337
|
+
end
|
338
|
+
```
|
339
|
+
|
340
|
+
#### Using the post_members_with_http_info variant
|
341
|
+
|
342
|
+
This returns an Array which contains the response data, status code and headers.
|
343
|
+
|
344
|
+
> <Array(<Members>, Integer, Hash)> post_members_with_http_info(inline_object1)
|
345
|
+
|
346
|
+
```ruby
|
347
|
+
begin
|
348
|
+
# Invite new members
|
349
|
+
data, status_code, headers = api_instance.post_members_with_http_info(inline_object1)
|
350
|
+
p status_code # => 2xx
|
351
|
+
p headers # => { ... }
|
352
|
+
p data # => <Members>
|
353
|
+
rescue LaunchDarklyApi::ApiError => e
|
354
|
+
puts "Error when calling AccountMembersApi->post_members_with_http_info: #{e}"
|
355
|
+
end
|
356
|
+
```
|
357
|
+
|
358
|
+
### Parameters
|
359
|
+
|
360
|
+
| Name | Type | Description | Notes |
|
361
|
+
| ---- | ---- | ----------- | ----- |
|
362
|
+
| **inline_object1** | [**Array<InlineObject1>**](InlineObject1.md) | | |
|
363
|
+
|
364
|
+
### Return type
|
365
|
+
|
366
|
+
[**Members**](Members.md)
|
367
|
+
|
368
|
+
### Authorization
|
369
|
+
|
370
|
+
[ApiKey](../README.md#ApiKey)
|
371
|
+
|
372
|
+
### HTTP request headers
|
373
|
+
|
374
|
+
- **Content-Type**: application/json
|
375
|
+
- **Accept**: application/json
|
376
|
+
|
@@ -0,0 +1,647 @@
|
|
1
|
+
# LaunchDarklyApi::AccountUsageBetaApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://app.launchdarkly.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_evaluations_usage**](AccountUsageBetaApi.md#get_evaluations_usage) | **GET** /api/v2/usage/evaluations/{projKey}/{envKey}/{flagKey} | Get evaluations usage |
|
8
|
+
| [**get_events_usage**](AccountUsageBetaApi.md#get_events_usage) | **GET** /api/v2/usage/events/{type} | Get events usage |
|
9
|
+
| [**get_mau_sdks_by_type**](AccountUsageBetaApi.md#get_mau_sdks_by_type) | **GET** /api/v2/usage/mau/sdks | Get MAU SDKs by type |
|
10
|
+
| [**get_mau_usage**](AccountUsageBetaApi.md#get_mau_usage) | **GET** /api/v2/usage/mau | Get MAU usage |
|
11
|
+
| [**get_mau_usage_by_category**](AccountUsageBetaApi.md#get_mau_usage_by_category) | **GET** /api/v2/usage/mau/bycategory | Get MAU usage by category |
|
12
|
+
| [**get_stream_usage**](AccountUsageBetaApi.md#get_stream_usage) | **GET** /api/v2/usage/streams/{source} | Get stream usage |
|
13
|
+
| [**get_stream_usage_by_sdk_version**](AccountUsageBetaApi.md#get_stream_usage_by_sdk_version) | **GET** /api/v2/usage/streams/{source}/bysdkversion | Get stream usage by SDK version |
|
14
|
+
| [**get_stream_usage_sdkversion**](AccountUsageBetaApi.md#get_stream_usage_sdkversion) | **GET** /api/v2/usage/streams/{source}/sdkversions | Get stream usage SDK versions |
|
15
|
+
|
16
|
+
|
17
|
+
## get_evaluations_usage
|
18
|
+
|
19
|
+
> <SeriesListRep> get_evaluations_usage(proj_key, env_key, flag_key, opts)
|
20
|
+
|
21
|
+
Get evaluations usage
|
22
|
+
|
23
|
+
Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'launchdarkly_api'
|
30
|
+
# setup authorization
|
31
|
+
LaunchDarklyApi.configure do |config|
|
32
|
+
# Configure API key authorization: ApiKey
|
33
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
34
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
35
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
36
|
+
end
|
37
|
+
|
38
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
39
|
+
proj_key = 'proj_key_example' # String | The project key.
|
40
|
+
env_key = 'env_key_example' # String | The environment key.
|
41
|
+
flag_key = 'flag_key_example' # String | The feature flag's key.
|
42
|
+
opts = {
|
43
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp. Defaults to 30 days ago.
|
44
|
+
to: 'to_example', # String | The series of data returned ends at this timestamp. Defaults to the current time.
|
45
|
+
tz: 'tz_example' # String | The timezone to use for breaks between days when returning daily data.
|
46
|
+
}
|
47
|
+
|
48
|
+
begin
|
49
|
+
# Get evaluations usage
|
50
|
+
result = api_instance.get_evaluations_usage(proj_key, env_key, flag_key, opts)
|
51
|
+
p result
|
52
|
+
rescue LaunchDarklyApi::ApiError => e
|
53
|
+
puts "Error when calling AccountUsageBetaApi->get_evaluations_usage: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
#### Using the get_evaluations_usage_with_http_info variant
|
58
|
+
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
60
|
+
|
61
|
+
> <Array(<SeriesListRep>, Integer, Hash)> get_evaluations_usage_with_http_info(proj_key, env_key, flag_key, opts)
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
begin
|
65
|
+
# Get evaluations usage
|
66
|
+
data, status_code, headers = api_instance.get_evaluations_usage_with_http_info(proj_key, env_key, flag_key, opts)
|
67
|
+
p status_code # => 2xx
|
68
|
+
p headers # => { ... }
|
69
|
+
p data # => <SeriesListRep>
|
70
|
+
rescue LaunchDarklyApi::ApiError => e
|
71
|
+
puts "Error when calling AccountUsageBetaApi->get_evaluations_usage_with_http_info: #{e}"
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
### Parameters
|
76
|
+
|
77
|
+
| Name | Type | Description | Notes |
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
79
|
+
| **proj_key** | **String** | The project key. | |
|
80
|
+
| **env_key** | **String** | The environment key. | |
|
81
|
+
| **flag_key** | **String** | The feature flag's key. | |
|
82
|
+
| **from** | **String** | The series of data returned starts from this timestamp. Defaults to 30 days ago. | [optional] |
|
83
|
+
| **to** | **String** | The series of data returned ends at this timestamp. Defaults to the current time. | [optional] |
|
84
|
+
| **tz** | **String** | The timezone to use for breaks between days when returning daily data. | [optional] |
|
85
|
+
|
86
|
+
### Return type
|
87
|
+
|
88
|
+
[**SeriesListRep**](SeriesListRep.md)
|
89
|
+
|
90
|
+
### Authorization
|
91
|
+
|
92
|
+
[ApiKey](../README.md#ApiKey)
|
93
|
+
|
94
|
+
### HTTP request headers
|
95
|
+
|
96
|
+
- **Content-Type**: Not defined
|
97
|
+
- **Accept**: application/json
|
98
|
+
|
99
|
+
|
100
|
+
## get_events_usage
|
101
|
+
|
102
|
+
> <SeriesListRep> get_events_usage(type, opts)
|
103
|
+
|
104
|
+
Get events usage
|
105
|
+
|
106
|
+
Get time-series arrays of the number of times a flag is evaluated, broken down by the variation that resulted from that evaluation. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.
|
107
|
+
|
108
|
+
### Examples
|
109
|
+
|
110
|
+
```ruby
|
111
|
+
require 'time'
|
112
|
+
require 'launchdarkly_api'
|
113
|
+
# setup authorization
|
114
|
+
LaunchDarklyApi.configure do |config|
|
115
|
+
# Configure API key authorization: ApiKey
|
116
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
117
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
118
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
119
|
+
end
|
120
|
+
|
121
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
122
|
+
type = 'type_example' # String | The type of event to retrieve. Must be either `received` or `published`.
|
123
|
+
opts = {
|
124
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp. Defaults to 24 hours ago.
|
125
|
+
to: 'to_example' # String | The series of data returned ends at this timestamp. Defaults to the current time.
|
126
|
+
}
|
127
|
+
|
128
|
+
begin
|
129
|
+
# Get events usage
|
130
|
+
result = api_instance.get_events_usage(type, opts)
|
131
|
+
p result
|
132
|
+
rescue LaunchDarklyApi::ApiError => e
|
133
|
+
puts "Error when calling AccountUsageBetaApi->get_events_usage: #{e}"
|
134
|
+
end
|
135
|
+
```
|
136
|
+
|
137
|
+
#### Using the get_events_usage_with_http_info variant
|
138
|
+
|
139
|
+
This returns an Array which contains the response data, status code and headers.
|
140
|
+
|
141
|
+
> <Array(<SeriesListRep>, Integer, Hash)> get_events_usage_with_http_info(type, opts)
|
142
|
+
|
143
|
+
```ruby
|
144
|
+
begin
|
145
|
+
# Get events usage
|
146
|
+
data, status_code, headers = api_instance.get_events_usage_with_http_info(type, opts)
|
147
|
+
p status_code # => 2xx
|
148
|
+
p headers # => { ... }
|
149
|
+
p data # => <SeriesListRep>
|
150
|
+
rescue LaunchDarklyApi::ApiError => e
|
151
|
+
puts "Error when calling AccountUsageBetaApi->get_events_usage_with_http_info: #{e}"
|
152
|
+
end
|
153
|
+
```
|
154
|
+
|
155
|
+
### Parameters
|
156
|
+
|
157
|
+
| Name | Type | Description | Notes |
|
158
|
+
| ---- | ---- | ----------- | ----- |
|
159
|
+
| **type** | **String** | The type of event to retrieve. Must be either `received` or `published`. | |
|
160
|
+
| **from** | **String** | The series of data returned starts from this timestamp. Defaults to 24 hours ago. | [optional] |
|
161
|
+
| **to** | **String** | The series of data returned ends at this timestamp. Defaults to the current time. | [optional] |
|
162
|
+
|
163
|
+
### Return type
|
164
|
+
|
165
|
+
[**SeriesListRep**](SeriesListRep.md)
|
166
|
+
|
167
|
+
### Authorization
|
168
|
+
|
169
|
+
[ApiKey](../README.md#ApiKey)
|
170
|
+
|
171
|
+
### HTTP request headers
|
172
|
+
|
173
|
+
- **Content-Type**: Not defined
|
174
|
+
- **Accept**: application/json
|
175
|
+
|
176
|
+
|
177
|
+
## get_mau_sdks_by_type
|
178
|
+
|
179
|
+
> <SdkListRep> get_mau_sdks_by_type(opts)
|
180
|
+
|
181
|
+
Get MAU SDKs by type
|
182
|
+
|
183
|
+
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.
|
184
|
+
|
185
|
+
### Examples
|
186
|
+
|
187
|
+
```ruby
|
188
|
+
require 'time'
|
189
|
+
require 'launchdarkly_api'
|
190
|
+
# setup authorization
|
191
|
+
LaunchDarklyApi.configure do |config|
|
192
|
+
# Configure API key authorization: ApiKey
|
193
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
194
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
195
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
196
|
+
end
|
197
|
+
|
198
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
199
|
+
opts = {
|
200
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp. Defaults to seven days ago.
|
201
|
+
to: 'to_example', # String | The series of data returned ends at this timestamp. Defaults to the current time.
|
202
|
+
sdktype: 'sdktype_example' # String | The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server`
|
203
|
+
}
|
204
|
+
|
205
|
+
begin
|
206
|
+
# Get MAU SDKs by type
|
207
|
+
result = api_instance.get_mau_sdks_by_type(opts)
|
208
|
+
p result
|
209
|
+
rescue LaunchDarklyApi::ApiError => e
|
210
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_sdks_by_type: #{e}"
|
211
|
+
end
|
212
|
+
```
|
213
|
+
|
214
|
+
#### Using the get_mau_sdks_by_type_with_http_info variant
|
215
|
+
|
216
|
+
This returns an Array which contains the response data, status code and headers.
|
217
|
+
|
218
|
+
> <Array(<SdkListRep>, Integer, Hash)> get_mau_sdks_by_type_with_http_info(opts)
|
219
|
+
|
220
|
+
```ruby
|
221
|
+
begin
|
222
|
+
# Get MAU SDKs by type
|
223
|
+
data, status_code, headers = api_instance.get_mau_sdks_by_type_with_http_info(opts)
|
224
|
+
p status_code # => 2xx
|
225
|
+
p headers # => { ... }
|
226
|
+
p data # => <SdkListRep>
|
227
|
+
rescue LaunchDarklyApi::ApiError => e
|
228
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_sdks_by_type_with_http_info: #{e}"
|
229
|
+
end
|
230
|
+
```
|
231
|
+
|
232
|
+
### Parameters
|
233
|
+
|
234
|
+
| Name | Type | Description | Notes |
|
235
|
+
| ---- | ---- | ----------- | ----- |
|
236
|
+
| **from** | **String** | The series of data returned starts from this timestamp. Defaults to seven days ago. | [optional] |
|
237
|
+
| **to** | **String** | The series of data returned ends at this timestamp. Defaults to the current time. | [optional] |
|
238
|
+
| **sdktype** | **String** | The type of SDK with monthly active users (MAU) to list. Must be either `client` or `server` | [optional] |
|
239
|
+
|
240
|
+
### Return type
|
241
|
+
|
242
|
+
[**SdkListRep**](SdkListRep.md)
|
243
|
+
|
244
|
+
### Authorization
|
245
|
+
|
246
|
+
[ApiKey](../README.md#ApiKey)
|
247
|
+
|
248
|
+
### HTTP request headers
|
249
|
+
|
250
|
+
- **Content-Type**: Not defined
|
251
|
+
- **Accept**: application/json
|
252
|
+
|
253
|
+
|
254
|
+
## get_mau_usage
|
255
|
+
|
256
|
+
> <SeriesListRep> get_mau_usage(opts)
|
257
|
+
|
258
|
+
Get MAU usage
|
259
|
+
|
260
|
+
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.
|
261
|
+
|
262
|
+
### Examples
|
263
|
+
|
264
|
+
```ruby
|
265
|
+
require 'time'
|
266
|
+
require 'launchdarkly_api'
|
267
|
+
# setup authorization
|
268
|
+
LaunchDarklyApi.configure do |config|
|
269
|
+
# Configure API key authorization: ApiKey
|
270
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
271
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
272
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
273
|
+
end
|
274
|
+
|
275
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
276
|
+
opts = {
|
277
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp. Defaults to 30 days ago.
|
278
|
+
to: 'to_example', # String | The series of data returned ends at this timestamp. Defaults to the current time.
|
279
|
+
project: 'project_example', # String | A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects.
|
280
|
+
environment: 'environment_example', # String | An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project.
|
281
|
+
sdktype: 'sdktype_example', # String | An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server
|
282
|
+
sdk: 'sdk_example', # String | An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK.
|
283
|
+
anonymous: 'anonymous_example', # String | If specified, filters results to either anonymous or nonanonymous users.
|
284
|
+
groupby: 'groupby_example' # String | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous
|
285
|
+
}
|
286
|
+
|
287
|
+
begin
|
288
|
+
# Get MAU usage
|
289
|
+
result = api_instance.get_mau_usage(opts)
|
290
|
+
p result
|
291
|
+
rescue LaunchDarklyApi::ApiError => e
|
292
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_usage: #{e}"
|
293
|
+
end
|
294
|
+
```
|
295
|
+
|
296
|
+
#### Using the get_mau_usage_with_http_info variant
|
297
|
+
|
298
|
+
This returns an Array which contains the response data, status code and headers.
|
299
|
+
|
300
|
+
> <Array(<SeriesListRep>, Integer, Hash)> get_mau_usage_with_http_info(opts)
|
301
|
+
|
302
|
+
```ruby
|
303
|
+
begin
|
304
|
+
# Get MAU usage
|
305
|
+
data, status_code, headers = api_instance.get_mau_usage_with_http_info(opts)
|
306
|
+
p status_code # => 2xx
|
307
|
+
p headers # => { ... }
|
308
|
+
p data # => <SeriesListRep>
|
309
|
+
rescue LaunchDarklyApi::ApiError => e
|
310
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_usage_with_http_info: #{e}"
|
311
|
+
end
|
312
|
+
```
|
313
|
+
|
314
|
+
### Parameters
|
315
|
+
|
316
|
+
| Name | Type | Description | Notes |
|
317
|
+
| ---- | ---- | ----------- | ----- |
|
318
|
+
| **from** | **String** | The series of data returned starts from this timestamp. Defaults to 30 days ago. | [optional] |
|
319
|
+
| **to** | **String** | The series of data returned ends at this timestamp. Defaults to the current time. | [optional] |
|
320
|
+
| **project** | **String** | A project key to filter results to. Can be specified multiple times, one query parameter per project key, to view data for multiple projects. | [optional] |
|
321
|
+
| **environment** | **String** | An environment key to filter results to. When using this parameter, exactly one project key must also be set. Can be specified multiple times as separate query parameters to view data for multiple environments within a single project. | [optional] |
|
322
|
+
| **sdktype** | **String** | An SDK type to filter results to. Can be specified multiple times, one query parameter per SDK type. Valid values: client, server | [optional] |
|
323
|
+
| **sdk** | **String** | An SDK name to filter results to. Can be specified multiple times, one query parameter per SDK. | [optional] |
|
324
|
+
| **anonymous** | **String** | If specified, filters results to either anonymous or nonanonymous users. | [optional] |
|
325
|
+
| **groupby** | **String** | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions (for example, to group by both project and SDK). Valid values: project, environment, sdktype, sdk, anonymous | [optional] |
|
326
|
+
|
327
|
+
### Return type
|
328
|
+
|
329
|
+
[**SeriesListRep**](SeriesListRep.md)
|
330
|
+
|
331
|
+
### Authorization
|
332
|
+
|
333
|
+
[ApiKey](../README.md#ApiKey)
|
334
|
+
|
335
|
+
### HTTP request headers
|
336
|
+
|
337
|
+
- **Content-Type**: Not defined
|
338
|
+
- **Accept**: application/json
|
339
|
+
|
340
|
+
|
341
|
+
## get_mau_usage_by_category
|
342
|
+
|
343
|
+
> <SeriesListRep> get_mau_usage_by_category(opts)
|
344
|
+
|
345
|
+
Get MAU usage by category
|
346
|
+
|
347
|
+
Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.
|
348
|
+
|
349
|
+
### Examples
|
350
|
+
|
351
|
+
```ruby
|
352
|
+
require 'time'
|
353
|
+
require 'launchdarkly_api'
|
354
|
+
# setup authorization
|
355
|
+
LaunchDarklyApi.configure do |config|
|
356
|
+
# Configure API key authorization: ApiKey
|
357
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
358
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
359
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
360
|
+
end
|
361
|
+
|
362
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
363
|
+
opts = {
|
364
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp. Defaults to 30 days ago.
|
365
|
+
to: 'to_example' # String | The series of data returned ends at this timestamp. Defaults to the current time.
|
366
|
+
}
|
367
|
+
|
368
|
+
begin
|
369
|
+
# Get MAU usage by category
|
370
|
+
result = api_instance.get_mau_usage_by_category(opts)
|
371
|
+
p result
|
372
|
+
rescue LaunchDarklyApi::ApiError => e
|
373
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_usage_by_category: #{e}"
|
374
|
+
end
|
375
|
+
```
|
376
|
+
|
377
|
+
#### Using the get_mau_usage_by_category_with_http_info variant
|
378
|
+
|
379
|
+
This returns an Array which contains the response data, status code and headers.
|
380
|
+
|
381
|
+
> <Array(<SeriesListRep>, Integer, Hash)> get_mau_usage_by_category_with_http_info(opts)
|
382
|
+
|
383
|
+
```ruby
|
384
|
+
begin
|
385
|
+
# Get MAU usage by category
|
386
|
+
data, status_code, headers = api_instance.get_mau_usage_by_category_with_http_info(opts)
|
387
|
+
p status_code # => 2xx
|
388
|
+
p headers # => { ... }
|
389
|
+
p data # => <SeriesListRep>
|
390
|
+
rescue LaunchDarklyApi::ApiError => e
|
391
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_usage_by_category_with_http_info: #{e}"
|
392
|
+
end
|
393
|
+
```
|
394
|
+
|
395
|
+
### Parameters
|
396
|
+
|
397
|
+
| Name | Type | Description | Notes |
|
398
|
+
| ---- | ---- | ----------- | ----- |
|
399
|
+
| **from** | **String** | The series of data returned starts from this timestamp. Defaults to 30 days ago. | [optional] |
|
400
|
+
| **to** | **String** | The series of data returned ends at this timestamp. Defaults to the current time. | [optional] |
|
401
|
+
|
402
|
+
### Return type
|
403
|
+
|
404
|
+
[**SeriesListRep**](SeriesListRep.md)
|
405
|
+
|
406
|
+
### Authorization
|
407
|
+
|
408
|
+
[ApiKey](../README.md#ApiKey)
|
409
|
+
|
410
|
+
### HTTP request headers
|
411
|
+
|
412
|
+
- **Content-Type**: Not defined
|
413
|
+
- **Accept**: application/json
|
414
|
+
|
415
|
+
|
416
|
+
## get_stream_usage
|
417
|
+
|
418
|
+
> <SeriesListRep> get_stream_usage(source, opts)
|
419
|
+
|
420
|
+
Get stream usage
|
421
|
+
|
422
|
+
Get a time-series array of the number of streaming connections to LaunchDarkly in each time period. The granularity of the data depends on the age of the data requested. If the requested range is within the past two hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.
|
423
|
+
|
424
|
+
### Examples
|
425
|
+
|
426
|
+
```ruby
|
427
|
+
require 'time'
|
428
|
+
require 'launchdarkly_api'
|
429
|
+
# setup authorization
|
430
|
+
LaunchDarklyApi.configure do |config|
|
431
|
+
# Configure API key authorization: ApiKey
|
432
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
433
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
434
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
435
|
+
end
|
436
|
+
|
437
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
438
|
+
source = 'source_example' # String | The source of streaming connections to describe. Must be either `client` or `server`.
|
439
|
+
opts = {
|
440
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp. Defaults to 30 days ago.
|
441
|
+
to: 'to_example', # String | The series of data returned ends at this timestamp. Defaults to the current time.
|
442
|
+
tz: 'tz_example' # String | The timezone to use for breaks between days when returning daily data.
|
443
|
+
}
|
444
|
+
|
445
|
+
begin
|
446
|
+
# Get stream usage
|
447
|
+
result = api_instance.get_stream_usage(source, opts)
|
448
|
+
p result
|
449
|
+
rescue LaunchDarklyApi::ApiError => e
|
450
|
+
puts "Error when calling AccountUsageBetaApi->get_stream_usage: #{e}"
|
451
|
+
end
|
452
|
+
```
|
453
|
+
|
454
|
+
#### Using the get_stream_usage_with_http_info variant
|
455
|
+
|
456
|
+
This returns an Array which contains the response data, status code and headers.
|
457
|
+
|
458
|
+
> <Array(<SeriesListRep>, Integer, Hash)> get_stream_usage_with_http_info(source, opts)
|
459
|
+
|
460
|
+
```ruby
|
461
|
+
begin
|
462
|
+
# Get stream usage
|
463
|
+
data, status_code, headers = api_instance.get_stream_usage_with_http_info(source, opts)
|
464
|
+
p status_code # => 2xx
|
465
|
+
p headers # => { ... }
|
466
|
+
p data # => <SeriesListRep>
|
467
|
+
rescue LaunchDarklyApi::ApiError => e
|
468
|
+
puts "Error when calling AccountUsageBetaApi->get_stream_usage_with_http_info: #{e}"
|
469
|
+
end
|
470
|
+
```
|
471
|
+
|
472
|
+
### Parameters
|
473
|
+
|
474
|
+
| Name | Type | Description | Notes |
|
475
|
+
| ---- | ---- | ----------- | ----- |
|
476
|
+
| **source** | **String** | The source of streaming connections to describe. Must be either `client` or `server`. | |
|
477
|
+
| **from** | **String** | The series of data returned starts from this timestamp. Defaults to 30 days ago. | [optional] |
|
478
|
+
| **to** | **String** | The series of data returned ends at this timestamp. Defaults to the current time. | [optional] |
|
479
|
+
| **tz** | **String** | The timezone to use for breaks between days when returning daily data. | [optional] |
|
480
|
+
|
481
|
+
### Return type
|
482
|
+
|
483
|
+
[**SeriesListRep**](SeriesListRep.md)
|
484
|
+
|
485
|
+
### Authorization
|
486
|
+
|
487
|
+
[ApiKey](../README.md#ApiKey)
|
488
|
+
|
489
|
+
### HTTP request headers
|
490
|
+
|
491
|
+
- **Content-Type**: Not defined
|
492
|
+
- **Accept**: application/json
|
493
|
+
|
494
|
+
|
495
|
+
## get_stream_usage_by_sdk_version
|
496
|
+
|
497
|
+
> <SeriesListRep> get_stream_usage_by_sdk_version(source, opts)
|
498
|
+
|
499
|
+
Get stream usage by SDK version
|
500
|
+
|
501
|
+
Get multiple series of the number of streaming connections to LaunchDarkly in each time period, separated by SDK type and version. Information about each series is in the metadata array. The granularity of the data depends on the age of the data requested. If the requested range is within the past 2 hours, minutely data is returned. If it is within the last two days, hourly data is returned. Otherwise, daily data is returned.
|
502
|
+
|
503
|
+
### Examples
|
504
|
+
|
505
|
+
```ruby
|
506
|
+
require 'time'
|
507
|
+
require 'launchdarkly_api'
|
508
|
+
# setup authorization
|
509
|
+
LaunchDarklyApi.configure do |config|
|
510
|
+
# Configure API key authorization: ApiKey
|
511
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
512
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
513
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
514
|
+
end
|
515
|
+
|
516
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
517
|
+
source = 'source_example' # String | The source of streaming connections to describe. Must be either `client` or `server`.
|
518
|
+
opts = {
|
519
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp. Defaults to 24 hours ago.
|
520
|
+
to: 'to_example', # String | The series of data returned ends at this timestamp. Defaults to the current time.
|
521
|
+
tz: 'tz_example', # String | The timezone to use for breaks between days when returning daily data.
|
522
|
+
sdk: 'sdk_example', # String | If included, this filters the returned series to only those that match this SDK name.
|
523
|
+
version: 'version_example' # String | If included, this filters the returned series to only those that match this SDK version.
|
524
|
+
}
|
525
|
+
|
526
|
+
begin
|
527
|
+
# Get stream usage by SDK version
|
528
|
+
result = api_instance.get_stream_usage_by_sdk_version(source, opts)
|
529
|
+
p result
|
530
|
+
rescue LaunchDarklyApi::ApiError => e
|
531
|
+
puts "Error when calling AccountUsageBetaApi->get_stream_usage_by_sdk_version: #{e}"
|
532
|
+
end
|
533
|
+
```
|
534
|
+
|
535
|
+
#### Using the get_stream_usage_by_sdk_version_with_http_info variant
|
536
|
+
|
537
|
+
This returns an Array which contains the response data, status code and headers.
|
538
|
+
|
539
|
+
> <Array(<SeriesListRep>, Integer, Hash)> get_stream_usage_by_sdk_version_with_http_info(source, opts)
|
540
|
+
|
541
|
+
```ruby
|
542
|
+
begin
|
543
|
+
# Get stream usage by SDK version
|
544
|
+
data, status_code, headers = api_instance.get_stream_usage_by_sdk_version_with_http_info(source, opts)
|
545
|
+
p status_code # => 2xx
|
546
|
+
p headers # => { ... }
|
547
|
+
p data # => <SeriesListRep>
|
548
|
+
rescue LaunchDarklyApi::ApiError => e
|
549
|
+
puts "Error when calling AccountUsageBetaApi->get_stream_usage_by_sdk_version_with_http_info: #{e}"
|
550
|
+
end
|
551
|
+
```
|
552
|
+
|
553
|
+
### Parameters
|
554
|
+
|
555
|
+
| Name | Type | Description | Notes |
|
556
|
+
| ---- | ---- | ----------- | ----- |
|
557
|
+
| **source** | **String** | The source of streaming connections to describe. Must be either `client` or `server`. | |
|
558
|
+
| **from** | **String** | The series of data returned starts from this timestamp. Defaults to 24 hours ago. | [optional] |
|
559
|
+
| **to** | **String** | The series of data returned ends at this timestamp. Defaults to the current time. | [optional] |
|
560
|
+
| **tz** | **String** | The timezone to use for breaks between days when returning daily data. | [optional] |
|
561
|
+
| **sdk** | **String** | If included, this filters the returned series to only those that match this SDK name. | [optional] |
|
562
|
+
| **version** | **String** | If included, this filters the returned series to only those that match this SDK version. | [optional] |
|
563
|
+
|
564
|
+
### Return type
|
565
|
+
|
566
|
+
[**SeriesListRep**](SeriesListRep.md)
|
567
|
+
|
568
|
+
### Authorization
|
569
|
+
|
570
|
+
[ApiKey](../README.md#ApiKey)
|
571
|
+
|
572
|
+
### HTTP request headers
|
573
|
+
|
574
|
+
- **Content-Type**: Not defined
|
575
|
+
- **Accept**: application/json
|
576
|
+
|
577
|
+
|
578
|
+
## get_stream_usage_sdkversion
|
579
|
+
|
580
|
+
> <SdkVersionListRep> get_stream_usage_sdkversion(source)
|
581
|
+
|
582
|
+
Get stream usage SDK versions
|
583
|
+
|
584
|
+
Get a list of SDK version objects, which contain an SDK name and version. These are all of the SDKs that have connected to LaunchDarkly from your account in the past 60 days.
|
585
|
+
|
586
|
+
### Examples
|
587
|
+
|
588
|
+
```ruby
|
589
|
+
require 'time'
|
590
|
+
require 'launchdarkly_api'
|
591
|
+
# setup authorization
|
592
|
+
LaunchDarklyApi.configure do |config|
|
593
|
+
# Configure API key authorization: ApiKey
|
594
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
595
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
596
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
597
|
+
end
|
598
|
+
|
599
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
600
|
+
source = 'source_example' # String | The source of streaming connections to describe. Must be either `client` or `server`.
|
601
|
+
|
602
|
+
begin
|
603
|
+
# Get stream usage SDK versions
|
604
|
+
result = api_instance.get_stream_usage_sdkversion(source)
|
605
|
+
p result
|
606
|
+
rescue LaunchDarklyApi::ApiError => e
|
607
|
+
puts "Error when calling AccountUsageBetaApi->get_stream_usage_sdkversion: #{e}"
|
608
|
+
end
|
609
|
+
```
|
610
|
+
|
611
|
+
#### Using the get_stream_usage_sdkversion_with_http_info variant
|
612
|
+
|
613
|
+
This returns an Array which contains the response data, status code and headers.
|
614
|
+
|
615
|
+
> <Array(<SdkVersionListRep>, Integer, Hash)> get_stream_usage_sdkversion_with_http_info(source)
|
616
|
+
|
617
|
+
```ruby
|
618
|
+
begin
|
619
|
+
# Get stream usage SDK versions
|
620
|
+
data, status_code, headers = api_instance.get_stream_usage_sdkversion_with_http_info(source)
|
621
|
+
p status_code # => 2xx
|
622
|
+
p headers # => { ... }
|
623
|
+
p data # => <SdkVersionListRep>
|
624
|
+
rescue LaunchDarklyApi::ApiError => e
|
625
|
+
puts "Error when calling AccountUsageBetaApi->get_stream_usage_sdkversion_with_http_info: #{e}"
|
626
|
+
end
|
627
|
+
```
|
628
|
+
|
629
|
+
### Parameters
|
630
|
+
|
631
|
+
| Name | Type | Description | Notes |
|
632
|
+
| ---- | ---- | ----------- | ----- |
|
633
|
+
| **source** | **String** | The source of streaming connections to describe. Must be either `client` or `server`. | |
|
634
|
+
|
635
|
+
### Return type
|
636
|
+
|
637
|
+
[**SdkVersionListRep**](SdkVersionListRep.md)
|
638
|
+
|
639
|
+
### Authorization
|
640
|
+
|
641
|
+
[ApiKey](../README.md#ApiKey)
|
642
|
+
|
643
|
+
### HTTP request headers
|
644
|
+
|
645
|
+
- **Content-Type**: Not defined
|
646
|
+
- **Accept**: application/json
|
647
|
+
|