launchdarkly_api 7.1.1 → 9.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (738) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +162 -78
  3. data/docs/Access.md +20 -0
  4. data/docs/AccessAllowedReason.md +28 -0
  5. data/docs/{AccessDeniedRep.md → AccessAllowedRep.md} +3 -3
  6. data/docs/AccessDenied.md +20 -0
  7. data/docs/{AccessDeniedReasonRep.md → AccessDeniedReason.md} +4 -4
  8. data/docs/AccessTokensApi.md +1 -1
  9. data/docs/AccountMembersApi.md +7 -7
  10. data/docs/AccountUsageBetaApi.md +11 -11
  11. data/docs/ActionOutputRep.md +1 -1
  12. data/docs/ApprovalsApi.md +15 -15
  13. data/docs/CodeReferencesApi.md +8 -8
  14. data/docs/ConditionInputRep.md +6 -0
  15. data/docs/ConditionOutputRep.md +6 -0
  16. data/docs/Conflict.md +1 -1
  17. data/docs/CreateFlagConfigApprovalRequestRequest.md +1 -1
  18. data/docs/CustomRole.md +1 -1
  19. data/docs/CustomRolesApi.md +23 -23
  20. data/docs/DataExportDestinationsApi.md +37 -37
  21. data/docs/Destination.md +1 -1
  22. data/docs/EnvironmentPost.md +6 -4
  23. data/docs/EnvironmentsApi.md +16 -16
  24. data/docs/EvaluationReason.md +28 -0
  25. data/docs/Experiment.md +36 -0
  26. data/docs/ExperimentCollectionRep.md +22 -0
  27. data/docs/ExperimentExpandableProperties.md +20 -0
  28. data/docs/ExperimentInfoRep.md +1 -1
  29. data/docs/ExperimentPatchInput.md +20 -0
  30. data/docs/ExperimentPost.md +26 -0
  31. data/docs/{ExperimentResultsRep.md → ExperimentResults.md} +2 -2
  32. data/docs/ExperimentsBetaApi.md +490 -30
  33. data/docs/Export.md +32 -0
  34. data/docs/FeatureFlag.md +1 -1
  35. data/docs/FeatureFlagBody.md +1 -1
  36. data/docs/FeatureFlagConfig.md +1 -1
  37. data/docs/FeatureFlagScheduledChange.md +1 -1
  38. data/docs/FeatureFlags.md +3 -1
  39. data/docs/FeatureFlagsApi.md +107 -105
  40. data/docs/FeatureFlagsBetaApi.md +22 -22
  41. data/docs/FileRep.md +20 -0
  42. data/docs/FlagConfigApprovalRequestResponse.md +1 -1
  43. data/docs/FlagGlobalAttributesRep.md +1 -1
  44. data/docs/FlagInput.md +20 -0
  45. data/docs/FlagLinkCollectionRep.md +20 -0
  46. data/docs/FlagLinkMember.md +24 -0
  47. data/docs/FlagLinkPost.md +30 -0
  48. data/docs/FlagLinkRep.md +38 -0
  49. data/docs/FlagLinksBetaApi.md +310 -0
  50. data/docs/FlagRep.md +22 -0
  51. data/docs/FlagScheduledChangesInput.md +1 -1
  52. data/docs/FlagTriggerInput.md +1 -1
  53. data/docs/FlagTriggersApi.md +55 -55
  54. data/docs/Import.md +30 -0
  55. data/docs/InitiatorRep.md +20 -0
  56. data/docs/Integration.md +1 -1
  57. data/docs/IntegrationAuditLogSubscriptionsApi.md +1 -1
  58. data/docs/IntegrationDeliveryConfiguration.md +38 -0
  59. data/docs/IntegrationDeliveryConfigurationCollection.md +20 -0
  60. data/docs/IntegrationDeliveryConfigurationCollectionLinks.md +20 -0
  61. data/docs/IntegrationDeliveryConfigurationLinks.md +24 -0
  62. data/docs/IntegrationDeliveryConfigurationPost.md +24 -0
  63. data/docs/IntegrationDeliveryConfigurationResponse.md +24 -0
  64. data/docs/IntegrationDeliveryConfigurationsBetaApi.md +541 -0
  65. data/docs/IterationExpandableProperties.md +20 -0
  66. data/docs/IterationInput.md +26 -0
  67. data/docs/IterationRep.md +40 -0
  68. data/docs/{ExperimentRep.md → LegacyExperimentRep.md} +2 -2
  69. data/docs/{MemberImportItemRep.md → MemberImportItem.md} +2 -2
  70. data/docs/{MemberSummaryRep.md → MemberSummary.md} +2 -2
  71. data/docs/MetricInput.md +20 -0
  72. data/docs/MetricListingRep.md +2 -2
  73. data/docs/MetricRep.md +2 -2
  74. data/docs/MetricV2Rep.md +22 -0
  75. data/docs/MetricsApi.md +22 -22
  76. data/docs/OtherApi.md +1 -1
  77. data/docs/ParameterRep.md +20 -0
  78. data/docs/PatchOperation.md +2 -2
  79. data/docs/PermissionGrantInput.md +4 -4
  80. data/docs/PostFlagScheduledChangesInput.md +1 -1
  81. data/docs/ProjectSummary.md +22 -0
  82. data/docs/ProjectsApi.md +1 -1
  83. data/docs/RelayAutoConfigRep.md +2 -2
  84. data/docs/RelayProxyConfigurationsApi.md +1 -1
  85. data/docs/RepositoryRep.md +1 -1
  86. data/docs/ResolvedContext.md +18 -0
  87. data/docs/ResolvedImage.md +22 -0
  88. data/docs/ResolvedTitle.md +20 -0
  89. data/docs/ResolvedUIBlockElement.md +24 -0
  90. data/docs/ResolvedUIBlocks.md +26 -0
  91. data/docs/ScheduleConditionInputRep.md +6 -0
  92. data/docs/ScheduleConditionOutputRep.md +7 -1
  93. data/docs/ScheduledChangesApi.md +12 -12
  94. data/docs/SegmentsApi.md +99 -99
  95. data/docs/SegmentsBetaApi.md +319 -0
  96. data/docs/SourceEnv.md +20 -0
  97. data/docs/StageInputRep.md +2 -0
  98. data/docs/Statement.md +2 -2
  99. data/docs/StatisticRep.md +2 -0
  100. data/docs/StatisticsRep.md +20 -0
  101. data/docs/TagCollection.md +22 -0
  102. data/docs/TagsApi.md +83 -0
  103. data/docs/Team.md +32 -0
  104. data/docs/{CustomRolesRep.md → TeamCustomRole.md} +3 -3
  105. data/docs/TeamCustomRoles.md +22 -0
  106. data/docs/TeamImportsRep.md +1 -1
  107. data/docs/TeamMaintainers.md +22 -0
  108. data/docs/TeamPatchInput.md +1 -1
  109. data/docs/TeamProjects.md +20 -0
  110. data/docs/{TeamCollectionRep.md → Teams.md} +3 -3
  111. data/docs/TeamsBetaApi.md +202 -46
  112. data/docs/TimestampRep.md +24 -0
  113. data/docs/Token.md +1 -1
  114. data/docs/TreatmentInput.md +24 -0
  115. data/docs/TreatmentParameterInput.md +20 -0
  116. data/docs/TreatmentRep.md +26 -0
  117. data/docs/TriggerPost.md +1 -1
  118. data/docs/TriggerWorkflowRep.md +2 -2
  119. data/docs/User.md +0 -2
  120. data/docs/UserFlagSetting.md +3 -1
  121. data/docs/UserRecord.md +2 -2
  122. data/docs/UserSegment.md +1 -1
  123. data/docs/UserSettingsApi.md +60 -60
  124. data/docs/Users.md +1 -1
  125. data/docs/UsersApi.md +43 -43
  126. data/docs/UsersRep.md +22 -0
  127. data/docs/Webhook.md +1 -1
  128. data/docs/WebhooksApi.md +1 -1
  129. data/docs/WorkflowsBetaApi.md +8 -8
  130. data/launchdarkly_api.gemspec +2 -2
  131. data/lib/launchdarkly_api/api/access_tokens_api.rb +1 -1
  132. data/lib/launchdarkly_api/api/account_members_api.rb +7 -7
  133. data/lib/launchdarkly_api/api/account_usage_beta_api.rb +20 -20
  134. data/lib/launchdarkly_api/api/approvals_api.rb +15 -15
  135. data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
  136. data/lib/launchdarkly_api/api/code_references_api.rb +10 -10
  137. data/lib/launchdarkly_api/api/custom_roles_api.rb +30 -30
  138. data/lib/launchdarkly_api/api/data_export_destinations_api.rb +57 -57
  139. data/lib/launchdarkly_api/api/environments_api.rb +21 -21
  140. data/lib/launchdarkly_api/api/experiments_beta_api.rb +526 -49
  141. data/lib/launchdarkly_api/api/feature_flags_api.rb +162 -159
  142. data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +38 -38
  143. data/lib/launchdarkly_api/api/flag_links_beta_api.rb +332 -0
  144. data/lib/launchdarkly_api/api/flag_triggers_api.rb +96 -96
  145. data/lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb +1 -1
  146. data/lib/launchdarkly_api/api/integration_delivery_configurations_beta_api.rb +569 -0
  147. data/lib/launchdarkly_api/api/metrics_api.rb +28 -28
  148. data/lib/launchdarkly_api/api/other_api.rb +3 -3
  149. data/lib/launchdarkly_api/api/projects_api.rb +1 -1
  150. data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +1 -1
  151. data/lib/launchdarkly_api/api/scheduled_changes_api.rb +11 -11
  152. data/lib/launchdarkly_api/api/segments_api.rb +160 -160
  153. data/lib/launchdarkly_api/api/segments_beta_api.rb +345 -0
  154. data/lib/launchdarkly_api/api/tags_api.rb +85 -0
  155. data/lib/launchdarkly_api/api/teams_beta_api.rb +195 -57
  156. data/lib/launchdarkly_api/api/user_settings_api.rb +100 -100
  157. data/lib/launchdarkly_api/api/users_api.rb +72 -72
  158. data/lib/launchdarkly_api/api/users_beta_api.rb +1 -1
  159. data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
  160. data/lib/launchdarkly_api/api/workflows_beta_api.rb +9 -9
  161. data/lib/launchdarkly_api/api_client.rb +1 -1
  162. data/lib/launchdarkly_api/api_error.rb +1 -1
  163. data/lib/launchdarkly_api/configuration.rb +1 -1
  164. data/lib/launchdarkly_api/models/access.rb +241 -0
  165. data/lib/launchdarkly_api/models/access_allowed_reason.rb +280 -0
  166. data/lib/launchdarkly_api/models/access_allowed_rep.rb +237 -0
  167. data/lib/launchdarkly_api/models/access_denied.rb +237 -0
  168. data/lib/launchdarkly_api/models/access_denied_reason.rb +280 -0
  169. data/lib/launchdarkly_api/models/access_token_post.rb +1 -1
  170. data/lib/launchdarkly_api/models/action_input_rep.rb +1 -1
  171. data/lib/launchdarkly_api/models/action_output_rep.rb +2 -2
  172. data/lib/launchdarkly_api/models/approval_condition_input_rep.rb +1 -1
  173. data/lib/launchdarkly_api/models/approval_condition_output_rep.rb +1 -1
  174. data/lib/launchdarkly_api/models/approval_settings.rb +1 -1
  175. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +1 -1
  176. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +1 -1
  177. data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +1 -1
  178. data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +1 -1
  179. data/lib/launchdarkly_api/models/big_segment_target.rb +1 -1
  180. data/lib/launchdarkly_api/models/branch_collection_rep.rb +1 -1
  181. data/lib/launchdarkly_api/models/branch_rep.rb +1 -1
  182. data/lib/launchdarkly_api/models/clause.rb +1 -1
  183. data/lib/launchdarkly_api/models/client_side_availability.rb +1 -1
  184. data/lib/launchdarkly_api/models/client_side_availability_post.rb +1 -1
  185. data/lib/launchdarkly_api/models/condition_base_output_rep.rb +1 -1
  186. data/lib/launchdarkly_api/models/condition_input_rep.rb +29 -2
  187. data/lib/launchdarkly_api/models/condition_output_rep.rb +29 -2
  188. data/lib/launchdarkly_api/models/confidence_interval_rep.rb +1 -1
  189. data/lib/launchdarkly_api/models/conflict.rb +4 -5
  190. data/lib/launchdarkly_api/models/conflict_output_rep.rb +1 -1
  191. data/lib/launchdarkly_api/models/copied_from_env.rb +1 -1
  192. data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +1 -1
  193. data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +2 -2
  194. data/lib/launchdarkly_api/models/custom_property.rb +1 -1
  195. data/lib/launchdarkly_api/models/custom_role.rb +2 -2
  196. data/lib/launchdarkly_api/models/custom_role_post.rb +1 -1
  197. data/lib/launchdarkly_api/models/custom_role_post_data.rb +1 -1
  198. data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
  199. data/lib/launchdarkly_api/models/custom_workflow_input_rep.rb +1 -1
  200. data/lib/launchdarkly_api/models/custom_workflow_meta.rb +1 -1
  201. data/lib/launchdarkly_api/models/custom_workflow_output_rep.rb +1 -1
  202. data/lib/launchdarkly_api/models/custom_workflow_stage_meta.rb +1 -1
  203. data/lib/launchdarkly_api/models/custom_workflows_listing_output_rep.rb +1 -1
  204. data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +1 -1
  205. data/lib/launchdarkly_api/models/defaults.rb +1 -1
  206. data/lib/launchdarkly_api/models/dependent_flag.rb +1 -1
  207. data/lib/launchdarkly_api/models/dependent_flag_environment.rb +1 -1
  208. data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +1 -1
  209. data/lib/launchdarkly_api/models/destination.rb +2 -2
  210. data/lib/launchdarkly_api/models/destination_post.rb +1 -1
  211. data/lib/launchdarkly_api/models/destinations.rb +1 -1
  212. data/lib/launchdarkly_api/models/environment.rb +1 -1
  213. data/lib/launchdarkly_api/models/environment_post.rb +17 -8
  214. data/lib/launchdarkly_api/models/evaluation_reason.rb +274 -0
  215. data/lib/launchdarkly_api/models/execution_output_rep.rb +1 -1
  216. data/lib/launchdarkly_api/models/experiment.rb +328 -0
  217. data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +1 -1
  218. data/lib/launchdarkly_api/models/experiment_collection_rep.rb +240 -0
  219. data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +1 -1
  220. data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +1 -1
  221. data/lib/launchdarkly_api/models/experiment_expandable_properties.rb +229 -0
  222. data/lib/launchdarkly_api/models/experiment_info_rep.rb +2 -2
  223. data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +1 -1
  224. data/lib/launchdarkly_api/models/experiment_patch_input.rb +229 -0
  225. data/lib/launchdarkly_api/models/experiment_post.rb +279 -0
  226. data/lib/launchdarkly_api/models/experiment_results.rb +280 -0
  227. data/lib/launchdarkly_api/models/experiment_stats_rep.rb +1 -1
  228. data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +1 -1
  229. data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +1 -1
  230. data/lib/launchdarkly_api/models/experiment_totals_rep.rb +1 -1
  231. data/lib/launchdarkly_api/models/expiring_user_target_error.rb +1 -1
  232. data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +1 -1
  233. data/lib/launchdarkly_api/models/expiring_user_target_item.rb +1 -1
  234. data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +1 -1
  235. data/lib/launchdarkly_api/models/export.rb +323 -0
  236. data/lib/launchdarkly_api/models/extinction.rb +1 -1
  237. data/lib/launchdarkly_api/models/extinction_collection_rep.rb +1 -1
  238. data/lib/launchdarkly_api/models/feature_flag.rb +2 -2
  239. data/lib/launchdarkly_api/models/feature_flag_body.rb +2 -2
  240. data/lib/launchdarkly_api/models/feature_flag_config.rb +2 -2
  241. data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +2 -2
  242. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +1 -1
  243. data/lib/launchdarkly_api/models/feature_flag_status.rb +1 -1
  244. data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
  245. data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
  246. data/lib/launchdarkly_api/models/feature_flags.rb +14 -5
  247. data/lib/launchdarkly_api/models/file_rep.rb +227 -0
  248. data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +2 -2
  249. data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +1 -1
  250. data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +1 -1
  251. data/lib/launchdarkly_api/models/flag_copy_config_post.rb +1 -1
  252. data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +2 -2
  253. data/lib/launchdarkly_api/models/flag_input.rb +237 -0
  254. data/lib/launchdarkly_api/models/flag_link_collection_rep.rb +241 -0
  255. data/lib/launchdarkly_api/models/flag_link_member.rb +257 -0
  256. data/lib/launchdarkly_api/models/flag_link_post.rb +274 -0
  257. data/lib/launchdarkly_api/models/flag_link_rep.rb +337 -0
  258. data/lib/launchdarkly_api/models/flag_listing_rep.rb +1 -1
  259. data/lib/launchdarkly_api/models/flag_rep.rb +243 -0
  260. data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +2 -2
  261. data/lib/launchdarkly_api/models/flag_status_rep.rb +1 -1
  262. data/lib/launchdarkly_api/models/flag_summary.rb +1 -1
  263. data/lib/launchdarkly_api/models/flag_trigger_input.rb +2 -2
  264. data/lib/launchdarkly_api/models/forbidden_error_rep.rb +1 -1
  265. data/lib/launchdarkly_api/models/hunk_rep.rb +1 -1
  266. data/lib/launchdarkly_api/models/import.rb +306 -0
  267. data/lib/launchdarkly_api/models/initiator_rep.rb +227 -0
  268. data/lib/launchdarkly_api/models/integration.rb +2 -2
  269. data/lib/launchdarkly_api/models/integration_delivery_configuration.rb +369 -0
  270. data/lib/launchdarkly_api/models/integration_delivery_configuration_collection.rb +239 -0
  271. data/lib/launchdarkly_api/models/integration_delivery_configuration_collection_links.rb +232 -0
  272. data/lib/launchdarkly_api/models/integration_delivery_configuration_links.rb +265 -0
  273. data/lib/launchdarkly_api/models/integration_delivery_configuration_post.rb +257 -0
  274. data/lib/launchdarkly_api/models/integration_delivery_configuration_response.rb +245 -0
  275. data/lib/launchdarkly_api/models/integration_metadata.rb +1 -1
  276. data/lib/launchdarkly_api/models/integration_status.rb +1 -1
  277. data/lib/launchdarkly_api/models/integration_status_rep.rb +1 -1
  278. data/lib/launchdarkly_api/models/integration_subscription_status_rep.rb +1 -1
  279. data/lib/launchdarkly_api/models/integrations.rb +1 -1
  280. data/lib/launchdarkly_api/models/invalid_request_error_rep.rb +1 -1
  281. data/lib/launchdarkly_api/models/ip_list.rb +1 -1
  282. data/lib/launchdarkly_api/models/iteration_expandable_properties.rb +231 -0
  283. data/lib/launchdarkly_api/models/iteration_input.rb +280 -0
  284. data/lib/launchdarkly_api/models/iteration_rep.rb +333 -0
  285. data/lib/launchdarkly_api/models/last_seen_metadata.rb +1 -1
  286. data/lib/launchdarkly_api/models/legacy_experiment_rep.rb +249 -0
  287. data/lib/launchdarkly_api/models/link.rb +1 -1
  288. data/lib/launchdarkly_api/models/member.rb +1 -1
  289. data/lib/launchdarkly_api/models/member_data_rep.rb +1 -1
  290. data/lib/launchdarkly_api/models/member_import_item.rb +246 -0
  291. data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +1 -1
  292. data/lib/launchdarkly_api/models/member_summary.rb +285 -0
  293. data/lib/launchdarkly_api/models/member_team_summary_rep.rb +1 -1
  294. data/lib/launchdarkly_api/models/member_teams_post_input.rb +1 -1
  295. data/lib/launchdarkly_api/models/members.rb +1 -1
  296. data/lib/launchdarkly_api/models/method_not_allowed_error_rep.rb +1 -1
  297. data/lib/launchdarkly_api/models/metric_collection_rep.rb +1 -1
  298. data/lib/launchdarkly_api/models/metric_input.rb +237 -0
  299. data/lib/launchdarkly_api/models/metric_listing_rep.rb +3 -3
  300. data/lib/launchdarkly_api/models/metric_post.rb +1 -1
  301. data/lib/launchdarkly_api/models/metric_rep.rb +3 -3
  302. data/lib/launchdarkly_api/models/metric_seen.rb +1 -1
  303. data/lib/launchdarkly_api/models/metric_v2_rep.rb +253 -0
  304. data/lib/launchdarkly_api/models/modification.rb +1 -1
  305. data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +1 -1
  306. data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +1 -1
  307. data/lib/launchdarkly_api/models/new_member_form.rb +1 -1
  308. data/lib/launchdarkly_api/models/not_found_error_rep.rb +1 -1
  309. data/lib/launchdarkly_api/models/parameter_rep.rb +227 -0
  310. data/lib/launchdarkly_api/models/parent_resource_rep.rb +1 -1
  311. data/lib/launchdarkly_api/models/patch_failed_error_rep.rb +1 -1
  312. data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
  313. data/lib/launchdarkly_api/models/patch_segment_instruction.rb +1 -1
  314. data/lib/launchdarkly_api/models/patch_segment_request.rb +1 -1
  315. data/lib/launchdarkly_api/models/patch_with_comment.rb +1 -1
  316. data/lib/launchdarkly_api/models/permission_grant_input.rb +16 -16
  317. data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +1 -1
  318. data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +1 -1
  319. data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +2 -2
  320. data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
  321. data/lib/launchdarkly_api/models/project.rb +1 -1
  322. data/lib/launchdarkly_api/models/project_listing_rep.rb +1 -1
  323. data/lib/launchdarkly_api/models/project_post.rb +1 -1
  324. data/lib/launchdarkly_api/models/project_summary.rb +238 -0
  325. data/lib/launchdarkly_api/models/projects.rb +1 -1
  326. data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +1 -1
  327. data/lib/launchdarkly_api/models/put_branch.rb +1 -1
  328. data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +1 -1
  329. data/lib/launchdarkly_api/models/recent_trigger_body.rb +1 -1
  330. data/lib/launchdarkly_api/models/reference_rep.rb +1 -1
  331. data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +1 -1
  332. data/lib/launchdarkly_api/models/relay_auto_config_post.rb +1 -1
  333. data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +3 -3
  334. data/lib/launchdarkly_api/models/repository_collection_rep.rb +1 -1
  335. data/lib/launchdarkly_api/models/repository_post.rb +1 -1
  336. data/lib/launchdarkly_api/models/repository_rep.rb +2 -2
  337. data/lib/launchdarkly_api/models/resolved_context.rb +220 -0
  338. data/lib/launchdarkly_api/models/resolved_image.rb +236 -0
  339. data/lib/launchdarkly_api/models/resolved_title.rb +229 -0
  340. data/lib/launchdarkly_api/models/resolved_ui_block_element.rb +245 -0
  341. data/lib/launchdarkly_api/models/resolved_ui_blocks.rb +254 -0
  342. data/lib/launchdarkly_api/models/resource_access.rb +1 -1
  343. data/lib/launchdarkly_api/models/resource_id_response.rb +1 -1
  344. data/lib/launchdarkly_api/models/review_output_rep.rb +1 -1
  345. data/lib/launchdarkly_api/models/review_response.rb +1 -1
  346. data/lib/launchdarkly_api/models/rollout.rb +1 -1
  347. data/lib/launchdarkly_api/models/rule.rb +1 -1
  348. data/lib/launchdarkly_api/models/schedule_condition_input_rep.rb +29 -2
  349. data/lib/launchdarkly_api/models/schedule_condition_output_rep.rb +32 -5
  350. data/lib/launchdarkly_api/models/sdk_list_rep.rb +1 -1
  351. data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +1 -1
  352. data/lib/launchdarkly_api/models/sdk_version_rep.rb +1 -1
  353. data/lib/launchdarkly_api/models/segment_body.rb +1 -1
  354. data/lib/launchdarkly_api/models/segment_metadata.rb +1 -1
  355. data/lib/launchdarkly_api/models/segment_user_list.rb +1 -1
  356. data/lib/launchdarkly_api/models/segment_user_state.rb +1 -1
  357. data/lib/launchdarkly_api/models/series_list_rep.rb +1 -1
  358. data/lib/launchdarkly_api/models/source_env.rb +229 -0
  359. data/lib/launchdarkly_api/models/source_flag.rb +1 -1
  360. data/lib/launchdarkly_api/models/stage_input_rep.rb +11 -2
  361. data/lib/launchdarkly_api/models/stage_output_rep.rb +1 -1
  362. data/lib/launchdarkly_api/models/statement.rb +3 -3
  363. data/lib/launchdarkly_api/models/statement_post.rb +1 -1
  364. data/lib/launchdarkly_api/models/statement_post_data.rb +1 -1
  365. data/lib/launchdarkly_api/models/statement_rep.rb +1 -1
  366. data/lib/launchdarkly_api/models/statistic_collection_rep.rb +1 -1
  367. data/lib/launchdarkly_api/models/statistic_rep.rb +16 -2
  368. data/lib/launchdarkly_api/models/statistics_rep.rb +231 -0
  369. data/lib/launchdarkly_api/models/statistics_root.rb +1 -1
  370. data/lib/launchdarkly_api/models/status_conflict_error_rep.rb +1 -1
  371. data/lib/launchdarkly_api/models/subject_data_rep.rb +1 -1
  372. data/lib/launchdarkly_api/models/subscription_post.rb +1 -1
  373. data/lib/launchdarkly_api/models/tag_collection.rb +252 -0
  374. data/lib/launchdarkly_api/models/target.rb +1 -1
  375. data/lib/launchdarkly_api/models/target_resource_rep.rb +1 -1
  376. data/lib/launchdarkly_api/models/team.rb +283 -0
  377. data/lib/launchdarkly_api/models/team_custom_role.rb +245 -0
  378. data/lib/launchdarkly_api/models/team_custom_roles.rb +240 -0
  379. data/lib/launchdarkly_api/models/team_imports_rep.rb +2 -2
  380. data/lib/launchdarkly_api/models/team_maintainers.rb +240 -0
  381. data/lib/launchdarkly_api/models/team_patch_input.rb +2 -2
  382. data/lib/launchdarkly_api/models/team_post_input.rb +1 -1
  383. data/lib/launchdarkly_api/models/team_projects.rb +229 -0
  384. data/lib/launchdarkly_api/models/teams.rb +240 -0
  385. data/lib/launchdarkly_api/models/timestamp_rep.rb +245 -0
  386. data/lib/launchdarkly_api/models/title_rep.rb +1 -1
  387. data/lib/launchdarkly_api/models/token.rb +2 -2
  388. data/lib/launchdarkly_api/models/token_data_rep.rb +1 -1
  389. data/lib/launchdarkly_api/models/tokens.rb +1 -1
  390. data/lib/launchdarkly_api/models/treatment_input.rb +267 -0
  391. data/lib/launchdarkly_api/models/treatment_parameter_input.rb +237 -0
  392. data/lib/launchdarkly_api/models/treatment_rep.rb +266 -0
  393. data/lib/launchdarkly_api/models/trigger_post.rb +2 -2
  394. data/lib/launchdarkly_api/models/trigger_workflow_collection_rep.rb +1 -1
  395. data/lib/launchdarkly_api/models/trigger_workflow_rep.rb +3 -3
  396. data/lib/launchdarkly_api/models/unauthorized_error_rep.rb +1 -1
  397. data/lib/launchdarkly_api/models/url_post.rb +1 -1
  398. data/lib/launchdarkly_api/models/user.rb +2 -13
  399. data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +1 -1
  400. data/lib/launchdarkly_api/models/user_flag_setting.rb +15 -6
  401. data/lib/launchdarkly_api/models/user_flag_settings.rb +1 -1
  402. data/lib/launchdarkly_api/models/user_record.rb +2 -2
  403. data/lib/launchdarkly_api/models/user_record_rep.rb +1 -1
  404. data/lib/launchdarkly_api/models/user_segment.rb +2 -2
  405. data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
  406. data/lib/launchdarkly_api/models/user_segments.rb +1 -1
  407. data/lib/launchdarkly_api/models/users.rb +1 -1
  408. data/lib/launchdarkly_api/models/users_rep.rb +250 -0
  409. data/lib/launchdarkly_api/models/value_put.rb +1 -1
  410. data/lib/launchdarkly_api/models/variation.rb +1 -1
  411. data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +1 -1
  412. data/lib/launchdarkly_api/models/variation_summary.rb +1 -1
  413. data/lib/launchdarkly_api/models/versions_rep.rb +1 -1
  414. data/lib/launchdarkly_api/models/webhook.rb +2 -2
  415. data/lib/launchdarkly_api/models/webhook_post.rb +1 -1
  416. data/lib/launchdarkly_api/models/webhooks.rb +1 -1
  417. data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
  418. data/lib/launchdarkly_api/version.rb +2 -2
  419. data/lib/launchdarkly_api.rb +62 -14
  420. data/spec/api/access_tokens_api_spec.rb +1 -1
  421. data/spec/api/account_members_api_spec.rb +4 -4
  422. data/spec/api/account_usage_beta_api_spec.rb +4 -4
  423. data/spec/api/approvals_api_spec.rb +8 -8
  424. data/spec/api/audit_log_api_spec.rb +1 -1
  425. data/spec/api/code_references_api_spec.rb +2 -2
  426. data/spec/api/custom_roles_api_spec.rb +5 -5
  427. data/spec/api/data_export_destinations_api_spec.rb +9 -9
  428. data/spec/api/environments_api_spec.rb +4 -4
  429. data/spec/api/experiments_beta_api_spec.rb +96 -10
  430. data/spec/api/feature_flags_api_spec.rb +26 -25
  431. data/spec/api/feature_flags_beta_api_spec.rb +8 -8
  432. data/spec/api/flag_links_beta_api_spec.rb +91 -0
  433. data/spec/api/flag_triggers_api_spec.rb +16 -16
  434. data/spec/api/integration_audit_log_subscriptions_api_spec.rb +1 -1
  435. data/spec/api/integration_delivery_configurations_beta_api_spec.rb +135 -0
  436. data/spec/api/metrics_api_spec.rb +4 -4
  437. data/spec/api/other_api_spec.rb +2 -2
  438. data/spec/api/projects_api_spec.rb +1 -1
  439. data/spec/api/relay_proxy_configurations_api_spec.rb +1 -1
  440. data/spec/api/scheduled_changes_api_spec.rb +6 -6
  441. data/spec/api/segments_api_spec.rb +28 -28
  442. data/spec/api/segments_beta_api_spec.rb +95 -0
  443. data/spec/api/tags_api_spec.rb +48 -0
  444. data/spec/api/teams_beta_api_spec.rb +41 -13
  445. data/spec/api/user_settings_api_spec.rb +18 -18
  446. data/spec/api/users_api_spec.rb +13 -13
  447. data/spec/api/users_beta_api_spec.rb +1 -1
  448. data/spec/api/webhooks_api_spec.rb +1 -1
  449. data/spec/api/workflows_beta_api_spec.rb +5 -5
  450. data/spec/api_client_spec.rb +1 -1
  451. data/spec/configuration_spec.rb +1 -1
  452. data/spec/models/access_allowed_reason_spec.rb +64 -0
  453. data/spec/models/access_allowed_rep_spec.rb +40 -0
  454. data/spec/models/access_denied_reason_spec.rb +64 -0
  455. data/spec/models/access_denied_spec.rb +40 -0
  456. data/spec/models/access_spec.rb +40 -0
  457. data/spec/models/access_token_post_spec.rb +1 -1
  458. data/spec/models/action_input_rep_spec.rb +1 -1
  459. data/spec/models/action_output_rep_spec.rb +1 -1
  460. data/spec/models/approval_condition_input_rep_spec.rb +1 -1
  461. data/spec/models/approval_condition_output_rep_spec.rb +1 -1
  462. data/spec/models/approval_settings_spec.rb +1 -1
  463. data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +1 -1
  464. data/spec/models/audit_log_entry_listing_rep_spec.rb +1 -1
  465. data/spec/models/audit_log_entry_rep_spec.rb +1 -1
  466. data/spec/models/authorized_app_data_rep_spec.rb +1 -1
  467. data/spec/models/big_segment_target_spec.rb +1 -1
  468. data/spec/models/branch_collection_rep_spec.rb +1 -1
  469. data/spec/models/branch_rep_spec.rb +1 -1
  470. data/spec/models/clause_spec.rb +1 -1
  471. data/spec/models/client_side_availability_post_spec.rb +1 -1
  472. data/spec/models/client_side_availability_spec.rb +1 -1
  473. data/spec/models/condition_base_output_rep_spec.rb +1 -1
  474. data/spec/models/condition_input_rep_spec.rb +19 -1
  475. data/spec/models/condition_output_rep_spec.rb +19 -1
  476. data/spec/models/confidence_interval_rep_spec.rb +1 -1
  477. data/spec/models/conflict_output_rep_spec.rb +1 -1
  478. data/spec/models/conflict_spec.rb +1 -1
  479. data/spec/models/copied_from_env_spec.rb +1 -1
  480. data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +1 -1
  481. data/spec/models/create_flag_config_approval_request_request_spec.rb +1 -1
  482. data/spec/models/custom_property_spec.rb +1 -1
  483. data/spec/models/custom_role_post_data_spec.rb +1 -1
  484. data/spec/models/custom_role_post_spec.rb +1 -1
  485. data/spec/models/custom_role_spec.rb +1 -1
  486. data/spec/models/custom_roles_spec.rb +1 -1
  487. data/spec/models/custom_workflow_input_rep_spec.rb +1 -1
  488. data/spec/models/custom_workflow_meta_spec.rb +1 -1
  489. data/spec/models/custom_workflow_output_rep_spec.rb +1 -1
  490. data/spec/models/custom_workflow_stage_meta_spec.rb +1 -1
  491. data/spec/models/custom_workflows_listing_output_rep_spec.rb +1 -1
  492. data/spec/models/default_client_side_availability_post_spec.rb +1 -1
  493. data/spec/models/defaults_spec.rb +1 -1
  494. data/spec/models/dependent_flag_environment_spec.rb +1 -1
  495. data/spec/models/dependent_flag_spec.rb +1 -1
  496. data/spec/models/dependent_flags_by_environment_spec.rb +1 -1
  497. data/spec/models/destination_post_spec.rb +1 -1
  498. data/spec/models/destination_spec.rb +1 -1
  499. data/spec/models/destinations_spec.rb +1 -1
  500. data/spec/models/environment_post_spec.rb +7 -1
  501. data/spec/models/environment_spec.rb +1 -1
  502. data/spec/models/evaluation_reason_spec.rb +64 -0
  503. data/spec/models/execution_output_rep_spec.rb +1 -1
  504. data/spec/models/experiment_allocation_rep_spec.rb +1 -1
  505. data/spec/models/experiment_collection_rep_spec.rb +46 -0
  506. data/spec/models/experiment_enabled_period_rep_spec.rb +1 -1
  507. data/spec/models/experiment_environment_setting_rep_spec.rb +1 -1
  508. data/spec/models/experiment_expandable_properties_spec.rb +40 -0
  509. data/spec/models/experiment_info_rep_spec.rb +1 -1
  510. data/spec/models/experiment_metadata_rep_spec.rb +1 -1
  511. data/spec/models/experiment_patch_input_spec.rb +40 -0
  512. data/spec/models/experiment_post_spec.rb +58 -0
  513. data/spec/models/experiment_results_spec.rb +70 -0
  514. data/spec/models/experiment_spec.rb +88 -0
  515. data/spec/models/experiment_stats_rep_spec.rb +1 -1
  516. data/spec/models/experiment_time_series_slice_spec.rb +1 -1
  517. data/spec/models/experiment_time_series_variation_slice_spec.rb +1 -1
  518. data/spec/models/experiment_totals_rep_spec.rb +1 -1
  519. data/spec/models/expiring_user_target_error_spec.rb +1 -1
  520. data/spec/models/expiring_user_target_get_response_spec.rb +1 -1
  521. data/spec/models/expiring_user_target_item_spec.rb +1 -1
  522. data/spec/models/expiring_user_target_patch_response_spec.rb +1 -1
  523. data/spec/models/export_spec.rb +76 -0
  524. data/spec/models/extinction_collection_rep_spec.rb +1 -1
  525. data/spec/models/extinction_spec.rb +1 -1
  526. data/spec/models/feature_flag_body_spec.rb +1 -1
  527. data/spec/models/feature_flag_config_spec.rb +1 -1
  528. data/spec/models/feature_flag_scheduled_change_spec.rb +1 -1
  529. data/spec/models/feature_flag_scheduled_changes_spec.rb +1 -1
  530. data/spec/models/feature_flag_spec.rb +1 -1
  531. data/spec/models/feature_flag_status_across_environments_spec.rb +1 -1
  532. data/spec/models/feature_flag_status_spec.rb +1 -1
  533. data/spec/models/feature_flag_statuses_spec.rb +1 -1
  534. data/spec/models/feature_flags_spec.rb +7 -1
  535. data/spec/models/file_rep_spec.rb +40 -0
  536. data/spec/models/flag_config_approval_request_response_spec.rb +1 -1
  537. data/spec/models/flag_config_approval_requests_response_spec.rb +1 -1
  538. data/spec/models/flag_copy_config_environment_spec.rb +1 -1
  539. data/spec/models/flag_copy_config_post_spec.rb +1 -1
  540. data/spec/models/flag_global_attributes_rep_spec.rb +1 -1
  541. data/spec/models/flag_input_spec.rb +40 -0
  542. data/spec/models/flag_link_collection_rep_spec.rb +40 -0
  543. data/spec/models/flag_link_member_spec.rb +52 -0
  544. data/spec/models/flag_link_post_spec.rb +70 -0
  545. data/spec/models/flag_link_rep_spec.rb +94 -0
  546. data/spec/models/flag_listing_rep_spec.rb +1 -1
  547. data/spec/models/flag_rep_spec.rb +46 -0
  548. data/spec/models/flag_scheduled_changes_input_spec.rb +1 -1
  549. data/spec/models/flag_status_rep_spec.rb +1 -1
  550. data/spec/models/flag_summary_spec.rb +1 -1
  551. data/spec/models/flag_trigger_input_spec.rb +1 -1
  552. data/spec/models/forbidden_error_rep_spec.rb +1 -1
  553. data/spec/models/hunk_rep_spec.rb +1 -1
  554. data/spec/models/import_spec.rb +70 -0
  555. data/spec/models/initiator_rep_spec.rb +40 -0
  556. data/spec/models/integration_delivery_configuration_collection_links_spec.rb +40 -0
  557. data/spec/models/integration_delivery_configuration_collection_spec.rb +40 -0
  558. data/spec/models/integration_delivery_configuration_links_spec.rb +52 -0
  559. data/spec/models/integration_delivery_configuration_post_spec.rb +52 -0
  560. data/spec/models/integration_delivery_configuration_response_spec.rb +52 -0
  561. data/spec/models/integration_delivery_configuration_spec.rb +94 -0
  562. data/spec/models/integration_metadata_spec.rb +1 -1
  563. data/spec/models/integration_spec.rb +1 -1
  564. data/spec/models/integration_status_rep_spec.rb +1 -1
  565. data/spec/models/integration_status_spec.rb +1 -1
  566. data/spec/models/integration_subscription_status_rep_spec.rb +1 -1
  567. data/spec/models/integrations_spec.rb +1 -1
  568. data/spec/models/invalid_request_error_rep_spec.rb +1 -1
  569. data/spec/models/ip_list_spec.rb +1 -1
  570. data/spec/models/iteration_expandable_properties_spec.rb +40 -0
  571. data/spec/models/iteration_input_spec.rb +58 -0
  572. data/spec/models/iteration_rep_spec.rb +100 -0
  573. data/spec/models/last_seen_metadata_spec.rb +1 -1
  574. data/spec/models/legacy_experiment_rep_spec.rb +52 -0
  575. data/spec/models/link_spec.rb +1 -1
  576. data/spec/models/member_data_rep_spec.rb +1 -1
  577. data/spec/models/member_import_item_spec.rb +46 -0
  578. data/spec/models/member_permission_grant_summary_rep_spec.rb +1 -1
  579. data/spec/models/member_spec.rb +1 -1
  580. data/spec/models/member_summary_spec.rb +64 -0
  581. data/spec/models/member_team_summary_rep_spec.rb +1 -1
  582. data/spec/models/member_teams_post_input_spec.rb +1 -1
  583. data/spec/models/members_spec.rb +1 -1
  584. data/spec/models/method_not_allowed_error_rep_spec.rb +1 -1
  585. data/spec/models/metric_collection_rep_spec.rb +1 -1
  586. data/spec/models/metric_input_spec.rb +40 -0
  587. data/spec/models/metric_listing_rep_spec.rb +1 -1
  588. data/spec/models/metric_post_spec.rb +1 -1
  589. data/spec/models/metric_rep_spec.rb +1 -1
  590. data/spec/models/metric_seen_spec.rb +1 -1
  591. data/spec/models/metric_v2_rep_spec.rb +46 -0
  592. data/spec/models/modification_spec.rb +1 -1
  593. data/spec/models/multi_environment_dependent_flag_spec.rb +1 -1
  594. data/spec/models/multi_environment_dependent_flags_spec.rb +1 -1
  595. data/spec/models/new_member_form_spec.rb +1 -1
  596. data/spec/models/not_found_error_rep_spec.rb +1 -1
  597. data/spec/models/parameter_rep_spec.rb +40 -0
  598. data/spec/models/parent_resource_rep_spec.rb +1 -1
  599. data/spec/models/patch_failed_error_rep_spec.rb +1 -1
  600. data/spec/models/patch_operation_spec.rb +1 -1
  601. data/spec/models/patch_segment_instruction_spec.rb +1 -1
  602. data/spec/models/patch_segment_request_spec.rb +1 -1
  603. data/spec/models/patch_with_comment_spec.rb +1 -1
  604. data/spec/models/permission_grant_input_spec.rb +3 -3
  605. data/spec/models/post_approval_request_apply_request_spec.rb +1 -1
  606. data/spec/models/post_approval_request_review_request_spec.rb +1 -1
  607. data/spec/models/post_flag_scheduled_changes_input_spec.rb +1 -1
  608. data/spec/models/prerequisite_spec.rb +1 -1
  609. data/spec/models/project_listing_rep_spec.rb +1 -1
  610. data/spec/models/project_post_spec.rb +1 -1
  611. data/spec/models/project_spec.rb +1 -1
  612. data/spec/models/project_summary_spec.rb +46 -0
  613. data/spec/models/projects_spec.rb +1 -1
  614. data/spec/models/pub_nub_detail_rep_spec.rb +1 -1
  615. data/spec/models/put_branch_spec.rb +1 -1
  616. data/spec/models/rate_limited_error_rep_spec.rb +1 -1
  617. data/spec/models/recent_trigger_body_spec.rb +1 -1
  618. data/spec/models/reference_rep_spec.rb +1 -1
  619. data/spec/models/relay_auto_config_collection_rep_spec.rb +1 -1
  620. data/spec/models/relay_auto_config_post_spec.rb +1 -1
  621. data/spec/models/relay_auto_config_rep_spec.rb +1 -1
  622. data/spec/models/repository_collection_rep_spec.rb +1 -1
  623. data/spec/models/repository_post_spec.rb +1 -1
  624. data/spec/models/repository_rep_spec.rb +1 -1
  625. data/spec/models/resolved_context_spec.rb +34 -0
  626. data/spec/models/resolved_image_spec.rb +46 -0
  627. data/spec/models/resolved_title_spec.rb +40 -0
  628. data/spec/models/resolved_ui_block_element_spec.rb +52 -0
  629. data/spec/models/resolved_ui_blocks_spec.rb +58 -0
  630. data/spec/models/resource_access_spec.rb +1 -1
  631. data/spec/models/resource_id_response_spec.rb +1 -1
  632. data/spec/models/review_output_rep_spec.rb +1 -1
  633. data/spec/models/review_response_spec.rb +1 -1
  634. data/spec/models/rollout_spec.rb +1 -1
  635. data/spec/models/rule_spec.rb +1 -1
  636. data/spec/models/schedule_condition_input_rep_spec.rb +19 -1
  637. data/spec/models/schedule_condition_output_rep_spec.rb +19 -1
  638. data/spec/models/sdk_list_rep_spec.rb +1 -1
  639. data/spec/models/sdk_version_list_rep_spec.rb +1 -1
  640. data/spec/models/sdk_version_rep_spec.rb +1 -1
  641. data/spec/models/segment_body_spec.rb +1 -1
  642. data/spec/models/segment_metadata_spec.rb +1 -1
  643. data/spec/models/segment_user_list_spec.rb +1 -1
  644. data/spec/models/segment_user_state_spec.rb +1 -1
  645. data/spec/models/series_list_rep_spec.rb +1 -1
  646. data/spec/models/source_env_spec.rb +40 -0
  647. data/spec/models/source_flag_spec.rb +1 -1
  648. data/spec/models/stage_input_rep_spec.rb +7 -1
  649. data/spec/models/stage_output_rep_spec.rb +1 -1
  650. data/spec/models/statement_post_data_spec.rb +1 -1
  651. data/spec/models/statement_post_spec.rb +1 -1
  652. data/spec/models/statement_rep_spec.rb +1 -1
  653. data/spec/models/statement_spec.rb +1 -1
  654. data/spec/models/statistic_collection_rep_spec.rb +1 -1
  655. data/spec/models/statistic_rep_spec.rb +7 -1
  656. data/spec/models/statistics_rep_spec.rb +40 -0
  657. data/spec/models/statistics_root_spec.rb +1 -1
  658. data/spec/models/status_conflict_error_rep_spec.rb +1 -1
  659. data/spec/models/subject_data_rep_spec.rb +1 -1
  660. data/spec/models/subscription_post_spec.rb +1 -1
  661. data/spec/models/tag_collection_spec.rb +46 -0
  662. data/spec/models/target_resource_rep_spec.rb +1 -1
  663. data/spec/models/target_spec.rb +1 -1
  664. data/spec/models/team_custom_role_spec.rb +52 -0
  665. data/spec/models/team_custom_roles_spec.rb +46 -0
  666. data/spec/models/team_imports_rep_spec.rb +1 -1
  667. data/spec/models/team_maintainers_spec.rb +46 -0
  668. data/spec/models/team_patch_input_spec.rb +1 -1
  669. data/spec/models/team_post_input_spec.rb +1 -1
  670. data/spec/models/team_projects_spec.rb +40 -0
  671. data/spec/models/team_spec.rb +76 -0
  672. data/spec/models/teams_spec.rb +46 -0
  673. data/spec/models/timestamp_rep_spec.rb +52 -0
  674. data/spec/models/title_rep_spec.rb +1 -1
  675. data/spec/models/token_data_rep_spec.rb +1 -1
  676. data/spec/models/token_spec.rb +1 -1
  677. data/spec/models/tokens_spec.rb +1 -1
  678. data/spec/models/treatment_input_spec.rb +52 -0
  679. data/spec/models/treatment_parameter_input_spec.rb +40 -0
  680. data/spec/models/treatment_rep_spec.rb +58 -0
  681. data/spec/models/trigger_post_spec.rb +1 -1
  682. data/spec/models/trigger_workflow_collection_rep_spec.rb +1 -1
  683. data/spec/models/trigger_workflow_rep_spec.rb +1 -1
  684. data/spec/models/unauthorized_error_rep_spec.rb +1 -1
  685. data/spec/models/url_post_spec.rb +1 -1
  686. data/spec/models/user_attribute_names_rep_spec.rb +1 -1
  687. data/spec/models/user_flag_setting_spec.rb +7 -1
  688. data/spec/models/user_flag_settings_spec.rb +1 -1
  689. data/spec/models/user_record_rep_spec.rb +1 -1
  690. data/spec/models/user_record_spec.rb +1 -1
  691. data/spec/models/user_segment_rule_spec.rb +1 -1
  692. data/spec/models/user_segment_spec.rb +1 -1
  693. data/spec/models/user_segments_spec.rb +1 -1
  694. data/spec/models/user_spec.rb +1 -7
  695. data/spec/models/users_rep_spec.rb +46 -0
  696. data/spec/models/users_spec.rb +1 -1
  697. data/spec/models/value_put_spec.rb +1 -1
  698. data/spec/models/variation_or_rollout_rep_spec.rb +1 -1
  699. data/spec/models/variation_spec.rb +1 -1
  700. data/spec/models/variation_summary_spec.rb +1 -1
  701. data/spec/models/versions_rep_spec.rb +1 -1
  702. data/spec/models/webhook_post_spec.rb +1 -1
  703. data/spec/models/webhook_spec.rb +1 -1
  704. data/spec/models/webhooks_spec.rb +1 -1
  705. data/spec/models/weighted_variation_spec.rb +1 -1
  706. data/spec/spec_helper.rb +1 -1
  707. metadata +300 -79
  708. data/docs/AccessRep.md +0 -18
  709. data/docs/DerivedAttribute.md +0 -20
  710. data/docs/ExpandedTeamRep.md +0 -44
  711. data/docs/PermissionGrantRep.md +0 -24
  712. data/docs/TeamRep.md +0 -40
  713. data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +0 -280
  714. data/lib/launchdarkly_api/models/access_denied_rep.rb +0 -237
  715. data/lib/launchdarkly_api/models/access_rep.rb +0 -225
  716. data/lib/launchdarkly_api/models/custom_roles_rep.rb +0 -247
  717. data/lib/launchdarkly_api/models/derived_attribute.rb +0 -228
  718. data/lib/launchdarkly_api/models/expanded_team_rep.rb +0 -349
  719. data/lib/launchdarkly_api/models/experiment_rep.rb +0 -249
  720. data/lib/launchdarkly_api/models/experiment_results_rep.rb +0 -280
  721. data/lib/launchdarkly_api/models/member_import_item_rep.rb +0 -246
  722. data/lib/launchdarkly_api/models/member_summary_rep.rb +0 -285
  723. data/lib/launchdarkly_api/models/permission_grant_rep.rb +0 -249
  724. data/lib/launchdarkly_api/models/team_collection_rep.rb +0 -240
  725. data/lib/launchdarkly_api/models/team_rep.rb +0 -327
  726. data/spec/models/access_denied_reason_rep_spec.rb +0 -64
  727. data/spec/models/access_denied_rep_spec.rb +0 -40
  728. data/spec/models/access_rep_spec.rb +0 -34
  729. data/spec/models/custom_roles_rep_spec.rb +0 -52
  730. data/spec/models/derived_attribute_spec.rb +0 -40
  731. data/spec/models/expanded_team_rep_spec.rb +0 -112
  732. data/spec/models/experiment_rep_spec.rb +0 -52
  733. data/spec/models/experiment_results_rep_spec.rb +0 -70
  734. data/spec/models/member_import_item_rep_spec.rb +0 -46
  735. data/spec/models/member_summary_rep_spec.rb +0 -64
  736. data/spec/models/permission_grant_rep_spec.rb +0 -52
  737. data/spec/models/team_collection_rep_spec.rb +0 -46
  738. data/spec/models/team_rep_spec.rb +0 -100
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #LaunchDarkly REST API
3
3
 
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.
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, such as a single feature flag, you receive a _detailed representation_ 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. In most cases, the detailed representation contains all of the attributes of the resource. In a few cases, the detailed representation contains many, but not all, of the attributes of the resource. Typically this happens when an attribute of the requested resource is itself paginated. You can request that the response include a particular attribute by using the `expand` request parameter. ### 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. ### Expanding responses Sometimes the detailed representation of a resource does not include all of the attributes of the resource by default. If this is the case, the request method will clearly document this and describe which attributes you can include in an expanded response. To include the additional attributes, append the `expand` request parameter to your request and add a comma-separated list of the attributes to include. For example, when you append `?expand=members,roles` to the [Get team](/tag/Teams-(beta)#operation/getTeam) endpoint, the expanded response includes both of these attributes. ## 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/Overview/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: 20210729 ``` 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 yyyymmdd format. In the example above the version `20210729` corresponds to July 29, 2021. ### 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. ### API version changelog | Version | Changes | |---|---| | `20210729` | <ul><li>Changed the [create approval request](/tag/Approvals#operation/postApprovalRequest) return value. It now returns HTTP Status Code `201` instead of `200`.</li><li> Changed the [get users](/tag/Users#operation/getUser) return value. It now returns a user record, not a user. </li><li> Added additional optional fields to environment, segments, flags, members, and segments, including the ability to create Big Segments. </li><li> Added default values for flag variations when new environments are created. </li><li> Added filtering and pagination for getting flags and members, including `limit`, `number`, `filter`, and `sort` query parameters. </li><li> Added endpoints for expiring user targets for flags and segments, scheduled changes, access tokens, Relay Proxy configuration, integrations and subscriptions, and approvals. </li></ul> | | `20191212` | <ul><li>[List feature flags](/tag/Feature-flags#operation/getFeatureFlags) now defaults to sending summaries of feature flag configurations, equivalent to setting the query parameter `summary=true`. Summaries omit flag targeting rules and individual user targets from the payload. </li><li> Added endpoints for flags, flag status, projects, environments, users, audit logs, members, users, custom roles, segments, usage, streams, events, and data export. </li></ul> | | `20160426` | <ul><li>Initial versioning of API. Tokens created before versioning have their version set to this.</li></ul> |
5
5
 
