launchdarkly_api 5.4.0 → 7.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (997) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/README.md +841 -263
  4. data/Rakefile +2 -0
  5. data/docs/AccessDeniedReasonRep.md +28 -0
  6. data/docs/AccessDeniedRep.md +20 -0
  7. data/docs/AccessRep.md +18 -0
  8. data/docs/AccessTokenPost.md +30 -0
  9. data/docs/AccessTokensApi.md +239 -126
  10. data/docs/AccountMembersApi.md +450 -0
  11. data/docs/AccountUsageBetaApi.md +647 -0
  12. data/docs/ActionInputRep.md +18 -0
  13. data/docs/ActionOutputRep.md +20 -0
  14. data/docs/ApprovalConditionInputRep.md +20 -0
  15. data/docs/ApprovalConditionOutputRep.md +26 -0
  16. data/docs/ApprovalSettings.md +32 -0
  17. data/docs/ApprovalsApi.md +554 -0
  18. data/docs/AuditLogApi.md +93 -55
  19. data/docs/AuditLogEntryListingRep.md +52 -0
  20. data/docs/AuditLogEntryListingRepCollection.md +20 -0
  21. data/docs/AuditLogEntryRep.md +64 -0
  22. data/docs/AuthorizedAppDataRep.md +26 -0
  23. data/docs/BigSegmentTarget.md +22 -0
  24. data/docs/BranchCollectionRep.md +20 -0
  25. data/docs/BranchRep.md +28 -0
  26. data/docs/Clause.md +21 -7
  27. data/docs/ClientSideAvailability.md +15 -4
  28. data/docs/ClientSideAvailabilityPost.md +20 -0
  29. data/docs/CodeReferencesApi.md +980 -0
  30. data/docs/ConditionBaseOutputRep.md +22 -0
  31. data/docs/ConditionInputRep.md +26 -0
  32. data/docs/ConditionOutputRep.md +34 -0
  33. data/docs/ConfidenceIntervalRep.md +20 -0
  34. data/docs/Conflict.md +20 -0
  35. data/docs/ConflictOutputRep.md +20 -0
  36. data/docs/CopiedFromEnv.md +20 -0
  37. data/docs/CreateCopyFlagConfigApprovalRequestRequest.md +28 -0
  38. data/docs/CreateFlagConfigApprovalRequestRequest.md +30 -0
  39. data/docs/CustomProperty.md +15 -4
  40. data/docs/CustomRole.md +27 -8
  41. data/docs/CustomRolePost.md +26 -0
  42. data/docs/CustomRolePostData.md +26 -0
  43. data/docs/CustomRoles.md +15 -4
  44. data/docs/CustomRolesApi.md +196 -100
  45. data/docs/CustomRolesRep.md +24 -0
  46. data/docs/CustomWorkflowInputRep.md +24 -0
  47. data/docs/CustomWorkflowMeta.md +20 -0
  48. data/docs/CustomWorkflowOutputRep.md +38 -0
  49. data/docs/CustomWorkflowStageMeta.md +20 -0
  50. data/docs/CustomWorkflowsListingOutputRep.md +18 -0
  51. data/docs/DataExportDestinationsApi.md +205 -117
  52. data/docs/DefaultClientSideAvailabilityPost.md +20 -0
  53. data/docs/Defaults.md +15 -4
  54. data/docs/DependentFlag.md +19 -6
  55. data/docs/DependentFlagEnvironment.md +19 -6
  56. data/docs/DependentFlagsByEnvironment.md +17 -5
  57. data/docs/DerivedAttribute.md +20 -0
  58. data/docs/Destination.md +27 -9
  59. data/docs/DestinationPost.md +24 -0
  60. data/docs/Destinations.md +15 -4
  61. data/docs/Environment.md +39 -16
  62. data/docs/EnvironmentPost.md +29 -11
  63. data/docs/EnvironmentsApi.md +246 -144
  64. data/docs/ExecutionOutputRep.md +18 -0
  65. data/docs/ExpandedTeamRep.md +44 -0
  66. data/docs/ExperimentAllocationRep.md +20 -0
  67. data/docs/ExperimentEnabledPeriodRep.md +20 -0
  68. data/docs/ExperimentEnvironmentSettingRep.md +22 -0
  69. data/docs/ExperimentInfoRep.md +20 -0
  70. data/docs/ExperimentMetadataRep.md +18 -0
  71. data/docs/ExperimentRep.md +24 -0
  72. data/docs/ExperimentResultsRep.md +30 -0
  73. data/docs/ExperimentStatsRep.md +24 -0
  74. data/docs/ExperimentTimeSeriesSlice.md +20 -0
  75. data/docs/ExperimentTimeSeriesVariationSlice.md +32 -0
  76. data/docs/ExperimentTotalsRep.md +32 -0
  77. data/docs/ExperimentsBetaApi.md +168 -0
  78. data/docs/ExpiringUserTargetError.md +20 -0
  79. data/docs/ExpiringUserTargetGetResponse.md +20 -0
  80. data/docs/ExpiringUserTargetItem.md +30 -0
  81. data/docs/ExpiringUserTargetPatchResponse.md +28 -0
  82. data/docs/Extinction.md +26 -0
  83. data/docs/ExtinctionCollectionRep.md +20 -0
  84. data/docs/FeatureFlag.md +55 -22
  85. data/docs/FeatureFlagBody.md +33 -11
  86. data/docs/FeatureFlagConfig.md +47 -17
  87. data/docs/FeatureFlagScheduledChange.md +27 -6
  88. data/docs/FeatureFlagScheduledChanges.md +15 -4
  89. data/docs/FeatureFlagStatus.md +17 -6
  90. data/docs/FeatureFlagStatusAcrossEnvironments.md +17 -5
  91. data/docs/FeatureFlagStatuses.md +15 -4
  92. data/docs/FeatureFlags.md +17 -5
  93. data/docs/FeatureFlagsApi.md +449 -1184
  94. data/docs/FeatureFlagsBetaApi.md +157 -0
  95. data/docs/FlagConfigApprovalRequestResponse.md +56 -0
  96. data/docs/FlagConfigApprovalRequestsResponse.md +20 -0
  97. data/docs/FlagCopyConfigEnvironment.md +20 -0
  98. data/docs/FlagCopyConfigPost.md +26 -0
  99. data/docs/FlagGlobalAttributesRep.md +58 -0
  100. data/docs/FlagListingRep.md +24 -0
  101. data/docs/FlagScheduledChangesInput.md +20 -0
  102. data/docs/FlagStatusRep.md +24 -0
  103. data/docs/FlagSummary.md +18 -0
  104. data/docs/FlagTriggerInput.md +20 -0
  105. data/docs/FlagTriggersApi.md +396 -0
  106. data/docs/ForbiddenErrorRep.md +20 -0
  107. data/docs/HunkRep.md +26 -0
  108. data/docs/Integration.md +35 -4
  109. data/docs/IntegrationAuditLogSubscriptionsApi.md +376 -0
  110. data/docs/IntegrationMetadata.md +24 -0
  111. data/docs/IntegrationStatus.md +20 -0
  112. data/docs/IntegrationStatusRep.md +22 -0
  113. data/docs/IntegrationSubscriptionStatusRep.md +26 -0
  114. data/docs/Integrations.md +17 -4
  115. data/docs/InvalidRequestErrorRep.md +20 -0
  116. data/docs/IpList.md +20 -0
  117. data/docs/LastSeenMetadata.md +18 -0
  118. data/docs/Link.md +15 -4
  119. data/docs/Member.md +47 -14
  120. data/docs/MemberDataRep.md +26 -0
  121. data/docs/MemberImportItemRep.md +22 -0
  122. data/docs/MemberPermissionGrantSummaryRep.md +22 -0
  123. data/docs/MemberSummaryRep.md +28 -0
  124. data/docs/MemberTeamSummaryRep.md +22 -0
  125. data/docs/MemberTeamsFormPost.md +18 -0
  126. data/docs/Members.md +17 -5
  127. data/docs/MethodNotAllowedErrorRep.md +20 -0
  128. data/docs/MetricCollectionRep.md +20 -0
  129. data/docs/MetricListingRep.md +52 -0
  130. data/docs/MetricPost.md +40 -0
  131. data/docs/MetricRep.md +62 -0
  132. data/docs/MetricSeen.md +20 -0
  133. data/docs/MetricsApi.md +376 -0
  134. data/docs/Modification.md +18 -0
  135. data/docs/MultiEnvironmentDependentFlag.md +17 -7
  136. data/docs/MultiEnvironmentDependentFlags.md +17 -5
  137. data/docs/NewMemberForm.md +28 -0
  138. data/docs/NotFoundErrorRep.md +20 -0
  139. data/docs/OtherApi.md +282 -0
  140. data/docs/ParentResourceRep.md +22 -0
  141. data/docs/PatchFailedErrorRep.md +20 -0
  142. data/docs/PatchOperation.md +17 -5
  143. data/docs/PatchSegmentInstruction.md +26 -0
  144. data/docs/PatchSegmentRequest.md +20 -0
  145. data/docs/PatchWithComment.md +20 -0
  146. data/docs/PermissionGrantInput.md +22 -0
  147. data/docs/PermissionGrantRep.md +24 -0
  148. data/docs/PostApprovalRequestApplyRequest.md +18 -0
  149. data/docs/PostApprovalRequestReviewRequest.md +20 -0
  150. data/docs/PostFlagScheduledChangesInput.md +22 -0
  151. data/docs/Prerequisite.md +15 -4
  152. data/docs/Project.md +27 -10
  153. data/docs/ProjectListingRep.md +30 -0
  154. data/docs/ProjectPost.md +28 -0
  155. data/docs/Projects.md +15 -4
  156. data/docs/ProjectsApi.md +196 -100
  157. data/docs/PubNubDetailRep.md +20 -0
  158. data/docs/PutBranch.md +28 -0
  159. data/docs/RateLimitedErrorRep.md +20 -0
  160. data/docs/RecentTriggerBody.md +20 -0
  161. data/docs/ReferenceRep.md +22 -0
  162. data/docs/RelayAutoConfigCollectionRep.md +18 -0
  163. data/docs/RelayAutoConfigPost.md +20 -0
  164. data/docs/RelayAutoConfigRep.md +34 -0
  165. data/docs/RelayProxyConfigurationsApi.md +244 -129
  166. data/docs/RepositoryCollectionRep.md +20 -0
  167. data/docs/RepositoryPost.md +28 -0
  168. data/docs/RepositoryRep.md +38 -0
  169. data/docs/ResourceAccess.md +20 -0
  170. data/docs/ResourceIDResponse.md +26 -0
  171. data/docs/ReviewOutputRep.md +26 -0
  172. data/docs/ReviewResponse.md +26 -0
  173. data/docs/Rollout.md +19 -4
  174. data/docs/Rule.md +25 -8
  175. data/docs/ScheduleConditionInputRep.md +20 -0
  176. data/docs/ScheduleConditionOutputRep.md +18 -0
  177. data/docs/ScheduledChangesApi.md +404 -0
  178. data/docs/SdkListRep.md +20 -0
  179. data/docs/SdkVersionListRep.md +20 -0
  180. data/docs/SdkVersionRep.md +20 -0
  181. data/docs/SegmentBody.md +26 -0
  182. data/docs/SegmentMetadata.md +28 -0
  183. data/docs/SegmentUserList.md +20 -0
  184. data/docs/SegmentUserState.md +20 -0
  185. data/docs/SegmentsApi.md +695 -0
  186. data/docs/SeriesListRep.md +22 -0
  187. data/docs/SourceFlag.md +20 -0
  188. data/docs/StageInputRep.md +22 -0
  189. data/docs/StageOutputRep.md +26 -0
  190. data/docs/Statement.md +21 -7
  191. data/docs/StatementPost.md +26 -0
  192. data/docs/StatementPostData.md +26 -0
  193. data/docs/StatementRep.md +26 -0
  194. data/docs/StatisticCollectionRep.md +20 -0
  195. data/docs/StatisticRep.md +30 -0
  196. data/docs/StatisticsRoot.md +20 -0
  197. data/docs/StatusConflictErrorRep.md +20 -0
  198. data/docs/SubjectDataRep.md +22 -0
  199. data/docs/SubscriptionPost.md +30 -0
  200. data/docs/Target.md +15 -4
  201. data/docs/TargetResourceRep.md +22 -0
  202. data/docs/TeamCollectionRep.md +22 -0
  203. data/docs/TeamImportsRep.md +18 -0
  204. data/docs/TeamPatchInput.md +20 -0
  205. data/docs/TeamPostInput.md +28 -0
  206. data/docs/TeamRep.md +40 -0
  207. data/docs/TeamsBetaApi.md +450 -0
  208. data/docs/TitleRep.md +32 -0
  209. data/docs/Token.md +43 -17
  210. data/docs/TokenDataRep.md +26 -0
  211. data/docs/Tokens.md +15 -4
  212. data/docs/TriggerPost.md +22 -0
  213. data/docs/TriggerWorkflowCollectionRep.md +20 -0
  214. data/docs/TriggerWorkflowRep.md +42 -0
  215. data/docs/UnauthorizedErrorRep.md +20 -0
  216. data/docs/UrlPost.md +24 -0
  217. data/docs/User.md +37 -13
  218. data/docs/UserAttributeNamesRep.md +22 -0
  219. data/docs/UserFlagSetting.md +17 -5
  220. data/docs/UserFlagSettings.md +15 -4
  221. data/docs/UserRecord.md +25 -7
  222. data/docs/UserRecordRep.md +26 -0
  223. data/docs/UserSegment.md +49 -14
  224. data/docs/UserSegmentRule.md +19 -5
  225. data/docs/UserSegments.md +15 -4
  226. data/docs/UserSettingsApi.md +217 -137
  227. data/docs/Users.md +17 -5
  228. data/docs/UsersApi.md +187 -114
  229. data/docs/UsersBetaApi.md +81 -0
  230. data/docs/ValuePut.md +20 -0
  231. data/docs/Variation.md +19 -6
  232. data/docs/VariationOrRolloutRep.md +20 -0
  233. data/docs/VariationSummary.md +30 -0
  234. data/docs/VersionsRep.md +24 -0
  235. data/docs/Webhook.md +29 -10
  236. data/docs/WebhookPost.md +30 -0
  237. data/docs/Webhooks.md +15 -4
  238. data/docs/WebhooksApi.md +199 -103
  239. data/docs/WeightedVariation.md +17 -4
  240. data/docs/WorkflowsBetaApi.md +316 -0
  241. data/git_push.sh +13 -11
  242. data/launchdarkly_api.gemspec +8 -16
  243. data/lib/launchdarkly_api/api/access_tokens_api.rb +198 -122
  244. data/lib/launchdarkly_api/api/account_members_api.rb +433 -0
  245. data/lib/launchdarkly_api/api/account_usage_beta_api.rb +598 -0
  246. data/lib/launchdarkly_api/api/approvals_api.rb +615 -0
  247. data/lib/launchdarkly_api/api/audit_log_api.rb +72 -51
  248. data/lib/launchdarkly_api/api/code_references_api.rb +929 -0
  249. data/lib/launchdarkly_api/api/custom_roles_api.rb +170 -105
  250. data/lib/launchdarkly_api/api/data_export_destinations_api.rb +210 -145
  251. data/lib/launchdarkly_api/api/environments_api.rb +205 -132
  252. data/lib/launchdarkly_api/api/experiments_beta_api.rb +190 -0
  253. data/lib/launchdarkly_api/api/feature_flags_api.rb +501 -1393
  254. data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -0
  255. data/lib/launchdarkly_api/api/flag_triggers_api.rb +437 -0
  256. data/lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb +377 -0
  257. data/lib/launchdarkly_api/api/metrics_api.rb +377 -0
  258. data/lib/launchdarkly_api/api/other_api.rb +248 -0
  259. data/lib/launchdarkly_api/api/projects_api.rb +155 -90
  260. data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +203 -127
  261. data/lib/launchdarkly_api/api/scheduled_changes_api.rb +443 -0
  262. data/lib/launchdarkly_api/api/segments_api.rb +735 -0
  263. data/lib/launchdarkly_api/api/teams_beta_api.rb +427 -0
  264. data/lib/launchdarkly_api/api/user_settings_api.rb +245 -180
  265. data/lib/launchdarkly_api/api/users_api.rb +185 -135
  266. data/lib/launchdarkly_api/api/users_beta_api.rb +91 -0
  267. data/lib/launchdarkly_api/api/webhooks_api.rb +178 -113
  268. data/lib/launchdarkly_api/api/workflows_beta_api.rb +345 -0
  269. data/lib/launchdarkly_api/api_client.rb +90 -91
  270. data/lib/launchdarkly_api/api_error.rb +23 -4
  271. data/lib/launchdarkly_api/configuration.rb +85 -16
  272. data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +280 -0
  273. data/lib/launchdarkly_api/models/access_denied_rep.rb +237 -0
  274. data/lib/launchdarkly_api/models/access_rep.rb +225 -0
  275. data/lib/launchdarkly_api/models/access_token_post.rb +317 -0
  276. data/lib/launchdarkly_api/models/action_input_rep.rb +219 -0
  277. data/lib/launchdarkly_api/models/action_output_rep.rb +239 -0
  278. data/lib/launchdarkly_api/models/approval_condition_input_rep.rb +229 -0
  279. data/lib/launchdarkly_api/models/approval_condition_output_rep.rb +278 -0
  280. data/lib/launchdarkly_api/models/approval_settings.rb +331 -0
  281. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +420 -0
  282. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +241 -0
  283. data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +481 -0
  284. data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +256 -0
  285. data/lib/launchdarkly_api/models/big_segment_target.rb +254 -0
  286. data/lib/launchdarkly_api/models/branch_collection_rep.rb +242 -0
  287. data/lib/launchdarkly_api/models/branch_rep.rb +291 -0
  288. data/lib/launchdarkly_api/models/clause.rb +78 -24
  289. data/lib/launchdarkly_api/models/client_side_availability.rb +65 -33
  290. data/lib/launchdarkly_api/models/client_side_availability_post.rb +237 -0
  291. data/lib/launchdarkly_api/models/condition_base_output_rep.rb +246 -0
  292. data/lib/launchdarkly_api/models/condition_input_rep.rb +256 -0
  293. data/lib/launchdarkly_api/models/condition_output_rep.rb +324 -0
  294. data/lib/launchdarkly_api/models/confidence_interval_rep.rb +227 -0
  295. data/lib/launchdarkly_api/models/conflict.rb +230 -0
  296. data/lib/launchdarkly_api/models/conflict_output_rep.rb +237 -0
  297. data/lib/launchdarkly_api/models/copied_from_env.rb +233 -0
  298. data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +286 -0
  299. data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +297 -0
  300. data/lib/launchdarkly_api/models/custom_property.rb +59 -23
  301. data/lib/launchdarkly_api/models/custom_role.rb +125 -49
  302. data/lib/launchdarkly_api/models/custom_role_post.rb +274 -0
  303. data/lib/launchdarkly_api/models/custom_role_post_data.rb +274 -0
  304. data/lib/launchdarkly_api/models/custom_roles.rb +58 -22
  305. data/lib/launchdarkly_api/models/custom_roles_rep.rb +247 -0
  306. data/lib/launchdarkly_api/models/custom_workflow_input_rep.rb +252 -0
  307. data/lib/launchdarkly_api/models/custom_workflow_meta.rb +227 -0
  308. data/lib/launchdarkly_api/models/custom_workflow_output_rep.rb +354 -0
  309. data/lib/launchdarkly_api/models/custom_workflow_stage_meta.rb +227 -0
  310. data/lib/launchdarkly_api/models/custom_workflows_listing_output_rep.rb +225 -0
  311. data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +237 -0
  312. data/lib/launchdarkly_api/models/defaults.rb +56 -25
  313. data/lib/launchdarkly_api/models/dependent_flag.rb +76 -25
  314. data/lib/launchdarkly_api/models/dependent_flag_environment.rb +76 -25
  315. data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +75 -24
  316. data/lib/launchdarkly_api/models/derived_attribute.rb +228 -0
  317. data/lib/launchdarkly_api/models/destination.rb +88 -47
  318. data/lib/launchdarkly_api/models/destination_post.rb +281 -0
  319. data/lib/launchdarkly_api/models/destinations.rb +58 -22
  320. data/lib/launchdarkly_api/models/environment.rb +167 -68
  321. data/lib/launchdarkly_api/models/environment_post.rb +90 -56
  322. data/lib/launchdarkly_api/models/execution_output_rep.rb +223 -0
  323. data/lib/launchdarkly_api/models/expanded_team_rep.rb +349 -0
  324. data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +237 -0
  325. data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +227 -0
  326. data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +238 -0
  327. data/lib/launchdarkly_api/models/experiment_info_rep.rb +239 -0
  328. data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +219 -0
  329. data/lib/launchdarkly_api/models/experiment_rep.rb +249 -0
  330. data/lib/launchdarkly_api/models/experiment_results_rep.rb +280 -0
  331. data/lib/launchdarkly_api/models/experiment_stats_rep.rb +245 -0
  332. data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +229 -0
  333. data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +281 -0
  334. data/lib/launchdarkly_api/models/experiment_totals_rep.rb +281 -0
  335. data/lib/launchdarkly_api/models/expiring_user_target_error.rb +237 -0
  336. data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +236 -0
  337. data/lib/launchdarkly_api/models/expiring_user_target_item.rb +300 -0
  338. data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +274 -0
  339. data/lib/launchdarkly_api/models/extinction.rb +283 -0
  340. data/lib/launchdarkly_api/models/extinction_collection_rep.rb +242 -0
  341. data/lib/launchdarkly_api/models/feature_flag.rb +276 -123
  342. data/lib/launchdarkly_api/models/feature_flag_body.rb +104 -54
  343. data/lib/launchdarkly_api/models/feature_flag_config.rb +184 -55
  344. data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +142 -38
  345. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +73 -32
  346. data/lib/launchdarkly_api/models/feature_flag_status.rb +70 -71
  347. data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +71 -33
  348. data/lib/launchdarkly_api/models/feature_flag_statuses.rb +64 -23
  349. data/lib/launchdarkly_api/models/feature_flags.rb +78 -32
  350. data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +457 -0
  351. data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +242 -0
  352. data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +232 -0
  353. data/lib/launchdarkly_api/models/flag_copy_config_post.rb +290 -0
  354. data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +514 -0
  355. data/lib/launchdarkly_api/models/flag_listing_rep.rb +257 -0
  356. data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +234 -0
  357. data/lib/launchdarkly_api/models/flag_status_rep.rb +256 -0
  358. data/lib/launchdarkly_api/models/flag_summary.rb +223 -0
  359. data/lib/launchdarkly_api/models/flag_trigger_input.rb +230 -0
  360. data/lib/launchdarkly_api/models/forbidden_error_rep.rb +227 -0
  361. data/lib/launchdarkly_api/models/hunk_rep.rb +266 -0
  362. data/lib/launchdarkly_api/models/integration.rb +159 -29
  363. data/lib/launchdarkly_api/models/integration_metadata.rb +265 -0
  364. data/lib/launchdarkly_api/models/integration_status.rb +237 -0
  365. data/lib/launchdarkly_api/models/integration_status_rep.rb +236 -0
  366. data/lib/launchdarkly_api/models/integration_subscription_status_rep.rb +256 -0
  367. data/lib/launchdarkly_api/models/integrations.rb +71 -27
  368. data/lib/launchdarkly_api/models/invalid_request_error_rep.rb +227 -0
  369. data/lib/launchdarkly_api/models/ip_list.rb +241 -0
  370. data/lib/launchdarkly_api/models/last_seen_metadata.rb +219 -0
  371. data/lib/launchdarkly_api/models/link.rb +54 -20
  372. data/lib/launchdarkly_api/models/member.rb +227 -67
  373. data/lib/launchdarkly_api/models/member_data_rep.rb +256 -0
  374. data/lib/launchdarkly_api/models/member_import_item_rep.rb +246 -0
  375. data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +253 -0
  376. data/lib/launchdarkly_api/models/member_summary_rep.rb +285 -0
  377. data/lib/launchdarkly_api/models/member_team_summary_rep.rb +253 -0
  378. data/lib/launchdarkly_api/models/member_teams_form_post.rb +226 -0
  379. data/lib/launchdarkly_api/models/members.rb +78 -32
  380. data/lib/launchdarkly_api/models/method_not_allowed_error_rep.rb +227 -0
  381. data/lib/launchdarkly_api/models/metric_collection_rep.rb +231 -0
  382. data/lib/launchdarkly_api/models/metric_listing_rep.rb +456 -0
  383. data/lib/launchdarkly_api/models/metric_post.rb +380 -0
  384. data/lib/launchdarkly_api/models/metric_rep.rb +505 -0
  385. data/lib/launchdarkly_api/models/metric_seen.rb +227 -0
  386. data/lib/launchdarkly_api/models/modification.rb +218 -0
  387. data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +69 -43
  388. data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +75 -24
  389. data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
  390. data/lib/launchdarkly_api/models/not_found_error_rep.rb +227 -0
  391. data/lib/launchdarkly_api/models/parent_resource_rep.rb +239 -0
  392. data/lib/launchdarkly_api/models/patch_failed_error_rep.rb +227 -0
  393. data/lib/launchdarkly_api/models/patch_operation.rb +59 -26
  394. data/lib/launchdarkly_api/models/patch_segment_instruction.rb +273 -0
  395. data/lib/launchdarkly_api/models/patch_segment_request.rb +236 -0
  396. data/lib/launchdarkly_api/models/patch_with_comment.rb +234 -0
  397. data/lib/launchdarkly_api/models/permission_grant_input.rb +240 -0
  398. data/lib/launchdarkly_api/models/permission_grant_rep.rb +249 -0
  399. data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +218 -0
  400. data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +227 -0
  401. data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +248 -0
  402. data/lib/launchdarkly_api/models/prerequisite.rb +64 -20
  403. data/lib/launchdarkly_api/models/project.rb +120 -50
  404. data/lib/launchdarkly_api/models/project_listing_rep.rb +306 -0
  405. data/lib/launchdarkly_api/models/project_post.rb +281 -0
  406. data/lib/launchdarkly_api/models/projects.rb +70 -22
  407. data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +227 -0
  408. data/lib/launchdarkly_api/models/put_branch.rb +284 -0
  409. data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +227 -0
  410. data/lib/launchdarkly_api/models/recent_trigger_body.rb +229 -0
  411. data/lib/launchdarkly_api/models/reference_rep.rb +250 -0
  412. data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +225 -0
  413. data/lib/launchdarkly_api/models/relay_auto_config_post.rb +240 -0
  414. data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +327 -0
  415. data/lib/launchdarkly_api/models/repository_collection_rep.rb +242 -0
  416. data/lib/launchdarkly_api/models/repository_post.rb +306 -0
  417. data/lib/launchdarkly_api/models/repository_rep.rb +385 -0
  418. data/lib/launchdarkly_api/models/resource_access.rb +228 -0
  419. data/lib/launchdarkly_api/models/resource_id_response.rb +254 -0
  420. data/lib/launchdarkly_api/models/review_output_rep.rb +264 -0
  421. data/lib/launchdarkly_api/models/review_response.rb +302 -0
  422. data/lib/launchdarkly_api/models/rollout.rb +89 -32
  423. data/lib/launchdarkly_api/models/rule.rb +89 -36
  424. data/lib/launchdarkly_api/models/schedule_condition_input_rep.rb +227 -0
  425. data/lib/launchdarkly_api/models/schedule_condition_output_rep.rb +218 -0
  426. data/lib/launchdarkly_api/models/sdk_list_rep.rb +241 -0
  427. data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +241 -0
  428. data/lib/launchdarkly_api/models/sdk_version_rep.rb +237 -0
  429. data/lib/launchdarkly_api/models/segment_body.rb +270 -0
  430. data/lib/launchdarkly_api/models/segment_metadata.rb +263 -0
  431. data/lib/launchdarkly_api/models/segment_user_list.rb +231 -0
  432. data/lib/launchdarkly_api/models/segment_user_state.rb +227 -0
  433. data/lib/launchdarkly_api/models/series_list_rep.rb +257 -0
  434. data/lib/launchdarkly_api/models/source_flag.rb +233 -0
  435. data/lib/launchdarkly_api/models/stage_input_rep.rb +238 -0
  436. data/lib/launchdarkly_api/models/stage_output_rep.rb +276 -0
  437. data/lib/launchdarkly_api/models/statement.rb +68 -61
  438. data/lib/launchdarkly_api/models/statement_post.rb +281 -0
  439. data/lib/launchdarkly_api/models/statement_post_data.rb +281 -0
  440. data/lib/launchdarkly_api/models/statement_rep.rb +271 -0
  441. data/lib/launchdarkly_api/models/statistic_collection_rep.rb +241 -0
  442. data/lib/launchdarkly_api/models/statistic_rep.rb +309 -0
  443. data/lib/launchdarkly_api/models/statistics_root.rb +229 -0
  444. data/lib/launchdarkly_api/models/status_conflict_error_rep.rb +227 -0
  445. data/lib/launchdarkly_api/models/subject_data_rep.rb +238 -0
  446. data/lib/launchdarkly_api/models/subscription_post.rb +293 -0
  447. data/lib/launchdarkly_api/models/target.rb +64 -20
  448. data/lib/launchdarkly_api/models/target_resource_rep.rb +240 -0
  449. data/lib/launchdarkly_api/models/team_collection_rep.rb +240 -0
  450. data/lib/launchdarkly_api/models/team_imports_rep.rb +220 -0
  451. data/lib/launchdarkly_api/models/team_patch_input.rb +229 -0
  452. data/lib/launchdarkly_api/models/team_post_input.rb +285 -0
  453. data/lib/launchdarkly_api/models/team_rep.rb +327 -0
  454. data/lib/launchdarkly_api/models/title_rep.rb +281 -0
  455. data/lib/launchdarkly_api/models/token.rb +159 -93
  456. data/lib/launchdarkly_api/models/token_data_rep.rb +256 -0
  457. data/lib/launchdarkly_api/models/tokens.rb +68 -32
  458. data/lib/launchdarkly_api/models/trigger_post.rb +245 -0
  459. data/lib/launchdarkly_api/models/trigger_workflow_collection_rep.rb +231 -0
  460. data/lib/launchdarkly_api/models/trigger_workflow_rep.rb +332 -0
  461. data/lib/launchdarkly_api/models/unauthorized_error_rep.rb +227 -0
  462. data/lib/launchdarkly_api/models/url_post.rb +279 -0
  463. data/lib/launchdarkly_api/models/user.rb +95 -37
  464. data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +245 -0
  465. data/lib/launchdarkly_api/models/user_flag_setting.rb +68 -27
  466. data/lib/launchdarkly_api/models/user_flag_settings.rb +78 -32
  467. data/lib/launchdarkly_api/models/user_record.rb +89 -34
  468. data/lib/launchdarkly_api/models/user_record_rep.rb +255 -0
  469. data/lib/launchdarkly_api/models/user_segment.rb +195 -69
  470. data/lib/launchdarkly_api/models/user_segment_rule.rb +71 -23
  471. data/lib/launchdarkly_api/models/user_segments.rb +78 -32
  472. data/lib/launchdarkly_api/models/users.rb +71 -25
  473. data/lib/launchdarkly_api/models/value_put.rb +229 -0
  474. data/lib/launchdarkly_api/models/variation.rb +70 -38
  475. data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +227 -0
  476. data/lib/launchdarkly_api/models/variation_summary.rb +287 -0
  477. data/lib/launchdarkly_api/models/versions_rep.rb +262 -0
  478. data/lib/launchdarkly_api/models/webhook.rb +120 -55
  479. data/lib/launchdarkly_api/models/webhook_post.rb +297 -0
  480. data/lib/launchdarkly_api/models/webhooks.rb +68 -22
  481. data/lib/launchdarkly_api/models/weighted_variation.rb +77 -24
  482. data/lib/launchdarkly_api/version.rb +5 -5
  483. data/lib/launchdarkly_api.rb +178 -95
  484. data/spec/api/access_tokens_api_spec.rb +23 -17
  485. data/spec/api/account_members_api_spec.rb +112 -0
  486. data/spec/api/account_usage_beta_api_spec.rb +156 -0
  487. data/spec/api/approvals_api_spec.rb +141 -0
  488. data/spec/api/audit_log_api_spec.rb +19 -17
  489. data/spec/api/code_references_api_spec.rb +208 -0
  490. data/spec/api/custom_roles_api_spec.rb +22 -17
  491. data/spec/api/data_export_destinations_api_spec.rb +30 -25
  492. data/spec/api/environments_api_spec.rb +31 -26
  493. data/spec/api/experiments_beta_api_spec.rb +67 -0
  494. data/spec/api/feature_flags_api_spec.rb +69 -267
  495. data/spec/api/feature_flags_beta_api_spec.rb +62 -0
  496. data/spec/api/flag_triggers_api_spec.rb +110 -0
  497. data/spec/api/integration_audit_log_subscriptions_api_spec.rb +100 -0
  498. data/spec/api/metrics_api_spec.rb +100 -0
  499. data/spec/api/other_api_spec.rb +79 -0
  500. data/spec/api/projects_api_spec.rb +22 -17
  501. data/spec/api/relay_proxy_configurations_api_spec.rb +37 -31
  502. data/spec/api/scheduled_changes_api_spec.rb +112 -0
  503. data/spec/api/segments_api_spec.rb +164 -0
  504. data/spec/api/teams_beta_api_spec.rb +111 -0
  505. data/spec/api/user_settings_api_spec.rb +41 -36
  506. data/spec/api/users_api_spec.rb +34 -28
  507. data/spec/api/users_beta_api_spec.rb +48 -0
  508. data/spec/api/webhooks_api_spec.rb +27 -22
  509. data/spec/api/workflows_beta_api_spec.rb +94 -0
  510. data/spec/api_client_spec.rb +7 -24
  511. data/spec/configuration_spec.rb +7 -7
  512. data/spec/models/access_denied_reason_rep_spec.rb +64 -0
  513. data/spec/models/access_denied_rep_spec.rb +40 -0
  514. data/spec/models/access_rep_spec.rb +34 -0
  515. data/spec/models/access_token_post_spec.rb +74 -0
  516. data/spec/models/action_input_rep_spec.rb +34 -0
  517. data/spec/models/action_output_rep_spec.rb +40 -0
  518. data/spec/models/approval_condition_input_rep_spec.rb +40 -0
  519. data/spec/models/approval_condition_output_rep_spec.rb +58 -0
  520. data/spec/models/approval_settings_spec.rb +76 -0
  521. data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +40 -0
  522. data/spec/models/audit_log_entry_listing_rep_spec.rb +136 -0
  523. data/spec/models/audit_log_entry_rep_spec.rb +172 -0
  524. data/spec/models/authorized_app_data_rep_spec.rb +58 -0
  525. data/spec/models/big_segment_target_spec.rb +46 -0
  526. data/spec/models/branch_collection_rep_spec.rb +40 -0
  527. data/spec/models/branch_rep_spec.rb +64 -0
  528. data/spec/models/clause_spec.rb +8 -15
  529. data/spec/models/client_side_availability_post_spec.rb +40 -0
  530. data/spec/models/client_side_availability_spec.rb +10 -17
  531. data/spec/models/condition_base_output_rep_spec.rb +46 -0
  532. data/spec/models/condition_input_rep_spec.rb +58 -0
  533. data/spec/models/condition_output_rep_spec.rb +82 -0
  534. data/spec/models/confidence_interval_rep_spec.rb +40 -0
  535. data/spec/models/conflict_output_rep_spec.rb +40 -0
  536. data/spec/models/conflict_spec.rb +40 -0
  537. data/spec/models/copied_from_env_spec.rb +40 -0
  538. data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +64 -0
  539. data/spec/models/create_flag_config_approval_request_request_spec.rb +70 -0
  540. data/spec/models/custom_property_spec.rb +8 -15
  541. data/spec/models/custom_role_post_data_spec.rb +58 -0
  542. data/spec/models/custom_role_post_spec.rb +58 -0
  543. data/spec/models/custom_role_spec.rb +24 -19
  544. data/spec/models/custom_roles_rep_spec.rb +52 -0
  545. data/spec/models/custom_roles_spec.rb +8 -15
  546. data/spec/models/custom_workflow_input_rep_spec.rb +52 -0
  547. data/spec/models/custom_workflow_meta_spec.rb +40 -0
  548. data/spec/models/custom_workflow_output_rep_spec.rb +94 -0
  549. data/spec/models/custom_workflow_stage_meta_spec.rb +40 -0
  550. data/spec/models/custom_workflows_listing_output_rep_spec.rb +34 -0
  551. data/spec/models/default_client_side_availability_post_spec.rb +40 -0
  552. data/spec/models/defaults_spec.rb +8 -15
  553. data/spec/models/dependent_flag_environment_spec.rb +8 -15
  554. data/spec/models/dependent_flag_spec.rb +8 -15
  555. data/spec/models/dependent_flags_by_environment_spec.rb +8 -15
  556. data/spec/models/derived_attribute_spec.rb +40 -0
  557. data/spec/models/destination_post_spec.rb +56 -0
  558. data/spec/models/destination_spec.rb +19 -20
  559. data/spec/models/destinations_spec.rb +8 -15
  560. data/spec/models/environment_post_spec.rb +10 -17
  561. data/spec/models/environment_spec.rb +11 -18
  562. data/spec/models/execution_output_rep_spec.rb +34 -0
  563. data/spec/models/expanded_team_rep_spec.rb +112 -0
  564. data/spec/models/experiment_allocation_rep_spec.rb +40 -0
  565. data/spec/models/experiment_enabled_period_rep_spec.rb +40 -0
  566. data/spec/models/experiment_environment_setting_rep_spec.rb +46 -0
  567. data/spec/models/experiment_info_rep_spec.rb +40 -0
  568. data/spec/models/experiment_metadata_rep_spec.rb +34 -0
  569. data/spec/models/experiment_rep_spec.rb +52 -0
  570. data/spec/models/experiment_results_rep_spec.rb +70 -0
  571. data/spec/models/experiment_stats_rep_spec.rb +52 -0
  572. data/spec/models/experiment_time_series_slice_spec.rb +40 -0
  573. data/spec/models/experiment_time_series_variation_slice_spec.rb +76 -0
  574. data/spec/models/experiment_totals_rep_spec.rb +76 -0
  575. data/spec/models/expiring_user_target_error_spec.rb +40 -0
  576. data/spec/models/expiring_user_target_get_response_spec.rb +40 -0
  577. data/spec/models/expiring_user_target_item_spec.rb +70 -0
  578. data/spec/models/expiring_user_target_patch_response_spec.rb +64 -0
  579. data/spec/models/extinction_collection_rep_spec.rb +40 -0
  580. data/spec/models/extinction_spec.rb +58 -0
  581. data/spec/models/feature_flag_body_spec.rb +24 -19
  582. data/spec/models/feature_flag_config_spec.rb +28 -17
  583. data/spec/models/feature_flag_scheduled_change_spec.rb +34 -17
  584. data/spec/models/feature_flag_scheduled_changes_spec.rb +10 -17
  585. data/spec/models/feature_flag_spec.rb +39 -30
  586. data/spec/models/feature_flag_status_across_environments_spec.rb +10 -17
  587. data/spec/models/feature_flag_status_spec.rb +8 -25
  588. data/spec/models/feature_flag_statuses_spec.rb +8 -15
  589. data/spec/models/feature_flags_spec.rb +10 -17
  590. data/spec/models/flag_config_approval_request_response_spec.rb +148 -0
  591. data/spec/models/flag_config_approval_requests_response_spec.rb +40 -0
  592. data/spec/models/flag_copy_config_environment_spec.rb +40 -0
  593. data/spec/models/flag_copy_config_post_spec.rb +66 -0
  594. data/spec/models/flag_global_attributes_rep_spec.rb +158 -0
  595. data/spec/models/flag_listing_rep_spec.rb +52 -0
  596. data/spec/models/flag_scheduled_changes_input_spec.rb +40 -0
  597. data/spec/models/flag_status_rep_spec.rb +52 -0
  598. data/spec/models/flag_summary_spec.rb +34 -0
  599. data/spec/models/flag_trigger_input_spec.rb +40 -0
  600. data/spec/models/forbidden_error_rep_spec.rb +40 -0
  601. data/spec/models/hunk_rep_spec.rb +58 -0
  602. data/spec/models/integration_metadata_spec.rb +52 -0
  603. data/spec/models/integration_spec.rb +69 -16
  604. data/spec/models/integration_status_rep_spec.rb +46 -0
  605. data/spec/models/integration_status_spec.rb +40 -0
  606. data/spec/models/integration_subscription_status_rep_spec.rb +58 -0
  607. data/spec/models/integrations_spec.rb +14 -15
  608. data/spec/models/invalid_request_error_rep_spec.rb +40 -0
  609. data/spec/models/ip_list_spec.rb +40 -0
  610. data/spec/models/last_seen_metadata_spec.rb +34 -0
  611. data/spec/models/link_spec.rb +8 -15
  612. data/spec/models/member_data_rep_spec.rb +58 -0
  613. data/spec/models/member_import_item_rep_spec.rb +46 -0
  614. data/spec/models/member_permission_grant_summary_rep_spec.rb +46 -0
  615. data/spec/models/member_spec.rb +50 -21
  616. data/spec/models/member_summary_rep_spec.rb +64 -0
  617. data/spec/models/member_team_summary_rep_spec.rb +46 -0
  618. data/spec/models/member_teams_form_post_spec.rb +34 -0
  619. data/spec/models/members_spec.rb +10 -17
  620. data/spec/models/method_not_allowed_error_rep_spec.rb +40 -0
  621. data/spec/models/metric_collection_rep_spec.rb +40 -0
  622. data/spec/models/metric_listing_rep_spec.rb +144 -0
  623. data/spec/models/metric_post_spec.rb +108 -0
  624. data/spec/models/metric_rep_spec.rb +174 -0
  625. data/spec/models/metric_seen_spec.rb +40 -0
  626. data/spec/models/modification_spec.rb +34 -0
  627. data/spec/models/multi_environment_dependent_flag_spec.rb +8 -27
  628. data/spec/models/multi_environment_dependent_flags_spec.rb +8 -15
  629. data/spec/models/new_member_form_spec.rb +64 -0
  630. data/spec/models/not_found_error_rep_spec.rb +40 -0
  631. data/spec/models/parent_resource_rep_spec.rb +46 -0
  632. data/spec/models/patch_failed_error_rep_spec.rb +40 -0
  633. data/spec/models/patch_operation_spec.rb +8 -15
  634. data/spec/models/patch_segment_instruction_spec.rb +58 -0
  635. data/spec/models/patch_segment_request_spec.rb +40 -0
  636. data/spec/models/patch_with_comment_spec.rb +40 -0
  637. data/spec/models/permission_grant_input_spec.rb +46 -0
  638. data/spec/models/permission_grant_rep_spec.rb +52 -0
  639. data/spec/models/post_approval_request_apply_request_spec.rb +34 -0
  640. data/spec/models/post_approval_request_review_request_spec.rb +40 -0
  641. data/spec/models/post_flag_scheduled_changes_input_spec.rb +46 -0
  642. data/spec/models/prerequisite_spec.rb +8 -15
  643. data/spec/models/project_listing_rep_spec.rb +70 -0
  644. data/spec/models/project_post_spec.rb +64 -0
  645. data/spec/models/project_spec.rb +12 -19
  646. data/spec/models/projects_spec.rb +8 -15
  647. data/spec/models/pub_nub_detail_rep_spec.rb +40 -0
  648. data/spec/models/put_branch_spec.rb +64 -0
  649. data/spec/models/rate_limited_error_rep_spec.rb +40 -0
  650. data/spec/models/recent_trigger_body_spec.rb +40 -0
  651. data/spec/models/reference_rep_spec.rb +46 -0
  652. data/spec/models/relay_auto_config_collection_rep_spec.rb +34 -0
  653. data/spec/models/relay_auto_config_post_spec.rb +40 -0
  654. data/spec/models/relay_auto_config_rep_spec.rb +82 -0
  655. data/spec/models/repository_collection_rep_spec.rb +40 -0
  656. data/spec/models/repository_post_spec.rb +68 -0
  657. data/spec/models/repository_rep_spec.rb +98 -0
  658. data/spec/models/resource_access_spec.rb +40 -0
  659. data/spec/models/resource_id_response_spec.rb +58 -0
  660. data/spec/models/review_output_rep_spec.rb +58 -0
  661. data/spec/models/review_response_spec.rb +62 -0
  662. data/spec/models/rollout_spec.rb +22 -17
  663. data/spec/models/rule_spec.rb +17 -18
  664. data/spec/models/schedule_condition_input_rep_spec.rb +40 -0
  665. data/spec/models/schedule_condition_output_rep_spec.rb +34 -0
  666. data/spec/models/sdk_list_rep_spec.rb +40 -0
  667. data/spec/models/sdk_version_list_rep_spec.rb +40 -0
  668. data/spec/models/sdk_version_rep_spec.rb +40 -0
  669. data/spec/models/segment_body_spec.rb +58 -0
  670. data/spec/models/segment_metadata_spec.rb +64 -0
  671. data/spec/models/segment_user_list_spec.rb +40 -0
  672. data/spec/models/segment_user_state_spec.rb +40 -0
  673. data/spec/models/series_list_rep_spec.rb +46 -0
  674. data/spec/models/source_flag_spec.rb +40 -0
  675. data/spec/models/stage_input_rep_spec.rb +46 -0
  676. data/spec/models/stage_output_rep_spec.rb +58 -0
  677. data/spec/models/statement_post_data_spec.rb +58 -0
  678. data/spec/models/statement_post_spec.rb +58 -0
  679. data/spec/models/statement_rep_spec.rb +58 -0
  680. data/spec/models/statement_spec.rb +8 -19
  681. data/spec/models/statistic_collection_rep_spec.rb +40 -0
  682. data/spec/models/statistic_rep_spec.rb +70 -0
  683. data/spec/models/statistics_root_spec.rb +40 -0
  684. data/spec/models/status_conflict_error_rep_spec.rb +40 -0
  685. data/spec/models/subject_data_rep_spec.rb +46 -0
  686. data/spec/models/subscription_post_spec.rb +70 -0
  687. data/spec/models/target_resource_rep_spec.rb +46 -0
  688. data/spec/models/target_spec.rb +8 -15
  689. data/spec/models/team_collection_rep_spec.rb +46 -0
  690. data/spec/models/team_imports_rep_spec.rb +34 -0
  691. data/spec/models/team_patch_input_spec.rb +40 -0
  692. data/spec/models/team_post_input_spec.rb +64 -0
  693. data/spec/models/team_rep_spec.rb +100 -0
  694. data/spec/models/title_rep_spec.rb +76 -0
  695. data/spec/models/token_data_rep_spec.rb +58 -0
  696. data/spec/models/token_spec.rb +27 -28
  697. data/spec/models/tokens_spec.rb +10 -17
  698. data/spec/models/trigger_post_spec.rb +46 -0
  699. data/spec/models/trigger_workflow_collection_rep_spec.rb +40 -0
  700. data/spec/models/trigger_workflow_rep_spec.rb +106 -0
  701. data/spec/models/unauthorized_error_rep_spec.rb +40 -0
  702. data/spec/models/url_post_spec.rb +56 -0
  703. data/spec/models/user_attribute_names_rep_spec.rb +46 -0
  704. data/spec/models/user_flag_setting_spec.rb +8 -15
  705. data/spec/models/user_flag_settings_spec.rb +10 -17
  706. data/spec/models/user_record_rep_spec.rb +58 -0
  707. data/spec/models/user_record_spec.rb +21 -16
  708. data/spec/models/user_segment_rule_spec.rb +14 -15
  709. data/spec/models/user_segment_spec.rb +58 -23
  710. data/spec/models/user_segments_spec.rb +10 -17
  711. data/spec/models/user_spec.rb +20 -15
  712. data/spec/models/users_spec.rb +8 -15
  713. data/spec/models/value_put_spec.rb +40 -0
  714. data/spec/models/variation_or_rollout_rep_spec.rb +40 -0
  715. data/spec/models/variation_spec.rb +10 -17
  716. data/spec/models/variation_summary_spec.rb +70 -0
  717. data/spec/models/versions_rep_spec.rb +52 -0
  718. data/spec/models/webhook_post_spec.rb +70 -0
  719. data/spec/models/webhook_spec.rb +18 -19
  720. data/spec/models/webhooks_spec.rb +8 -15
  721. data/spec/models/weighted_variation_spec.rb +14 -15
  722. data/spec/spec_helper.rb +4 -4
  723. metadata +1015 -578
  724. data/docs/ApprovalRequest.md +0 -21
  725. data/docs/ApprovalRequestApplyConfigBody.md +0 -8
  726. data/docs/ApprovalRequestConfigBody.md +0 -13
  727. data/docs/ApprovalRequestFlagConfigCopyBody.md +0 -13
  728. data/docs/ApprovalRequestReview.md +0 -11
  729. data/docs/ApprovalRequestReviewConfigBody.md +0 -9
  730. data/docs/ApprovalRequestReviewStatus.md +0 -7
  731. data/docs/ApprovalRequests.md +0 -9
  732. data/docs/AuditLogEntries.md +0 -9
  733. data/docs/AuditLogEntry.md +0 -19
  734. data/docs/AuditLogEntryTarget.md +0 -10
  735. data/docs/BigSegmentTargetChanges.md +0 -9
  736. data/docs/BigSegmentTargetsBody.md +0 -9
  737. data/docs/CopyActions.md +0 -7
  738. data/docs/CustomPropertyValues.md +0 -7
  739. data/docs/CustomRoleBody.md +0 -11
  740. data/docs/CustomerMetricsApi.md +0 -511
  741. data/docs/DependentFlagEnvironmentLinks.md +0 -9
  742. data/docs/DependentFlagLinks.md +0 -8
  743. data/docs/DependentFlagsLinks.md +0 -9
  744. data/docs/DestinationAmazonKinesis.md +0 -10
  745. data/docs/DestinationBody.md +0 -11
  746. data/docs/DestinationGooglePubSub.md +0 -9
  747. data/docs/DestinationMParticle.md +0 -11
  748. data/docs/DestinationSegment.md +0 -8
  749. data/docs/EnvironmentApprovalSettings.md +0 -13
  750. data/docs/EvaluationUsageError.md +0 -9
  751. data/docs/Events.md +0 -8
  752. data/docs/Fallthrough.md +0 -9
  753. data/docs/FeatureFlagCopyBody.md +0 -12
  754. data/docs/FeatureFlagCopyObject.md +0 -9
  755. data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
  756. data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
  757. data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
  758. data/docs/FeatureFlagStatusLinks.md +0 -9
  759. data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
  760. data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
  761. data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
  762. data/docs/FlagListItem.md +0 -11
  763. data/docs/HierarchicalLinks.md +0 -9
  764. data/docs/Id.md +0 -7
  765. data/docs/IntegrationSubscription.md +0 -16
  766. data/docs/IntegrationSubscriptionStatus.md +0 -10
  767. data/docs/IntegrationsApi.md +0 -334
  768. data/docs/Links.md +0 -9
  769. data/docs/MAU.md +0 -10
  770. data/docs/MAUMetadata.md +0 -7
  771. data/docs/MAUbyCategory.md +0 -10
  772. data/docs/MemberLastSeenMetadata.md +0 -8
  773. data/docs/MembersBody.md +0 -13
  774. data/docs/PatchComment.md +0 -9
  775. data/docs/Policy.md +0 -12
  776. data/docs/ProjectBody.md +0 -13
  777. data/docs/RelayProxyConfig.md +0 -15
  778. data/docs/RelayProxyConfigBody.md +0 -9
  779. data/docs/RelayProxyConfigs.md +0 -8
  780. data/docs/Role.md +0 -7
  781. data/docs/RootApi.md +0 -56
  782. data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
  783. data/docs/SemanticPatchInstruction.md +0 -7
  784. data/docs/SemanticPatchInstructionInner.md +0 -8
  785. data/docs/SemanticPatchOperation.md +0 -9
  786. data/docs/Site.md +0 -9
  787. data/docs/Source.md +0 -9
  788. data/docs/Stream.md +0 -10
  789. data/docs/StreamBySDK.md +0 -10
  790. data/docs/StreamBySDKLinks.md +0 -9
  791. data/docs/StreamBySDKLinksMetadata.md +0 -10
  792. data/docs/StreamLinks.md +0 -10
  793. data/docs/StreamSDKVersion.md +0 -9
  794. data/docs/StreamSDKVersionData.md +0 -9
  795. data/docs/StreamUsageError.md +0 -9
  796. data/docs/StreamUsageLinks.md +0 -10
  797. data/docs/StreamUsageMetadata.md +0 -10
  798. data/docs/StreamUsageSeries.md +0 -9
  799. data/docs/Streams.md +0 -8
  800. data/docs/SubscriptionBody.md +0 -12
  801. data/docs/TeamMembersApi.md +0 -329
  802. data/docs/TokenBody.md +0 -13
  803. data/docs/Usage.md +0 -9
  804. data/docs/UsageError.md +0 -8
  805. data/docs/UsageLinks.md +0 -10
  806. data/docs/UserSegmentBody.md +0 -12
  807. data/docs/UserSegmentsApi.md +0 -488
  808. data/docs/UserSettingsBody.md +0 -8
  809. data/docs/UserTargetingExpirationForFlag.md +0 -14
  810. data/docs/UserTargetingExpirationForFlags.md +0 -9
  811. data/docs/UserTargetingExpirationForSegment.md +0 -14
  812. data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
  813. data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
  814. data/docs/WebhookBody.md +0 -14
  815. data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
  816. data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
  817. data/lib/launchdarkly_api/api/root_api.rb +0 -69
  818. data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
  819. data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
  820. data/lib/launchdarkly_api/models/approval_request.rb +0 -346
  821. data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
  822. data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
  823. data/lib/launchdarkly_api/models/approval_request_flag_config_copy_body.rb +0 -254
  824. data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
  825. data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
  826. data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
  827. data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
  828. data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
  829. data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
  830. data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
  831. data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
  832. data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
  833. data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
  834. data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
  835. data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
  836. data/lib/launchdarkly_api/models/dependent_flag__links.rb +0 -184
  837. data/lib/launchdarkly_api/models/dependent_flag_environment__links.rb +0 -193
  838. data/lib/launchdarkly_api/models/dependent_flags_links.rb +0 -193
  839. data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
  840. data/lib/launchdarkly_api/models/destination_body.rb +0 -264
  841. data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
  842. data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
  843. data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
  844. data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -272
  845. data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
  846. data/lib/launchdarkly_api/models/events.rb +0 -184
  847. data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
  848. data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
  849. data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
  850. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
  851. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
  852. data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
  853. data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
  854. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
  855. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
  856. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
  857. data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
  858. data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
  859. data/lib/launchdarkly_api/models/id.rb +0 -176
  860. data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
  861. data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
  862. data/lib/launchdarkly_api/models/links.rb +0 -193
  863. data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
  864. data/lib/launchdarkly_api/models/mau.rb +0 -206
  865. data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
  866. data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
  867. data/lib/launchdarkly_api/models/members_body.rb +0 -238
  868. data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
  869. data/lib/launchdarkly_api/models/policy.rb +0 -231
  870. data/lib/launchdarkly_api/models/project_body.rb +0 -243
  871. data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
  872. data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
  873. data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
  874. data/lib/launchdarkly_api/models/role.rb +0 -32
  875. data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
  876. data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
  877. data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
  878. data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
  879. data/lib/launchdarkly_api/models/site.rb +0 -193
  880. data/lib/launchdarkly_api/models/source.rb +0 -195
  881. data/lib/launchdarkly_api/models/stream.rb +0 -206
  882. data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
  883. data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
  884. data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
  885. data/lib/launchdarkly_api/models/stream_links.rb +0 -205
  886. data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
  887. data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
  888. data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
  889. data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
  890. data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
  891. data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
  892. data/lib/launchdarkly_api/models/streams.rb +0 -184
  893. data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
  894. data/lib/launchdarkly_api/models/token_body.rb +0 -238
  895. data/lib/launchdarkly_api/models/usage.rb +0 -195
  896. data/lib/launchdarkly_api/models/usage_error.rb +0 -184
  897. data/lib/launchdarkly_api/models/usage_links.rb +0 -205
  898. data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
  899. data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
  900. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
  901. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
  902. data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
  903. data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
  904. data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
  905. data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
  906. data/openapi.yml +0 -4922
  907. data/spec/api/customer_metrics_api_spec.rb +0 -141
  908. data/spec/api/integrations_api_spec.rb +0 -105
  909. data/spec/api/root_api_spec.rb +0 -45
  910. data/spec/api/team_members_api_spec.rb +0 -104
  911. data/spec/api/user_segments_api_spec.rb +0 -142
  912. data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
  913. data/spec/models/approval_request_config_body_spec.rb +0 -71
  914. data/spec/models/approval_request_flag_config_copy_body_spec.rb +0 -71
  915. data/spec/models/approval_request_review_config_body_spec.rb +0 -51
  916. data/spec/models/approval_request_review_spec.rb +0 -59
  917. data/spec/models/approval_request_review_status_spec.rb +0 -35
  918. data/spec/models/approval_request_spec.rb +0 -123
  919. data/spec/models/approval_requests_spec.rb +0 -47
  920. data/spec/models/audit_log_entries_spec.rb +0 -47
  921. data/spec/models/audit_log_entry_spec.rb +0 -107
  922. data/spec/models/audit_log_entry_target_spec.rb +0 -53
  923. data/spec/models/big_segment_target_changes_spec.rb +0 -47
  924. data/spec/models/big_segment_targets_body_spec.rb +0 -47
  925. data/spec/models/copy_actions_spec.rb +0 -35
  926. data/spec/models/custom_property_values_spec.rb +0 -35
  927. data/spec/models/custom_role_body_spec.rb +0 -59
  928. data/spec/models/dependent_flag__links_spec.rb +0 -41
  929. data/spec/models/dependent_flag_environment__links_spec.rb +0 -47
  930. data/spec/models/dependent_flags_links_spec.rb +0 -47
  931. data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
  932. data/spec/models/destination_body_spec.rb +0 -63
  933. data/spec/models/destination_google_pub_sub_spec.rb +0 -47
  934. data/spec/models/destination_m_particle_spec.rb +0 -59
  935. data/spec/models/destination_segment_spec.rb +0 -41
  936. data/spec/models/environment_approval_settings_spec.rb +0 -75
  937. data/spec/models/evaluation_usage_error_spec.rb +0 -47
  938. data/spec/models/events_spec.rb +0 -41
  939. data/spec/models/fallthrough_spec.rb +0 -47
  940. data/spec/models/feature_flag_copy_body_spec.rb +0 -65
  941. data/spec/models/feature_flag_copy_object_spec.rb +0 -47
  942. data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
  943. data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
  944. data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
  945. data/spec/models/feature_flag_status_links_spec.rb +0 -47
  946. data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
  947. data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
  948. data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
  949. data/spec/models/flag_list_item_spec.rb +0 -59
  950. data/spec/models/hierarchical_links_spec.rb +0 -47
  951. data/spec/models/id_spec.rb +0 -35
  952. data/spec/models/integration_subscription__status_spec.rb +0 -53
  953. data/spec/models/integration_subscription_spec.rb +0 -89
  954. data/spec/models/links_spec.rb +0 -47
  955. data/spec/models/ma_uby_category_spec.rb +0 -53
  956. data/spec/models/mau_metadata_spec.rb +0 -35
  957. data/spec/models/mau_spec.rb +0 -53
  958. data/spec/models/member__last_seen_metadata_spec.rb +0 -41
  959. data/spec/models/members_body_spec.rb +0 -71
  960. data/spec/models/patch_comment_spec.rb +0 -47
  961. data/spec/models/policy_spec.rb +0 -65
  962. data/spec/models/project_body_spec.rb +0 -71
  963. data/spec/models/relay_proxy_config_body_spec.rb +0 -47
  964. data/spec/models/relay_proxy_config_spec.rb +0 -83
  965. data/spec/models/relay_proxy_configs_spec.rb +0 -41
  966. data/spec/models/role_spec.rb +0 -35
  967. data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +0 -47
  968. data/spec/models/semantic_patch_instruction_inner_spec.rb +0 -41
  969. data/spec/models/semantic_patch_instruction_spec.rb +0 -35
  970. data/spec/models/semantic_patch_operation_spec.rb +0 -47
  971. data/spec/models/site_spec.rb +0 -47
  972. data/spec/models/source_spec.rb +0 -47
  973. data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
  974. data/spec/models/stream_by_sdk_links_spec.rb +0 -47
  975. data/spec/models/stream_by_sdk_spec.rb +0 -53
  976. data/spec/models/stream_links_spec.rb +0 -53
  977. data/spec/models/stream_sdk_version_data_spec.rb +0 -47
  978. data/spec/models/stream_sdk_version_spec.rb +0 -47
  979. data/spec/models/stream_spec.rb +0 -53
  980. data/spec/models/stream_usage_error_spec.rb +0 -47
  981. data/spec/models/stream_usage_links_spec.rb +0 -53
  982. data/spec/models/stream_usage_metadata_spec.rb +0 -53
  983. data/spec/models/stream_usage_series_spec.rb +0 -47
  984. data/spec/models/streams_spec.rb +0 -41
  985. data/spec/models/subscription_body_spec.rb +0 -65
  986. data/spec/models/token_body_spec.rb +0 -71
  987. data/spec/models/usage_error_spec.rb +0 -41
  988. data/spec/models/usage_links_spec.rb +0 -53
  989. data/spec/models/usage_spec.rb +0 -47
  990. data/spec/models/user_segment_body_spec.rb +0 -65
  991. data/spec/models/user_settings_body_spec.rb +0 -41
  992. data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
  993. data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
  994. data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
  995. data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
  996. data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
  997. data/spec/models/webhook_body_spec.rb +0 -77
