launchdarkly_api 7.0.0 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (651) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +142 -64
  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 +76 -2
  10. data/docs/AccountUsageBetaApi.md +11 -11
  11. data/docs/ApprovalsApi.md +14 -14
  12. data/docs/CodeReferencesApi.md +13 -9
  13. data/docs/ConditionInputRep.md +6 -0
  14. data/docs/ConditionOutputRep.md +6 -0
  15. data/docs/CustomRole.md +1 -1
  16. data/docs/CustomRolesApi.md +24 -24
  17. data/docs/DataExportDestinationsApi.md +37 -37
  18. data/docs/Destination.md +1 -1
  19. data/docs/EnvironmentPost.md +6 -4
  20. data/docs/EnvironmentsApi.md +16 -16
  21. data/docs/ExperimentsBetaApi.md +22 -22
  22. data/docs/Export.md +32 -0
  23. data/docs/FeatureFlag.md +1 -1
  24. data/docs/FeatureFlagBody.md +1 -1
  25. data/docs/FeatureFlagConfig.md +1 -1
  26. data/docs/FeatureFlags.md +3 -1
  27. data/docs/FeatureFlagsApi.md +107 -107
  28. data/docs/FeatureFlagsBetaApi.md +20 -20
  29. data/docs/FileRep.md +20 -0
  30. data/docs/FlagGlobalAttributesRep.md +1 -1
  31. data/docs/FlagLinkCollectionRep.md +20 -0
  32. data/docs/FlagLinkMember.md +24 -0
  33. data/docs/FlagLinkPost.md +30 -0
  34. data/docs/FlagLinkRep.md +38 -0
  35. data/docs/FlagLinksBetaApi.md +310 -0
  36. data/docs/FlagTriggerInput.md +20 -0
  37. data/docs/FlagTriggersApi.md +396 -0
  38. data/docs/Import.md +30 -0
  39. data/docs/InitiatorRep.md +20 -0
  40. data/docs/Integration.md +40 -0
  41. data/docs/IntegrationAuditLogSubscriptionsApi.md +376 -0
  42. data/docs/IntegrationDeliveryConfiguration.md +38 -0
  43. data/docs/IntegrationDeliveryConfigurationCollection.md +20 -0
  44. data/docs/IntegrationDeliveryConfigurationCollectionLinks.md +20 -0
  45. data/docs/IntegrationDeliveryConfigurationLinks.md +24 -0
  46. data/docs/IntegrationDeliveryConfigurationPost.md +24 -0
  47. data/docs/IntegrationDeliveryConfigurationResponse.md +24 -0
  48. data/docs/IntegrationDeliveryConfigurationsBetaApi.md +541 -0
  49. data/docs/IntegrationStatusRep.md +22 -0
  50. data/docs/IntegrationSubscriptionStatusRep.md +26 -0
  51. data/docs/Integrations.md +22 -0
  52. data/docs/MemberImportItem.md +22 -0
  53. data/docs/{MemberSummaryRep.md → MemberSummary.md} +2 -2
  54. data/docs/MemberTeamsPostInput.md +18 -0
  55. data/docs/MetricListingRep.md +3 -3
  56. data/docs/MetricPost.md +1 -1
  57. data/docs/MetricRep.md +3 -3
  58. data/docs/MetricSeen.md +2 -2
  59. data/docs/MetricsApi.md +23 -23
  60. data/docs/PatchOperation.md +2 -2
  61. data/docs/PermissionGrantInput.md +4 -4
  62. data/docs/ProjectSummary.md +22 -0
  63. data/docs/ProjectsApi.md +1 -1
  64. data/docs/PutBranch.md +3 -1
  65. data/docs/RecentTriggerBody.md +20 -0
  66. data/docs/RelayAutoConfigRep.md +2 -2
  67. data/docs/RelayProxyConfigurationsApi.md +1 -1
  68. data/docs/RepositoryRep.md +1 -1
  69. data/docs/ResolvedContext.md +18 -0
  70. data/docs/ResolvedImage.md +22 -0
  71. data/docs/ResolvedTitle.md +20 -0
  72. data/docs/ResolvedUIBlockElement.md +24 -0
  73. data/docs/ResolvedUIBlocks.md +26 -0
  74. data/docs/Rule.md +3 -1
  75. data/docs/ScheduleConditionInputRep.md +6 -0
  76. data/docs/ScheduleConditionOutputRep.md +7 -1
  77. data/docs/ScheduledChangesApi.md +11 -11
  78. data/docs/SegmentsApi.md +100 -100
  79. data/docs/SegmentsBetaApi.md +313 -0
  80. data/docs/SourceEnv.md +20 -0
  81. data/docs/Statement.md +2 -2
  82. data/docs/StatementPost.md +2 -2
  83. data/docs/StatementPostData.md +2 -2
  84. data/docs/SubscriptionPost.md +30 -0
  85. data/docs/TagCollection.md +22 -0
  86. data/docs/TagsApi.md +83 -0
  87. data/docs/Team.md +32 -0
  88. data/docs/TeamCustomRole.md +24 -0
  89. data/docs/TeamCustomRoles.md +22 -0
  90. data/docs/TeamImportsRep.md +18 -0
  91. data/docs/TeamMaintainers.md +22 -0
  92. data/docs/TeamProjects.md +20 -0
  93. data/docs/{TeamCollectionRep.md → Teams.md} +3 -3
  94. data/docs/TeamsBetaApi.md +265 -33
  95. data/docs/TimestampRep.md +24 -0
  96. data/docs/Token.md +1 -1
  97. data/docs/TriggerPost.md +22 -0
  98. data/docs/TriggerWorkflowCollectionRep.md +20 -0
  99. data/docs/TriggerWorkflowRep.md +42 -0
  100. data/docs/User.md +0 -2
  101. data/docs/UserRecord.md +1 -1
  102. data/docs/UserSegment.md +1 -1
  103. data/docs/UserSettingsApi.md +60 -60
  104. data/docs/UsersApi.md +41 -41
  105. data/docs/Webhook.md +1 -1
  106. data/docs/WebhooksApi.md +1 -1
  107. data/docs/WorkflowsBetaApi.md +8 -8
  108. data/launchdarkly_api.gemspec +2 -2
  109. data/lib/launchdarkly_api/api/access_tokens_api.rb +1 -1
  110. data/lib/launchdarkly_api/api/account_members_api.rb +77 -3
  111. data/lib/launchdarkly_api/api/account_usage_beta_api.rb +20 -20
  112. data/lib/launchdarkly_api/api/approvals_api.rb +15 -15
  113. data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
  114. data/lib/launchdarkly_api/api/code_references_api.rb +16 -10
  115. data/lib/launchdarkly_api/api/custom_roles_api.rb +30 -30
  116. data/lib/launchdarkly_api/api/data_export_destinations_api.rb +57 -57
  117. data/lib/launchdarkly_api/api/environments_api.rb +21 -21
  118. data/lib/launchdarkly_api/api/experiments_beta_api.rb +39 -39
  119. data/lib/launchdarkly_api/api/feature_flags_api.rb +162 -162
  120. data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +34 -34
  121. data/lib/launchdarkly_api/api/flag_links_beta_api.rb +332 -0
  122. data/lib/launchdarkly_api/api/flag_triggers_api.rb +437 -0
  123. data/lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb +377 -0
  124. data/lib/launchdarkly_api/api/integration_delivery_configurations_beta_api.rb +569 -0
  125. data/lib/launchdarkly_api/api/metrics_api.rb +30 -30
  126. data/lib/launchdarkly_api/api/other_api.rb +1 -1
  127. data/lib/launchdarkly_api/api/projects_api.rb +1 -1
  128. data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +1 -1
  129. data/lib/launchdarkly_api/api/scheduled_changes_api.rb +13 -13
  130. data/lib/launchdarkly_api/api/segments_api.rb +162 -162
  131. data/lib/launchdarkly_api/api/segments_beta_api.rb +334 -0
  132. data/lib/launchdarkly_api/api/tags_api.rb +85 -0
  133. data/lib/launchdarkly_api/api/teams_beta_api.rb +249 -40
  134. data/lib/launchdarkly_api/api/user_settings_api.rb +100 -100
  135. data/lib/launchdarkly_api/api/users_api.rb +69 -69
  136. data/lib/launchdarkly_api/api/users_beta_api.rb +1 -1
  137. data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
  138. data/lib/launchdarkly_api/api/workflows_beta_api.rb +9 -9
  139. data/lib/launchdarkly_api/api_client.rb +1 -1
  140. data/lib/launchdarkly_api/api_error.rb +1 -1
  141. data/lib/launchdarkly_api/configuration.rb +1 -1
  142. data/lib/launchdarkly_api/models/access.rb +241 -0
  143. data/lib/launchdarkly_api/models/access_allowed_reason.rb +280 -0
  144. data/lib/launchdarkly_api/models/access_allowed_rep.rb +237 -0
  145. data/lib/launchdarkly_api/models/{access_denied_rep.rb → access_denied.rb} +5 -5
  146. data/lib/launchdarkly_api/models/{access_denied_reason_rep.rb → access_denied_reason.rb} +6 -6
  147. data/lib/launchdarkly_api/models/access_token_post.rb +1 -1
  148. data/lib/launchdarkly_api/models/action_input_rep.rb +1 -1
  149. data/lib/launchdarkly_api/models/action_output_rep.rb +1 -1
  150. data/lib/launchdarkly_api/models/approval_condition_input_rep.rb +1 -1
  151. data/lib/launchdarkly_api/models/approval_condition_output_rep.rb +1 -1
  152. data/lib/launchdarkly_api/models/approval_settings.rb +1 -1
  153. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +1 -1
  154. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +1 -1
  155. data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +1 -1
  156. data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +1 -1
  157. data/lib/launchdarkly_api/models/big_segment_target.rb +1 -1
  158. data/lib/launchdarkly_api/models/branch_collection_rep.rb +1 -1
  159. data/lib/launchdarkly_api/models/branch_rep.rb +1 -1
  160. data/lib/launchdarkly_api/models/clause.rb +1 -1
  161. data/lib/launchdarkly_api/models/client_side_availability.rb +1 -1
  162. data/lib/launchdarkly_api/models/client_side_availability_post.rb +1 -1
  163. data/lib/launchdarkly_api/models/condition_base_output_rep.rb +1 -1
  164. data/lib/launchdarkly_api/models/condition_input_rep.rb +29 -2
  165. data/lib/launchdarkly_api/models/condition_output_rep.rb +29 -2
  166. data/lib/launchdarkly_api/models/confidence_interval_rep.rb +1 -1
  167. data/lib/launchdarkly_api/models/conflict.rb +1 -1
  168. data/lib/launchdarkly_api/models/conflict_output_rep.rb +1 -1
  169. data/lib/launchdarkly_api/models/copied_from_env.rb +1 -1
  170. data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +1 -1
  171. data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +1 -1
  172. data/lib/launchdarkly_api/models/custom_property.rb +1 -1
  173. data/lib/launchdarkly_api/models/custom_role.rb +2 -2
  174. data/lib/launchdarkly_api/models/custom_role_post.rb +1 -1
  175. data/lib/launchdarkly_api/models/custom_role_post_data.rb +1 -1
  176. data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
  177. data/lib/launchdarkly_api/models/custom_workflow_input_rep.rb +1 -1
  178. data/lib/launchdarkly_api/models/custom_workflow_meta.rb +1 -1
  179. data/lib/launchdarkly_api/models/custom_workflow_output_rep.rb +1 -1
  180. data/lib/launchdarkly_api/models/custom_workflow_stage_meta.rb +1 -1
  181. data/lib/launchdarkly_api/models/custom_workflows_listing_output_rep.rb +1 -1
  182. data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +1 -1
  183. data/lib/launchdarkly_api/models/defaults.rb +1 -1
  184. data/lib/launchdarkly_api/models/dependent_flag.rb +1 -1
  185. data/lib/launchdarkly_api/models/dependent_flag_environment.rb +1 -1
  186. data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +1 -1
  187. data/lib/launchdarkly_api/models/destination.rb +2 -2
  188. data/lib/launchdarkly_api/models/destination_post.rb +1 -1
  189. data/lib/launchdarkly_api/models/destinations.rb +1 -1
  190. data/lib/launchdarkly_api/models/environment.rb +1 -1
  191. data/lib/launchdarkly_api/models/environment_post.rb +17 -8
  192. data/lib/launchdarkly_api/models/execution_output_rep.rb +1 -1
  193. data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +1 -1
  194. data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +1 -1
  195. data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +1 -1
  196. data/lib/launchdarkly_api/models/experiment_info_rep.rb +1 -1
  197. data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +1 -1
  198. data/lib/launchdarkly_api/models/experiment_rep.rb +1 -1
  199. data/lib/launchdarkly_api/models/experiment_results_rep.rb +1 -1
  200. data/lib/launchdarkly_api/models/experiment_stats_rep.rb +1 -1
  201. data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +1 -1
  202. data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +1 -1
  203. data/lib/launchdarkly_api/models/experiment_totals_rep.rb +1 -1
  204. data/lib/launchdarkly_api/models/expiring_user_target_error.rb +1 -1
  205. data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +1 -1
  206. data/lib/launchdarkly_api/models/expiring_user_target_item.rb +1 -1
  207. data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +1 -1
  208. data/lib/launchdarkly_api/models/export.rb +323 -0
  209. data/lib/launchdarkly_api/models/extinction.rb +1 -1
  210. data/lib/launchdarkly_api/models/extinction_collection_rep.rb +1 -1
  211. data/lib/launchdarkly_api/models/feature_flag.rb +2 -2
  212. data/lib/launchdarkly_api/models/feature_flag_body.rb +2 -2
  213. data/lib/launchdarkly_api/models/feature_flag_config.rb +2 -2
  214. data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +1 -1
  215. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +1 -1
  216. data/lib/launchdarkly_api/models/feature_flag_status.rb +1 -1
  217. data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
  218. data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
  219. data/lib/launchdarkly_api/models/feature_flags.rb +14 -5
  220. data/lib/launchdarkly_api/models/file_rep.rb +227 -0
  221. data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +1 -1
  222. data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +1 -1
  223. data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +1 -1
  224. data/lib/launchdarkly_api/models/flag_copy_config_post.rb +1 -1
  225. data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +2 -2
  226. data/lib/launchdarkly_api/models/flag_link_collection_rep.rb +241 -0
  227. data/lib/launchdarkly_api/models/flag_link_member.rb +257 -0
  228. data/lib/launchdarkly_api/models/flag_link_post.rb +274 -0
  229. data/lib/launchdarkly_api/models/flag_link_rep.rb +337 -0
  230. data/lib/launchdarkly_api/models/flag_listing_rep.rb +1 -1
  231. data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +1 -1
  232. data/lib/launchdarkly_api/models/flag_status_rep.rb +1 -1
  233. data/lib/launchdarkly_api/models/flag_summary.rb +1 -1
  234. data/lib/launchdarkly_api/models/flag_trigger_input.rb +230 -0
  235. data/lib/launchdarkly_api/models/forbidden_error_rep.rb +1 -1
  236. data/lib/launchdarkly_api/models/hunk_rep.rb +1 -1
  237. data/lib/launchdarkly_api/models/import.rb +306 -0
  238. data/lib/launchdarkly_api/models/{derived_attribute.rb → initiator_rep.rb} +17 -18
  239. data/lib/launchdarkly_api/models/integration.rb +325 -0
  240. data/lib/launchdarkly_api/models/integration_delivery_configuration.rb +369 -0
  241. data/lib/launchdarkly_api/models/integration_delivery_configuration_collection.rb +239 -0
  242. data/lib/launchdarkly_api/models/integration_delivery_configuration_collection_links.rb +232 -0
  243. data/lib/launchdarkly_api/models/integration_delivery_configuration_links.rb +265 -0
  244. data/lib/launchdarkly_api/models/integration_delivery_configuration_post.rb +257 -0
  245. data/lib/launchdarkly_api/models/integration_delivery_configuration_response.rb +245 -0
  246. data/lib/launchdarkly_api/models/integration_metadata.rb +1 -1
  247. data/lib/launchdarkly_api/models/integration_status.rb +1 -1
  248. data/lib/launchdarkly_api/models/integration_status_rep.rb +236 -0
  249. data/lib/launchdarkly_api/models/integration_subscription_status_rep.rb +256 -0
  250. data/lib/launchdarkly_api/models/integrations.rb +240 -0
  251. data/lib/launchdarkly_api/models/invalid_request_error_rep.rb +1 -1
  252. data/lib/launchdarkly_api/models/ip_list.rb +1 -1
  253. data/lib/launchdarkly_api/models/last_seen_metadata.rb +1 -1
  254. data/lib/launchdarkly_api/models/link.rb +1 -1
  255. data/lib/launchdarkly_api/models/member.rb +1 -1
  256. data/lib/launchdarkly_api/models/member_data_rep.rb +1 -1
  257. data/lib/launchdarkly_api/models/member_import_item.rb +246 -0
  258. data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +1 -1
  259. data/lib/launchdarkly_api/models/{member_summary_rep.rb → member_summary.rb} +4 -4
  260. data/lib/launchdarkly_api/models/member_team_summary_rep.rb +1 -1
  261. data/lib/launchdarkly_api/models/member_teams_post_input.rb +226 -0
  262. data/lib/launchdarkly_api/models/members.rb +1 -1
  263. data/lib/launchdarkly_api/models/method_not_allowed_error_rep.rb +1 -1
  264. data/lib/launchdarkly_api/models/metric_collection_rep.rb +1 -1
  265. data/lib/launchdarkly_api/models/metric_listing_rep.rb +16 -4
  266. data/lib/launchdarkly_api/models/metric_post.rb +14 -2
  267. data/lib/launchdarkly_api/models/metric_rep.rb +16 -4
  268. data/lib/launchdarkly_api/models/metric_seen.rb +8 -8
  269. data/lib/launchdarkly_api/models/modification.rb +1 -1
  270. data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +1 -1
  271. data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +1 -1
  272. data/lib/launchdarkly_api/models/new_member_form.rb +1 -1
  273. data/lib/launchdarkly_api/models/not_found_error_rep.rb +1 -1
  274. data/lib/launchdarkly_api/models/parent_resource_rep.rb +1 -1
  275. data/lib/launchdarkly_api/models/patch_failed_error_rep.rb +1 -1
  276. data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
  277. data/lib/launchdarkly_api/models/patch_segment_instruction.rb +1 -1
  278. data/lib/launchdarkly_api/models/patch_segment_request.rb +1 -1
  279. data/lib/launchdarkly_api/models/patch_with_comment.rb +1 -1
  280. data/lib/launchdarkly_api/models/permission_grant_input.rb +16 -16
  281. data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +1 -1
  282. data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +1 -1
  283. data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +1 -1
  284. data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
  285. data/lib/launchdarkly_api/models/project.rb +1 -1
  286. data/lib/launchdarkly_api/models/project_listing_rep.rb +1 -1
  287. data/lib/launchdarkly_api/models/project_post.rb +1 -1
  288. data/lib/launchdarkly_api/models/project_summary.rb +238 -0
  289. data/lib/launchdarkly_api/models/projects.rb +1 -1
  290. data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +1 -1
  291. data/lib/launchdarkly_api/models/put_branch.rb +14 -5
  292. data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +1 -1
  293. data/lib/launchdarkly_api/models/recent_trigger_body.rb +229 -0
  294. data/lib/launchdarkly_api/models/reference_rep.rb +1 -1
  295. data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +1 -1
  296. data/lib/launchdarkly_api/models/relay_auto_config_post.rb +1 -1
  297. data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +3 -3
  298. data/lib/launchdarkly_api/models/repository_collection_rep.rb +1 -1
  299. data/lib/launchdarkly_api/models/repository_post.rb +1 -1
  300. data/lib/launchdarkly_api/models/repository_rep.rb +2 -2
  301. data/lib/launchdarkly_api/models/{access_rep.rb → resolved_context.rb} +12 -17
  302. data/lib/launchdarkly_api/models/resolved_image.rb +236 -0
  303. data/lib/launchdarkly_api/models/resolved_title.rb +229 -0
  304. data/lib/launchdarkly_api/models/resolved_ui_block_element.rb +245 -0
  305. data/lib/launchdarkly_api/models/resolved_ui_blocks.rb +254 -0
  306. data/lib/launchdarkly_api/models/resource_access.rb +1 -1
  307. data/lib/launchdarkly_api/models/resource_id_response.rb +1 -1
  308. data/lib/launchdarkly_api/models/review_output_rep.rb +1 -1
  309. data/lib/launchdarkly_api/models/review_response.rb +1 -1
  310. data/lib/launchdarkly_api/models/rollout.rb +1 -1
  311. data/lib/launchdarkly_api/models/rule.rb +14 -5
  312. data/lib/launchdarkly_api/models/schedule_condition_input_rep.rb +29 -2
  313. data/lib/launchdarkly_api/models/schedule_condition_output_rep.rb +32 -5
  314. data/lib/launchdarkly_api/models/sdk_list_rep.rb +1 -1
  315. data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +1 -1
  316. data/lib/launchdarkly_api/models/sdk_version_rep.rb +1 -1
  317. data/lib/launchdarkly_api/models/segment_body.rb +1 -1
  318. data/lib/launchdarkly_api/models/segment_metadata.rb +1 -1
  319. data/lib/launchdarkly_api/models/segment_user_list.rb +1 -1
  320. data/lib/launchdarkly_api/models/segment_user_state.rb +1 -1
  321. data/lib/launchdarkly_api/models/series_list_rep.rb +1 -1
  322. data/lib/launchdarkly_api/models/source_env.rb +229 -0
  323. data/lib/launchdarkly_api/models/source_flag.rb +1 -1
  324. data/lib/launchdarkly_api/models/stage_input_rep.rb +1 -1
  325. data/lib/launchdarkly_api/models/stage_output_rep.rb +1 -1
  326. data/lib/launchdarkly_api/models/statement.rb +3 -3
  327. data/lib/launchdarkly_api/models/statement_post.rb +1 -11
  328. data/lib/launchdarkly_api/models/statement_post_data.rb +1 -11
  329. data/lib/launchdarkly_api/models/statement_rep.rb +1 -1
  330. data/lib/launchdarkly_api/models/statistic_collection_rep.rb +1 -1
  331. data/lib/launchdarkly_api/models/statistic_rep.rb +1 -1
  332. data/lib/launchdarkly_api/models/statistics_root.rb +1 -1
  333. data/lib/launchdarkly_api/models/status_conflict_error_rep.rb +1 -1
  334. data/lib/launchdarkly_api/models/subject_data_rep.rb +1 -1
  335. data/lib/launchdarkly_api/models/subscription_post.rb +293 -0
  336. data/lib/launchdarkly_api/models/tag_collection.rb +252 -0
  337. data/lib/launchdarkly_api/models/target.rb +1 -1
  338. data/lib/launchdarkly_api/models/target_resource_rep.rb +1 -1
  339. data/lib/launchdarkly_api/models/{team_rep.rb → team.rb} +18 -62
  340. data/lib/launchdarkly_api/models/team_custom_role.rb +245 -0
  341. data/lib/launchdarkly_api/models/team_custom_roles.rb +240 -0
  342. data/lib/launchdarkly_api/models/{permission_grant_rep.rb → team_imports_rep.rb} +12 -41
  343. data/lib/launchdarkly_api/models/team_maintainers.rb +240 -0
  344. data/lib/launchdarkly_api/models/team_patch_input.rb +1 -1
  345. data/lib/launchdarkly_api/models/team_post_input.rb +1 -1
  346. data/lib/launchdarkly_api/models/team_projects.rb +229 -0
  347. data/lib/launchdarkly_api/models/{team_collection_rep.rb → teams.rb} +5 -5
  348. data/lib/launchdarkly_api/models/timestamp_rep.rb +245 -0
  349. data/lib/launchdarkly_api/models/title_rep.rb +1 -1
  350. data/lib/launchdarkly_api/models/token.rb +2 -2
  351. data/lib/launchdarkly_api/models/token_data_rep.rb +1 -1
  352. data/lib/launchdarkly_api/models/tokens.rb +1 -1
  353. data/lib/launchdarkly_api/models/trigger_post.rb +245 -0
  354. data/lib/launchdarkly_api/models/trigger_workflow_collection_rep.rb +231 -0
  355. data/lib/launchdarkly_api/models/trigger_workflow_rep.rb +332 -0
  356. data/lib/launchdarkly_api/models/unauthorized_error_rep.rb +1 -1
  357. data/lib/launchdarkly_api/models/url_post.rb +1 -1
  358. data/lib/launchdarkly_api/models/user.rb +2 -13
  359. data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +1 -1
  360. data/lib/launchdarkly_api/models/user_flag_setting.rb +1 -1
  361. data/lib/launchdarkly_api/models/user_flag_settings.rb +1 -1
  362. data/lib/launchdarkly_api/models/user_record.rb +2 -2
  363. data/lib/launchdarkly_api/models/user_record_rep.rb +1 -1
  364. data/lib/launchdarkly_api/models/user_segment.rb +2 -2
  365. data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
  366. data/lib/launchdarkly_api/models/user_segments.rb +1 -1
  367. data/lib/launchdarkly_api/models/users.rb +1 -1
  368. data/lib/launchdarkly_api/models/value_put.rb +1 -1
  369. data/lib/launchdarkly_api/models/variation.rb +1 -1
  370. data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +1 -1
  371. data/lib/launchdarkly_api/models/variation_summary.rb +1 -1
  372. data/lib/launchdarkly_api/models/versions_rep.rb +1 -1
  373. data/lib/launchdarkly_api/models/webhook.rb +2 -2
  374. data/lib/launchdarkly_api/models/webhook_post.rb +1 -1
  375. data/lib/launchdarkly_api/models/webhooks.rb +1 -1
  376. data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
  377. data/lib/launchdarkly_api/version.rb +2 -2
  378. data/lib/launchdarkly_api.rb +55 -9
  379. data/spec/api/access_tokens_api_spec.rb +1 -1
  380. data/spec/api/account_members_api_spec.rb +15 -2
  381. data/spec/api/account_usage_beta_api_spec.rb +4 -4
  382. data/spec/api/approvals_api_spec.rb +8 -8
  383. data/spec/api/audit_log_api_spec.rb +1 -1
  384. data/spec/api/code_references_api_spec.rb +4 -2
  385. data/spec/api/custom_roles_api_spec.rb +5 -5
  386. data/spec/api/data_export_destinations_api_spec.rb +9 -9
  387. data/spec/api/environments_api_spec.rb +4 -4
  388. data/spec/api/experiments_beta_api_spec.rb +7 -7
  389. data/spec/api/feature_flags_api_spec.rb +26 -26
  390. data/spec/api/feature_flags_beta_api_spec.rb +6 -6
  391. data/spec/api/flag_links_beta_api_spec.rb +91 -0
  392. data/spec/api/flag_triggers_api_spec.rb +110 -0
  393. data/spec/api/integration_audit_log_subscriptions_api_spec.rb +100 -0
  394. data/spec/api/integration_delivery_configurations_beta_api_spec.rb +135 -0
  395. data/spec/api/metrics_api_spec.rb +5 -5
  396. data/spec/api/other_api_spec.rb +1 -1
  397. data/spec/api/projects_api_spec.rb +1 -1
  398. data/spec/api/relay_proxy_configurations_api_spec.rb +1 -1
  399. data/spec/api/scheduled_changes_api_spec.rb +7 -7
  400. data/spec/api/segments_api_spec.rb +29 -29
  401. data/spec/api/segments_beta_api_spec.rb +93 -0
  402. data/spec/api/tags_api_spec.rb +48 -0
  403. data/spec/api/teams_beta_api_spec.rb +49 -8
  404. data/spec/api/user_settings_api_spec.rb +18 -18
  405. data/spec/api/users_api_spec.rb +12 -12
  406. data/spec/api/users_beta_api_spec.rb +1 -1
  407. data/spec/api/webhooks_api_spec.rb +1 -1
  408. data/spec/api/workflows_beta_api_spec.rb +5 -5
  409. data/spec/api_client_spec.rb +1 -1
  410. data/spec/configuration_spec.rb +1 -1
  411. data/spec/models/access_allowed_reason_spec.rb +64 -0
  412. data/spec/models/access_allowed_rep_spec.rb +40 -0
  413. data/spec/models/{access_denied_reason_rep_spec.rb → access_denied_reason_spec.rb} +7 -7
  414. data/spec/models/{access_denied_rep_spec.rb → access_denied_spec.rb} +7 -7
  415. data/spec/models/{derived_attribute_spec.rb → access_spec.rb} +9 -9
  416. data/spec/models/access_token_post_spec.rb +1 -1
  417. data/spec/models/action_input_rep_spec.rb +1 -1
  418. data/spec/models/action_output_rep_spec.rb +1 -1
  419. data/spec/models/approval_condition_input_rep_spec.rb +1 -1
  420. data/spec/models/approval_condition_output_rep_spec.rb +1 -1
  421. data/spec/models/approval_settings_spec.rb +1 -1
  422. data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +1 -1
  423. data/spec/models/audit_log_entry_listing_rep_spec.rb +1 -1
  424. data/spec/models/audit_log_entry_rep_spec.rb +1 -1
  425. data/spec/models/authorized_app_data_rep_spec.rb +1 -1
  426. data/spec/models/big_segment_target_spec.rb +1 -1
  427. data/spec/models/branch_collection_rep_spec.rb +1 -1
  428. data/spec/models/branch_rep_spec.rb +1 -1
  429. data/spec/models/clause_spec.rb +1 -1
  430. data/spec/models/client_side_availability_post_spec.rb +1 -1
  431. data/spec/models/client_side_availability_spec.rb +1 -1
  432. data/spec/models/condition_base_output_rep_spec.rb +1 -1
  433. data/spec/models/condition_input_rep_spec.rb +19 -1
  434. data/spec/models/condition_output_rep_spec.rb +19 -1
  435. data/spec/models/confidence_interval_rep_spec.rb +1 -1
  436. data/spec/models/conflict_output_rep_spec.rb +1 -1
  437. data/spec/models/conflict_spec.rb +1 -1
  438. data/spec/models/copied_from_env_spec.rb +1 -1
  439. data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +1 -1
  440. data/spec/models/create_flag_config_approval_request_request_spec.rb +1 -1
  441. data/spec/models/custom_property_spec.rb +1 -1
  442. data/spec/models/custom_role_post_data_spec.rb +1 -1
  443. data/spec/models/custom_role_post_spec.rb +1 -1
  444. data/spec/models/custom_role_spec.rb +1 -1
  445. data/spec/models/custom_roles_spec.rb +1 -1
  446. data/spec/models/custom_workflow_input_rep_spec.rb +1 -1
  447. data/spec/models/custom_workflow_meta_spec.rb +1 -1
  448. data/spec/models/custom_workflow_output_rep_spec.rb +1 -1
  449. data/spec/models/custom_workflow_stage_meta_spec.rb +1 -1
  450. data/spec/models/custom_workflows_listing_output_rep_spec.rb +1 -1
  451. data/spec/models/default_client_side_availability_post_spec.rb +1 -1
  452. data/spec/models/defaults_spec.rb +1 -1
  453. data/spec/models/dependent_flag_environment_spec.rb +1 -1
  454. data/spec/models/dependent_flag_spec.rb +1 -1
  455. data/spec/models/dependent_flags_by_environment_spec.rb +1 -1
  456. data/spec/models/destination_post_spec.rb +1 -1
  457. data/spec/models/destination_spec.rb +1 -1
  458. data/spec/models/destinations_spec.rb +1 -1
  459. data/spec/models/environment_post_spec.rb +7 -1
  460. data/spec/models/environment_spec.rb +1 -1
  461. data/spec/models/execution_output_rep_spec.rb +1 -1
  462. data/spec/models/experiment_allocation_rep_spec.rb +1 -1
  463. data/spec/models/experiment_enabled_period_rep_spec.rb +1 -1
  464. data/spec/models/experiment_environment_setting_rep_spec.rb +1 -1
  465. data/spec/models/experiment_info_rep_spec.rb +1 -1
  466. data/spec/models/experiment_metadata_rep_spec.rb +1 -1
  467. data/spec/models/experiment_rep_spec.rb +1 -1
  468. data/spec/models/experiment_results_rep_spec.rb +1 -1
  469. data/spec/models/experiment_stats_rep_spec.rb +1 -1
  470. data/spec/models/experiment_time_series_slice_spec.rb +1 -1
  471. data/spec/models/experiment_time_series_variation_slice_spec.rb +1 -1
  472. data/spec/models/experiment_totals_rep_spec.rb +1 -1
  473. data/spec/models/expiring_user_target_error_spec.rb +1 -1
  474. data/spec/models/expiring_user_target_get_response_spec.rb +1 -1
  475. data/spec/models/expiring_user_target_item_spec.rb +1 -1
  476. data/spec/models/expiring_user_target_patch_response_spec.rb +1 -1
  477. data/spec/models/export_spec.rb +76 -0
  478. data/spec/models/extinction_collection_rep_spec.rb +1 -1
  479. data/spec/models/extinction_spec.rb +1 -1
  480. data/spec/models/feature_flag_body_spec.rb +1 -1
  481. data/spec/models/feature_flag_config_spec.rb +1 -1
  482. data/spec/models/feature_flag_scheduled_change_spec.rb +1 -1
  483. data/spec/models/feature_flag_scheduled_changes_spec.rb +1 -1
  484. data/spec/models/feature_flag_spec.rb +1 -1
  485. data/spec/models/feature_flag_status_across_environments_spec.rb +1 -1
  486. data/spec/models/feature_flag_status_spec.rb +1 -1
  487. data/spec/models/feature_flag_statuses_spec.rb +1 -1
  488. data/spec/models/feature_flags_spec.rb +7 -1
  489. data/spec/models/file_rep_spec.rb +40 -0
  490. data/spec/models/flag_config_approval_request_response_spec.rb +1 -1
  491. data/spec/models/flag_config_approval_requests_response_spec.rb +1 -1
  492. data/spec/models/flag_copy_config_environment_spec.rb +1 -1
  493. data/spec/models/flag_copy_config_post_spec.rb +1 -1
  494. data/spec/models/flag_global_attributes_rep_spec.rb +1 -1
  495. data/spec/models/flag_link_collection_rep_spec.rb +40 -0
  496. data/spec/models/flag_link_member_spec.rb +52 -0
  497. data/spec/models/flag_link_post_spec.rb +70 -0
  498. data/spec/models/flag_link_rep_spec.rb +94 -0
  499. data/spec/models/flag_listing_rep_spec.rb +1 -1
  500. data/spec/models/flag_scheduled_changes_input_spec.rb +1 -1
  501. data/spec/models/flag_status_rep_spec.rb +1 -1
  502. data/spec/models/flag_summary_spec.rb +1 -1
  503. data/spec/models/flag_trigger_input_spec.rb +40 -0
  504. data/spec/models/forbidden_error_rep_spec.rb +1 -1
  505. data/spec/models/hunk_rep_spec.rb +1 -1
  506. data/spec/models/import_spec.rb +70 -0
  507. data/spec/models/initiator_rep_spec.rb +40 -0
  508. data/spec/models/integration_delivery_configuration_collection_links_spec.rb +40 -0
  509. data/spec/models/integration_delivery_configuration_collection_spec.rb +40 -0
  510. data/spec/models/integration_delivery_configuration_links_spec.rb +52 -0
  511. data/spec/models/integration_delivery_configuration_post_spec.rb +52 -0
  512. data/spec/models/integration_delivery_configuration_response_spec.rb +52 -0
  513. data/spec/models/integration_delivery_configuration_spec.rb +94 -0
  514. data/spec/models/integration_metadata_spec.rb +1 -1
  515. data/spec/models/integration_spec.rb +100 -0
  516. data/spec/models/integration_status_rep_spec.rb +46 -0
  517. data/spec/models/integration_status_spec.rb +1 -1
  518. data/spec/models/integration_subscription_status_rep_spec.rb +58 -0
  519. data/spec/models/{permission_grant_rep_spec.rb → integrations_spec.rb} +10 -16
  520. data/spec/models/invalid_request_error_rep_spec.rb +1 -1
  521. data/spec/models/ip_list_spec.rb +1 -1
  522. data/spec/models/last_seen_metadata_spec.rb +1 -1
  523. data/spec/models/link_spec.rb +1 -1
  524. data/spec/models/member_data_rep_spec.rb +1 -1
  525. data/spec/models/member_import_item_spec.rb +46 -0
  526. data/spec/models/member_permission_grant_summary_rep_spec.rb +1 -1
  527. data/spec/models/member_spec.rb +1 -1
  528. data/spec/models/{member_summary_rep_spec.rb → member_summary_spec.rb} +7 -7
  529. data/spec/models/member_team_summary_rep_spec.rb +1 -1
  530. data/spec/models/member_teams_post_input_spec.rb +34 -0
  531. data/spec/models/members_spec.rb +1 -1
  532. data/spec/models/method_not_allowed_error_rep_spec.rb +1 -1
  533. data/spec/models/metric_collection_rep_spec.rb +1 -1
  534. data/spec/models/metric_listing_rep_spec.rb +5 -1
  535. data/spec/models/metric_post_spec.rb +5 -1
  536. data/spec/models/metric_rep_spec.rb +5 -1
  537. data/spec/models/metric_seen_spec.rb +2 -2
  538. data/spec/models/modification_spec.rb +1 -1
  539. data/spec/models/multi_environment_dependent_flag_spec.rb +1 -1
  540. data/spec/models/multi_environment_dependent_flags_spec.rb +1 -1
  541. data/spec/models/new_member_form_spec.rb +1 -1
  542. data/spec/models/not_found_error_rep_spec.rb +1 -1
  543. data/spec/models/parent_resource_rep_spec.rb +1 -1
  544. data/spec/models/patch_failed_error_rep_spec.rb +1 -1
  545. data/spec/models/patch_operation_spec.rb +1 -1
  546. data/spec/models/patch_segment_instruction_spec.rb +1 -1
  547. data/spec/models/patch_segment_request_spec.rb +1 -1
  548. data/spec/models/patch_with_comment_spec.rb +1 -1
  549. data/spec/models/permission_grant_input_spec.rb +3 -3
  550. data/spec/models/post_approval_request_apply_request_spec.rb +1 -1
  551. data/spec/models/post_approval_request_review_request_spec.rb +1 -1
  552. data/spec/models/post_flag_scheduled_changes_input_spec.rb +1 -1
  553. data/spec/models/prerequisite_spec.rb +1 -1
  554. data/spec/models/project_listing_rep_spec.rb +1 -1
  555. data/spec/models/project_post_spec.rb +1 -1
  556. data/spec/models/project_spec.rb +1 -1
  557. data/spec/models/project_summary_spec.rb +46 -0
  558. data/spec/models/projects_spec.rb +1 -1
  559. data/spec/models/pub_nub_detail_rep_spec.rb +1 -1
  560. data/spec/models/put_branch_spec.rb +7 -1
  561. data/spec/models/rate_limited_error_rep_spec.rb +1 -1
  562. data/spec/models/recent_trigger_body_spec.rb +40 -0
  563. data/spec/models/reference_rep_spec.rb +1 -1
  564. data/spec/models/relay_auto_config_collection_rep_spec.rb +1 -1
  565. data/spec/models/relay_auto_config_post_spec.rb +1 -1
  566. data/spec/models/relay_auto_config_rep_spec.rb +1 -1
  567. data/spec/models/repository_collection_rep_spec.rb +1 -1
  568. data/spec/models/repository_post_spec.rb +1 -1
  569. data/spec/models/repository_rep_spec.rb +1 -1
  570. data/spec/models/resolved_context_spec.rb +34 -0
  571. data/spec/models/resolved_image_spec.rb +46 -0
  572. data/spec/models/resolved_title_spec.rb +40 -0
  573. data/spec/models/resolved_ui_block_element_spec.rb +52 -0
  574. data/spec/models/resolved_ui_blocks_spec.rb +58 -0
  575. data/spec/models/resource_access_spec.rb +1 -1
  576. data/spec/models/resource_id_response_spec.rb +1 -1
  577. data/spec/models/review_output_rep_spec.rb +1 -1
  578. data/spec/models/review_response_spec.rb +1 -1
  579. data/spec/models/rollout_spec.rb +1 -1
  580. data/spec/models/rule_spec.rb +7 -1
  581. data/spec/models/schedule_condition_input_rep_spec.rb +19 -1
  582. data/spec/models/schedule_condition_output_rep_spec.rb +19 -1
  583. data/spec/models/sdk_list_rep_spec.rb +1 -1
  584. data/spec/models/sdk_version_list_rep_spec.rb +1 -1
  585. data/spec/models/sdk_version_rep_spec.rb +1 -1
  586. data/spec/models/segment_body_spec.rb +1 -1
  587. data/spec/models/segment_metadata_spec.rb +1 -1
  588. data/spec/models/segment_user_list_spec.rb +1 -1
  589. data/spec/models/segment_user_state_spec.rb +1 -1
  590. data/spec/models/series_list_rep_spec.rb +1 -1
  591. data/spec/models/source_env_spec.rb +40 -0
  592. data/spec/models/source_flag_spec.rb +1 -1
  593. data/spec/models/stage_input_rep_spec.rb +1 -1
  594. data/spec/models/stage_output_rep_spec.rb +1 -1
  595. data/spec/models/statement_post_data_spec.rb +1 -1
  596. data/spec/models/statement_post_spec.rb +1 -1
  597. data/spec/models/statement_rep_spec.rb +1 -1
  598. data/spec/models/statement_spec.rb +1 -1
  599. data/spec/models/statistic_collection_rep_spec.rb +1 -1
  600. data/spec/models/statistic_rep_spec.rb +1 -1
  601. data/spec/models/statistics_root_spec.rb +1 -1
  602. data/spec/models/status_conflict_error_rep_spec.rb +1 -1
  603. data/spec/models/subject_data_rep_spec.rb +1 -1
  604. data/spec/models/subscription_post_spec.rb +70 -0
  605. data/spec/models/tag_collection_spec.rb +46 -0
  606. data/spec/models/target_resource_rep_spec.rb +1 -1
  607. data/spec/models/target_spec.rb +1 -1
  608. data/spec/models/team_custom_role_spec.rb +52 -0
  609. data/spec/models/team_custom_roles_spec.rb +46 -0
  610. data/spec/models/{access_rep_spec.rb → team_imports_rep_spec.rb} +8 -8
  611. data/spec/models/team_maintainers_spec.rb +46 -0
  612. data/spec/models/team_patch_input_spec.rb +1 -1
  613. data/spec/models/team_post_input_spec.rb +1 -1
  614. data/spec/models/team_projects_spec.rb +40 -0
  615. data/spec/models/{team_rep_spec.rb → team_spec.rb} +9 -33
  616. data/spec/models/{team_collection_rep_spec.rb → teams_spec.rb} +7 -7
  617. data/spec/models/timestamp_rep_spec.rb +52 -0
  618. data/spec/models/title_rep_spec.rb +1 -1
  619. data/spec/models/token_data_rep_spec.rb +1 -1
  620. data/spec/models/token_spec.rb +1 -1
  621. data/spec/models/tokens_spec.rb +1 -1
  622. data/spec/models/trigger_post_spec.rb +46 -0
  623. data/spec/models/trigger_workflow_collection_rep_spec.rb +40 -0
  624. data/spec/models/trigger_workflow_rep_spec.rb +106 -0
  625. data/spec/models/unauthorized_error_rep_spec.rb +1 -1
  626. data/spec/models/url_post_spec.rb +1 -1
  627. data/spec/models/user_attribute_names_rep_spec.rb +1 -1
  628. data/spec/models/user_flag_setting_spec.rb +1 -1
  629. data/spec/models/user_flag_settings_spec.rb +1 -1
  630. data/spec/models/user_record_rep_spec.rb +1 -1
  631. data/spec/models/user_record_spec.rb +1 -1
  632. data/spec/models/user_segment_rule_spec.rb +1 -1
  633. data/spec/models/user_segment_spec.rb +1 -1
  634. data/spec/models/user_segments_spec.rb +1 -1
  635. data/spec/models/user_spec.rb +1 -7
  636. data/spec/models/users_spec.rb +1 -1
  637. data/spec/models/value_put_spec.rb +1 -1
  638. data/spec/models/variation_or_rollout_rep_spec.rb +1 -1
  639. data/spec/models/variation_spec.rb +1 -1
  640. data/spec/models/variation_summary_spec.rb +1 -1
  641. data/spec/models/versions_rep_spec.rb +1 -1
  642. data/spec/models/webhook_post_spec.rb +1 -1
  643. data/spec/models/webhook_spec.rb +1 -1
  644. data/spec/models/webhooks_spec.rb +1 -1
  645. data/spec/models/weighted_variation_spec.rb +1 -1
  646. data/spec/spec_helper.rb +1 -1
  647. metadata +249 -47
  648. data/docs/AccessRep.md +0 -18
  649. data/docs/DerivedAttribute.md +0 -20
  650. data/docs/PermissionGrantRep.md +0 -24
  651. data/docs/TeamRep.md +0 -40