6
6
  The version of the OpenAPI document: 2.0
7
7
  Contact: support@launchdarkly.com
@@ -21,30 +21,30 @@ module LaunchDarklyApi
21
21
  end
22
22
  # Copy feature flag
23
23
  # The includedActions and excludedActions define the parts of the flag configuration that are copied or not copied. By default, the entire flag configuration is copied. You can have either `includedActions` or `excludedActions` but not both. Valid `includedActions` and `excludedActions` include: - `updateOn` - `updatePrerequisites` - `updateTargets` - `updateRules` - `updateFallthrough` - `updateOffVariation` The `source` and `target` must be JSON objects if using curl, specifying the environment key and (optional) current flag configuration version in that environment. For example: ```json { \"key\": \"production\", \"currentVersion\": 3 } ``` If target is specified as above, the API will test to ensure that the current flag version in the `production` environment is `3`, and reject attempts to copy settings to `production` otherwise. You can use this to enforce optimistic locking on copy attempts.
24
- # @param proj_key [String] The project key.
25
- # @param feature_flag_key [String] The feature flag&#39;s key. The key identifies the flag in your code.
24
+ # @param project_key [String] The project key
25
+ # @param feature_flag_key [String] The feature flag key. The key identifies the flag in your code.
26
26
  # @param flag_copy_config_post [FlagCopyConfigPost]
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @return [FeatureFlag]
29
- def copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post, opts = {})
30
- data, _status_code, _headers = copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post, opts)
29
+ def copy_feature_flag(project_key, feature_flag_key, flag_copy_config_post, opts = {})
30
+ data, _status_code, _headers = copy_feature_flag_with_http_info(project_key, feature_flag_key, flag_copy_config_post, opts)
31
31
  data