@@ -1,16 +1,16 @@
1
1
  =begin
2
2
  #LaunchDarkly REST API
3
3
 
4
- #Build custom integrations with the LaunchDarkly REST API
4
+ ## Overview ## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > #### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ### Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ### Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. ## Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ### Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ### Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. ## Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ### Updates via JSON Patch [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ### Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ### Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ### Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsForSegment) ## Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ### HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | ## CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. ## Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ### Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ### Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ### IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. ## OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. ## Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). ## Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. ## Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ### Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` ## Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ### Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ### Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
5
5
 
6
- OpenAPI spec version: 5.4.0
6
+ The version of the OpenAPI document: 2.0
7
7
  Contact: support@launchdarkly.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.17
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.0
10
10
 
11
11
  =end
12
12
 
13
- require 'uri'
13
+ require 'cgi'
14
14
 
15
15
  module LaunchDarklyApi
16
16
  class UserSettingsApi
@@ -20,343 +20,408 @@ module LaunchDarklyApi
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get expiring dates on flags for user
23
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
24
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
25
- # @param user_key The user's key.
23
+ # Get a list of flags for which the given user is scheduled for removal.
24
+ # @param proj_key [String] The project key.
25
+ # @param user_key [String] The user key.
26
+ # @param env_key [String] The environment key.
26
27
  # @param [Hash] opts the optional parameters
27
- # @return [UserTargetingExpirationOnFlagsForUser]
28
- def get_expiring_user_targets_for_user(project_key, environment_key, user_key, opts = {})
29
- data, _status_code, _headers = get_expiring_user_targets_for_user_with_http_info(project_key, environment_key, user_key, opts)
28
+ # @return [ExpiringUserTargetGetResponse]
29
+ def get_expiring_flags_for_user(proj_key, user_key, env_key, opts = {})
30
+ data, _status_code, _headers = get_expiring_flags_for_user_with_http_info(proj_key, user_key, env_key, opts)
30
31
  data