@@ -4,22 +4,22 @@ All URIs are relative to *https://app.launchdarkly.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**copy_feature_flag**](FeatureFlagsApi.md#copy_feature_flag) | **POST** /api/v2/flags/{projKey}/{featureFlagKey}/copy | Copy feature flag |
8
- | [**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /api/v2/flags/{projKey}/{key} | Delete feature flag |
9
- | [**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey} | Get expiring user targets for feature flag |
10
- | [**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /api/v2/flags/{projKey}/{key} | Get feature flag |
11
- | [**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /api/v2/flag-statuses/{projKey}/{envKey}/{key} | Get feature flag status |
12
- | [**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /api/v2/flag-status/{projKey}/{key} | Get flag status across environments |
13
- | [**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /api/v2/flag-statuses/{projKey}/{envKey} | List feature flag statuses |
14
- | [**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /api/v2/flags/{projKey} | List feature flags |
15
- | [**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey} | Update expiring user targets on feature flag |
16
- | [**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /api/v2/flags/{projKey}/{key} | Update feature flag |
17
- | [**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /api/v2/flags/{projKey} | Create a feature flag |
7
+ | [**copy_feature_flag**](FeatureFlagsApi.md#copy_feature_flag) | **POST** /api/v2/flags/{projectKey}/{featureFlagKey}/copy | Copy feature flag |
8
+ | [**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /api/v2/flags/{projectKey}/{featureFlagKey} | Delete feature flag |
9
+ | [**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag |
10
+ | [**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey} | Get feature flag |
11
+ | [**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /api/v2/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get feature flag status |
12
+ | [**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /api/v2/flag-status/{projectKey}/{featureFlagKey} | Get flag status across environments |
13
+ | [**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /api/v2/flag-statuses/{projectKey}/{environmentKey} | List feature flag statuses |
14
+ | [**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /api/v2/flags/{projectKey} | List feature flags |
15
+ | [**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update expiring user targets on feature flag |
16
+ | [**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /api/v2/flags/{projectKey}/{featureFlagKey} | Update feature flag |
17
+ | [**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /api/v2/flags/{projectKey} | Create a feature flag |
18
18
 
19
19
 
20
20
  ## copy_feature_flag
21
21
 
22
- > <FeatureFlag> copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post)
22
+ > <FeatureFlag> copy_feature_flag(project_key, feature_flag_key, flag_copy_config_post)
23
23
 
24
24
  Copy feature flag
25
25
 
@@ -39,13 +39,13 @@ LaunchDarklyApi.configure do |config|
39
39
  end
40
40
 
41
41
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
42
- proj_key = 'proj_key_example' # String | The project key.
43
- feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
42
+ project_key = 'project_key_example' # String | The project key
43
+ feature_flag_key = 'feature_flag_key_example' # String | The feature flag key. The key identifies the flag in your code.
44
44
  flag_copy_config_post = LaunchDarklyApi::FlagCopyConfigPost.new({source: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'}), target: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'})}) # FlagCopyConfigPost |
45
45
 
46
46
  begin
47
47
  # Copy feature flag
48
- result = api_instance.copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post)
48
+ result = api_instance.copy_feature_flag(project_key, feature_flag_key, flag_copy_config_post)
49
49
  p result
50
50
  rescue LaunchDarklyApi::ApiError => e
51
51
  puts "Error when calling FeatureFlagsApi->copy_feature_flag: #{e}"
@@ -56,12 +56,12 @@ end
56
56
 
57
57
  This returns an Array which contains the response data, status code and headers.
58
58
 
59
- > <Array(<FeatureFlag>, Integer, Hash)> copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post)
59
+ > <Array(<FeatureFlag>, Integer, Hash)> copy_feature_flag_with_http_info(project_key, feature_flag_key, flag_copy_config_post)
60
60
 
61
61
  ```ruby
62
62
  begin
63
63
  # Copy feature flag
64
- data, status_code, headers = api_instance.copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post)
64
+ data, status_code, headers = api_instance.copy_feature_flag_with_http_info(project_key, feature_flag_key, flag_copy_config_post)
65
65
  p status_code # => 2xx
66
66
  p headers # => { ... }
67
67
  p data # => <FeatureFlag>
@@ -74,8 +74,8 @@ end
74
74
 
75
75
  | Name | Type | Description | Notes |
76
76
  | ---- | ---- | ----------- | ----- |
77
- | **proj_key** | **String** | The project key. | |
78
- | **feature_flag_key** | **String** | The feature flag&#39;s key. The key identifies the flag in your code. | |
77
+ | **project_key** | **String** | The project key | |
78
+ | **feature_flag_key** | **String** | The feature flag key. The key identifies the flag in your code. | |
79
79
  | **flag_copy_config_post** | [**FlagCopyConfigPost**](FlagCopyConfigPost.md) | | |
80
80
 
81
81
  ### Return type
@@ -94,7 +94,7 @@ end
94
94
 
95
95
  ## delete_feature_flag
96
96
 
97
- > delete_feature_flag(proj_key, key)
97
+ > delete_feature_flag(project_key, feature_flag_key)
98
98
 
99
99
  Delete feature flag
100
100
 
@@ -114,12 +114,12 @@ LaunchDarklyApi.configure do |config|
114
114
  end
115
115
 
116
116
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
117
- proj_key = 'proj_key_example' # String | The project key.
118
- key = 'key_example' # String | The feature flag's key. The key identifies the flag in your code.
117
+ project_key = 'project_key_example' # String | The project key
118
+ feature_flag_key = 'feature_flag_key_example' # String | The feature flag key. The key identifies the flag in your code.
119
119
 
120
120
  begin
121
121
  # Delete feature flag
122
- api_instance.delete_feature_flag(proj_key, key)
122
+ api_instance.delete_feature_flag(project_key, feature_flag_key)
123
123
  rescue LaunchDarklyApi::ApiError => e
124
124
  puts "Error when calling FeatureFlagsApi->delete_feature_flag: #{e}"
125
125
  end
@@ -129,12 +129,12 @@ end
129
129
 
130
130
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
131
131
 
132
- > <Array(nil, Integer, Hash)> delete_feature_flag_with_http_info(proj_key, key)
132
+ > <Array(nil, Integer, Hash)> delete_feature_flag_with_http_info(project_key, feature_flag_key)
133
133
 
134
134
  ```ruby
135
135
  begin
136
136
  # Delete feature flag
137
- data, status_code, headers = api_instance.delete_feature_flag_with_http_info(proj_key, key)
137
+ data, status_code, headers = api_instance.delete_feature_flag_with_http_info(project_key, feature_flag_key)
138
138
  p status_code # => 2xx
139
139
  p headers # => { ... }
140
140
  p data # => nil
@@ -147,8 +147,8 @@ end
147
147
 
148
148
  | Name | Type | Description | Notes |
149
149
  | ---- | ---- | ----------- | ----- |
150
- | **proj_key** | **String** | The project key. | |
151
- | **key** | **String** | The feature flag&#39;s key. The key identifies the flag in your code. | |
150
+ | **project_key** | **String** | The project key | |
151
+ | **feature_flag_key** | **String** | The feature flag key. The key identifies the flag in your code. | |
152
152
 
153
153
  ### Return type
154
154
 
@@ -166,7 +166,7 @@ nil (empty response body)
166
166
 
167
167
  ## get_expiring_user_targets
168
168
 
169
- > <ExpiringUserTargetGetResponse> get_expiring_user_targets(proj_key, env_key, flag_key)
169
+ > <ExpiringUserTargetGetResponse> get_expiring_user_targets(project_key, environment_key, feature_flag_key)
170
170
 
171
171
  Get expiring user targets for feature flag
172
172
 
@@ -186,13 +186,13 @@ LaunchDarklyApi.configure do |config|
186
186
  end
187
187
 
188
188
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
189
- proj_key = 'proj_key_example' # String | The project key.
190
- env_key = 'env_key_example' # String | The environment key.
191
- flag_key = 'flag_key_example' # String | The feature flag key.
189
+ project_key = 'project_key_example' # String | The project key
190
+ environment_key = 'environment_key_example' # String | The environment key
191
+ feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
192
192
 
193
193
  begin
194
194
  # Get expiring user targets for feature flag
195
- result = api_instance.get_expiring_user_targets(proj_key, env_key, flag_key)
195
+ result = api_instance.get_expiring_user_targets(project_key, environment_key, feature_flag_key)
196
196
  p result
197
197
  rescue LaunchDarklyApi::ApiError => e
198
198
  puts "Error when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
@@ -203,12 +203,12 @@ end
203
203
 
204
204
  This returns an Array which contains the response data, status code and headers.
205
205
 
206
- > <Array(<ExpiringUserTargetGetResponse>, Integer, Hash)> get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key)
206
+ > <Array(<ExpiringUserTargetGetResponse>, Integer, Hash)> get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key)
207
207
 
208
208
  ```ruby
209
209
  begin
210
210
  # Get expiring user targets for feature flag
211
- data, status_code, headers = api_instance.get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key)
211
+ data, status_code, headers = api_instance.get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key)
212
212
  p status_code # => 2xx
213
213
  p headers # => { ... }
214
214
  p data # => <ExpiringUserTargetGetResponse>
@@ -221,9 +221,9 @@ end
221
221
 
222
222
  | Name | Type | Description | Notes |
223
223
  | ---- | ---- | ----------- | ----- |
224
- | **proj_key** | **String** | The project key. | |
225
- | **env_key** | **String** | The environment key. | |
226
- | **flag_key** | **String** | The feature flag key. | |
224
+ | **project_key** | **String** | The project key | |
225
+ | **environment_key** | **String** | The environment key | |
226
+ | **feature_flag_key** | **String** | The feature flag key | |
227
227
 
228
228
  ### Return type
229
229
 
@@ -241,7 +241,7 @@ end
241
241
 
242
242
  ## get_feature_flag
243
243
 
244
- > <FeatureFlag> get_feature_flag(proj_key, key, opts)
244
+ > <FeatureFlag> get_feature_flag(project_key, feature_flag_key, opts)
245
245
 
246
246
  Get feature flag
247
247
 
@@ -261,15 +261,15 @@ LaunchDarklyApi.configure do |config|
261
261
  end
262
262
 
263
263
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
264
- proj_key = 'proj_key_example' # String | The project key
265
- key = 'key_example' # String | The feature flag key
264
+ project_key = 'project_key_example' # String | The project key
265
+ feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
266
266
  opts = {
267
267
  env: 'env_example' # String | Filter configurations by environment
268
268
  }
269
269
 
270
270
  begin
271
271
  # Get feature flag
272
- result = api_instance.get_feature_flag(proj_key, key, opts)
272
+ result = api_instance.get_feature_flag(project_key, feature_flag_key, opts)
273
273
  p result
274
274
  rescue LaunchDarklyApi::ApiError => e
275
275
  puts "Error when calling FeatureFlagsApi->get_feature_flag: #{e}"
@@ -280,12 +280,12 @@ end
280
280
 
281
281
  This returns an Array which contains the response data, status code and headers.
282
282
 
283
- > <Array(<FeatureFlag>, Integer, Hash)> get_feature_flag_with_http_info(proj_key, key, opts)
283
+ > <Array(<FeatureFlag>, Integer, Hash)> get_feature_flag_with_http_info(project_key, feature_flag_key, opts)
284
284
 
285
285
  ```ruby
286
286
  begin
287
287
  # Get feature flag
288
- data, status_code, headers = api_instance.get_feature_flag_with_http_info(proj_key, key, opts)
288
+ data, status_code, headers = api_instance.get_feature_flag_with_http_info(project_key, feature_flag_key, opts)
289
289
  p status_code # => 2xx
290
290
  p headers # => { ... }
291
291
  p data # => <FeatureFlag>
@@ -298,8 +298,8 @@ end
298
298
 
299
299
  | Name | Type | Description | Notes |
300
300
  | ---- | ---- | ----------- | ----- |
301
- | **proj_key** | **String** | The project key | |
302
- | **key** | **String** | The feature flag key | |
301
+ | **project_key** | **String** | The project key | |
302
+ | **feature_flag_key** | **String** | The feature flag key | |
303
303
  | **env** | **String** | Filter configurations by environment | [optional] |
304
304
 
305
305
  ### Return type
@@ -318,7 +318,7 @@ end
318
318
 
319
319
  ## get_feature_flag_status
320
320
 
321
- > <FlagStatusRep> get_feature_flag_status(proj_key, env_key, key)
321
+ > <FlagStatusRep> get_feature_flag_status(project_key, environment_key, feature_flag_key)
322
322
 
323
323
  Get feature flag status
324
324
 
@@ -338,13 +338,13 @@ LaunchDarklyApi.configure do |config|
338
338
  end
339
339
 
340
340
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
341
- proj_key = 'proj_key_example' # String | The project key
342
- env_key = 'env_key_example' # String | The environment key
343
- key = 'key_example' # String | The feature flag key
341
+ project_key = 'project_key_example' # String | The project key
342
+ environment_key = 'environment_key_example' # String | The environment key
343
+ feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
344
344
 
345
345
  begin
346
346
  # Get feature flag status
347
- result = api_instance.get_feature_flag_status(proj_key, env_key, key)
347
+ result = api_instance.get_feature_flag_status(project_key, environment_key, feature_flag_key)
348
348
  p result
349
349
  rescue LaunchDarklyApi::ApiError => e
350
350
  puts "Error when calling FeatureFlagsApi->get_feature_flag_status: #{e}"
@@ -355,12 +355,12 @@ end
355
355
 
356
356
  This returns an Array which contains the response data, status code and headers.
357
357
 
358
- > <Array(<FlagStatusRep>, Integer, Hash)> get_feature_flag_status_with_http_info(proj_key, env_key, key)
358
+ > <Array(<FlagStatusRep>, Integer, Hash)> get_feature_flag_status_with_http_info(project_key, environment_key, feature_flag_key)
359
359
 
360
360
  ```ruby
361
361
  begin
362
362
  # Get feature flag status
363
- data, status_code, headers = api_instance.get_feature_flag_status_with_http_info(proj_key, env_key, key)
363
+ data, status_code, headers = api_instance.get_feature_flag_status_with_http_info(project_key, environment_key, feature_flag_key)
364
364
  p status_code # => 2xx
365
365
  p headers # => { ... }
366
366
  p data # => <FlagStatusRep>
@@ -373,9 +373,9 @@ end
373
373
 
374
374
  | Name | Type | Description | Notes |
375
375
  | ---- | ---- | ----------- | ----- |
376
- | **proj_key** | **String** | The project key | |
377
- | **env_key** | **String** | The environment key | |
378
- | **key** | **String** | The feature flag key | |
376
+ | **project_key** | **String** | The project key | |
377
+ | **environment_key** | **String** | The environment key | |
378
+ | **feature_flag_key** | **String** | The feature flag key | |
379
379
 
380
380
  ### Return type
381
381
 
@@ -393,7 +393,7 @@ end
393
393
 
394
394
  ## get_feature_flag_status_across_environments
395
395
 
396
- > <FeatureFlagStatusAcrossEnvironments> get_feature_flag_status_across_environments(proj_key, key, opts)
396
+ > <FeatureFlagStatusAcrossEnvironments> get_feature_flag_status_across_environments(project_key, feature_flag_key, opts)
397
397
 
398
398
  Get flag status across environments
399
399
 
@@ -413,15 +413,15 @@ LaunchDarklyApi.configure do |config|
413
413
  end
414
414
 
415
415
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
416
- proj_key = 'proj_key_example' # String | The project key
417
- key = 'key_example' # String | The feature flag key
416
+ project_key = 'project_key_example' # String | The project key
417
+ feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
418
418
  opts = {
419
419
  env: 'env_example' # String | Optional environment filter
420
420
  }
421
421
 
422
422
  begin
423
423
  # Get flag status across environments
424
- result = api_instance.get_feature_flag_status_across_environments(proj_key, key, opts)
424
+ result = api_instance.get_feature_flag_status_across_environments(project_key, feature_flag_key, opts)
425
425
  p result
426
426
  rescue LaunchDarklyApi::ApiError => e
427
427
  puts "Error when calling FeatureFlagsApi->get_feature_flag_status_across_environments: #{e}"
@@ -432,12 +432,12 @@ end
432
432
 
433
433
  This returns an Array which contains the response data, status code and headers.
434
434
 
435
- > <Array(<FeatureFlagStatusAcrossEnvironments>, Integer, Hash)> get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts)
435
+ > <Array(<FeatureFlagStatusAcrossEnvironments>, Integer, Hash)> get_feature_flag_status_across_environments_with_http_info(project_key, feature_flag_key, opts)
436
436
 
437
437
  ```ruby
438
438
  begin
439
439
  # Get flag status across environments
440
- data, status_code, headers = api_instance.get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts)
440
+ data, status_code, headers = api_instance.get_feature_flag_status_across_environments_with_http_info(project_key, feature_flag_key, opts)
441
441
  p status_code # => 2xx
442
442
  p headers # => { ... }
443
443
  p data # => <FeatureFlagStatusAcrossEnvironments>
@@ -450,8 +450,8 @@ end
450
450
 
451
451
  | Name | Type | Description | Notes |
452
452
  | ---- | ---- | ----------- | ----- |
453
- | **proj_key** | **String** | The project key | |
454
- | **key** | **String** | The feature flag key | |
453
+ | **project_key** | **String** | The project key | |
454
+ | **feature_flag_key** | **String** | The feature flag key | |
455
455
  | **env** | **String** | Optional environment filter | [optional] |
456
456
 
457
457
  ### Return type
@@ -470,7 +470,7 @@ end
470
470
 
471
471
  ## get_feature_flag_statuses
472
472
 
473
- > <FeatureFlagStatuses> get_feature_flag_statuses(proj_key, env_key)
473
+ > <FeatureFlagStatuses> get_feature_flag_statuses(project_key, environment_key)
474
474
 
475
475
  List feature flag statuses
476
476
 
@@ -490,12 +490,12 @@ LaunchDarklyApi.configure do |config|
490
490
  end
491
491
 
492
492
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
493
- proj_key = 'proj_key_example' # String | The project key
494
- env_key = 'env_key_example' # String | Filter configurations by environment
493
+ project_key = 'project_key_example' # String | The project key
494
+ environment_key = 'environment_key_example' # String | The environment key
495
495
 
496
496
  begin
497
497
  # List feature flag statuses
498
- result = api_instance.get_feature_flag_statuses(proj_key, env_key)
498
+ result = api_instance.get_feature_flag_statuses(project_key, environment_key)
499
499
  p result
500
500
  rescue LaunchDarklyApi::ApiError => e
501
501
  puts "Error when calling FeatureFlagsApi->get_feature_flag_statuses: #{e}"
@@ -506,12 +506,12 @@ end
506
506
 
507
507
  This returns an Array which contains the response data, status code and headers.
508
508
 
509
- > <Array(<FeatureFlagStatuses>, Integer, Hash)> get_feature_flag_statuses_with_http_info(proj_key, env_key)
509
+ > <Array(<FeatureFlagStatuses>, Integer, Hash)> get_feature_flag_statuses_with_http_info(project_key, environment_key)
510
510
 
511
511
  ```ruby
512
512
  begin
513
513
  # List feature flag statuses
514
- data, status_code, headers = api_instance.get_feature_flag_statuses_with_http_info(proj_key, env_key)
514
+ data, status_code, headers = api_instance.get_feature_flag_statuses_with_http_info(project_key, environment_key)
515
515
  p status_code # => 2xx
516
516
  p headers # => { ... }
517
517
  p data # => <FeatureFlagStatuses>
@@ -524,8 +524,8 @@ end
524
524
 
525
525
  | Name | Type | Description | Notes |
526
526
  | ---- | ---- | ----------- | ----- |
527
- | **proj_key** | **String** | The project key | |
528
- | **env_key** | **String** | Filter configurations by environment | |
527
+ | **project_key** | **String** | The project key | |
528
+ | **environment_key** | **String** | The environment key | |
529
529
 
530
530
  ### Return type
531
531
 
@@ -543,7 +543,7 @@ end
543
543
 
544
544
  ## get_feature_flags
545
545
 
546
- > <FeatureFlags> get_feature_flags(proj_key, opts)
546
+ > <FeatureFlags> get_feature_flags(project_key, opts)
547
547
 
548
548
  List feature flags
549
549
 
@@ -563,22 +563,22 @@ LaunchDarklyApi.configure do |config|
563
563
  end
564
564
 
565
565
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
566
- proj_key = 'proj_key_example' # String | The project key
566
+ project_key = 'project_key_example' # String | The project key
567
567
  opts = {
568
568
  env: 'env_example', # String | Filter configurations by environment
569
569
  tag: 'tag_example', # String | Filter feature flags by tag
570
570
  limit: 789, # Integer | The number of feature flags to return. Defaults to -1, which returns all flags
571
571
  offset: 789, # Integer | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next limit items
572
- query: 'query_example', # String | A string that matches against the flags' keys and names. It is not case sensitive
573
572
  archived: true, # Boolean | A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned
574
573
  summary: true, # Boolean | By default in API version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned
575
574
  filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value
576
- sort: 'sort_example' # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
575
+ sort: 'sort_example', # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
576
+ compare: true # Boolean | A boolean to filter results by only flags that have differences between environments
577
577
  }
578
578
 
579
579
  begin
580
580
  # List feature flags
581
- result = api_instance.get_feature_flags(proj_key, opts)
581
+ result = api_instance.get_feature_flags(project_key, opts)
582
582
  p result
583
583
  rescue LaunchDarklyApi::ApiError => e
584
584
  puts "Error when calling FeatureFlagsApi->get_feature_flags: #{e}"
@@ -589,12 +589,12 @@ end
589
589
 
590
590
  This returns an Array which contains the response data, status code and headers.
591
591
 
592
- > <Array(<FeatureFlags>, Integer, Hash)> get_feature_flags_with_http_info(proj_key, opts)
592
+ > <Array(<FeatureFlags>, Integer, Hash)> get_feature_flags_with_http_info(project_key, opts)
593
593
 
594
594
  ```ruby
595
595
  begin
596
596
  # List feature flags
597
- data, status_code, headers = api_instance.get_feature_flags_with_http_info(proj_key, opts)
597
+ data, status_code, headers = api_instance.get_feature_flags_with_http_info(project_key, opts)
598
598
  p status_code # => 2xx
599
599
  p headers # => { ... }
600
600
  p data # => <FeatureFlags>
@@ -607,16 +607,16 @@ end
607
607
 
608
608
  | Name | Type | Description | Notes |
609
609
  | ---- | ---- | ----------- | ----- |
610
- | **proj_key** | **String** | The project key | |
610
+ | **project_key** | **String** | The project key | |
611
611
  | **env** | **String** | Filter configurations by environment | [optional] |
612
612
  | **tag** | **String** | Filter feature flags by tag | [optional] |
613
613
  | **limit** | **Integer** | The number of feature flags to return. Defaults to -1, which returns all flags | [optional] |
614
614
  | **offset** | **Integer** | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next limit items | [optional] |
615
- | **query** | **String** | A string that matches against the flags&#39; keys and names. It is not case sensitive | [optional] |
616
615
  | **archived** | **Boolean** | A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned | [optional] |
617
616
  | **summary** | **Boolean** | 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 | [optional] |
618
617
  | **filter** | **String** | A comma-separated list of filters. Each filter is of the form field:value | [optional] |
619
618
  | **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order | [optional] |
619
+ | **compare** | **Boolean** | A boolean to filter results by only flags that have differences between environments | [optional] |
620
620
 
621
621
  ### Return type
622
622
 
@@ -634,7 +634,7 @@ end
634
634
 
635
635
  ## patch_expiring_user_targets
636
636
 
637
- > <ExpiringUserTargetPatchResponse> patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment)
637
+ > <ExpiringUserTargetPatchResponse> patch_expiring_user_targets(project_key, environment_key, feature_flag_key, patch_with_comment)
638
638
 
639
639
  Update expiring user targets on feature flag
640
640
 
@@ -654,14 +654,14 @@ LaunchDarklyApi.configure do |config|
654
654
  end
655
655
 
656
656
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
657
- proj_key = 'proj_key_example' # String | The project key.
658
- env_key = 'env_key_example' # String | The environment key.
659
- flag_key = 'flag_key_example' # String | The feature flag key.
660
- patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})]}) # PatchWithComment |
657
+ project_key = 'project_key_example' # String | The project key
658
+ environment_key = 'environment_key_example' # String | The environment key
659
+ feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
660
+ patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField', value: new example value})]}) # PatchWithComment |
661
661
 
662
662
  begin
663
663
  # Update expiring user targets on feature flag
664
- result = api_instance.patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment)
664
+ result = api_instance.patch_expiring_user_targets(project_key, environment_key, feature_flag_key, patch_with_comment)
665
665
  p result
666
666
  rescue LaunchDarklyApi::ApiError => e
667
667
  puts "Error when calling FeatureFlagsApi->patch_expiring_user_targets: #{e}"
@@ -672,12 +672,12 @@ end
672
672
 
673
673
  This returns an Array which contains the response data, status code and headers.
674
674
 
675
- > <Array(<ExpiringUserTargetPatchResponse>, Integer, Hash)> patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment)
675
+ > <Array(<ExpiringUserTargetPatchResponse>, Integer, Hash)> patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, patch_with_comment)
676
676
 
677
677
  ```ruby
678
678
  begin
679
679
  # Update expiring user targets on feature flag
680
- data, status_code, headers = api_instance.patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment)
680
+ data, status_code, headers = api_instance.patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, patch_with_comment)
681
681
  p status_code # => 2xx
682
682
  p headers # => { ... }
683
683
  p data # => <ExpiringUserTargetPatchResponse>
@@ -690,9 +690,9 @@ end
690
690
 
691
691
  | Name | Type | Description | Notes |
692
692
  | ---- | ---- | ----------- | ----- |
693
- | **proj_key** | **String** | The project key. | |
694
- | **env_key** | **String** | The environment key. | |
695
- | **flag_key** | **String** | The feature flag key. | |
693
+ | **project_key** | **String** | The project key | |
694
+ | **environment_key** | **String** | The environment key | |
695
+ | **feature_flag_key** | **String** | The feature flag key | |
696
696
  | **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
697
697
 
698
698
  ### Return type
@@ -711,11 +711,11 @@ end
711
711
 
712
712
  ## patch_feature_flag
713
713
 
714
- > <FeatureFlag> patch_feature_flag(proj_key, key, patch_with_comment)
714
+ > <FeatureFlag> patch_feature_flag(project_key, feature_flag_key, patch_with_comment)
715
715
 
716
716
  Update feature flag
717
717
 
718
- Perform a partial update to a feature flag. ## Using JSON Patches on a feature flag When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: ```json { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ``` If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` ## Using semantic patches on a feature flag To use a [semantic patch](/#section/Updates/Updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you receive a `400` response as your semantic patch will be interpreted as a JSON patch. Use this header: ``` Content-Type: application/json; domain-model=launchdarkly.semanticpatch ``` The body of a semantic patch request takes the following three properties: 1. comment `string`: (Optional) A description of the update. 1. environmentKey `string`: (Required) The key of the LaunchDarkly environment. 1. instructions `array`: (Required) The action or list of actions to be performed by the update. Each update action in the list must be an object/hash table with a `kind` property, although depending on the action, other properties may be necessary. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, `removeUserTargets` does nothing when the targets have already been removed). They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn't correspond to a variation on the flag or a rule ID that doesn't belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions. ### Instructions #### `turnFlagOn` Sets the flag's targeting state to on. #### `turnFlagOff` Sets the flag's targeting state to off. #### `addUserTargets` Adds the user keys in `values` to the individual user targets for the variation specified by `variationId`. Returns an error if this causes the same user key to be targeted in multiple variations. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `removeUserTargets` Removes the user keys in `values` to the individual user targets for the variation specified by `variationId`. Does nothing if the user keys are not targeted. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `replaceUserTargets` Completely replaces the existing set of user targeting. All variations must be provided. Example: ```json { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"variation-1\", \"values\": [\"blah\", \"foo\", \"bar\"] }, { \"variationId\": \"variation-2\", \"values\": [\"abc\", \"def\"] } ] } ``` ##### Parameters - `targets`: a list of user targeting #### `clearUserTargets` Removes all individual user targets from the variation specified by `variationId` ##### Parameters - `variationId`: ID of a variation on the flag #### `addPrerequisite` Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag. ##### Parameters - `key`: flag key of another flag - `variationId`: ID of a variation of the flag with key `key` #### `removePrerequisite` Removes the prerequisite indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite #### `updatePrerequisite` Changes the prerequisite with flag key `key` to the variation indicated by `variationId`. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite - `variationId`: ID of a variation of the flag with key `key` #### `replacePrerequisites` Completely replaces the existing set of prerequisites for a given flag. Example: ```json { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"flag-key\", \"variationId\": \"variation-1\" }, { \"key\": \"another-flag\", \"variationId\": \"variation-2\" } ] } ``` ##### Parameters - `prerequisites`: a list of prerequisites #### `addRule` Adds a new rule to the flag with the given `clauses` which serves the variation indicated by `variationId` or the percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. If `beforeRuleId` is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list. ##### Parameters - `clauses`: Array of clauses (see `addClauses`) - `beforeRuleId`: Optional ID of a rule in the flag - `variationId`: ID of a variation of the flag - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `removeRule` Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag #### `replaceRules` Completely replaces the existing rules for a given flag. Example: ```json { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"variation-1\", \"description\": \"myRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ``` ##### Parameters - `rules`: a list of rules #### `addClauses` Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauses`: Array of clause objects, with `attribute` (string), `op` (string), and `values` (array of strings, numbers, or dates) properties. #### `removeClauses` Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. #### Parameters - `ruleId`: ID of a rule in the flag - `clauseIds`: Array of IDs of clauses in the rule #### `updateClause` Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `clause`: Clause object #### `addValuesToClause` Adds `values` to the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `values`: Array of strings #### `removeValuesFromClause` Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters `ruleId`: ID of a rule in the flag `clauseId`: ID of a clause in that rule `values`: Array of strings #### `reorderRules` Rearranges the rules to match the order given in `ruleIds`. Will return an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag #### `updateRuleVariationOrRollout` Updates what the rule indicated by `ruleId` serves if its clauses evaluate to true. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters - `ruleId`: ID of a rule in the flag - `variationId`: ID of a variation of the flag or - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `updateFallthroughVariationOrRollout` Updates the flag's fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters `variationId`: ID of a variation of the flag or `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) `rolloutBucketBy`: Optional user attribute #### `updateOffVariation` Updates the variation served when the flag's targeting is off to the variation indicated by `variationId`. ##### Parameters `variationId`: ID of a variation of the flag ### Example ```json { \"environmentKey\": \"production\", \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"turnFlagOff\" }, { \"kind\": \"addUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId\", \"userId2\"] }, { \"kind\": \"removeUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId3\", \"userId4\"] }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": null }, { \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } ], \"variationId\": null, \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": \"key\" }, { \"kind\": \"removeRule\", \"ruleId\": \"99f12464-a429-40fc-86cc-b27612188955\" }, { \"kind\": \"reorderRules\", \"ruleIds\": [\"2f72974e-de68-4243-8dd3-739582147a1f\", \"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"addClauses\", \"ruleId\": \"1134\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"in\", \"negate\": false, \"values\": [\"test@test.com\"] } ] }, { \"kind\": \"removeClauses\", \"ruleId\": \"1242529\", \"clauseIds\": [\"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"updateClause\", \"ruleId\": \"2f72974e-de68-4243-8dd3-739582147a1f\", \"clauseId\": \"309845\", \"clause\": { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } }, { \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"2342\", \"rolloutWeights\": null, \"rolloutBucketBy\": null }, { \"kind\": \"updateOffVariation\", \"variationId\": \"3242453\" }, { \"kind\": \"addPrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"updatePrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"removePrerequisite\", \"key\": \"flagKey\" } ] } ``` ## Using JSON patches on a feature flag If you do not include the header described above, you can use [JSON patch](/#section/Updates/Updates-via-JSON-Patch).
718
+ Perform a partial update to a feature flag. ## Using JSON Patches on a feature flag When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: ```json { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ``` If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` ## Using semantic patches on a feature flag To use a [semantic patch](/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).
719
719
 
720
720
  ### Examples
721
721
 
@@ -731,13 +731,13 @@ LaunchDarklyApi.configure do |config|
731
731
  end
732
732
 
733
733
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
734
- proj_key = 'proj_key_example' # String | The project key.
735
- key = 'key_example' # String | The feature flag's key. The key identifies the flag in your code.
736
- patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/biscuits', value: Chocolate Digestive})]}) # PatchWithComment |
734
+ project_key = 'project_key_example' # String | The project key
735
+ feature_flag_key = 'feature_flag_key_example' # String | The feature flag key. The key identifies the flag in your code.
736
+ patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField', value: new example value})]}) # PatchWithComment |
737
737
 
738
738
  begin
739
739
  # Update feature flag
740
- result = api_instance.patch_feature_flag(proj_key, key, patch_with_comment)
740
+ result = api_instance.patch_feature_flag(project_key, feature_flag_key, patch_with_comment)
741
741
  p result
742
742
  rescue LaunchDarklyApi::ApiError => e
743
743
  puts "Error when calling FeatureFlagsApi->patch_feature_flag: #{e}"
@@ -748,12 +748,12 @@ end
748
748
 
749
749
  This returns an Array which contains the response data, status code and headers.
750
750
 
751
- > <Array(<FeatureFlag>, Integer, Hash)> patch_feature_flag_with_http_info(proj_key, key, patch_with_comment)
751
+ > <Array(<FeatureFlag>, Integer, Hash)> patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_with_comment)
752
752
 
753
753
  ```ruby
754
754
  begin
755
755
  # Update feature flag
756
- data, status_code, headers = api_instance.patch_feature_flag_with_http_info(proj_key, key, patch_with_comment)
756
+ data, status_code, headers = api_instance.patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_with_comment)
757
757
  p status_code # => 2xx
758
758
  p headers # => { ... }
759
759
  p data # => <FeatureFlag>
@@ -766,8 +766,8 @@ end
766
766
 
767
767
  | Name | Type | Description | Notes |
768
768
  | ---- | ---- | ----------- | ----- |
769
- | **proj_key** | **String** | The project key. | |
770
- | **key** | **String** | The feature flag&#39;s key. The key identifies the flag in your code. | |
769
+ | **project_key** | **String** | The project key | |
770
+ | **feature_flag_key** | **String** | The feature flag key. The key identifies the flag in your code. | |
771
771
  | **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
772
772
 
773
773
  ### Return type
@@ -786,7 +786,7 @@ end
786
786
 
787
787
  ## post_feature_flag
788
788
 
789
- > <FeatureFlag> post_feature_flag(proj_key, feature_flag_body, opts)
789
+ > <FeatureFlag> post_feature_flag(project_key, feature_flag_body, opts)
790
790
 
791
791
  Create a feature flag
792
792
 
@@ -806,7 +806,7 @@ LaunchDarklyApi.configure do |config|
806
806
  end
807
807
 
808
808
  api_instance = LaunchDarklyApi::FeatureFlagsApi.new
809
- proj_key = 'proj_key_example' # String | The project key.
809
+ project_key = 'project_key_example' # String | The project key
810
810
  feature_flag_body = LaunchDarklyApi::FeatureFlagBody.new({name: 'name_example', key: 'key_example'}) # FeatureFlagBody |
811
811
  opts = {
812
812
  clone: 'clone_example' # String | The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag.
@@ -814,7 +814,7 @@ opts = {
814
814
 
815
815
  begin
816
816
  # Create a feature flag
817
- result = api_instance.post_feature_flag(proj_key, feature_flag_body, opts)
817
+ result = api_instance.post_feature_flag(project_key, feature_flag_body, opts)
818
818
  p result
819
819
  rescue LaunchDarklyApi::ApiError => e
820
820
  puts "Error when calling FeatureFlagsApi->post_feature_flag: #{e}"
@@ -825,12 +825,12 @@ end
825
825
 
826
826
  This returns an Array which contains the response data, status code and headers.
827
827
 
828
- > <Array(<FeatureFlag>, Integer, Hash)> post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
828
+ > <Array(<FeatureFlag>, Integer, Hash)> post_feature_flag_with_http_info(project_key, feature_flag_body, opts)
829
829
 
830
830
  ```ruby
831
831
  begin
832
832
  # Create a feature flag
833
- data, status_code, headers = api_instance.post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
833
+ data, status_code, headers = api_instance.post_feature_flag_with_http_info(project_key, feature_flag_body, opts)
834
834
  p status_code # => 2xx
835
835
  p headers # => { ... }
836
836
  p data # => <FeatureFlag>
@@ -843,7 +843,7 @@ end
843
843
 
844
844
  | Name | Type | Description | Notes |
845
845
  | ---- | ---- | ----------- | ----- |
846
- | **proj_key** | **String** | The project key. | |
846
+ | **project_key** | **String** | The project key | |
847
847
  | **feature_flag_body** | [**FeatureFlagBody**](FeatureFlagBody.md) | | |
848
848
  | **clone** | **String** | 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. | [optional] |
849
849