32
32
  end
33
33
 
34
34
  # Copy feature flag
35
35
  # The includedActions and excludedActions define the parts of the flag configuration that are copied or not copied. By default, the entire flag configuration is copied. You can have either &#x60;includedActions&#x60; or &#x60;excludedActions&#x60; but not both. Valid &#x60;includedActions&#x60; and &#x60;excludedActions&#x60; include: - &#x60;updateOn&#x60; - &#x60;updatePrerequisites&#x60; - &#x60;updateTargets&#x60; - &#x60;updateRules&#x60; - &#x60;updateFallthrough&#x60; - &#x60;updateOffVariation&#x60; The &#x60;source&#x60; and &#x60;target&#x60; must be JSON objects if using curl, specifying the environment key and (optional) current flag configuration version in that environment. For example: &#x60;&#x60;&#x60;json { \&quot;key\&quot;: \&quot;production\&quot;, \&quot;currentVersion\&quot;: 3 } &#x60;&#x60;&#x60; If target is specified as above, the API will test to ensure that the current flag version in the &#x60;production&#x60; environment is &#x60;3&#x60;, and reject attempts to copy settings to &#x60;production&#x60; otherwise. You can use this to enforce optimistic locking on copy attempts.
36
- # @param proj_key [String] The project key.
37
- # @param feature_flag_key [String] The feature flag&#39;s key. The key identifies the flag in your code.
36
+ # @param project_key [String] The project key
37
+ # @param feature_flag_key [String] The feature flag key. The key identifies the flag in your code.
38
38
  # @param flag_copy_config_post [FlagCopyConfigPost]
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
41
- def copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post, opts = {})
41
+ def copy_feature_flag_with_http_info(project_key, feature_flag_key, flag_copy_config_post, opts = {})
42
42
  if @api_client.config.debugging