31
32
  end
32
33
 
33
34
  # Get expiring dates on flags for user
34
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
35
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
36
- # @param user_key The user's key.
35
+ # Get a list of flags for which the given user is scheduled for removal.
36
+ # @param proj_key [String] The project key.
37
+ # @param user_key [String] The user key.
38
+ # @param env_key [String] The environment key.
37
39
  # @param [Hash] opts the optional parameters
38
- # @return [Array<(UserTargetingExpirationOnFlagsForUser, Fixnum, Hash)>] UserTargetingExpirationOnFlagsForUser data, response status code and response headers
39
- def get_expiring_user_targets_for_user_with_http_info(project_key, environment_key, user_key, opts = {})
40
+ # @return [Array<(ExpiringUserTargetGetResponse, Integer, Hash)>] ExpiringUserTargetGetResponse data, response status code and response headers
41
+ def get_expiring_flags_for_user_with_http_info(proj_key, user_key, env_key, opts = {})
40
42
  if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: UserSettingsApi.get_expiring_user_targets_for_user ...'
43
+ @api_client.config.logger.debug 'Calling API: UserSettingsApi.get_expiring_flags_for_user ...'
42
44
  end
43
- # verify the required parameter 'project_key' is set
44
- if @api_client.config.client_side_validation && project_key.nil?
45
- fail ArgumentError, "Missing the required parameter 'project_key' when calling UserSettingsApi.get_expiring_user_targets_for_user"
46
- end
47
- # verify the required parameter 'environment_key' is set
48
- if @api_client.config.client_side_validation && environment_key.nil?
49
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling UserSettingsApi.get_expiring_user_targets_for_user"
45
+ # verify the required parameter 'proj_key' is set
46
+ if @api_client.config.client_side_validation && proj_key.nil?
47
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling UserSettingsApi.get_expiring_flags_for_user"
50
48
  end
51
49
  # verify the required parameter 'user_key' is set
52
50
  if @api_client.config.client_side_validation && user_key.nil?
53
- fail ArgumentError, "Missing the required parameter 'user_key' when calling UserSettingsApi.get_expiring_user_targets_for_user"
51
+ fail ArgumentError, "Missing the required parameter 'user_key' when calling UserSettingsApi.get_expiring_flags_for_user"
52
+ end
53
+ # verify the required parameter 'env_key' is set
54
+ if @api_client.config.client_side_validation && env_key.nil?
55
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling UserSettingsApi.get_expiring_flags_for_user"
54
56
  end
55
57
  # resource path
56
- local_var_path = '/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'userKey' + '}', user_key.to_s)
58
+ local_var_path = '/api/v2/users/{projKey}/{userKey}/expiring-user-targets/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'userKey' + '}', CGI.escape(user_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s))
57
59
 
58
60
  # query parameters
59
- query_params = {}
61
+ query_params = opts[:query_params] || {}
60
62
 
61
63
  # header parameters
62
- header_params = {}
64
+ header_params = opts[:header_params] || {}
63
65
  # HTTP header 'Accept' (if needed)
64
66
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
- # HTTP header 'Content-Type'
66
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
67
67
 
68
68
  # form parameters
69
- form_params = {}
69
+ form_params = opts[:form_params] || {}
70
70
 