43
43
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.copy_feature_flag ...'
44
44
  end
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 FeatureFlagsApi.copy_feature_flag"
45
+ # verify the required parameter 'project_key' is set
46
+ if @api_client.config.client_side_validation && project_key.nil?
47
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.copy_feature_flag"
48
48
  end
49
49
  # verify the required parameter 'feature_flag_key' is set
50
50
  if @api_client.config.client_side_validation && feature_flag_key.nil?
@@ -55,7 +55,7 @@ module LaunchDarklyApi
55
55
  fail ArgumentError, "Missing the required parameter 'flag_copy_config_post' when calling FeatureFlagsApi.copy_feature_flag"
56
56
  end
57
57
  # resource path
58
- local_var_path = '/api/v2/flags/{projKey}/{featureFlagKey}/copy'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
58
+ local_var_path = '/api/v2/flags/{projectKey}/{featureFlagKey}/copy'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
59
59
 
60
60
  # query parameters
61
61
  query_params = opts[:query_params] || {}
@@ -101,35 +101,35 @@ module LaunchDarklyApi
101
101
 
102
102
  # Delete feature flag
103
103
  # Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
104
- # @param proj_key [String] The project key.
105
- # @param key [String] The feature flag&#39;s key. The key identifies the flag in your code.
104
+ # @param project_key [String] The project key
105
+ # @param feature_flag_key [String] The feature flag key. The key identifies the flag in your code.
106
106
  # @param [Hash] opts the optional parameters
107
107
  # @return [nil]
108
- def delete_feature_flag(proj_key, key, opts = {})
109
- delete_feature_flag_with_http_info(proj_key, key, opts)
108
+ def delete_feature_flag(project_key, feature_flag_key, opts = {})
109
+ delete_feature_flag_with_http_info(project_key, feature_flag_key, opts)
110
110
  nil
111
111
  end
112
112
 
113
113
  # Delete feature flag
114
114
  # Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
115
- # @param proj_key [String] The project key.
116
- # @param key [String] The feature flag&#39;s key. The key identifies the flag in your code.
115
+ # @param project_key [String] The project key
116
+ # @param feature_flag_key [String] The feature flag key. The key identifies the flag in your code.
117
117
  # @param [Hash] opts the optional parameters
118
118
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
119
- def delete_feature_flag_with_http_info(proj_key, key, opts = {})
119
+ def delete_feature_flag_with_http_info(project_key, feature_flag_key, opts = {})
120
120
  if @api_client.config.debugging
121
121
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.delete_feature_flag ...'
122
122
  end
123
- # verify the required parameter 'proj_key' is set
124
- if @api_client.config.client_side_validation && proj_key.nil?
125
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.delete_feature_flag"
123
+ # verify the required parameter 'project_key' is set
124
+ if @api_client.config.client_side_validation && project_key.nil?
125
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.delete_feature_flag"
126
126
  end
127
- # verify the required parameter 'key' is set
128
- if @api_client.config.client_side_validation && key.nil?
129
- fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.delete_feature_flag"
127
+ # verify the required parameter 'feature_flag_key' is set
128
+ if @api_client.config.client_side_validation && feature_flag_key.nil?
129
+ fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.delete_feature_flag"
130
130
  end
131
131
  # resource path
132
- local_var_path = '/api/v2/flags/{projKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
132
+ local_var_path = '/api/v2/flags/{projectKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
133
133
 
134
134
  # query parameters
135
135
  query_params = opts[:query_params] || {}
@@ -170,41 +170,41 @@ module LaunchDarklyApi
170
170
 
171
171
  # Get expiring user targets for feature flag
172
172
  # Get a list of user targets on a feature flag that are scheduled for removal.
173
- # @param proj_key [String] The project key.
174
- # @param env_key [String] The environment key.
175
- # @param flag_key [String] The feature flag key.
173
+ # @param project_key [String] The project key
174
+ # @param environment_key [String] The environment key
175
+ # @param feature_flag_key [String] The feature flag key
176
176
  # @param [Hash] opts the optional parameters
177
177
  # @return [ExpiringUserTargetGetResponse]
178
- def get_expiring_user_targets(proj_key, env_key, flag_key, opts = {})
179
- data, _status_code, _headers = get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, opts)
178
+ def get_expiring_user_targets(project_key, environment_key, feature_flag_key, opts = {})
179
+ data, _status_code, _headers = get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, opts)
180
180
  data
181
181
  end
182
182
 
183
183
  # Get expiring user targets for feature flag
184
184
  # Get a list of user targets on a feature flag that are scheduled for removal.
185
- # @param proj_key [String] The project key.
186
- # @param env_key [String] The environment key.
187
- # @param flag_key [String] The feature flag key.
185
+ # @param project_key [String] The project key
186
+ # @param environment_key [String] The environment key
187
+ # @param feature_flag_key [String] The feature flag key
188
188
  # @param [Hash] opts the optional parameters
189
189
  # @return [Array<(ExpiringUserTargetGetResponse, Integer, Hash)>] ExpiringUserTargetGetResponse data, response status code and response headers
190
- def get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, opts = {})
190
+ def get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, opts = {})
191
191
  if @api_client.config.debugging
192
192
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_expiring_user_targets ...'
193
193
  end
194
- # verify the required parameter 'proj_key' is set
195
- if @api_client.config.client_side_validation && proj_key.nil?
196
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_expiring_user_targets"
194
+ # verify the required parameter 'project_key' is set
195
+ if @api_client.config.client_side_validation && project_key.nil?
196
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_expiring_user_targets"
197
197
  end
198
- # verify the required parameter 'env_key' is set
199
- if @api_client.config.client_side_validation && env_key.nil?
200
- fail ArgumentError, "Missing the required parameter 'env_key' when calling FeatureFlagsApi.get_expiring_user_targets"
198
+ # verify the required parameter 'environment_key' is set
199
+ if @api_client.config.client_side_validation && environment_key.nil?
200
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_expiring_user_targets"
201
201
  end
202
- # verify the required parameter 'flag_key' is set
203
- if @api_client.config.client_side_validation && flag_key.nil?
204
- fail ArgumentError, "Missing the required parameter 'flag_key' when calling FeatureFlagsApi.get_expiring_user_targets"
202
+ # verify the required parameter 'feature_flag_key' is set
203
+ if @api_client.config.client_side_validation && feature_flag_key.nil?
204
+ fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_expiring_user_targets"
205
205
  end
206
206
  # resource path
207
- local_var_path = '/api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_key.to_s))
207
+ local_var_path = '/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
208
208
 
209
209
  # query parameters
210
210
  query_params = opts[:query_params] || {}
@@ -245,37 +245,37 @@ module LaunchDarklyApi
245
245
 
246
246
  # Get feature flag
247
247
  # Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment.
248
- # @param proj_key [String] The project key
249
- # @param key [String] The feature flag key
248
+ # @param project_key [String] The project key
249
+ # @param feature_flag_key [String] The feature flag key
250
250
  # @param [Hash] opts the optional parameters
251
251
  # @option opts [String] :env Filter configurations by environment
252
252
  # @return [FeatureFlag]
253
- def get_feature_flag(proj_key, key, opts = {})
254
- data, _status_code, _headers = get_feature_flag_with_http_info(proj_key, key, opts)
253
+ def get_feature_flag(project_key, feature_flag_key, opts = {})
254
+ data, _status_code, _headers = get_feature_flag_with_http_info(project_key, feature_flag_key, opts)
255
255
  data
256
256
  end
257
257
 
258
258
  # Get feature flag
259
259
  # Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the &#x60;env&#x60; query parameter. For example, setting &#x60;env&#x3D;production&#x60; restricts the returned configurations to just the &#x60;production&#x60; environment.
260
- # @param proj_key [String] The project key
261
- # @param key [String] The feature flag key
260
+ # @param project_key [String] The project key
261
+ # @param feature_flag_key [String] The feature flag key
262
262
  # @param [Hash] opts the optional parameters
263
263
  # @option opts [String] :env Filter configurations by environment
264
264
  # @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
265
- def get_feature_flag_with_http_info(proj_key, key, opts = {})
265
+ def get_feature_flag_with_http_info(project_key, feature_flag_key, opts = {})
266
266
  if @api_client.config.debugging
267
267
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flag ...'
268
268
  end
269
- # verify the required parameter 'proj_key' is set
270
- if @api_client.config.client_side_validation && proj_key.nil?
271
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flag"
269
+ # verify the required parameter 'project_key' is set
270
+ if @api_client.config.client_side_validation && project_key.nil?
271
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flag"
272
272
  end
273
- # verify the required parameter 'key' is set
274
- if @api_client.config.client_side_validation && key.nil?
275
- fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.get_feature_flag"
273
+ # verify the required parameter 'feature_flag_key' is set
274
+ if @api_client.config.client_side_validation && feature_flag_key.nil?
275
+ fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_feature_flag"
276
276
  end
277
277
  # resource path
278
- local_var_path = '/api/v2/flags/{projKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
278
+ local_var_path = '/api/v2/flags/{projectKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
279
279
 
280
280
  # query parameters
281
281
  query_params = opts[:query_params] || {}
@@ -317,41 +317,41 @@ module LaunchDarklyApi
317
317
 
318
318
  # Get feature flag status
319
319
  # Get the status for a particular feature flag.
320
- # @param proj_key [String] The project key
321
- # @param env_key [String] The environment key
322
- # @param key [String] The feature flag key
320
+ # @param project_key [String] The project key
321
+ # @param environment_key [String] The environment key
322
+ # @param feature_flag_key [String] The feature flag key
323
323
  # @param [Hash] opts the optional parameters
324
324
  # @return [FlagStatusRep]