71
71
  # http body (model)
72
- post_body = nil
73
- auth_names = ['Token']
74
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type] || 'ExpiringUserTargetGetResponse'
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"UserSettingsApi.get_expiring_flags_for_user",
75
82
  :header_params => header_params,
76
83
  :query_params => query_params,
77
84
  :form_params => form_params,
78
85
  :body => post_body,
79
86
  :auth_names => auth_names,
80
- :return_type => 'UserTargetingExpirationOnFlagsForUser')
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
81
91
  if @api_client.config.debugging
82
- @api_client.config.logger.debug "API called: UserSettingsApi#get_expiring_user_targets_for_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
92
+ @api_client.config.logger.debug "API called: UserSettingsApi#get_expiring_flags_for_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
83
93
  end
84
94
  return data, status_code, headers
85
95
  end
86
- # Fetch a single flag setting for a user by key.
87
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
88
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
89
- # @param user_key The user&#39;s key.
90
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
96
+
97
+ # Get flag setting for user
98
+ # Get a single flag setting for a user by key. The most important attribute in the response is the `_value`. The `_value` is the current setting that the user sees. For a boolean feature toggle, this is `true`, `false`, or `null`. `null` returns if there is no defined fallback value. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled.<br /><br />The setting attribute indicates whether you've explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. A setting of `null` means that you haven't assigned that user to a specific variation.
99
+ # @param proj_key [String] The project key
100
+ # @param env_key [String] The environment key
101
+ # @param key [String] The user key
102
+ # @param feature_key [String] The feature flag key
91
103
  # @param [Hash] opts the optional parameters