325
- def get_feature_flag_status(proj_key, env_key, key, opts = {})
326
- data, _status_code, _headers = get_feature_flag_status_with_http_info(proj_key, env_key, key, opts)
325
+ def get_feature_flag_status(project_key, environment_key, feature_flag_key, opts = {})
326
+ data, _status_code, _headers = get_feature_flag_status_with_http_info(project_key, environment_key, feature_flag_key, opts)
327
327
  data
328
328
  end
329
329
 
330
330
  # Get feature flag status
331
331
  # Get the status for a particular feature flag.
332
- # @param proj_key [String] The project key
333
- # @param env_key [String] The environment key
334
- # @param key [String] The feature flag key
332
+ # @param project_key [String] The project key
333
+ # @param environment_key [String] The environment key
334
+ # @param feature_flag_key [String] The feature flag key
335
335
  # @param [Hash] opts the optional parameters
336
336
  # @return [Array<(FlagStatusRep, Integer, Hash)>] FlagStatusRep data, response status code and response headers
337
- def get_feature_flag_status_with_http_info(proj_key, env_key, key, opts = {})
337
+ def get_feature_flag_status_with_http_info(project_key, environment_key, feature_flag_key, opts = {})
338
338
  if @api_client.config.debugging
339
339
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flag_status ...'
340
340
  end
341
- # verify the required parameter 'proj_key' is set
342
- if @api_client.config.client_side_validation && proj_key.nil?
343
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flag_status"
341
+ # verify the required parameter 'project_key' is set
342
+ if @api_client.config.client_side_validation && project_key.nil?
343
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flag_status"
344
344
  end
345
- # verify the required parameter 'env_key' is set
346
- if @api_client.config.client_side_validation && env_key.nil?
347
- fail ArgumentError, "Missing the required parameter 'env_key' when calling FeatureFlagsApi.get_feature_flag_status"
345
+ # verify the required parameter 'environment_key' is set
346
+ if @api_client.config.client_side_validation && environment_key.nil?
347
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_feature_flag_status"
348
348
  end
349
- # verify the required parameter 'key' is set
350
- if @api_client.config.client_side_validation && key.nil?
351
- fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.get_feature_flag_status"
349
+ # verify the required parameter 'feature_flag_key' is set
350
+ if @api_client.config.client_side_validation && feature_flag_key.nil?
351
+ fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_feature_flag_status"
352
352
  end
353
353
  # resource path
354
- local_var_path = '/api/v2/flag-statuses/{projKey}/{envKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
354
+ local_var_path = '/api/v2/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
355
355
 
356
356
  # query parameters
357
357
  query_params = opts[:query_params] || {}
@@ -392,37 +392,37 @@ module LaunchDarklyApi
392
392
 
393
393
  # Get flag status across environments
394
394
  # Get the status for a particular feature flag across environments.
395
- # @param proj_key [String] The project key
396
- # @param key [String] The feature flag key
395
+ # @param project_key [String] The project key
396
+ # @param feature_flag_key [String] The feature flag key
397
397
  # @param [Hash] opts the optional parameters
398
398
  # @option opts [String] :env Optional environment filter
399
399
  # @return [FeatureFlagStatusAcrossEnvironments]
400
- def get_feature_flag_status_across_environments(proj_key, key, opts = {})
401
- data, _status_code, _headers = get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts)
400
+ def get_feature_flag_status_across_environments(project_key, feature_flag_key, opts = {})
401
+ data, _status_code, _headers = get_feature_flag_status_across_environments_with_http_info(project_key, feature_flag_key, opts)
402
402
  data
403
403
  end
404
404
 
405
405
  # Get flag status across environments
406
406
  # Get the status for a particular feature flag across environments.
407
- # @param proj_key [String] The project key
408
- # @param key [String] The feature flag key
407
+ # @param project_key [String] The project key
408
+ # @param feature_flag_key [String] The feature flag key
409
409
  # @param [Hash] opts the optional parameters
410
410
  # @option opts [String] :env Optional environment filter
411
411
  # @return [Array<(FeatureFlagStatusAcrossEnvironments, Integer, Hash)>] FeatureFlagStatusAcrossEnvironments data, response status code and response headers
412
- def get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts = {})
412
+ def get_feature_flag_status_across_environments_with_http_info(project_key, feature_flag_key, opts = {})
413
413
  if @api_client.config.debugging
414
414
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flag_status_across_environments ...'
415
415
  end
416
- # verify the required parameter 'proj_key' is set
417
- if @api_client.config.client_side_validation && proj_key.nil?
418
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flag_status_across_environments"
416
+ # verify the required parameter 'project_key' is set
417
+ if @api_client.config.client_side_validation && project_key.nil?
418
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flag_status_across_environments"
419
419
  end
420
- # verify the required parameter 'key' is set
421
- if @api_client.config.client_side_validation && key.nil?
422
- fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.get_feature_flag_status_across_environments"
420
+ # verify the required parameter 'feature_flag_key' is set
421
+ if @api_client.config.client_side_validation && feature_flag_key.nil?
422
+ fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_feature_flag_status_across_environments"
423
423
  end
424
424
  # resource path
425
- local_var_path = '/api/v2/flag-status/{projKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
425
+ local_var_path = '/api/v2/flag-status/{projectKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
426
426
 
427
427
  # query parameters
428
428
  query_params = opts[:query_params] || {}
@@ -464,35 +464,35 @@ module LaunchDarklyApi
464
464
 
465
465
  # List feature flag statuses
466
466
  # Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - `new`: the feature flag was created within the last seven days, and has not been requested yet - `active`: the feature flag was requested by your servers or clients within the last seven days - `inactive`: the feature flag was created more than seven days ago, and hasn't been requested by your servers or clients within the past seven days - `launched`: one variation of the feature flag has been rolled out to all your users for at least 7 days
467
- # @param proj_key [String] The project key
468
- # @param env_key [String] Filter configurations by environment
467
+ # @param project_key [String] The project key
468
+ # @param environment_key [String] The environment key
469
469
  # @param [Hash] opts the optional parameters
470
470
  # @return [FeatureFlagStatuses]
471
- def get_feature_flag_statuses(proj_key, env_key, opts = {})
472
- data, _status_code, _headers = get_feature_flag_statuses_with_http_info(proj_key, env_key, opts)
471
+ def get_feature_flag_statuses(project_key, environment_key, opts = {})
472
+ data, _status_code, _headers = get_feature_flag_statuses_with_http_info(project_key, environment_key, opts)
473
473
  data
474
474
  end
475
475
 
476
476
  # List feature flag statuses
477
477
  # Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - &#x60;new&#x60;: the feature flag was created within the last seven days, and has not been requested yet - &#x60;active&#x60;: the feature flag was requested by your servers or clients within the last seven days - &#x60;inactive&#x60;: the feature flag was created more than seven days ago, and hasn&#39;t been requested by your servers or clients within the past seven days - &#x60;launched&#x60;: one variation of the feature flag has been rolled out to all your users for at least 7 days
478
- # @param proj_key [String] The project key
479
- # @param env_key [String] Filter configurations by environment
478
+ # @param project_key [String] The project key
479
+ # @param environment_key [String] The environment key
480
480
  # @param [Hash] opts the optional parameters
481
481
  # @return [Array<(FeatureFlagStatuses, Integer, Hash)>] FeatureFlagStatuses data, response status code and response headers
482
- def get_feature_flag_statuses_with_http_info(proj_key, env_key, opts = {})
482
+ def get_feature_flag_statuses_with_http_info(project_key, environment_key, opts = {})
483
483
  if @api_client.config.debugging
484
484
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flag_statuses ...'
485
485
  end
486
- # verify the required parameter 'proj_key' is set
487
- if @api_client.config.client_side_validation && proj_key.nil?
488
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flag_statuses"
486
+ # verify the required parameter 'project_key' is set
487
+ if @api_client.config.client_side_validation && project_key.nil?
488
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flag_statuses"
489
489
  end
490
- # verify the required parameter 'env_key' is set
491
- if @api_client.config.client_side_validation && env_key.nil?
492
- fail ArgumentError, "Missing the required parameter 'env_key' when calling FeatureFlagsApi.get_feature_flag_statuses"
490
+ # verify the required parameter 'environment_key' is set
491
+ if @api_client.config.client_side_validation && environment_key.nil?
492
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_feature_flag_statuses"
493
493
  end
494
494
  # resource path
495
- local_var_path = '/api/v2/flag-statuses/{projKey}/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s))
495
+ local_var_path = '/api/v2/flag-statuses/{projectKey}/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s))
496
496
 
497
497
  # query parameters
498
498
  query_params = opts[:query_params] || {}
@@ -533,7 +533,7 @@ module LaunchDarklyApi
533
533
 
534
534
  # List feature flags
535
535
  # Get a list of all features in the given project. By default, each feature includes configurations for each environment. You can filter environments with the env query parameter. For example, setting `env=production` restricts the returned configurations to just your production environment. You can also filter feature flags by tag with the tag query parameter. We support the following fields for filters: - `query` is a string that matches against the flags' keys and names. It is not case sensitive. - `archived` is a boolean to filter the list to archived flags. When this is absent, only unarchived flags are returned. - `type` is a string allowing filtering to `temporary` or `permanent` flags. - `status` is a string allowing filtering to `new`, `inactive`, `active`, or `launched` flags in the specified environment. This filter also requires a `filterEnv` field to be set to a valid environment. For example: `filter=status:active,filterEnv:production`. - `tags` is a + separated list of tags. It filters the list to members who have all of the tags in the list. - `hasExperiment` is a boolean with values of true or false and returns any flags that have an attached metric. - `hasDataExport` is a boolean with values of true or false and returns any flags that are currently exporting data in the specified environment. This includes flags that are exporting data via Experimentation. This filter also requires a `filterEnv` field to be set to a valid environment key. e.g. `filter=hasExperiment:true,filterEnv:production` - `evaluated` is an object that contains a key of `after` and a value in Unix time in milliseconds. This returns all flags that have been evaluated since the time you specify in the environment provided. This filter also requires a `filterEnv` field to be set to a valid environment. For example: `filter=evaluated:{\"after\": 1590768455282},filterEnv:production`. - `filterEnv` is a string with the key of a valid environment. The filterEnv field is used for filters that are environment specific. If there are multiple environment specific filters you should only declare this parameter once. For example: `filter=evaluated:{\"after\": 1590768455282},filterEnv:production,status:active`. An example filter is `query:abc,tags:foo+bar`. This matches flags with the string `abc` in their key or name, ignoring case, which also have the tags `foo` and `bar`. By default, this returns all flags. You can page through the list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links will not be present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page.
536
- # @param proj_key [String] The project key
536
+ # @param project_key [String] The project key
537
537
  # @param [Hash] opts the optional parameters
538
538
  # @option opts [String] :env Filter configurations by environment
539
539
  # @option opts [String] :tag Filter feature flags by tag
@@ -543,15 +543,16 @@ module LaunchDarklyApi
543
543
  # @option opts [Boolean] :summary By default in API version &gt;&#x3D; 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary&#x3D;0 to include these fields for each flag returned
544
544
  # @option opts [String] :filter A comma-separated list of filters. Each filter is of the form field:value
545
545
  # @option opts [String] :sort A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
546
+ # @option opts [Boolean] :compare A boolean to filter results by only flags that have differences between environments
546
547
  # @return [FeatureFlags]
547
- def get_feature_flags(proj_key, opts = {})
548
- data, _status_code, _headers = get_feature_flags_with_http_info(proj_key, opts)
548
+ def get_feature_flags(project_key, opts = {})
549
+ data, _status_code, _headers = get_feature_flags_with_http_info(project_key, opts)
549
550
  data
550
551
  end
551
552
 
552
553
  # List feature flags
553
554
  # Get a list of all features in the given project. By default, each feature includes configurations for each environment. You can filter environments with the env query parameter. For example, setting &#x60;env&#x3D;production&#x60; restricts the returned configurations to just your production environment. You can also filter feature flags by tag with the tag query parameter. We support the following fields for filters: - &#x60;query&#x60; is a string that matches against the flags&#39; keys and names. It is not case sensitive. - &#x60;archived&#x60; is a boolean to filter the list to archived flags. When this is absent, only unarchived flags are returned. - &#x60;type&#x60; is a string allowing filtering to &#x60;temporary&#x60; or &#x60;permanent&#x60; flags. - &#x60;status&#x60; is a string allowing filtering to &#x60;new&#x60;, &#x60;inactive&#x60;, &#x60;active&#x60;, or &#x60;launched&#x60; flags in the specified environment. This filter also requires a &#x60;filterEnv&#x60; field to be set to a valid environment. For example: &#x60;filter&#x3D;status:active,filterEnv:production&#x60;. - &#x60;tags&#x60; is a + separated list of tags. It filters the list to members who have all of the tags in the list. - &#x60;hasExperiment&#x60; is a boolean with values of true or false and returns any flags that have an attached metric. - &#x60;hasDataExport&#x60; is a boolean with values of true or false and returns any flags that are currently exporting data in the specified environment. This includes flags that are exporting data via Experimentation. This filter also requires a &#x60;filterEnv&#x60; field to be set to a valid environment key. e.g. &#x60;filter&#x3D;hasExperiment:true,filterEnv:production&#x60; - &#x60;evaluated&#x60; is an object that contains a key of &#x60;after&#x60; and a value in Unix time in milliseconds. This returns all flags that have been evaluated since the time you specify in the environment provided. This filter also requires a &#x60;filterEnv&#x60; field to be set to a valid environment. For example: &#x60;filter&#x3D;evaluated:{\&quot;after\&quot;: 1590768455282},filterEnv:production&#x60;. - &#x60;filterEnv&#x60; is a string with the key of a valid environment. The filterEnv field is used for filters that are environment specific. If there are multiple environment specific filters you should only declare this parameter once. For example: &#x60;filter&#x3D;evaluated:{\&quot;after\&quot;: 1590768455282},filterEnv:production,status:active&#x60;. An example filter is &#x60;query:abc,tags:foo+bar&#x60;. This matches flags with the string &#x60;abc&#x60; in their key or name, ignoring case, which also have the tags &#x60;foo&#x60; and &#x60;bar&#x60;. By default, this returns all flags. You can page through the list with the &#x60;limit&#x60; parameter and by following the &#x60;first&#x60;, &#x60;prev&#x60;, &#x60;next&#x60;, and &#x60;last&#x60; links in the returned &#x60;_links&#x60; field. These links will not be present if the pages they refer to don&#39;t exist. For example, the &#x60;first&#x60; and &#x60;prev&#x60; links will be missing from the response on the first page.
554
- # @param proj_key [String] The project key
555
+ # @param project_key [String] The project key
555
556
  # @param [Hash] opts the optional parameters
556
557
  # @option opts [String] :env Filter configurations by environment
557
558
  # @option opts [String] :tag Filter feature flags by tag
@@ -561,17 +562,18 @@ module LaunchDarklyApi
561
562
  # @option opts [Boolean] :summary By default in API version &gt;&#x3D; 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary&#x3D;0 to include these fields for each flag returned
562
563
  # @option opts [String] :filter A comma-separated list of filters. Each filter is of the form field:value
563
564
  # @option opts [String] :sort A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
565
+ # @option opts [Boolean] :compare A boolean to filter results by only flags that have differences between environments
564
566
  # @return [Array<(FeatureFlags, Integer, Hash)>] FeatureFlags data, response status code and response headers
565
- def get_feature_flags_with_http_info(proj_key, opts = {})
567
+ def get_feature_flags_with_http_info(project_key, opts = {})
566
568
  if @api_client.config.debugging
567
569
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flags ...'
568
570
  end
569
- # verify the required parameter 'proj_key' is set
570
- if @api_client.config.client_side_validation && proj_key.nil?
571
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flags"
571
+ # verify the required parameter 'project_key' is set
572
+ if @api_client.config.client_side_validation && project_key.nil?
573
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flags"
572
574
  end
573
575
  # resource path
574
- local_var_path = '/api/v2/flags/{projKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s))
576
+ local_var_path = '/api/v2/flags/{projectKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
575
577
 
576
578
  # query parameters
577
579
  query_params = opts[:query_params] || {}
@@ -583,6 +585,7 @@ module LaunchDarklyApi
583
585
  query_params[:'summary'] = opts[:'summary'] if !opts[:'summary'].nil?
584
586
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
585
587
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
588
+ query_params[:'compare'] = opts[:'compare'] if !opts[:'compare'].nil?
586
589
 
587
590
  # header parameters
588
591
  header_params = opts[:header_params] || {}
@@ -620,47 +623,47 @@ module LaunchDarklyApi
620
623
 
621
624
  # Update expiring user targets on feature flag
622
625
  # Update the list of user targets on a feature flag that are scheduled for removal.