92
104
  # @return [UserFlagSetting]
93
- def get_user_flag_setting(project_key, environment_key, user_key, feature_flag_key, opts = {})
94
- data, _status_code, _headers = get_user_flag_setting_with_http_info(project_key, environment_key, user_key, feature_flag_key, opts)
105
+ def get_user_flag_setting(proj_key, env_key, key, feature_key, opts = {})
106
+ data, _status_code, _headers = get_user_flag_setting_with_http_info(proj_key, env_key, key, feature_key, opts)
95
107
  data
96
108
  end
97
109
 
98
- # Fetch a single flag setting for a user by key.
99
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
100
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
101
- # @param user_key The user&#39;s key.
102
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
110
+ # Get flag setting for user
111
+ # Get a single flag setting for a user by key. The most important attribute in the response is the &#x60;_value&#x60;. The &#x60;_value&#x60; is the current setting that the user sees. For a boolean feature toggle, this is &#x60;true&#x60;, &#x60;false&#x60;, or &#x60;null&#x60;. &#x60;null&#x60; returns if there is no defined fallback value. The example response indicates that the user &#x60;Abbie_Braun&#x60; has the &#x60;sort.order&#x60; flag enabled.&lt;br /&gt;&lt;br /&gt;The setting attribute indicates whether you&#39;ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be &#x60;false&#x60;. A setting of &#x60;null&#x60; means that you haven&#39;t assigned that user to a specific variation.
112
+ # @param proj_key [String] The project key
113
+ # @param env_key [String] The environment key
114
+ # @param key [String] The user key
115
+ # @param feature_key [String] The feature flag key
103
116
  # @param [Hash] opts the optional parameters
104
- # @return [Array<(UserFlagSetting, Fixnum, Hash)>] UserFlagSetting data, response status code and response headers
105
- def get_user_flag_setting_with_http_info(project_key, environment_key, user_key, feature_flag_key, opts = {})
117
+ # @return [Array<(UserFlagSetting, Integer, Hash)>] UserFlagSetting data, response status code and response headers
118
+ def get_user_flag_setting_with_http_info(proj_key, env_key, key, feature_key, opts = {})
106
119
  if @api_client.config.debugging
107
120
  @api_client.config.logger.debug 'Calling API: UserSettingsApi.get_user_flag_setting ...'
108
121
  end
109
- # verify the required parameter 'project_key' is set
110
- if @api_client.config.client_side_validation && project_key.nil?
111
- fail ArgumentError, "Missing the required parameter 'project_key' when calling UserSettingsApi.get_user_flag_setting"
122
+ # verify the required parameter 'proj_key' is set
123
+ if @api_client.config.client_side_validation && proj_key.nil?
124
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling UserSettingsApi.get_user_flag_setting"
112
125
  end
113
- # verify the required parameter 'environment_key' is set
114
- if @api_client.config.client_side_validation && environment_key.nil?
115
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling UserSettingsApi.get_user_flag_setting"
126
+ # verify the required parameter 'env_key' is set
127
+ if @api_client.config.client_side_validation && env_key.nil?
128
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling UserSettingsApi.get_user_flag_setting"
116
129
  end
117
- # verify the required parameter 'user_key' is set
118
- if @api_client.config.client_side_validation && user_key.nil?
119
- fail ArgumentError, "Missing the required parameter 'user_key' when calling UserSettingsApi.get_user_flag_setting"
130
+ # verify the required parameter 'key' is set
131
+ if @api_client.config.client_side_validation && key.nil?
132
+ fail ArgumentError, "Missing the required parameter 'key' when calling UserSettingsApi.get_user_flag_setting"
120
133
  end
121
- # verify the required parameter 'feature_flag_key' is set
122
- if @api_client.config.client_side_validation && feature_flag_key.nil?
123
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling UserSettingsApi.get_user_flag_setting"
134
+ # verify the required parameter 'feature_key' is set
135
+ if @api_client.config.client_side_validation && feature_key.nil?
136
+ fail ArgumentError, "Missing the required parameter 'feature_key' when calling UserSettingsApi.get_user_flag_setting"
124
137
  end
125
138
  # resource path
126
- local_var_path = '/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'userKey' + '}', user_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
139
+ local_var_path = '/api/v2/users/{projKey}/{envKey}/{key}/flags/{featureKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s)).sub('{' + 'featureKey' + '}', CGI.escape(feature_key.to_s))
127
140
 
128
141
  # query parameters
129
- query_params = {}
142
+ query_params = opts[:query_params] || {}
130
143
 
131
144
  # header parameters
132
- header_params = {}
145
+ header_params = opts[:header_params] || {}
133
146
  # HTTP header 'Accept' (if needed)
134
147
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
135
- # HTTP header 'Content-Type'
136
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
137
148
 
138
149
  # form parameters
139
- form_params = {}
150
+ form_params = opts[:form_params] || {}
140
151
 
141
152
  # http body (model)
142
- post_body = nil
143
- auth_names = ['Token']
144
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
153
+ post_body = opts[:debug_body]
154
+
155
+ # return_type
156
+ return_type = opts[:debug_return_type] || 'UserFlagSetting'
157
+
158
+ # auth_names
159
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
160
+
161
+ new_options = opts.merge(
162
+ :operation => :"UserSettingsApi.get_user_flag_setting",
145
163
  :header_params => header_params,
146
164
  :query_params => query_params,
147
165
  :form_params => form_params,
148
166
  :body => post_body,
149
167
  :auth_names => auth_names,
150
- :return_type => 'UserFlagSetting')
168
+ :return_type => return_type
169
+ )
170
+
171
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
151
172
  if @api_client.config.debugging
152
173
  @api_client.config.logger.debug "API called: UserSettingsApi#get_user_flag_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
153
174
  end
154
175
  return data, status_code, headers
155
176
  end
156
- # Fetch a single flag setting for a user by key.
157
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
158
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
159
- # @param user_key The user&#39;s key.
177
+
178
+ # List flag settings for user
179
+ # Get the current flag settings for a given user. The most important attribute in the response is the `_value`. The `_value` is the setting that the user sees. For a boolean feature toggle, this is `true`, `false`, or `null`. `null` returns if there is no defined fallthrough value. The example response indicates that the user `Abbie_Braun` has the `sort.order` flag enabled and the `alternate.page` flag disabled.<br /><br />The setting attribute indicates whether you've explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be `false`. A setting of `null` means that you haven't assigned that user to a specific variation.
180
+ # @param proj_key [String] The project key
181
+ # @param env_key [String] The environment key
182
+ # @param key [String] The user key
160
183
  # @param [Hash] opts the optional parameters
161
184
  # @return [UserFlagSettings]
162
- def get_user_flag_settings(project_key, environment_key, user_key, opts = {})
163
- data, _status_code, _headers = get_user_flag_settings_with_http_info(project_key, environment_key, user_key, opts)
185
+ def get_user_flag_settings(proj_key, env_key, key, opts = {})
186
+ data, _status_code, _headers = get_user_flag_settings_with_http_info(proj_key, env_key, key, opts)
164
187
  data
165
188
  end
166
189
 
167
- # Fetch a single flag setting for a user by key.
168
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
169
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
170
- # @param user_key The user&#39;s key.
190
+ # List flag settings for user
191
+ # Get the current flag settings for a given user. The most important attribute in the response is the &#x60;_value&#x60;. The &#x60;_value&#x60; is the setting that the user sees. For a boolean feature toggle, this is &#x60;true&#x60;, &#x60;false&#x60;, or &#x60;null&#x60;. &#x60;null&#x60; returns if there is no defined fallthrough value. The example response indicates that the user &#x60;Abbie_Braun&#x60; has the &#x60;sort.order&#x60; flag enabled and the &#x60;alternate.page&#x60; flag disabled.&lt;br /&gt;&lt;br /&gt;The setting attribute indicates whether you&#39;ve explicitly targeted a user to receive a particular variation. For example, if you have turned off a feature flag for a user, this setting will be &#x60;false&#x60;. A setting of &#x60;null&#x60; means that you haven&#39;t assigned that user to a specific variation.
192
+ # @param proj_key [String] The project key
193
+ # @param env_key [String] The environment key
194
+ # @param key [String] The user key
171
195
  # @param [Hash] opts the optional parameters
172
- # @return [Array<(UserFlagSettings, Fixnum, Hash)>] UserFlagSettings data, response status code and response headers
173
- def get_user_flag_settings_with_http_info(project_key, environment_key, user_key, opts = {})
196
+ # @return [Array<(UserFlagSettings, Integer, Hash)>] UserFlagSettings data, response status code and response headers
197
+ def get_user_flag_settings_with_http_info(proj_key, env_key, key, opts = {})
174
198
  if @api_client.config.debugging
175
199
  @api_client.config.logger.debug 'Calling API: UserSettingsApi.get_user_flag_settings ...'
176
200
  end
177
- # verify the required parameter 'project_key' is set
178
- if @api_client.config.client_side_validation && project_key.nil?
179
- fail ArgumentError, "Missing the required parameter 'project_key' when calling UserSettingsApi.get_user_flag_settings"
201
+ # verify the required parameter 'proj_key' is set
202
+ if @api_client.config.client_side_validation && proj_key.nil?
203
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling UserSettingsApi.get_user_flag_settings"
180
204
  end
181
- # verify the required parameter 'environment_key' is set
182
- if @api_client.config.client_side_validation && environment_key.nil?
183
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling UserSettingsApi.get_user_flag_settings"
205
+ # verify the required parameter 'env_key' is set
206
+ if @api_client.config.client_side_validation && env_key.nil?
207
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling UserSettingsApi.get_user_flag_settings"
184
208
  end
185
- # verify the required parameter 'user_key' is set
186
- if @api_client.config.client_side_validation && user_key.nil?
187
- fail ArgumentError, "Missing the required parameter 'user_key' when calling UserSettingsApi.get_user_flag_settings"
209
+ # verify the required parameter 'key' is set
210
+ if @api_client.config.client_side_validation && key.nil?
211
+ fail ArgumentError, "Missing the required parameter 'key' when calling UserSettingsApi.get_user_flag_settings"
188
212
  end
189
213
  # resource path
190
- local_var_path = '/users/{projectKey}/{environmentKey}/{userKey}/flags'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'userKey' + '}', user_key.to_s)
214
+ local_var_path = '/api/v2/users/{projKey}/{envKey}/{key}/flags'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
191
215
 
192
216
  # query parameters
193
- query_params = {}
217
+ query_params = opts[:query_params] || {}
194
218
 
195
219
  # header parameters
196
- header_params = {}
220
+ header_params = opts[:header_params] || {}
197
221
  # HTTP header 'Accept' (if needed)
198
222
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
199
- # HTTP header 'Content-Type'
200
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
201
223
 
202
224
  # form parameters
203
- form_params = {}
225
+ form_params = opts[:form_params] || {}
204
226
 
205
227
  # http body (model)
206
- post_body = nil
207
- auth_names = ['Token']
208
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
228
+ post_body = opts[:debug_body]
229
+
230
+ # return_type
231
+ return_type = opts[:debug_return_type] || 'UserFlagSettings'
232
+
233
+ # auth_names
234
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
235
+
236
+ new_options = opts.merge(
237
+ :operation => :"UserSettingsApi.get_user_flag_settings",
209
238
  :header_params => header_params,
210
239
  :query_params => query_params,
211
240
  :form_params => form_params,
212
241
  :body => post_body,
213
242
  :auth_names => auth_names,
214
- :return_type => 'UserFlagSettings')
243
+ :return_type => return_type
244
+ )
245
+
246
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
215
247
  if @api_client.config.debugging
216
248
  @api_client.config.logger.debug "API called: UserSettingsApi#get_user_flag_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
217
249
  end
218
250
  return data, status_code, headers
219
251
  end
220
- # Update, add, or delete expiring user targets for a single user on all flags
221
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
222
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
223
- # @param user_key The user&#39;s key.
224
- # @param semantic_patch_with_comment Requires a Semantic Patch representation of the desired changes to the resource. &#39;https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches&#39;. The addition of comments is also supported.
252
+
253
+ # Update expiring user target for flags
254
+ # Schedule the specified user for removal from individual user targeting on one or more flags. You can only schedule a user for removal on a single variation per flag. To learn more about semantic patches, read [Updates](/#section/Updates). If you previously patched the flag, and the patch included the user's data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user's key before, it calculates the flag values based on the user key alone.
255
+ # @param proj_key [String] The project key.
256
+ # @param user_key [String] The user key.
257
+ # @param env_key [String] The environment key.
258
+ # @param patch_with_comment [PatchWithComment]
225
259
  # @param [Hash] opts the optional parameters
226
- # @return [UserTargetingExpirationOnFlagsForUser]
227
- def patch_expiring_user_targets_for_flags(project_key, environment_key, user_key, semantic_patch_with_comment, opts = {})
228
- data, _status_code, _headers = patch_expiring_user_targets_for_flags_with_http_info(project_key, environment_key, user_key, semantic_patch_with_comment, opts)
260
+ # @return [ExpiringUserTargetPatchResponse]
261
+ def patch_expiring_flags_for_user(proj_key, user_key, env_key, patch_with_comment, opts = {})
262
+ data, _status_code, _headers = patch_expiring_flags_for_user_with_http_info(proj_key, user_key, env_key, patch_with_comment, opts)
229
263
  data
230
264
  end
231
265
 
232
- # Update, add, or delete expiring user targets for a single user on all flags
233
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
234
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
235
- # @param user_key The user&#39;s key.
236
- # @param semantic_patch_with_comment Requires a Semantic Patch representation of the desired changes to the resource. &#39;https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches&#39;. The addition of comments is also supported.
266
+ # Update expiring user target for flags
267
+ # Schedule the specified user for removal from individual user targeting on one or more flags. You can only schedule a user for removal on a single variation per flag. To learn more about semantic patches, read [Updates](/#section/Updates). If you previously patched the flag, and the patch included the user&#39;s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user&#39;s key before, it calculates the flag values based on the user key alone.
268
+ # @param proj_key [String] The project key.
269
+ # @param user_key [String] The user key.
270
+ # @param env_key [String] The environment key.
271
+ # @param patch_with_comment [PatchWithComment]
237
272
  # @param [Hash] opts the optional parameters