623
- # @param proj_key [String] The project key.
624
- # @param env_key [String] The environment key.
625
- # @param flag_key [String] The feature flag key.
626
+ # @param project_key [String] The project key
627
+ # @param environment_key [String] The environment key
628
+ # @param feature_flag_key [String] The feature flag key
626
629
  # @param patch_with_comment [PatchWithComment]
627
630
  # @param [Hash] opts the optional parameters
628
631
  # @return [ExpiringUserTargetPatchResponse]
629
- def patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment, opts = {})
630
- data, _status_code, _headers = patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment, opts)
632
+ def patch_expiring_user_targets(project_key, environment_key, feature_flag_key, patch_with_comment, opts = {})
633
+ data, _status_code, _headers = patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, patch_with_comment, opts)
631
634
  data
632
635
  end
633
636
 
634
637
  # Update expiring user targets on feature flag
635
638
  # Update the list of user targets on a feature flag that are scheduled for removal.
636
- # @param proj_key [String] The project key.
637
- # @param env_key [String] The environment key.
638
- # @param flag_key [String] The feature flag key.
639
+ # @param project_key [String] The project key
640
+ # @param environment_key [String] The environment key
641
+ # @param feature_flag_key [String] The feature flag key
639
642
  # @param patch_with_comment [PatchWithComment]
640
643
  # @param [Hash] opts the optional parameters
641
644
  # @return [Array<(ExpiringUserTargetPatchResponse, Integer, Hash)>] ExpiringUserTargetPatchResponse data, response status code and response headers
642
- def patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment, opts = {})
645
+ def patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, patch_with_comment, opts = {})
643
646
  if @api_client.config.debugging
644
647
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.patch_expiring_user_targets ...'
645
648
  end
646
- # verify the required parameter 'proj_key' is set
647
- if @api_client.config.client_side_validation && proj_key.nil?
648
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
649
+ # verify the required parameter 'project_key' is set
650
+ if @api_client.config.client_side_validation && project_key.nil?
651
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
649
652
  end
650
- # verify the required parameter 'env_key' is set
651
- if @api_client.config.client_side_validation && env_key.nil?
652
- fail ArgumentError, "Missing the required parameter 'env_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
653
+ # verify the required parameter 'environment_key' is set
654
+ if @api_client.config.client_side_validation && environment_key.nil?
655
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
653
656
  end
654
- # verify the required parameter 'flag_key' is set
655
- if @api_client.config.client_side_validation && flag_key.nil?
656
- fail ArgumentError, "Missing the required parameter 'flag_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
657
+ # verify the required parameter 'feature_flag_key' is set
658
+ if @api_client.config.client_side_validation && feature_flag_key.nil?
659
+ fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
657
660
  end
658
661
  # verify the required parameter 'patch_with_comment' is set
659
662
  if @api_client.config.client_side_validation && patch_with_comment.nil?
660
663
  fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling FeatureFlagsApi.patch_expiring_user_targets"
661
664
  end
662
665
  # resource path
663
- local_var_path = '/api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_key.to_s))
666
+ local_var_path = '/api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
664
667
 
665
668
  # query parameters
666
669
  query_params = opts[:query_params] || {}
@@ -705,42 +708,42 @@ module LaunchDarklyApi
705
708
  end
706
709
 
707
710
  # Update feature flag
708
- # Perform a partial update to a feature flag. ## Using JSON Patches on a feature flag When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: ```json { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ``` If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` ## Using semantic patches on a feature flag To use a [semantic patch](/reference#updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you will receive a `400` response because your semantic patch will be interpreted as a JSON patch. Use this header: ``` Content-Type: application/json; domain-model=launchdarkly.semanticpatch ``` The body of a semantic patch request takes the following three properties: 1. comment `string`: (Optional) A description of the update. 1. environmentKey `string`: (Required) The key of the LaunchDarkly environment. 1. instructions `array`: (Required) The action or list of actions to be performed by the update. Each update action in the list must be an object/hash table with a `kind` property, although depending on the action, other properties may be necessary. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, `removeUserTargets` does nothing when the targets have already been removed). They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn't correspond to a variation on the flag or a rule ID that doesn't belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions. ### Instructions #### `turnFlagOn` Sets the flag's targeting state to on. #### `turnFlagOff` Sets the flag's targeting state to off. #### `addUserTargets` Adds the user keys in `values` to the individual user targets for the variation specified by `variationId`. Returns an error if this causes the same user key to be targeted in multiple variations. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `removeUserTargets` Removes the user keys in `values` to the individual user targets for the variation specified by `variationId`. Does nothing if the user keys are not targeted. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `replaceUserTargets` Completely replaces the existing set of user targeting. All variations must be provided. Example: ```json { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"variation-1\", \"values\": [\"blah\", \"foo\", \"bar\"] }, { \"variationId\": \"variation-2\", \"values\": [\"abc\", \"def\"] } ] } ``` ##### Parameters - `targets`: a list of user targeting #### `clearUserTargets` Removes all individual user targets from the variation specified by `variationId` ##### Parameters - `variationId`: ID of a variation on the flag #### `addPrerequisite` Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag. ##### Parameters - `key`: flag key of another flag - `variationId`: ID of a variation of the flag with key `key` #### `removePrerequisite` Removes the prerequisite indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite #### `updatePrerequisite` Changes the prerequisite with flag key `key` to the variation indicated by `variationId`. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite - `variationId`: ID of a variation of the flag with key `key` #### `replacePrerequisites` Completely replaces the existing set of prerequisites for a given flag. Example: ```json { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"flag-key\", \"variationId\": \"variation-1\" }, { \"key\": \"another-flag\", \"variationId\": \"variation-2\" } ] } ``` ##### Parameters - `prerequisites`: a list of prerequisites #### `addRule` Adds a new rule to the flag with the given `clauses` which serves the variation indicated by `variationId` or the percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. If `beforeRuleId` is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list. ##### Parameters - `clauses`: Array of clauses (see `addClauses`) - `beforeRuleId`: Optional ID of a rule in the flag - `variationId`: ID of a variation of the flag - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `removeRule` Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag #### `replaceRules` Completely replaces the existing rules for a given flag. Example: ```json { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"variation-1\", \"description\": \"myRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ``` ##### Parameters - `rules`: a list of rules #### `addClauses` Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauses`: Array of clause objects, with `attribute` (string), `op` (string), and `values` (array of strings, numbers, or dates) properties. #### `removeClauses` Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. #### Parameters - `ruleId`: ID of a rule in the flag - `clauseIds`: Array of IDs of clauses in the rule #### `updateClause` Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `clause`: Clause object #### `addValuesToClause` Adds `values` to the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `values`: Array of strings #### `removeValuesFromClause` Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters `ruleId`: ID of a rule in the flag `clauseId`: ID of a clause in that rule `values`: Array of strings #### `reorderRules` Rearranges the rules to match the order given in `ruleIds`. Will return an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag #### `updateRuleVariationOrRollout` Updates what the rule indicated by `ruleId` serves if its clauses evaluate to true. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters - `ruleId`: ID of a rule in the flag - `variationId`: ID of a variation of the flag or - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `updateFallthroughVariationOrRollout` Updates the flag's fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters `variationId`: ID of a variation of the flag or `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) `rolloutBucketBy`: Optional user attribute #### `updateOffVariation` Updates the variation served when the flag's targeting is off to the variation indicated by `variationId`. ##### Parameters `variationId`: ID of a variation of the flag ### Example ```json { \"environmentKey\": \"production\", \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"turnFlagOff\" }, { \"kind\": \"addUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId\", \"userId2\"] }, { \"kind\": \"removeUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId3\", \"userId4\"] }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": null }, { \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } ], \"variationId\": null, \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": \"key\" }, { \"kind\": \"removeRule\", \"ruleId\": \"99f12464-a429-40fc-86cc-b27612188955\" }, { \"kind\": \"reorderRules\", \"ruleIds\": [\"2f72974e-de68-4243-8dd3-739582147a1f\", \"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"addClauses\", \"ruleId\": \"1134\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"in\", \"negate\": false, \"values\": [\"test@test.com\"] } ] }, { \"kind\": \"removeClauses\", \"ruleId\": \"1242529\", \"clauseIds\": [\"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"updateClause\", \"ruleId\": \"2f72974e-de68-4243-8dd3-739582147a1f\", \"clauseId\": \"309845\", \"clause\": { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } }, { \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"2342\", \"rolloutWeights\": null, \"rolloutBucketBy\": null }, { \"kind\": \"updateOffVariation\", \"variationId\": \"3242453\" }, { \"kind\": \"addPrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"updatePrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"removePrerequisite\", \"key\": \"flagKey\" } ] } ``` ## Using JSON patches on a feature flag If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch).
709
- # @param proj_key [String] The project key.
710
- # @param key [String] The feature flag&#39;s key. The key identifies the flag in your code.
711
+ # Perform a partial update to a feature flag. ## Using semantic patches on a feature flag To use a [semantic patch](/reference#updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you will receive a `400` response because your semantic patch will be interpreted as a JSON patch. Use this header: ``` Content-Type: application/json; domain-model=launchdarkly.semanticpatch ``` The body of a semantic patch request takes the following three properties: 1. `comment` (string): (Optional) A description of the update. 1. `environmentKey` (string): (Required) The key of the LaunchDarkly environment. 1. `instructions` (array): (Required) The list of actions to be performed by the update. Each action in the list must be an object/hash table with a `kind` property that indicates the instruction. Depending on the `kind`, the API may require other parameters. When this is the case, add the parameters as additional fields to the instruction object. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, `removeUserTargets` does nothing when the targets have already been removed. They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn't correspond to a variation on the flag or a rule ID that doesn't belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions. ### Instructions #### `turnFlagOn` Sets the flag's targeting state to on. For example, to flip a flag on, use this request body: ```json { \"environmentKey\": \"example-environment-key\", \"instructions\": [ { \"kind\": \"turnFlagOn\" } ] } ``` #### `turnFlagOff` Sets the flag's targeting state to off. For example, to flip a flag off, use this request body: ```json { \"environmentKey\": \"example-environment-key\", \"instructions\": [ { \"kind\": \"turnFlagOff\" } ] } ``` #### `addUserTargets` Adds the user keys in `values` to the individual user targets for the variation specified by `variationId`. Returns an error if this causes the same user key to be targeted in multiple variations. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `removeUserTargets` Removes the user keys in `values` to the individual user targets for the variation specified by `variationId`. Does nothing if the user keys are not targeted. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `replaceUserTargets` Completely replaces the existing set of user targeting. All variations must be provided. Example: ```json { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"variation-1\", \"values\": [\"blah\", \"foo\", \"bar\"] }, { \"variationId\": \"variation-2\", \"values\": [\"abc\", \"def\"] } ] } ``` ##### Parameters - `targets`: a list of user targeting #### `clearUserTargets` Removes all individual user targets from the variation specified by `variationId` ##### Parameters - `variationId`: ID of a variation on the flag #### `addPrerequisite` Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag. ##### Parameters - `key`: flag key of another flag - `variationId`: ID of a variation of the flag with key `key` #### `removePrerequisite` Removes the prerequisite indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite #### `updatePrerequisite` Changes the prerequisite with flag key `key` to the variation indicated by `variationId`. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite - `variationId`: ID of a variation of the flag with key `key` #### `replacePrerequisites` Completely replaces the existing set of prerequisites for a given flag. Example: ```json { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"flag-key\", \"variationId\": \"variation-1\" }, { \"key\": \"another-flag\", \"variationId\": \"variation-2\" } ] } ``` ##### Parameters - `prerequisites`: a list of prerequisites #### `addRule` Adds a new rule to the flag with the given `clauses` which serves the variation indicated by `variationId` or the percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. If `beforeRuleId` is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list. ##### Parameters - `clauses`: Array of clauses (see `addClauses`) - `beforeRuleId`: Optional ID of a rule in the flag - `variationId`: ID of a variation of the flag - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `removeRule` Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag #### `replaceRules` Completely replaces the existing rules for a given flag. Example: ```json { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"variation-1\", \"description\": \"myRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ``` ##### Parameters - `rules`: a list of rules #### `addClauses` Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauses`: Array of clause objects, with `attribute` (string), `op` (string), and `values` (array of strings, numbers, or dates) properties. #### `removeClauses` Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. #### Parameters - `ruleId`: ID of a rule in the flag - `clauseIds`: Array of IDs of clauses in the rule #### `updateClause` Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `clause`: Clause object #### `addValuesToClause` Adds `values` to the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `values`: Array of strings #### `removeValuesFromClause` Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters `ruleId`: ID of a rule in the flag `clauseId`: ID of a clause in that rule `values`: Array of strings #### `reorderRules` Rearranges the rules to match the order given in `ruleIds`. Will return an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag #### `updateRuleVariationOrRollout` Updates what the rule indicated by `ruleId` serves if its clauses evaluate to true. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters - `ruleId`: ID of a rule in the flag - `variationId`: ID of a variation of the flag or - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `updateFallthroughVariationOrRollout` Updates the flag's fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters `variationId`: ID of a variation of the flag or `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) `rolloutBucketBy`: Optional user attribute #### `updateOffVariation` Updates the variation served when the flag's targeting is off to the variation indicated by `variationId`. ##### Parameters `variationId`: ID of a variation of the flag ### Example ```json { \"environmentKey\": \"production\", \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"turnFlagOff\" }, { \"kind\": \"addUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId\", \"userId2\"] }, { \"kind\": \"removeUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId3\", \"userId4\"] }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": null }, { \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } ], \"variationId\": null, \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": \"key\" }, { \"kind\": \"removeRule\", \"ruleId\": \"99f12464-a429-40fc-86cc-b27612188955\" }, { \"kind\": \"reorderRules\", \"ruleIds\": [\"2f72974e-de68-4243-8dd3-739582147a1f\", \"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"addClauses\", \"ruleId\": \"1134\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"in\", \"negate\": false, \"values\": [\"test@test.com\"] } ] }, { \"kind\": \"removeClauses\", \"ruleId\": \"1242529\", \"clauseIds\": [\"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"updateClause\", \"ruleId\": \"2f72974e-de68-4243-8dd3-739582147a1f\", \"clauseId\": \"309845\", \"clause\": { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } }, { \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"2342\", \"rolloutWeights\": null, \"rolloutBucketBy\": null }, { \"kind\": \"updateOffVariation\", \"variationId\": \"3242453\" }, { \"kind\": \"addPrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"updatePrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"removePrerequisite\", \"key\": \"flagKey\" } ] } ``` ## Using JSON Patches on a feature flag If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch). When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: ```json { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ``` If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` ## Required approvals If a request attempts to alter a flag configuration in an environment where approvals are required for the flag, the request will fail with a 405. Changes to the flag configuration in that environment will required creating an [approval request](/tag/Approvals) or a [workflow](/tag/Workflows-(beta)). ## Conflicts If a flag configuration change made through this endpoint would cause a pending scheduled change or approval request to fail, this endpoint will return a 400. You can ignore this check by adding an `ignoreConflicts` query parameter set to `true`.
712
+ # @param project_key [String] The project key
713
+ # @param feature_flag_key [String] The feature flag key. The key identifies the flag in your code.
711
714
  # @param patch_with_comment [PatchWithComment]
712
715
  # @param [Hash] opts the optional parameters
713
716
  # @return [FeatureFlag]
714
- def patch_feature_flag(proj_key, key, patch_with_comment, opts = {})
715
- data, _status_code, _headers = patch_feature_flag_with_http_info(proj_key, key, patch_with_comment, opts)
717
+ def patch_feature_flag(project_key, feature_flag_key, patch_with_comment, opts = {})
718
+ data, _status_code, _headers = patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_with_comment, opts)
716
719
  data
717
720
  end
718
721
 
719
722
  # Update feature flag
720
- # Perform a partial update to a feature flag. ## Using JSON Patches on a feature flag When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: &#x60;&#x60;&#x60;json { \&quot;op\&quot;: \&quot;add\&quot;, \&quot;path\&quot;: \&quot;/environments/devint/targets/0/values/-\&quot;, \&quot;value\&quot;: \&quot;TestClient10\&quot; } &#x60;&#x60;&#x60; If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: &#x60;&#x60;&#x60;json [ { \&quot;op\&quot;: \&quot;add\&quot;, \&quot;path\&quot;: \&quot;/environments/devint/targets/-\&quot;, \&quot;value\&quot;: { \&quot;variation\&quot;: 0, \&quot;values\&quot;: [\&quot;TestClient10\&quot;] } } ] &#x60;&#x60;&#x60; ## Using semantic patches on a feature flag To use a [semantic patch](/reference#updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you will receive a &#x60;400&#x60; response because your semantic patch will be interpreted as a JSON patch. Use this header: &#x60;&#x60;&#x60; Content-Type: application/json; domain-model&#x3D;launchdarkly.semanticpatch &#x60;&#x60;&#x60; The body of a semantic patch request takes the following three properties: 1. comment &#x60;string&#x60;: (Optional) A description of the update. 1. environmentKey &#x60;string&#x60;: (Required) The key of the LaunchDarkly environment. 1. instructions &#x60;array&#x60;: (Required) The action or list of actions to be performed by the update. Each update action in the list must be an object/hash table with a &#x60;kind&#x60; property, although depending on the action, other properties may be necessary. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, &#x60;removeUserTargets&#x60; does nothing when the targets have already been removed). They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn&#39;t correspond to a variation on the flag or a rule ID that doesn&#39;t belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions. ### Instructions #### &#x60;turnFlagOn&#x60; Sets the flag&#39;s targeting state to on. #### &#x60;turnFlagOff&#x60; Sets the flag&#39;s targeting state to off. #### &#x60;addUserTargets&#x60; Adds the user keys in &#x60;values&#x60; to the individual user targets for the variation specified by &#x60;variationId&#x60;. Returns an error if this causes the same user key to be targeted in multiple variations. ##### Parameters - &#x60;values&#x60;: list of user keys - &#x60;variationId&#x60;: ID of a variation on the flag #### &#x60;removeUserTargets&#x60; Removes the user keys in &#x60;values&#x60; to the individual user targets for the variation specified by &#x60;variationId&#x60;. Does nothing if the user keys are not targeted. ##### Parameters - &#x60;values&#x60;: list of user keys - &#x60;variationId&#x60;: ID of a variation on the flag #### &#x60;replaceUserTargets&#x60; Completely replaces the existing set of user targeting. All variations must be provided. Example: &#x60;&#x60;&#x60;json { \&quot;kind\&quot;: \&quot;replaceUserTargets\&quot;, \&quot;targets\&quot;: [ { \&quot;variationId\&quot;: \&quot;variation-1\&quot;, \&quot;values\&quot;: [\&quot;blah\&quot;, \&quot;foo\&quot;, \&quot;bar\&quot;] }, { \&quot;variationId\&quot;: \&quot;variation-2\&quot;, \&quot;values\&quot;: [\&quot;abc\&quot;, \&quot;def\&quot;] } ] } &#x60;&#x60;&#x60; ##### Parameters - &#x60;targets&#x60;: a list of user targeting #### &#x60;clearUserTargets&#x60; Removes all individual user targets from the variation specified by &#x60;variationId&#x60; ##### Parameters - &#x60;variationId&#x60;: ID of a variation on the flag #### &#x60;addPrerequisite&#x60; Adds the flag indicated by &#x60;key&#x60; with variation &#x60;variationId&#x60; as a prerequisite to the flag. ##### Parameters - &#x60;key&#x60;: flag key of another flag - &#x60;variationId&#x60;: ID of a variation of the flag with key &#x60;key&#x60; #### &#x60;removePrerequisite&#x60; Removes the prerequisite indicated by &#x60;key&#x60;. Does nothing if this prerequisite does not exist. ##### Parameters - &#x60;key&#x60;: flag key of an existing prerequisite #### &#x60;updatePrerequisite&#x60; Changes the prerequisite with flag key &#x60;key&#x60; to the variation indicated by &#x60;variationId&#x60;. Returns an error if this prerequisite does not exist. ##### Parameters - &#x60;key&#x60;: flag key of an existing prerequisite - &#x60;variationId&#x60;: ID of a variation of the flag with key &#x60;key&#x60; #### &#x60;replacePrerequisites&#x60; Completely replaces the existing set of prerequisites for a given flag. Example: &#x60;&#x60;&#x60;json { \&quot;kind\&quot;: \&quot;replacePrerequisites\&quot;, \&quot;prerequisites\&quot;: [ { \&quot;key\&quot;: \&quot;flag-key\&quot;, \&quot;variationId\&quot;: \&quot;variation-1\&quot; }, { \&quot;key\&quot;: \&quot;another-flag\&quot;, \&quot;variationId\&quot;: \&quot;variation-2\&quot; } ] } &#x60;&#x60;&#x60; ##### Parameters - &#x60;prerequisites&#x60;: a list of prerequisites #### &#x60;addRule&#x60; Adds a new rule to the flag with the given &#x60;clauses&#x60; which serves the variation indicated by &#x60;variationId&#x60; or the percent rollout indicated by &#x60;rolloutWeights&#x60; and &#x60;rolloutBucketBy&#x60;. If &#x60;beforeRuleId&#x60; is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list. ##### Parameters - &#x60;clauses&#x60;: Array of clauses (see &#x60;addClauses&#x60;) - &#x60;beforeRuleId&#x60;: Optional ID of a rule in the flag - &#x60;variationId&#x60;: ID of a variation of the flag - &#x60;rolloutWeights&#x60;: Map of variationId to weight in thousandths of a percent (0-100000) - &#x60;rolloutBucketBy&#x60;: Optional user attribute #### &#x60;removeRule&#x60; Removes the targeting rule specified by &#x60;ruleId&#x60;. Does nothing if the rule does not exist. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag #### &#x60;replaceRules&#x60; Completely replaces the existing rules for a given flag. Example: &#x60;&#x60;&#x60;json { \&quot;kind\&quot;: \&quot;replaceRules\&quot;, \&quot;rules\&quot;: [ { \&quot;variationId\&quot;: \&quot;variation-1\&quot;, \&quot;description\&quot;: \&quot;myRule\&quot;, \&quot;clauses\&quot;: [ { \&quot;attribute\&quot;: \&quot;segmentMatch\&quot;, \&quot;op\&quot;: \&quot;segmentMatch\&quot;, \&quot;values\&quot;: [\&quot;test\&quot;] } ], \&quot;trackEvents\&quot;: true } ] } &#x60;&#x60;&#x60; ##### Parameters - &#x60;rules&#x60;: a list of rules #### &#x60;addClauses&#x60; Adds the given clauses to the rule indicated by &#x60;ruleId&#x60;. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;clauses&#x60;: Array of clause objects, with &#x60;attribute&#x60; (string), &#x60;op&#x60; (string), and &#x60;values&#x60; (array of strings, numbers, or dates) properties. #### &#x60;removeClauses&#x60; Removes the clauses specified by &#x60;clauseIds&#x60; from the rule indicated by &#x60;ruleId&#x60;. #### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;clauseIds&#x60;: Array of IDs of clauses in the rule #### &#x60;updateClause&#x60; Replaces the clause indicated by &#x60;ruleId&#x60; and &#x60;clauseId&#x60; with &#x60;clause&#x60;. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;clauseId&#x60;: ID of a clause in that rule - &#x60;clause&#x60;: Clause object #### &#x60;addValuesToClause&#x60; Adds &#x60;values&#x60; to the values of the clause indicated by &#x60;ruleId&#x60; and &#x60;clauseId&#x60;. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;clauseId&#x60;: ID of a clause in that rule - &#x60;values&#x60;: Array of strings #### &#x60;removeValuesFromClause&#x60; Removes &#x60;values&#x60; from the values of the clause indicated by &#x60;ruleId&#x60; and &#x60;clauseId&#x60;. ##### Parameters &#x60;ruleId&#x60;: ID of a rule in the flag &#x60;clauseId&#x60;: ID of a clause in that rule &#x60;values&#x60;: Array of strings #### &#x60;reorderRules&#x60; Rearranges the rules to match the order given in &#x60;ruleIds&#x60;. Will return an error if &#x60;ruleIds&#x60; does not match the current set of rules on the flag. ##### Parameters - &#x60;ruleIds&#x60;: Array of IDs of all rules in the flag #### &#x60;updateRuleVariationOrRollout&#x60; Updates what the rule indicated by &#x60;ruleId&#x60; serves if its clauses evaluate to true. Can either be a fixed variation indicated by &#x60;variationId&#x60; or a percent rollout indicated by &#x60;rolloutWeights&#x60; and &#x60;rolloutBucketBy&#x60;. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;variationId&#x60;: ID of a variation of the flag or - &#x60;rolloutWeights&#x60;: Map of variationId to weight in thousandths of a percent (0-100000) - &#x60;rolloutBucketBy&#x60;: Optional user attribute #### &#x60;updateFallthroughVariationOrRollout&#x60; Updates the flag&#39;s fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by &#x60;variationId&#x60; or a percent rollout indicated by &#x60;rolloutWeights&#x60; and &#x60;rolloutBucketBy&#x60;. ##### Parameters &#x60;variationId&#x60;: ID of a variation of the flag or &#x60;rolloutWeights&#x60;: Map of variationId to weight in thousandths of a percent (0-100000) &#x60;rolloutBucketBy&#x60;: Optional user attribute #### &#x60;updateOffVariation&#x60; Updates the variation served when the flag&#39;s targeting is off to the variation indicated by &#x60;variationId&#x60;. ##### Parameters &#x60;variationId&#x60;: ID of a variation of the flag ### Example &#x60;&#x60;&#x60;json { \&quot;environmentKey\&quot;: \&quot;production\&quot;, \&quot;instructions\&quot;: [ { \&quot;kind\&quot;: \&quot;turnFlagOn\&quot; }, { \&quot;kind\&quot;: \&quot;turnFlagOff\&quot; }, { \&quot;kind\&quot;: \&quot;addUserTargets\&quot;, \&quot;variationId\&quot;: \&quot;8bfb304e-d516-47e5-8727-e7f798e8992d\&quot;, \&quot;values\&quot;: [\&quot;userId\&quot;, \&quot;userId2\&quot;] }, { \&quot;kind\&quot;: \&quot;removeUserTargets\&quot;, \&quot;variationId\&quot;: \&quot;8bfb304e-d516-47e5-8727-e7f798e8992d\&quot;, \&quot;values\&quot;: [\&quot;userId3\&quot;, \&quot;userId4\&quot;] }, { \&quot;kind\&quot;: \&quot;updateFallthroughVariationOrRollout\&quot;, \&quot;rolloutWeights\&quot;: { \&quot;variationId\&quot;: 50000, \&quot;variationId2\&quot;: 50000 }, \&quot;rolloutBucketBy\&quot;: null }, { \&quot;kind\&quot;: \&quot;addRule\&quot;, \&quot;clauses\&quot;: [ { \&quot;attribute\&quot;: \&quot;segmentMatch\&quot;, \&quot;negate\&quot;: false, \&quot;values\&quot;: [\&quot;test-segment\&quot;] } ], \&quot;variationId\&quot;: null, \&quot;rolloutWeights\&quot;: { \&quot;variationId\&quot;: 50000, \&quot;variationId2\&quot;: 50000 }, \&quot;rolloutBucketBy\&quot;: \&quot;key\&quot; }, { \&quot;kind\&quot;: \&quot;removeRule\&quot;, \&quot;ruleId\&quot;: \&quot;99f12464-a429-40fc-86cc-b27612188955\&quot; }, { \&quot;kind\&quot;: \&quot;reorderRules\&quot;, \&quot;ruleIds\&quot;: [\&quot;2f72974e-de68-4243-8dd3-739582147a1f\&quot;, \&quot;8bfb304e-d516-47e5-8727-e7f798e8992d\&quot;] }, { \&quot;kind\&quot;: \&quot;addClauses\&quot;, \&quot;ruleId\&quot;: \&quot;1134\&quot;, \&quot;clauses\&quot;: [ { \&quot;attribute\&quot;: \&quot;email\&quot;, \&quot;op\&quot;: \&quot;in\&quot;, \&quot;negate\&quot;: false, \&quot;values\&quot;: [\&quot;test@test.com\&quot;] } ] }, { \&quot;kind\&quot;: \&quot;removeClauses\&quot;, \&quot;ruleId\&quot;: \&quot;1242529\&quot;, \&quot;clauseIds\&quot;: [\&quot;8bfb304e-d516-47e5-8727-e7f798e8992d\&quot;] }, { \&quot;kind\&quot;: \&quot;updateClause\&quot;, \&quot;ruleId\&quot;: \&quot;2f72974e-de68-4243-8dd3-739582147a1f\&quot;, \&quot;clauseId\&quot;: \&quot;309845\&quot;, \&quot;clause\&quot;: { \&quot;attribute\&quot;: \&quot;segmentMatch\&quot;, \&quot;negate\&quot;: false, \&quot;values\&quot;: [\&quot;test-segment\&quot;] } }, { \&quot;kind\&quot;: \&quot;updateRuleVariationOrRollout\&quot;, \&quot;ruleId\&quot;: \&quot;2342\&quot;, \&quot;rolloutWeights\&quot;: null, \&quot;rolloutBucketBy\&quot;: null }, { \&quot;kind\&quot;: \&quot;updateOffVariation\&quot;, \&quot;variationId\&quot;: \&quot;3242453\&quot; }, { \&quot;kind\&quot;: \&quot;addPrerequisite\&quot;, \&quot;variationId\&quot;: \&quot;234235\&quot;, \&quot;key\&quot;: \&quot;flagKey2\&quot; }, { \&quot;kind\&quot;: \&quot;updatePrerequisite\&quot;, \&quot;variationId\&quot;: \&quot;234235\&quot;, \&quot;key\&quot;: \&quot;flagKey2\&quot; }, { \&quot;kind\&quot;: \&quot;removePrerequisite\&quot;, \&quot;key\&quot;: \&quot;flagKey\&quot; } ] } &#x60;&#x60;&#x60; ## Using JSON patches on a feature flag If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch).
721
- # @param proj_key [String] The project key.
722
- # @param key [String] The feature flag&#39;s key. The key identifies the flag in your code.
723
+ # Perform a partial update to a feature flag. ## Using semantic patches on a feature flag To use a [semantic patch](/reference#updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you will receive a &#x60;400&#x60; response because your semantic patch will be interpreted as a JSON patch. Use this header: &#x60;&#x60;&#x60; Content-Type: application/json; domain-model&#x3D;launchdarkly.semanticpatch &#x60;&#x60;&#x60; The body of a semantic patch request takes the following three properties: 1. &#x60;comment&#x60; (string): (Optional) A description of the update. 1. &#x60;environmentKey&#x60; (string): (Required) The key of the LaunchDarkly environment. 1. &#x60;instructions&#x60; (array): (Required) The list of actions to be performed by the update. Each action in the list must be an object/hash table with a &#x60;kind&#x60; property that indicates the instruction. Depending on the &#x60;kind&#x60;, the API may require other parameters. When this is the case, add the parameters as additional fields to the instruction object. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, &#x60;removeUserTargets&#x60; does nothing when the targets have already been removed. They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn&#39;t correspond to a variation on the flag or a rule ID that doesn&#39;t belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions. ### Instructions #### &#x60;turnFlagOn&#x60; Sets the flag&#39;s targeting state to on. For example, to flip a flag on, use this request body: &#x60;&#x60;&#x60;json { \&quot;environmentKey\&quot;: \&quot;example-environment-key\&quot;, \&quot;instructions\&quot;: [ { \&quot;kind\&quot;: \&quot;turnFlagOn\&quot; } ] } &#x60;&#x60;&#x60; #### &#x60;turnFlagOff&#x60; Sets the flag&#39;s targeting state to off. For example, to flip a flag off, use this request body: &#x60;&#x60;&#x60;json { \&quot;environmentKey\&quot;: \&quot;example-environment-key\&quot;, \&quot;instructions\&quot;: [ { \&quot;kind\&quot;: \&quot;turnFlagOff\&quot; } ] } &#x60;&#x60;&#x60; #### &#x60;addUserTargets&#x60; Adds the user keys in &#x60;values&#x60; to the individual user targets for the variation specified by &#x60;variationId&#x60;. Returns an error if this causes the same user key to be targeted in multiple variations. ##### Parameters - &#x60;values&#x60;: list of user keys - &#x60;variationId&#x60;: ID of a variation on the flag #### &#x60;removeUserTargets&#x60; Removes the user keys in &#x60;values&#x60; to the individual user targets for the variation specified by &#x60;variationId&#x60;. Does nothing if the user keys are not targeted. ##### Parameters - &#x60;values&#x60;: list of user keys - &#x60;variationId&#x60;: ID of a variation on the flag #### &#x60;replaceUserTargets&#x60; Completely replaces the existing set of user targeting. All variations must be provided. Example: &#x60;&#x60;&#x60;json { \&quot;kind\&quot;: \&quot;replaceUserTargets\&quot;, \&quot;targets\&quot;: [ { \&quot;variationId\&quot;: \&quot;variation-1\&quot;, \&quot;values\&quot;: [\&quot;blah\&quot;, \&quot;foo\&quot;, \&quot;bar\&quot;] }, { \&quot;variationId\&quot;: \&quot;variation-2\&quot;, \&quot;values\&quot;: [\&quot;abc\&quot;, \&quot;def\&quot;] } ] } &#x60;&#x60;&#x60; ##### Parameters - &#x60;targets&#x60;: a list of user targeting #### &#x60;clearUserTargets&#x60; Removes all individual user targets from the variation specified by &#x60;variationId&#x60; ##### Parameters - &#x60;variationId&#x60;: ID of a variation on the flag #### &#x60;addPrerequisite&#x60; Adds the flag indicated by &#x60;key&#x60; with variation &#x60;variationId&#x60; as a prerequisite to the flag. ##### Parameters - &#x60;key&#x60;: flag key of another flag - &#x60;variationId&#x60;: ID of a variation of the flag with key &#x60;key&#x60; #### &#x60;removePrerequisite&#x60; Removes the prerequisite indicated by &#x60;key&#x60;. Does nothing if this prerequisite does not exist. ##### Parameters - &#x60;key&#x60;: flag key of an existing prerequisite #### &#x60;updatePrerequisite&#x60; Changes the prerequisite with flag key &#x60;key&#x60; to the variation indicated by &#x60;variationId&#x60;. Returns an error if this prerequisite does not exist. ##### Parameters - &#x60;key&#x60;: flag key of an existing prerequisite - &#x60;variationId&#x60;: ID of a variation of the flag with key &#x60;key&#x60; #### &#x60;replacePrerequisites&#x60; Completely replaces the existing set of prerequisites for a given flag. Example: &#x60;&#x60;&#x60;json { \&quot;kind\&quot;: \&quot;replacePrerequisites\&quot;, \&quot;prerequisites\&quot;: [ { \&quot;key\&quot;: \&quot;flag-key\&quot;, \&quot;variationId\&quot;: \&quot;variation-1\&quot; }, { \&quot;key\&quot;: \&quot;another-flag\&quot;, \&quot;variationId\&quot;: \&quot;variation-2\&quot; } ] } &#x60;&#x60;&#x60; ##### Parameters - &#x60;prerequisites&#x60;: a list of prerequisites #### &#x60;addRule&#x60; Adds a new rule to the flag with the given &#x60;clauses&#x60; which serves the variation indicated by &#x60;variationId&#x60; or the percent rollout indicated by &#x60;rolloutWeights&#x60; and &#x60;rolloutBucketBy&#x60;. If &#x60;beforeRuleId&#x60; is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list. ##### Parameters - &#x60;clauses&#x60;: Array of clauses (see &#x60;addClauses&#x60;) - &#x60;beforeRuleId&#x60;: Optional ID of a rule in the flag - &#x60;variationId&#x60;: ID of a variation of the flag - &#x60;rolloutWeights&#x60;: Map of variationId to weight in thousandths of a percent (0-100000) - &#x60;rolloutBucketBy&#x60;: Optional user attribute #### &#x60;removeRule&#x60; Removes the targeting rule specified by &#x60;ruleId&#x60;. Does nothing if the rule does not exist. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag #### &#x60;replaceRules&#x60; Completely replaces the existing rules for a given flag. Example: &#x60;&#x60;&#x60;json { \&quot;kind\&quot;: \&quot;replaceRules\&quot;, \&quot;rules\&quot;: [ { \&quot;variationId\&quot;: \&quot;variation-1\&quot;, \&quot;description\&quot;: \&quot;myRule\&quot;, \&quot;clauses\&quot;: [ { \&quot;attribute\&quot;: \&quot;segmentMatch\&quot;, \&quot;op\&quot;: \&quot;segmentMatch\&quot;, \&quot;values\&quot;: [\&quot;test\&quot;] } ], \&quot;trackEvents\&quot;: true } ] } &#x60;&#x60;&#x60; ##### Parameters - &#x60;rules&#x60;: a list of rules #### &#x60;addClauses&#x60; Adds the given clauses to the rule indicated by &#x60;ruleId&#x60;. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;clauses&#x60;: Array of clause objects, with &#x60;attribute&#x60; (string), &#x60;op&#x60; (string), and &#x60;values&#x60; (array of strings, numbers, or dates) properties. #### &#x60;removeClauses&#x60; Removes the clauses specified by &#x60;clauseIds&#x60; from the rule indicated by &#x60;ruleId&#x60;. #### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;clauseIds&#x60;: Array of IDs of clauses in the rule #### &#x60;updateClause&#x60; Replaces the clause indicated by &#x60;ruleId&#x60; and &#x60;clauseId&#x60; with &#x60;clause&#x60;. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;clauseId&#x60;: ID of a clause in that rule - &#x60;clause&#x60;: Clause object #### &#x60;addValuesToClause&#x60; Adds &#x60;values&#x60; to the values of the clause indicated by &#x60;ruleId&#x60; and &#x60;clauseId&#x60;. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;clauseId&#x60;: ID of a clause in that rule - &#x60;values&#x60;: Array of strings #### &#x60;removeValuesFromClause&#x60; Removes &#x60;values&#x60; from the values of the clause indicated by &#x60;ruleId&#x60; and &#x60;clauseId&#x60;. ##### Parameters &#x60;ruleId&#x60;: ID of a rule in the flag &#x60;clauseId&#x60;: ID of a clause in that rule &#x60;values&#x60;: Array of strings #### &#x60;reorderRules&#x60; Rearranges the rules to match the order given in &#x60;ruleIds&#x60;. Will return an error if &#x60;ruleIds&#x60; does not match the current set of rules on the flag. ##### Parameters - &#x60;ruleIds&#x60;: Array of IDs of all rules in the flag #### &#x60;updateRuleVariationOrRollout&#x60; Updates what the rule indicated by &#x60;ruleId&#x60; serves if its clauses evaluate to true. Can either be a fixed variation indicated by &#x60;variationId&#x60; or a percent rollout indicated by &#x60;rolloutWeights&#x60; and &#x60;rolloutBucketBy&#x60;. ##### Parameters - &#x60;ruleId&#x60;: ID of a rule in the flag - &#x60;variationId&#x60;: ID of a variation of the flag or - &#x60;rolloutWeights&#x60;: Map of variationId to weight in thousandths of a percent (0-100000) - &#x60;rolloutBucketBy&#x60;: Optional user attribute #### &#x60;updateFallthroughVariationOrRollout&#x60; Updates the flag&#39;s fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by &#x60;variationId&#x60; or a percent rollout indicated by &#x60;rolloutWeights&#x60; and &#x60;rolloutBucketBy&#x60;. ##### Parameters &#x60;variationId&#x60;: ID of a variation of the flag or &#x60;rolloutWeights&#x60;: Map of variationId to weight in thousandths of a percent (0-100000) &#x60;rolloutBucketBy&#x60;: Optional user attribute #### &#x60;updateOffVariation&#x60; Updates the variation served when the flag&#39;s targeting is off to the variation indicated by &#x60;variationId&#x60;. ##### Parameters &#x60;variationId&#x60;: ID of a variation of the flag ### Example &#x60;&#x60;&#x60;json { \&quot;environmentKey\&quot;: \&quot;production\&quot;, \&quot;instructions\&quot;: [ { \&quot;kind\&quot;: \&quot;turnFlagOn\&quot; }, { \&quot;kind\&quot;: \&quot;turnFlagOff\&quot; }, { \&quot;kind\&quot;: \&quot;addUserTargets\&quot;, \&quot;variationId\&quot;: \&quot;8bfb304e-d516-47e5-8727-e7f798e8992d\&quot;, \&quot;values\&quot;: [\&quot;userId\&quot;, \&quot;userId2\&quot;] }, { \&quot;kind\&quot;: \&quot;removeUserTargets\&quot;, \&quot;variationId\&quot;: \&quot;8bfb304e-d516-47e5-8727-e7f798e8992d\&quot;, \&quot;values\&quot;: [\&quot;userId3\&quot;, \&quot;userId4\&quot;] }, { \&quot;kind\&quot;: \&quot;updateFallthroughVariationOrRollout\&quot;, \&quot;rolloutWeights\&quot;: { \&quot;variationId\&quot;: 50000, \&quot;variationId2\&quot;: 50000 }, \&quot;rolloutBucketBy\&quot;: null }, { \&quot;kind\&quot;: \&quot;addRule\&quot;, \&quot;clauses\&quot;: [ { \&quot;attribute\&quot;: \&quot;segmentMatch\&quot;, \&quot;negate\&quot;: false, \&quot;values\&quot;: [\&quot;test-segment\&quot;] } ], \&quot;variationId\&quot;: null, \&quot;rolloutWeights\&quot;: { \&quot;variationId\&quot;: 50000, \&quot;variationId2\&quot;: 50000 }, \&quot;rolloutBucketBy\&quot;: \&quot;key\&quot; }, { \&quot;kind\&quot;: \&quot;removeRule\&quot;, \&quot;ruleId\&quot;: \&quot;99f12464-a429-40fc-86cc-b27612188955\&quot; }, { \&quot;kind\&quot;: \&quot;reorderRules\&quot;, \&quot;ruleIds\&quot;: [\&quot;2f72974e-de68-4243-8dd3-739582147a1f\&quot;, \&quot;8bfb304e-d516-47e5-8727-e7f798e8992d\&quot;] }, { \&quot;kind\&quot;: \&quot;addClauses\&quot;, \&quot;ruleId\&quot;: \&quot;1134\&quot;, \&quot;clauses\&quot;: [ { \&quot;attribute\&quot;: \&quot;email\&quot;, \&quot;op\&quot;: \&quot;in\&quot;, \&quot;negate\&quot;: false, \&quot;values\&quot;: [\&quot;test@test.com\&quot;] } ] }, { \&quot;kind\&quot;: \&quot;removeClauses\&quot;, \&quot;ruleId\&quot;: \&quot;1242529\&quot;, \&quot;clauseIds\&quot;: [\&quot;8bfb304e-d516-47e5-8727-e7f798e8992d\&quot;] }, { \&quot;kind\&quot;: \&quot;updateClause\&quot;, \&quot;ruleId\&quot;: \&quot;2f72974e-de68-4243-8dd3-739582147a1f\&quot;, \&quot;clauseId\&quot;: \&quot;309845\&quot;, \&quot;clause\&quot;: { \&quot;attribute\&quot;: \&quot;segmentMatch\&quot;, \&quot;negate\&quot;: false, \&quot;values\&quot;: [\&quot;test-segment\&quot;] } }, { \&quot;kind\&quot;: \&quot;updateRuleVariationOrRollout\&quot;, \&quot;ruleId\&quot;: \&quot;2342\&quot;, \&quot;rolloutWeights\&quot;: null, \&quot;rolloutBucketBy\&quot;: null }, { \&quot;kind\&quot;: \&quot;updateOffVariation\&quot;, \&quot;variationId\&quot;: \&quot;3242453\&quot; }, { \&quot;kind\&quot;: \&quot;addPrerequisite\&quot;, \&quot;variationId\&quot;: \&quot;234235\&quot;, \&quot;key\&quot;: \&quot;flagKey2\&quot; }, { \&quot;kind\&quot;: \&quot;updatePrerequisite\&quot;, \&quot;variationId\&quot;: \&quot;234235\&quot;, \&quot;key\&quot;: \&quot;flagKey2\&quot; }, { \&quot;kind\&quot;: \&quot;removePrerequisite\&quot;, \&quot;key\&quot;: \&quot;flagKey\&quot; } ] } &#x60;&#x60;&#x60; ## Using JSON Patches on a feature flag If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch). When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: &#x60;&#x60;&#x60;json { \&quot;op\&quot;: \&quot;add\&quot;, \&quot;path\&quot;: \&quot;/environments/devint/targets/0/values/-\&quot;, \&quot;value\&quot;: \&quot;TestClient10\&quot; } &#x60;&#x60;&#x60; If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: &#x60;&#x60;&#x60;json [ { \&quot;op\&quot;: \&quot;add\&quot;, \&quot;path\&quot;: \&quot;/environments/devint/targets/-\&quot;, \&quot;value\&quot;: { \&quot;variation\&quot;: 0, \&quot;values\&quot;: [\&quot;TestClient10\&quot;] } } ] &#x60;&#x60;&#x60; ## Required approvals If a request attempts to alter a flag configuration in an environment where approvals are required for the flag, the request will fail with a 405. Changes to the flag configuration in that environment will required creating an [approval request](/tag/Approvals) or a [workflow](/tag/Workflows-(beta)). ## Conflicts If a flag configuration change made through this endpoint would cause a pending scheduled change or approval request to fail, this endpoint will return a 400. You can ignore this check by adding an &#x60;ignoreConflicts&#x60; query parameter set to &#x60;true&#x60;.
724
+ # @param project_key [String] The project key
725
+ # @param feature_flag_key [String] The feature flag key. The key identifies the flag in your code.
723
726
  # @param patch_with_comment [PatchWithComment]