238
- # @return [Array<(UserTargetingExpirationOnFlagsForUser, Fixnum, Hash)>] UserTargetingExpirationOnFlagsForUser data, response status code and response headers
239
- def patch_expiring_user_targets_for_flags_with_http_info(project_key, environment_key, user_key, semantic_patch_with_comment, opts = {})
273
+ # @return [Array<(ExpiringUserTargetPatchResponse, Integer, Hash)>] ExpiringUserTargetPatchResponse data, response status code and response headers
274
+ def patch_expiring_flags_for_user_with_http_info(proj_key, user_key, env_key, patch_with_comment, opts = {})
240
275
  if @api_client.config.debugging
241
- @api_client.config.logger.debug 'Calling API: UserSettingsApi.patch_expiring_user_targets_for_flags ...'
242
- end
243
- # verify the required parameter 'project_key' is set
244
- if @api_client.config.client_side_validation && project_key.nil?
245
- fail ArgumentError, "Missing the required parameter 'project_key' when calling UserSettingsApi.patch_expiring_user_targets_for_flags"
276
+ @api_client.config.logger.debug 'Calling API: UserSettingsApi.patch_expiring_flags_for_user ...'
246
277
  end
247
- # verify the required parameter 'environment_key' is set
248
- if @api_client.config.client_side_validation && environment_key.nil?
249
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling UserSettingsApi.patch_expiring_user_targets_for_flags"
278
+ # verify the required parameter 'proj_key' is set
279
+ if @api_client.config.client_side_validation && proj_key.nil?
280
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling UserSettingsApi.patch_expiring_flags_for_user"
250
281
  end
251
282
  # verify the required parameter 'user_key' is set
252
283
  if @api_client.config.client_side_validation && user_key.nil?
253
- fail ArgumentError, "Missing the required parameter 'user_key' when calling UserSettingsApi.patch_expiring_user_targets_for_flags"
284
+ fail ArgumentError, "Missing the required parameter 'user_key' when calling UserSettingsApi.patch_expiring_flags_for_user"
254
285
  end
255
- # verify the required parameter 'semantic_patch_with_comment' is set
256
- if @api_client.config.client_side_validation && semantic_patch_with_comment.nil?
257
- fail ArgumentError, "Missing the required parameter 'semantic_patch_with_comment' when calling UserSettingsApi.patch_expiring_user_targets_for_flags"
286
+ # verify the required parameter 'env_key' is set
287
+ if @api_client.config.client_side_validation && env_key.nil?
288
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling UserSettingsApi.patch_expiring_flags_for_user"
289
+ end
290
+ # verify the required parameter 'patch_with_comment' is set
291
+ if @api_client.config.client_side_validation && patch_with_comment.nil?
292
+ fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling UserSettingsApi.patch_expiring_flags_for_user"
258
293
  end
259
294
  # resource path
260
- local_var_path = '/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'userKey' + '}', user_key.to_s)
295
+ local_var_path = '/api/v2/users/{projKey}/{userKey}/expiring-user-targets/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'userKey' + '}', CGI.escape(user_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s))
261
296
 
262
297
  # query parameters
263
- query_params = {}
298
+ query_params = opts[:query_params] || {}
264
299
 
265
300
  # header parameters
266
- header_params = {}
301
+ header_params = opts[:header_params] || {}
267
302
  # HTTP header 'Accept' (if needed)
268
303
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
269
304
  # HTTP header 'Content-Type'
270
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
305
+ content_type = @api_client.select_header_content_type(['application/json'])
306
+ if !content_type.nil?
307
+ header_params['Content-Type'] = content_type
308
+ end
271
309
 
272
310
  # form parameters
273
- form_params = {}
311
+ form_params = opts[:form_params] || {}
274
312
 
275
313
  # http body (model)
276
- post_body = @api_client.object_to_http_body(semantic_patch_with_comment)
277
- auth_names = ['Token']
278
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
314
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_with_comment)
315
+
316
+ # return_type
317
+ return_type = opts[:debug_return_type] || 'ExpiringUserTargetPatchResponse'
318
+
319
+ # auth_names
320
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
321
+
322
+ new_options = opts.merge(
323
+ :operation => :"UserSettingsApi.patch_expiring_flags_for_user",
279
324
  :header_params => header_params,
280
325
  :query_params => query_params,
281
326
  :form_params => form_params,
282
327
  :body => post_body,
283
328
  :auth_names => auth_names,
284
- :return_type => 'UserTargetingExpirationOnFlagsForUser')
329
+ :return_type => return_type
330
+ )
331
+
332
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
285
333
  if @api_client.config.debugging
286
- @api_client.config.logger.debug "API called: UserSettingsApi#patch_expiring_user_targets_for_flags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
334
+ @api_client.config.logger.debug "API called: UserSettingsApi#patch_expiring_flags_for_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
287
335
  end
288
336
  return data, status_code, headers
289
337
  end
290
- # Specifically enable or disable a feature flag for a user based on their key.
291
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
292
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
293
- # @param user_key The user&#39;s key.
294
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
295
- # @param user_settings_body
338
+
339
+ # Update flag settings for user
340
+ # Enable or disable a feature flag for a user based on their key. To change the setting, send a `PUT` request to this URL with a request body containing the flag value. For example, to disable the sort.order flag for the user `test@test.com`, send a `PUT` to `https://app.launchdarkly.com/api/v2/users/default/production/test@test.com/flags/sort.order` with the following body: ```json { \"setting\": false } ``` Omitting the setting attribute, or a setting of null, in your `PUT` \"clears\" the current setting for a user. If you previously patched the flag, and the patch included the user's data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user's key before, it calculates the flag values based on the user key alone.
341
+ # @param proj_key [String] The project key
342
+ # @param env_key [String] The environment key
343
+ # @param key [String] The user key
344
+ # @param feature_key [String] The feature flag key
345
+ # @param value_put [ValuePut]
296
346
  # @param [Hash] opts the optional parameters
297
347
  # @return [nil]
298
- def put_flag_setting(project_key, environment_key, user_key, feature_flag_key, user_settings_body, opts = {})
299
- put_flag_setting_with_http_info(project_key, environment_key, user_key, feature_flag_key, user_settings_body, opts)
348
+ def put_flag_setting(proj_key, env_key, key, feature_key, value_put, opts = {})
349
+ put_flag_setting_with_http_info(proj_key, env_key, key, feature_key, value_put, opts)
300
350
  nil
301
351
  end
302
352
 
303
- # Specifically enable or disable a feature flag for a user based on their key.
304
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
305
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
306
- # @param user_key The user&#39;s key.
307
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
308
- # @param user_settings_body
353
+ # Update flag settings for user
354
+ # Enable or disable a feature flag for a user based on their key. To change the setting, send a &#x60;PUT&#x60; request to this URL with a request body containing the flag value. For example, to disable the sort.order flag for the user &#x60;test@test.com&#x60;, send a &#x60;PUT&#x60; to &#x60;https://app.launchdarkly.com/api/v2/users/default/production/test@test.com/flags/sort.order&#x60; with the following body: &#x60;&#x60;&#x60;json { \&quot;setting\&quot;: false } &#x60;&#x60;&#x60; Omitting the setting attribute, or a setting of null, in your &#x60;PUT&#x60; \&quot;clears\&quot; the current setting for a user. If you previously patched the flag, and the patch included the user&#39;s data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the user&#39;s key before, it calculates the flag values based on the user key alone.
355
+ # @param proj_key [String] The project key
356
+ # @param env_key [String] The environment key
357
+ # @param key [String] The user key
358
+ # @param feature_key [String] The feature flag key
359
+ # @param value_put [ValuePut]
309
360
  # @param [Hash] opts the optional parameters
310
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
311
- def put_flag_setting_with_http_info(project_key, environment_key, user_key, feature_flag_key, user_settings_body, opts = {})
361
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
362
+ def put_flag_setting_with_http_info(proj_key, env_key, key, feature_key, value_put, opts = {})
312
363
  if @api_client.config.debugging
313
364
  @api_client.config.logger.debug 'Calling API: UserSettingsApi.put_flag_setting ...'
314
365
  end
315
- # verify the required parameter 'project_key' is set
316
- if @api_client.config.client_side_validation && project_key.nil?
317
- fail ArgumentError, "Missing the required parameter 'project_key' when calling UserSettingsApi.put_flag_setting"
366
+ # verify the required parameter 'proj_key' is set
367
+ if @api_client.config.client_side_validation && proj_key.nil?
368
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling UserSettingsApi.put_flag_setting"
318
369
  end
319
- # verify the required parameter 'environment_key' is set
320
- if @api_client.config.client_side_validation && environment_key.nil?
321
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling UserSettingsApi.put_flag_setting"
370
+ # verify the required parameter 'env_key' is set
371
+ if @api_client.config.client_side_validation && env_key.nil?
372
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling UserSettingsApi.put_flag_setting"
322
373
  end
323
- # verify the required parameter 'user_key' is set
324
- if @api_client.config.client_side_validation && user_key.nil?
325
- fail ArgumentError, "Missing the required parameter 'user_key' when calling UserSettingsApi.put_flag_setting"
374
+ # verify the required parameter 'key' is set
375
+ if @api_client.config.client_side_validation && key.nil?
376
+ fail ArgumentError, "Missing the required parameter 'key' when calling UserSettingsApi.put_flag_setting"
326
377
  end
327
- # verify the required parameter 'feature_flag_key' is set
328
- if @api_client.config.client_side_validation && feature_flag_key.nil?
329
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling UserSettingsApi.put_flag_setting"
378
+ # verify the required parameter 'feature_key' is set
379
+ if @api_client.config.client_side_validation && feature_key.nil?
380
+ fail ArgumentError, "Missing the required parameter 'feature_key' when calling UserSettingsApi.put_flag_setting"
330
381
  end
331
- # verify the required parameter 'user_settings_body' is set
332
- if @api_client.config.client_side_validation && user_settings_body.nil?
333
- fail ArgumentError, "Missing the required parameter 'user_settings_body' when calling UserSettingsApi.put_flag_setting"
382
+ # verify the required parameter 'value_put' is set
383
+ if @api_client.config.client_side_validation && value_put.nil?
384
+ fail ArgumentError, "Missing the required parameter 'value_put' when calling UserSettingsApi.put_flag_setting"
334
385
  end
335
386
  # resource path
336
- local_var_path = '/users/{projectKey}/{environmentKey}/{userKey}/flags/{featureFlagKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'userKey' + '}', user_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
387
+ local_var_path = '/api/v2/users/{projKey}/{envKey}/{key}/flags/{featureKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s)).sub('{' + 'featureKey' + '}', CGI.escape(feature_key.to_s))
337
388
 
338
389
  # query parameters
339
- query_params = {}
390
+ query_params = opts[:query_params] || {}
340
391
 
341
392
  # header parameters
342
- header_params = {}
393
+ header_params = opts[:header_params] || {}
343
394
  # HTTP header 'Accept' (if needed)
344
395
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
345
396
  # HTTP header 'Content-Type'
346
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
397
+ content_type = @api_client.select_header_content_type(['application/json'])
398
+ if !content_type.nil?
399
+ header_params['Content-Type'] = content_type
400
+ end
347
401
 
348
402
  # form parameters
349
- form_params = {}
403
+ form_params = opts[:form_params] || {}
350
404
 
351
405
  # http body (model)
352
- post_body = @api_client.object_to_http_body(user_settings_body)
353
- auth_names = ['Token']
354
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
406
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(value_put)
407
+
408
+ # return_type
409
+ return_type = opts[:debug_return_type]
410
+
411
+ # auth_names
412
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
413
+
414
+ new_options = opts.merge(
415
+ :operation => :"UserSettingsApi.put_flag_setting",
355
416
  :header_params => header_params,
356
417
  :query_params => query_params,
357
418
  :form_params => form_params,
358
419
  :body => post_body,
359
- :auth_names => auth_names)
420
+ :auth_names => auth_names,
421
+ :return_type => return_type
422
+ )
423
+
424
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
360
425
  if @api_client.config.debugging
361
426
  @api_client.config.logger.debug "API called: UserSettingsApi#put_flag_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
362
427
  end