724
727
  # @param [Hash] opts the optional parameters
725
728
  # @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
726
- def patch_feature_flag_with_http_info(proj_key, key, patch_with_comment, opts = {})
729
+ def patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_with_comment, opts = {})
727
730
  if @api_client.config.debugging
728
731
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.patch_feature_flag ...'
729
732
  end
730
- # verify the required parameter 'proj_key' is set
731
- if @api_client.config.client_side_validation && proj_key.nil?
732
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.patch_feature_flag"
733
+ # verify the required parameter 'project_key' is set
734
+ if @api_client.config.client_side_validation && project_key.nil?
735
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.patch_feature_flag"
733
736
  end
734
- # verify the required parameter 'key' is set
735
- if @api_client.config.client_side_validation && key.nil?
736
- fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.patch_feature_flag"
737
+ # verify the required parameter 'feature_flag_key' is set
738
+ if @api_client.config.client_side_validation && feature_flag_key.nil?
739
+ fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.patch_feature_flag"
737
740
  end
738
741
  # verify the required parameter 'patch_with_comment' is set
739
742
  if @api_client.config.client_side_validation && patch_with_comment.nil?
740
743
  fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling FeatureFlagsApi.patch_feature_flag"
741
744
  end
742
745
  # resource path
743
- local_var_path = '/api/v2/flags/{projKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
746
+ local_var_path = '/api/v2/flags/{projectKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
744
747
 
745
748
  # query parameters
746
749
  query_params = opts[:query_params] || {}
@@ -786,37 +789,37 @@ module LaunchDarklyApi
786
789
 
787
790
  # Create a feature flag
788
791
  # Create a feature flag with the given name, key, and variations
789
- # @param proj_key [String] The project key.
792
+ # @param project_key [String] The project key
790
793
  # @param feature_flag_body [FeatureFlagBody]
791
794
  # @param [Hash] opts the optional parameters
792
795
  # @option opts [String] :clone The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting &#x60;clone&#x3D;flagKey&#x60; copies the full targeting configuration for all environments, including &#x60;on/off&#x60; state, from the original flag to the new flag.
793
796
  # @return [FeatureFlag]
794
- def post_feature_flag(proj_key, feature_flag_body, opts = {})
795
- data, _status_code, _headers = post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
797
+ def post_feature_flag(project_key, feature_flag_body, opts = {})
798
+ data, _status_code, _headers = post_feature_flag_with_http_info(project_key, feature_flag_body, opts)
796
799
  data
797
800
  end
798
801
 
799
802
  # Create a feature flag
800
803
  # Create a feature flag with the given name, key, and variations
801
- # @param proj_key [String] The project key.
804
+ # @param project_key [String] The project key
802
805
  # @param feature_flag_body [FeatureFlagBody]
803
806
  # @param [Hash] opts the optional parameters
804
807
  # @option opts [String] :clone The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting &#x60;clone&#x3D;flagKey&#x60; copies the full targeting configuration for all environments, including &#x60;on/off&#x60; state, from the original flag to the new flag.
805
808
  # @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
806
- def post_feature_flag_with_http_info(proj_key, feature_flag_body, opts = {})
809
+ def post_feature_flag_with_http_info(project_key, feature_flag_body, opts = {})
807
810
  if @api_client.config.debugging
808
811
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.post_feature_flag ...'
809
812
  end
810
- # verify the required parameter 'proj_key' is set
811
- if @api_client.config.client_side_validation && proj_key.nil?
812
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.post_feature_flag"
813
+ # verify the required parameter 'project_key' is set
814
+ if @api_client.config.client_side_validation && project_key.nil?
815
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.post_feature_flag"
813
816
  end
814
817
  # verify the required parameter 'feature_flag_body' is set
815
818
  if @api_client.config.client_side_validation && feature_flag_body.nil?
816
819
  fail ArgumentError, "Missing the required parameter 'feature_flag_body' when calling FeatureFlagsApi.post_feature_flag"
817
820
  end
818
821
  # resource path
819
- local_var_path = '/api/v2/flags/{projKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s))
822
+ local_var_path = '/api/v2/flags/{projectKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
820
823
 
821
824
  # query parameters
822
825
  query_params = opts[:query_params] || {}