launchdarkly_api 7.1.1 → 9.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (738) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +162 -78
  3. data/docs/Access.md +20 -0
  4. data/docs/AccessAllowedReason.md +28 -0
  5. data/docs/{AccessDeniedRep.md → AccessAllowedRep.md} +3 -3
  6. data/docs/AccessDenied.md +20 -0
  7. data/docs/{AccessDeniedReasonRep.md → AccessDeniedReason.md} +4 -4
  8. data/docs/AccessTokensApi.md +1 -1
  9. data/docs/AccountMembersApi.md +7 -7
  10. data/docs/AccountUsageBetaApi.md +11 -11
  11. data/docs/ActionOutputRep.md +1 -1
  12. data/docs/ApprovalsApi.md +15 -15
  13. data/docs/CodeReferencesApi.md +8 -8
  14. data/docs/ConditionInputRep.md +6 -0
  15. data/docs/ConditionOutputRep.md +6 -0
  16. data/docs/Conflict.md +1 -1
  17. data/docs/CreateFlagConfigApprovalRequestRequest.md +1 -1
  18. data/docs/CustomRole.md +1 -1
  19. data/docs/CustomRolesApi.md +23 -23
  20. data/docs/DataExportDestinationsApi.md +37 -37
  21. data/docs/Destination.md +1 -1
  22. data/docs/EnvironmentPost.md +6 -4
  23. data/docs/EnvironmentsApi.md +16 -16
  24. data/docs/EvaluationReason.md +28 -0
  25. data/docs/Experiment.md +36 -0
  26. data/docs/ExperimentCollectionRep.md +22 -0
  27. data/docs/ExperimentExpandableProperties.md +20 -0
  28. data/docs/ExperimentInfoRep.md +1 -1
  29. data/docs/ExperimentPatchInput.md +20 -0
  30. data/docs/ExperimentPost.md +26 -0
  31. data/docs/{ExperimentResultsRep.md → ExperimentResults.md} +2 -2
  32. data/docs/ExperimentsBetaApi.md +490 -30
  33. data/docs/Export.md +32 -0
  34. data/docs/FeatureFlag.md +1 -1
  35. data/docs/FeatureFlagBody.md +1 -1
  36. data/docs/FeatureFlagConfig.md +1 -1
  37. data/docs/FeatureFlagScheduledChange.md +1 -1
  38. data/docs/FeatureFlags.md +3 -1
  39. data/docs/FeatureFlagsApi.md +107 -105
  40. data/docs/FeatureFlagsBetaApi.md +22 -22
  41. data/docs/FileRep.md +20 -0
  42. data/docs/FlagConfigApprovalRequestResponse.md +1 -1
  43. data/docs/FlagGlobalAttributesRep.md +1 -1
  44. data/docs/FlagInput.md +20 -0
  45. data/docs/FlagLinkCollectionRep.md +20 -0
  46. data/docs/FlagLinkMember.md +24 -0
  47. data/docs/FlagLinkPost.md +30 -0
  48. data/docs/FlagLinkRep.md +38 -0
  49. data/docs/FlagLinksBetaApi.md +310 -0
  50. data/docs/FlagRep.md +22 -0
  51. data/docs/FlagScheduledChangesInput.md +1 -1
  52. data/docs/FlagTriggerInput.md +1 -1
  53. data/docs/FlagTriggersApi.md +55 -55
  54. data/docs/Import.md +30 -0
  55. data/docs/InitiatorRep.md +20 -0
  56. data/docs/Integration.md +1 -1
  57. data/docs/IntegrationAuditLogSubscriptionsApi.md +1 -1
  58. data/docs/IntegrationDeliveryConfiguration.md +38 -0
  59. data/docs/IntegrationDeliveryConfigurationCollection.md +20 -0
  60. data/docs/IntegrationDeliveryConfigurationCollectionLinks.md +20 -0
  61. data/docs/IntegrationDeliveryConfigurationLinks.md +24 -0
  62. data/docs/IntegrationDeliveryConfigurationPost.md +24 -0
  63. data/docs/IntegrationDeliveryConfigurationResponse.md +24 -0
  64. data/docs/IntegrationDeliveryConfigurationsBetaApi.md +541 -0
  65. data/docs/IterationExpandableProperties.md +20 -0
  66. data/docs/IterationInput.md +26 -0
  67. data/docs/IterationRep.md +40 -0
  68. data/docs/{ExperimentRep.md → LegacyExperimentRep.md} +2 -2
  69. data/docs/{MemberImportItemRep.md → MemberImportItem.md} +2 -2
  70. data/docs/{MemberSummaryRep.md → MemberSummary.md} +2 -2
  71. data/docs/MetricInput.md +20 -0
  72. data/docs/MetricListingRep.md +2 -2
  73. data/docs/MetricRep.md +2 -2
  74. data/docs/MetricV2Rep.md +22 -0
  75. data/docs/MetricsApi.md +22 -22
  76. data/docs/OtherApi.md +1 -1
  77. data/docs/ParameterRep.md +20 -0
  78. data/docs/PatchOperation.md +2 -2
  79. data/docs/PermissionGrantInput.md +4 -4
  80. data/docs/PostFlagScheduledChangesInput.md +1 -1
  81. data/docs/ProjectSummary.md +22 -0
  82. data/docs/ProjectsApi.md +1 -1
  83. data/docs/RelayAutoConfigRep.md +2 -2
  84. data/docs/RelayProxyConfigurationsApi.md +1 -1
  85. data/docs/RepositoryRep.md +1 -1
  86. data/docs/ResolvedContext.md +18 -0
  87. data/docs/ResolvedImage.md +22 -0
  88. data/docs/ResolvedTitle.md +20 -0
  89. data/docs/ResolvedUIBlockElement.md +24 -0
  90. data/docs/ResolvedUIBlocks.md +26 -0
  91. data/docs/ScheduleConditionInputRep.md +6 -0
  92. data/docs/ScheduleConditionOutputRep.md +7 -1
  93. data/docs/ScheduledChangesApi.md +12 -12
  94. data/docs/SegmentsApi.md +99 -99
  95. data/docs/SegmentsBetaApi.md +319 -0
  96. data/docs/SourceEnv.md +20 -0
  97. data/docs/StageInputRep.md +2 -0
  98. data/docs/Statement.md +2 -2
  99. data/docs/StatisticRep.md +2 -0
  100. data/docs/StatisticsRep.md +20 -0
  101. data/docs/TagCollection.md +22 -0
  102. data/docs/TagsApi.md +83 -0
  103. data/docs/Team.md +32 -0
  104. data/docs/{CustomRolesRep.md → TeamCustomRole.md} +3 -3
  105. data/docs/TeamCustomRoles.md +22 -0
  106. data/docs/TeamImportsRep.md +1 -1
  107. data/docs/TeamMaintainers.md +22 -0
  108. data/docs/TeamPatchInput.md +1 -1
  109. data/docs/TeamProjects.md +20 -0
  110. data/docs/{TeamCollectionRep.md → Teams.md} +3 -3
  111. data/docs/TeamsBetaApi.md +202 -46
  112. data/docs/TimestampRep.md +24 -0
  113. data/docs/Token.md +1 -1
  114. data/docs/TreatmentInput.md +24 -0
  115. data/docs/TreatmentParameterInput.md +20 -0
  116. data/docs/TreatmentRep.md +26 -0
  117. data/docs/TriggerPost.md +1 -1
  118. data/docs/TriggerWorkflowRep.md +2 -2
  119. data/docs/User.md +0 -2
  120. data/docs/UserFlagSetting.md +3 -1
  121. data/docs/UserRecord.md +2 -2
  122. data/docs/UserSegment.md +1 -1
  123. data/docs/UserSettingsApi.md +60 -60
  124. data/docs/Users.md +1 -1
  125. data/docs/UsersApi.md +43 -43
  126. data/docs/UsersRep.md +22 -0
  127. data/docs/Webhook.md +1 -1
  128. data/docs/WebhooksApi.md +1 -1
  129. data/docs/WorkflowsBetaApi.md +8 -8
  130. data/launchdarkly_api.gemspec +2 -2
  131. data/lib/launchdarkly_api/api/access_tokens_api.rb +1 -1
  132. data/lib/launchdarkly_api/api/account_members_api.rb +7 -7
  133. data/lib/launchdarkly_api/api/account_usage_beta_api.rb +20 -20
  134. data/lib/launchdarkly_api/api/approvals_api.rb +15 -15
  135. data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
  136. data/lib/launchdarkly_api/api/code_references_api.rb +10 -10
  137. data/lib/launchdarkly_api/api/custom_roles_api.rb +30 -30
  138. data/lib/launchdarkly_api/api/data_export_destinations_api.rb +57 -57
  139. data/lib/launchdarkly_api/api/environments_api.rb +21 -21
  140. data/lib/launchdarkly_api/api/experiments_beta_api.rb +526 -49
  141. data/lib/launchdarkly_api/api/feature_flags_api.rb +162 -159
  142. data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +38 -38
  143. data/lib/launchdarkly_api/api/flag_links_beta_api.rb +332 -0
  144. data/lib/launchdarkly_api/api/flag_triggers_api.rb +96 -96
  145. data/lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb +1 -1
  146. data/lib/launchdarkly_api/api/integration_delivery_configurations_beta_api.rb +569 -0
  147. data/lib/launchdarkly_api/api/metrics_api.rb +28 -28
  148. data/lib/launchdarkly_api/api/other_api.rb +3 -3
  149. data/lib/launchdarkly_api/api/projects_api.rb +1 -1
  150. data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +1 -1
  151. data/lib/launchdarkly_api/api/scheduled_changes_api.rb +11 -11
  152. data/lib/launchdarkly_api/api/segments_api.rb +160 -160
  153. data/lib/launchdarkly_api/api/segments_beta_api.rb +345 -0
  154. data/lib/launchdarkly_api/api/tags_api.rb +85 -0
  155. data/lib/launchdarkly_api/api/teams_beta_api.rb +195 -57
  156. data/lib/launchdarkly_api/api/user_settings_api.rb +100 -100
  157. data/lib/launchdarkly_api/api/users_api.rb +72 -72
  158. data/lib/launchdarkly_api/api/users_beta_api.rb +1 -1
  159. data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
  160. data/lib/launchdarkly_api/api/workflows_beta_api.rb +9 -9
  161. data/lib/launchdarkly_api/api_client.rb +1 -1
  162. data/lib/launchdarkly_api/api_error.rb +1 -1
  163. data/lib/launchdarkly_api/configuration.rb +1 -1
  164. data/lib/launchdarkly_api/models/access.rb +241 -0
  165. data/lib/launchdarkly_api/models/access_allowed_reason.rb +280 -0
  166. data/lib/launchdarkly_api/models/access_allowed_rep.rb +237 -0
  167. data/lib/launchdarkly_api/models/access_denied.rb +237 -0
  168. data/lib/launchdarkly_api/models/access_denied_reason.rb +280 -0
  169. data/lib/launchdarkly_api/models/access_token_post.rb +1 -1
  170. data/lib/launchdarkly_api/models/action_input_rep.rb +1 -1
  171. data/lib/launchdarkly_api/models/action_output_rep.rb +2 -2
  172. data/lib/launchdarkly_api/models/approval_condition_input_rep.rb +1 -1
  173. data/lib/launchdarkly_api/models/approval_condition_output_rep.rb +1 -1
  174. data/lib/launchdarkly_api/models/approval_settings.rb +1 -1
  175. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +1 -1
  176. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +1 -1
  177. data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +1 -1
  178. data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +1 -1
  179. data/lib/launchdarkly_api/models/big_segment_target.rb +1 -1
  180. data/lib/launchdarkly_api/models/branch_collection_rep.rb +1 -1
  181. data/lib/launchdarkly_api/models/branch_rep.rb +1 -1
  182. data/lib/launchdarkly_api/models/clause.rb +1 -1
  183. data/lib/launchdarkly_api/models/client_side_availability.rb +1 -1
  184. data/lib/launchdarkly_api/models/client_side_availability_post.rb +1 -1
  185. data/lib/launchdarkly_api/models/condition_base_output_rep.rb +1 -1
  186. data/lib/launchdarkly_api/models/condition_input_rep.rb +29 -2
  187. data/lib/launchdarkly_api/models/condition_output_rep.rb +29 -2
  188. data/lib/launchdarkly_api/models/confidence_interval_rep.rb +1 -1
  189. data/lib/launchdarkly_api/models/conflict.rb +4 -5
  190. data/lib/launchdarkly_api/models/conflict_output_rep.rb +1 -1
  191. data/lib/launchdarkly_api/models/copied_from_env.rb +1 -1
  192. data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +1 -1
  193. data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +2 -2
  194. data/lib/launchdarkly_api/models/custom_property.rb +1 -1
  195. data/lib/launchdarkly_api/models/custom_role.rb +2 -2
  196. data/lib/launchdarkly_api/models/custom_role_post.rb +1 -1
  197. data/lib/launchdarkly_api/models/custom_role_post_data.rb +1 -1
  198. data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
  199. data/lib/launchdarkly_api/models/custom_workflow_input_rep.rb +1 -1
  200. data/lib/launchdarkly_api/models/custom_workflow_meta.rb +1 -1
  201. data/lib/launchdarkly_api/models/custom_workflow_output_rep.rb +1 -1
  202. data/lib/launchdarkly_api/models/custom_workflow_stage_meta.rb +1 -1
  203. data/lib/launchdarkly_api/models/custom_workflows_listing_output_rep.rb +1 -1
  204. data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +1 -1
  205. data/lib/launchdarkly_api/models/defaults.rb +1 -1
  206. data/lib/launchdarkly_api/models/dependent_flag.rb +1 -1
  207. data/lib/launchdarkly_api/models/dependent_flag_environment.rb +1 -1
  208. data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +1 -1
  209. data/lib/launchdarkly_api/models/destination.rb +2 -2
  210. data/lib/launchdarkly_api/models/destination_post.rb +1 -1
  211. data/lib/launchdarkly_api/models/destinations.rb +1 -1
  212. data/lib/launchdarkly_api/models/environment.rb +1 -1
  213. data/lib/launchdarkly_api/models/environment_post.rb +17 -8
  214. data/lib/launchdarkly_api/models/evaluation_reason.rb +274 -0
  215. data/lib/launchdarkly_api/models/execution_output_rep.rb +1 -1
  216. data/lib/launchdarkly_api/models/experiment.rb +328 -0
  217. data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +1 -1
  218. data/lib/launchdarkly_api/models/experiment_collection_rep.rb +240 -0
  219. data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +1 -1
  220. data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +1 -1
  221. data/lib/launchdarkly_api/models/experiment_expandable_properties.rb +229 -0
  222. data/lib/launchdarkly_api/models/experiment_info_rep.rb +2 -2
  223. data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +1 -1
  224. data/lib/launchdarkly_api/models/experiment_patch_input.rb +229 -0
  225. data/lib/launchdarkly_api/models/experiment_post.rb +279 -0
  226. data/lib/launchdarkly_api/models/experiment_results.rb +280 -0
  227. data/lib/launchdarkly_api/models/experiment_stats_rep.rb +1 -1
  228. data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +1 -1
  229. data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +1 -1
  230. data/lib/launchdarkly_api/models/experiment_totals_rep.rb +1 -1
  231. data/lib/launchdarkly_api/models/expiring_user_target_error.rb +1 -1
  232. data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +1 -1
  233. data/lib/launchdarkly_api/models/expiring_user_target_item.rb +1 -1
  234. data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +1 -1
  235. data/lib/launchdarkly_api/models/export.rb +323 -0
  236. data/lib/launchdarkly_api/models/extinction.rb +1 -1
  237. data/lib/launchdarkly_api/models/extinction_collection_rep.rb +1 -1
  238. data/lib/launchdarkly_api/models/feature_flag.rb +2 -2
  239. data/lib/launchdarkly_api/models/feature_flag_body.rb +2 -2
  240. data/lib/launchdarkly_api/models/feature_flag_config.rb +2 -2
  241. data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +2 -2
  242. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +1 -1
  243. data/lib/launchdarkly_api/models/feature_flag_status.rb +1 -1
  244. data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
  245. data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
  246. data/lib/launchdarkly_api/models/feature_flags.rb +14 -5
  247. data/lib/launchdarkly_api/models/file_rep.rb +227 -0
  248. data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +2 -2
  249. data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +1 -1
  250. data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +1 -1
  251. data/lib/launchdarkly_api/models/flag_copy_config_post.rb +1 -1
  252. data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +2 -2
  253. data/lib/launchdarkly_api/models/flag_input.rb +237 -0
  254. data/lib/launchdarkly_api/models/flag_link_collection_rep.rb +241 -0
  255. data/lib/launchdarkly_api/models/flag_link_member.rb +257 -0
  256. data/lib/launchdarkly_api/models/flag_link_post.rb +274 -0
  257. data/lib/launchdarkly_api/models/flag_link_rep.rb +337 -0
  258. data/lib/launchdarkly_api/models/flag_listing_rep.rb +1 -1
  259. data/lib/launchdarkly_api/models/flag_rep.rb +243 -0
  260. data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +2 -2
  261. data/lib/launchdarkly_api/models/flag_status_rep.rb +1 -1
  262. data/lib/launchdarkly_api/models/flag_summary.rb +1 -1
  263. data/lib/launchdarkly_api/models/flag_trigger_input.rb +2 -2
  264. data/lib/launchdarkly_api/models/forbidden_error_rep.rb +1 -1
  265. data/lib/launchdarkly_api/models/hunk_rep.rb +1 -1
  266. data/lib/launchdarkly_api/models/import.rb +306 -0
  267. data/lib/launchdarkly_api/models/initiator_rep.rb +227 -0
  268. data/lib/launchdarkly_api/models/integration.rb +2 -2
  269. data/lib/launchdarkly_api/models/integration_delivery_configuration.rb +369 -0
  270. data/lib/launchdarkly_api/models/integration_delivery_configuration_collection.rb +239 -0
  271. data/lib/launchdarkly_api/models/integration_delivery_configuration_collection_links.rb +232 -0
  272. data/lib/launchdarkly_api/models/integration_delivery_configuration_links.rb +265 -0
  273. data/lib/launchdarkly_api/models/integration_delivery_configuration_post.rb +257 -0
  274. data/lib/launchdarkly_api/models/integration_delivery_configuration_response.rb +245 -0
  275. data/lib/launchdarkly_api/models/integration_metadata.rb +1 -1
  276. data/lib/launchdarkly_api/models/integration_status.rb +1 -1
  277. data/lib/launchdarkly_api/models/integration_status_rep.rb +1 -1
  278. data/lib/launchdarkly_api/models/integration_subscription_status_rep.rb +1 -1
  279. data/lib/launchdarkly_api/models/integrations.rb +1 -1
  280. data/lib/launchdarkly_api/models/invalid_request_error_rep.rb +1 -1
  281. data/lib/launchdarkly_api/models/ip_list.rb +1 -1
  282. data/lib/launchdarkly_api/models/iteration_expandable_properties.rb +231 -0
  283. data/lib/launchdarkly_api/models/iteration_input.rb +280 -0
  284. data/lib/launchdarkly_api/models/iteration_rep.rb +333 -0
  285. data/lib/launchdarkly_api/models/last_seen_metadata.rb +1 -1
  286. data/lib/launchdarkly_api/models/legacy_experiment_rep.rb +249 -0
  287. data/lib/launchdarkly_api/models/link.rb +1 -1
  288. data/lib/launchdarkly_api/models/member.rb +1 -1
  289. data/lib/launchdarkly_api/models/member_data_rep.rb +1 -1
  290. data/lib/launchdarkly_api/models/member_import_item.rb +246 -0
  291. data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +1 -1
  292. data/lib/launchdarkly_api/models/member_summary.rb +285 -0
  293. data/lib/launchdarkly_api/models/member_team_summary_rep.rb +1 -1
  294. data/lib/launchdarkly_api/models/member_teams_post_input.rb +1 -1
  295. data/lib/launchdarkly_api/models/members.rb +1 -1
  296. data/lib/launchdarkly_api/models/method_not_allowed_error_rep.rb +1 -1
  297. data/lib/launchdarkly_api/models/metric_collection_rep.rb +1 -1
  298. data/lib/launchdarkly_api/models/metric_input.rb +237 -0
  299. data/lib/launchdarkly_api/models/metric_listing_rep.rb +3 -3
  300. data/lib/launchdarkly_api/models/metric_post.rb +1 -1
  301. data/lib/launchdarkly_api/models/metric_rep.rb +3 -3
  302. data/lib/launchdarkly_api/models/metric_seen.rb +1 -1
  303. data/lib/launchdarkly_api/models/metric_v2_rep.rb +253 -0
  304. data/lib/launchdarkly_api/models/modification.rb +1 -1
  305. data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +1 -1
  306. data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +1 -1
  307. data/lib/launchdarkly_api/models/new_member_form.rb +1 -1
  308. data/lib/launchdarkly_api/models/not_found_error_rep.rb +1 -1
  309. data/lib/launchdarkly_api/models/parameter_rep.rb +227 -0
  310. data/lib/launchdarkly_api/models/parent_resource_rep.rb +1 -1
  311. data/lib/launchdarkly_api/models/patch_failed_error_rep.rb +1 -1
  312. data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
  313. data/lib/launchdarkly_api/models/patch_segment_instruction.rb +1 -1
  314. data/lib/launchdarkly_api/models/patch_segment_request.rb +1 -1
  315. data/lib/launchdarkly_api/models/patch_with_comment.rb +1 -1
  316. data/lib/launchdarkly_api/models/permission_grant_input.rb +16 -16
  317. data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +1 -1
  318. data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +1 -1
  319. data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +2 -2
  320. data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
  321. data/lib/launchdarkly_api/models/project.rb +1 -1
  322. data/lib/launchdarkly_api/models/project_listing_rep.rb +1 -1
  323. data/lib/launchdarkly_api/models/project_post.rb +1 -1
  324. data/lib/launchdarkly_api/models/project_summary.rb +238 -0
  325. data/lib/launchdarkly_api/models/projects.rb +1 -1
  326. data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +1 -1
  327. data/lib/launchdarkly_api/models/put_branch.rb +1 -1
  328. data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +1 -1
  329. data/lib/launchdarkly_api/models/recent_trigger_body.rb +1 -1
  330. data/lib/launchdarkly_api/models/reference_rep.rb +1 -1
  331. data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +1 -1
  332. data/lib/launchdarkly_api/models/relay_auto_config_post.rb +1 -1
  333. data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +3 -3
  334. data/lib/launchdarkly_api/models/repository_collection_rep.rb +1 -1
  335. data/lib/launchdarkly_api/models/repository_post.rb +1 -1
  336. data/lib/launchdarkly_api/models/repository_rep.rb +2 -2
  337. data/lib/launchdarkly_api/models/resolved_context.rb +220 -0
  338. data/lib/launchdarkly_api/models/resolved_image.rb +236 -0
  339. data/lib/launchdarkly_api/models/resolved_title.rb +229 -0
  340. data/lib/launchdarkly_api/models/resolved_ui_block_element.rb +245 -0
  341. data/lib/launchdarkly_api/models/resolved_ui_blocks.rb +254 -0
  342. data/lib/launchdarkly_api/models/resource_access.rb +1 -1
  343. data/lib/launchdarkly_api/models/resource_id_response.rb +1 -1
  344. data/lib/launchdarkly_api/models/review_output_rep.rb +1 -1
  345. data/lib/launchdarkly_api/models/review_response.rb +1 -1
  346. data/lib/launchdarkly_api/models/rollout.rb +1 -1
  347. data/lib/launchdarkly_api/models/rule.rb +1 -1
  348. data/lib/launchdarkly_api/models/schedule_condition_input_rep.rb +29 -2
  349. data/lib/launchdarkly_api/models/schedule_condition_output_rep.rb +32 -5
  350. data/lib/launchdarkly_api/models/sdk_list_rep.rb +1 -1
  351. data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +1 -1
  352. data/lib/launchdarkly_api/models/sdk_version_rep.rb +1 -1
  353. data/lib/launchdarkly_api/models/segment_body.rb +1 -1
  354. data/lib/launchdarkly_api/models/segment_metadata.rb +1 -1
  355. data/lib/launchdarkly_api/models/segment_user_list.rb +1 -1
  356. data/lib/launchdarkly_api/models/segment_user_state.rb +1 -1
  357. data/lib/launchdarkly_api/models/series_list_rep.rb +1 -1
  358. data/lib/launchdarkly_api/models/source_env.rb +229 -0
  359. data/lib/launchdarkly_api/models/source_flag.rb +1 -1
  360. data/lib/launchdarkly_api/models/stage_input_rep.rb +11 -2
  361. data/lib/launchdarkly_api/models/stage_output_rep.rb +1 -1
  362. data/lib/launchdarkly_api/models/statement.rb +3 -3
  363. data/lib/launchdarkly_api/models/statement_post.rb +1 -1
  364. data/lib/launchdarkly_api/models/statement_post_data.rb +1 -1
  365. data/lib/launchdarkly_api/models/statement_rep.rb +1 -1
  366. data/lib/launchdarkly_api/models/statistic_collection_rep.rb +1 -1
  367. data/lib/launchdarkly_api/models/statistic_rep.rb +16 -2
  368. data/lib/launchdarkly_api/models/statistics_rep.rb +231 -0
  369. data/lib/launchdarkly_api/models/statistics_root.rb +1 -1
  370. data/lib/launchdarkly_api/models/status_conflict_error_rep.rb +1 -1
  371. data/lib/launchdarkly_api/models/subject_data_rep.rb +1 -1
  372. data/lib/launchdarkly_api/models/subscription_post.rb +1 -1
  373. data/lib/launchdarkly_api/models/tag_collection.rb +252 -0
  374. data/lib/launchdarkly_api/models/target.rb +1 -1
  375. data/lib/launchdarkly_api/models/target_resource_rep.rb +1 -1
  376. data/lib/launchdarkly_api/models/team.rb +283 -0
  377. data/lib/launchdarkly_api/models/team_custom_role.rb +245 -0
  378. data/lib/launchdarkly_api/models/team_custom_roles.rb +240 -0
  379. data/lib/launchdarkly_api/models/team_imports_rep.rb +2 -2
  380. data/lib/launchdarkly_api/models/team_maintainers.rb +240 -0
  381. data/lib/launchdarkly_api/models/team_patch_input.rb +2 -2
  382. data/lib/launchdarkly_api/models/team_post_input.rb +1 -1
  383. data/lib/launchdarkly_api/models/team_projects.rb +229 -0
  384. data/lib/launchdarkly_api/models/teams.rb +240 -0
  385. data/lib/launchdarkly_api/models/timestamp_rep.rb +245 -0
  386. data/lib/launchdarkly_api/models/title_rep.rb +1 -1
  387. data/lib/launchdarkly_api/models/token.rb +2 -2
  388. data/lib/launchdarkly_api/models/token_data_rep.rb +1 -1
  389. data/lib/launchdarkly_api/models/tokens.rb +1 -1
  390. data/lib/launchdarkly_api/models/treatment_input.rb +267 -0
  391. data/lib/launchdarkly_api/models/treatment_parameter_input.rb +237 -0
  392. data/lib/launchdarkly_api/models/treatment_rep.rb +266 -0
  393. data/lib/launchdarkly_api/models/trigger_post.rb +2 -2
  394. data/lib/launchdarkly_api/models/trigger_workflow_collection_rep.rb +1 -1
  395. data/lib/launchdarkly_api/models/trigger_workflow_rep.rb +3 -3
  396. data/lib/launchdarkly_api/models/unauthorized_error_rep.rb +1 -1
  397. data/lib/launchdarkly_api/models/url_post.rb +1 -1
  398. data/lib/launchdarkly_api/models/user.rb +2 -13
  399. data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +1 -1
  400. data/lib/launchdarkly_api/models/user_flag_setting.rb +15 -6
  401. data/lib/launchdarkly_api/models/user_flag_settings.rb +1 -1
  402. data/lib/launchdarkly_api/models/user_record.rb +2 -2
  403. data/lib/launchdarkly_api/models/user_record_rep.rb +1 -1
  404. data/lib/launchdarkly_api/models/user_segment.rb +2 -2
  405. data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
  406. data/lib/launchdarkly_api/models/user_segments.rb +1 -1
  407. data/lib/launchdarkly_api/models/users.rb +1 -1
  408. data/lib/launchdarkly_api/models/users_rep.rb +250 -0
  409. data/lib/launchdarkly_api/models/value_put.rb +1 -1
  410. data/lib/launchdarkly_api/models/variation.rb +1 -1
  411. data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +1 -1
  412. data/lib/launchdarkly_api/models/variation_summary.rb +1 -1
  413. data/lib/launchdarkly_api/models/versions_rep.rb +1 -1
  414. data/lib/launchdarkly_api/models/webhook.rb +2 -2
  415. data/lib/launchdarkly_api/models/webhook_post.rb +1 -1
  416. data/lib/launchdarkly_api/models/webhooks.rb +1 -1
  417. data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
  418. data/lib/launchdarkly_api/version.rb +2 -2
  419. data/lib/launchdarkly_api.rb +62 -14
  420. data/spec/api/access_tokens_api_spec.rb +1 -1
  421. data/spec/api/account_members_api_spec.rb +4 -4
  422. data/spec/api/account_usage_beta_api_spec.rb +4 -4
  423. data/spec/api/approvals_api_spec.rb +8 -8
  424. data/spec/api/audit_log_api_spec.rb +1 -1
  425. data/spec/api/code_references_api_spec.rb +2 -2
  426. data/spec/api/custom_roles_api_spec.rb +5 -5
  427. data/spec/api/data_export_destinations_api_spec.rb +9 -9
  428. data/spec/api/environments_api_spec.rb +4 -4
  429. data/spec/api/experiments_beta_api_spec.rb +96 -10
  430. data/spec/api/feature_flags_api_spec.rb +26 -25
  431. data/spec/api/feature_flags_beta_api_spec.rb +8 -8
  432. data/spec/api/flag_links_beta_api_spec.rb +91 -0
  433. data/spec/api/flag_triggers_api_spec.rb +16 -16
  434. data/spec/api/integration_audit_log_subscriptions_api_spec.rb +1 -1
  435. data/spec/api/integration_delivery_configurations_beta_api_spec.rb +135 -0
  436. data/spec/api/metrics_api_spec.rb +4 -4
  437. data/spec/api/other_api_spec.rb +2 -2
  438. data/spec/api/projects_api_spec.rb +1 -1
  439. data/spec/api/relay_proxy_configurations_api_spec.rb +1 -1
  440. data/spec/api/scheduled_changes_api_spec.rb +6 -6
  441. data/spec/api/segments_api_spec.rb +28 -28
  442. data/spec/api/segments_beta_api_spec.rb +95 -0
  443. data/spec/api/tags_api_spec.rb +48 -0
  444. data/spec/api/teams_beta_api_spec.rb +41 -13
  445. data/spec/api/user_settings_api_spec.rb +18 -18
  446. data/spec/api/users_api_spec.rb +13 -13
  447. data/spec/api/users_beta_api_spec.rb +1 -1
  448. data/spec/api/webhooks_api_spec.rb +1 -1
  449. data/spec/api/workflows_beta_api_spec.rb +5 -5
  450. data/spec/api_client_spec.rb +1 -1
  451. data/spec/configuration_spec.rb +1 -1
  452. data/spec/models/access_allowed_reason_spec.rb +64 -0
  453. data/spec/models/access_allowed_rep_spec.rb +40 -0
  454. data/spec/models/access_denied_reason_spec.rb +64 -0
  455. data/spec/models/access_denied_spec.rb +40 -0
  456. data/spec/models/access_spec.rb +40 -0
  457. data/spec/models/access_token_post_spec.rb +1 -1
  458. data/spec/models/action_input_rep_spec.rb +1 -1
  459. data/spec/models/action_output_rep_spec.rb +1 -1
  460. data/spec/models/approval_condition_input_rep_spec.rb +1 -1
  461. data/spec/models/approval_condition_output_rep_spec.rb +1 -1
  462. data/spec/models/approval_settings_spec.rb +1 -1
  463. data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +1 -1
  464. data/spec/models/audit_log_entry_listing_rep_spec.rb +1 -1
  465. data/spec/models/audit_log_entry_rep_spec.rb +1 -1
  466. data/spec/models/authorized_app_data_rep_spec.rb +1 -1
  467. data/spec/models/big_segment_target_spec.rb +1 -1
  468. data/spec/models/branch_collection_rep_spec.rb +1 -1
  469. data/spec/models/branch_rep_spec.rb +1 -1
  470. data/spec/models/clause_spec.rb +1 -1
  471. data/spec/models/client_side_availability_post_spec.rb +1 -1
  472. data/spec/models/client_side_availability_spec.rb +1 -1
  473. data/spec/models/condition_base_output_rep_spec.rb +1 -1
  474. data/spec/models/condition_input_rep_spec.rb +19 -1
  475. data/spec/models/condition_output_rep_spec.rb +19 -1
  476. data/spec/models/confidence_interval_rep_spec.rb +1 -1
  477. data/spec/models/conflict_output_rep_spec.rb +1 -1
  478. data/spec/models/conflict_spec.rb +1 -1
  479. data/spec/models/copied_from_env_spec.rb +1 -1
  480. data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +1 -1
  481. data/spec/models/create_flag_config_approval_request_request_spec.rb +1 -1
  482. data/spec/models/custom_property_spec.rb +1 -1
  483. data/spec/models/custom_role_post_data_spec.rb +1 -1
  484. data/spec/models/custom_role_post_spec.rb +1 -1
  485. data/spec/models/custom_role_spec.rb +1 -1
  486. data/spec/models/custom_roles_spec.rb +1 -1
  487. data/spec/models/custom_workflow_input_rep_spec.rb +1 -1
  488. data/spec/models/custom_workflow_meta_spec.rb +1 -1
  489. data/spec/models/custom_workflow_output_rep_spec.rb +1 -1
  490. data/spec/models/custom_workflow_stage_meta_spec.rb +1 -1
  491. data/spec/models/custom_workflows_listing_output_rep_spec.rb +1 -1
  492. data/spec/models/default_client_side_availability_post_spec.rb +1 -1
  493. data/spec/models/defaults_spec.rb +1 -1
  494. data/spec/models/dependent_flag_environment_spec.rb +1 -1
  495. data/spec/models/dependent_flag_spec.rb +1 -1
  496. data/spec/models/dependent_flags_by_environment_spec.rb +1 -1
  497. data/spec/models/destination_post_spec.rb +1 -1
  498. data/spec/models/destination_spec.rb +1 -1
  499. data/spec/models/destinations_spec.rb +1 -1
  500. data/spec/models/environment_post_spec.rb +7 -1
  501. data/spec/models/environment_spec.rb +1 -1
  502. data/spec/models/evaluation_reason_spec.rb +64 -0
  503. data/spec/models/execution_output_rep_spec.rb +1 -1
  504. data/spec/models/experiment_allocation_rep_spec.rb +1 -1
  505. data/spec/models/experiment_collection_rep_spec.rb +46 -0
  506. data/spec/models/experiment_enabled_period_rep_spec.rb +1 -1
  507. data/spec/models/experiment_environment_setting_rep_spec.rb +1 -1
  508. data/spec/models/experiment_expandable_properties_spec.rb +40 -0
  509. data/spec/models/experiment_info_rep_spec.rb +1 -1
  510. data/spec/models/experiment_metadata_rep_spec.rb +1 -1
  511. data/spec/models/experiment_patch_input_spec.rb +40 -0
  512. data/spec/models/experiment_post_spec.rb +58 -0
  513. data/spec/models/experiment_results_spec.rb +70 -0
  514. data/spec/models/experiment_spec.rb +88 -0
  515. data/spec/models/experiment_stats_rep_spec.rb +1 -1
  516. data/spec/models/experiment_time_series_slice_spec.rb +1 -1
  517. data/spec/models/experiment_time_series_variation_slice_spec.rb +1 -1
  518. data/spec/models/experiment_totals_rep_spec.rb +1 -1
  519. data/spec/models/expiring_user_target_error_spec.rb +1 -1
  520. data/spec/models/expiring_user_target_get_response_spec.rb +1 -1
  521. data/spec/models/expiring_user_target_item_spec.rb +1 -1
  522. data/spec/models/expiring_user_target_patch_response_spec.rb +1 -1
  523. data/spec/models/export_spec.rb +76 -0
  524. data/spec/models/extinction_collection_rep_spec.rb +1 -1
  525. data/spec/models/extinction_spec.rb +1 -1
  526. data/spec/models/feature_flag_body_spec.rb +1 -1
  527. data/spec/models/feature_flag_config_spec.rb +1 -1
  528. data/spec/models/feature_flag_scheduled_change_spec.rb +1 -1
  529. data/spec/models/feature_flag_scheduled_changes_spec.rb +1 -1
  530. data/spec/models/feature_flag_spec.rb +1 -1
  531. data/spec/models/feature_flag_status_across_environments_spec.rb +1 -1
  532. data/spec/models/feature_flag_status_spec.rb +1 -1
  533. data/spec/models/feature_flag_statuses_spec.rb +1 -1
  534. data/spec/models/feature_flags_spec.rb +7 -1
  535. data/spec/models/file_rep_spec.rb +40 -0
  536. data/spec/models/flag_config_approval_request_response_spec.rb +1 -1
  537. data/spec/models/flag_config_approval_requests_response_spec.rb +1 -1
  538. data/spec/models/flag_copy_config_environment_spec.rb +1 -1
  539. data/spec/models/flag_copy_config_post_spec.rb +1 -1
  540. data/spec/models/flag_global_attributes_rep_spec.rb +1 -1
  541. data/spec/models/flag_input_spec.rb +40 -0
  542. data/spec/models/flag_link_collection_rep_spec.rb +40 -0
  543. data/spec/models/flag_link_member_spec.rb +52 -0
  544. data/spec/models/flag_link_post_spec.rb +70 -0
  545. data/spec/models/flag_link_rep_spec.rb +94 -0
  546. data/spec/models/flag_listing_rep_spec.rb +1 -1
  547. data/spec/models/flag_rep_spec.rb +46 -0
  548. data/spec/models/flag_scheduled_changes_input_spec.rb +1 -1
  549. data/spec/models/flag_status_rep_spec.rb +1 -1
  550. data/spec/models/flag_summary_spec.rb +1 -1
  551. data/spec/models/flag_trigger_input_spec.rb +1 -1
  552. data/spec/models/forbidden_error_rep_spec.rb +1 -1
  553. data/spec/models/hunk_rep_spec.rb +1 -1
  554. data/spec/models/import_spec.rb +70 -0
  555. data/spec/models/initiator_rep_spec.rb +40 -0
  556. data/spec/models/integration_delivery_configuration_collection_links_spec.rb +40 -0
  557. data/spec/models/integration_delivery_configuration_collection_spec.rb +40 -0
  558. data/spec/models/integration_delivery_configuration_links_spec.rb +52 -0
  559. data/spec/models/integration_delivery_configuration_post_spec.rb +52 -0
  560. data/spec/models/integration_delivery_configuration_response_spec.rb +52 -0
  561. data/spec/models/integration_delivery_configuration_spec.rb +94 -0
  562. data/spec/models/integration_metadata_spec.rb +1 -1
  563. data/spec/models/integration_spec.rb +1 -1
  564. data/spec/models/integration_status_rep_spec.rb +1 -1
  565. data/spec/models/integration_status_spec.rb +1 -1
  566. data/spec/models/integration_subscription_status_rep_spec.rb +1 -1
  567. data/spec/models/integrations_spec.rb +1 -1
  568. data/spec/models/invalid_request_error_rep_spec.rb +1 -1
  569. data/spec/models/ip_list_spec.rb +1 -1
  570. data/spec/models/iteration_expandable_properties_spec.rb +40 -0
  571. data/spec/models/iteration_input_spec.rb +58 -0
  572. data/spec/models/iteration_rep_spec.rb +100 -0
  573. data/spec/models/last_seen_metadata_spec.rb +1 -1
  574. data/spec/models/legacy_experiment_rep_spec.rb +52 -0
  575. data/spec/models/link_spec.rb +1 -1
  576. data/spec/models/member_data_rep_spec.rb +1 -1
  577. data/spec/models/member_import_item_spec.rb +46 -0
  578. data/spec/models/member_permission_grant_summary_rep_spec.rb +1 -1
  579. data/spec/models/member_spec.rb +1 -1
  580. data/spec/models/member_summary_spec.rb +64 -0
  581. data/spec/models/member_team_summary_rep_spec.rb +1 -1
  582. data/spec/models/member_teams_post_input_spec.rb +1 -1
  583. data/spec/models/members_spec.rb +1 -1
  584. data/spec/models/method_not_allowed_error_rep_spec.rb +1 -1
  585. data/spec/models/metric_collection_rep_spec.rb +1 -1
  586. data/spec/models/metric_input_spec.rb +40 -0
  587. data/spec/models/metric_listing_rep_spec.rb +1 -1
  588. data/spec/models/metric_post_spec.rb +1 -1
  589. data/spec/models/metric_rep_spec.rb +1 -1
  590. data/spec/models/metric_seen_spec.rb +1 -1
  591. data/spec/models/metric_v2_rep_spec.rb +46 -0
  592. data/spec/models/modification_spec.rb +1 -1
  593. data/spec/models/multi_environment_dependent_flag_spec.rb +1 -1
  594. data/spec/models/multi_environment_dependent_flags_spec.rb +1 -1
  595. data/spec/models/new_member_form_spec.rb +1 -1
  596. data/spec/models/not_found_error_rep_spec.rb +1 -1
  597. data/spec/models/parameter_rep_spec.rb +40 -0
  598. data/spec/models/parent_resource_rep_spec.rb +1 -1
  599. data/spec/models/patch_failed_error_rep_spec.rb +1 -1
  600. data/spec/models/patch_operation_spec.rb +1 -1
  601. data/spec/models/patch_segment_instruction_spec.rb +1 -1
  602. data/spec/models/patch_segment_request_spec.rb +1 -1
  603. data/spec/models/patch_with_comment_spec.rb +1 -1
  604. data/spec/models/permission_grant_input_spec.rb +3 -3
  605. data/spec/models/post_approval_request_apply_request_spec.rb +1 -1
  606. data/spec/models/post_approval_request_review_request_spec.rb +1 -1
  607. data/spec/models/post_flag_scheduled_changes_input_spec.rb +1 -1
  608. data/spec/models/prerequisite_spec.rb +1 -1
  609. data/spec/models/project_listing_rep_spec.rb +1 -1
  610. data/spec/models/project_post_spec.rb +1 -1
  611. data/spec/models/project_spec.rb +1 -1
  612. data/spec/models/project_summary_spec.rb +46 -0
  613. data/spec/models/projects_spec.rb +1 -1
  614. data/spec/models/pub_nub_detail_rep_spec.rb +1 -1
  615. data/spec/models/put_branch_spec.rb +1 -1
  616. data/spec/models/rate_limited_error_rep_spec.rb +1 -1
  617. data/spec/models/recent_trigger_body_spec.rb +1 -1
  618. data/spec/models/reference_rep_spec.rb +1 -1
  619. data/spec/models/relay_auto_config_collection_rep_spec.rb +1 -1
  620. data/spec/models/relay_auto_config_post_spec.rb +1 -1
  621. data/spec/models/relay_auto_config_rep_spec.rb +1 -1
  622. data/spec/models/repository_collection_rep_spec.rb +1 -1
  623. data/spec/models/repository_post_spec.rb +1 -1
  624. data/spec/models/repository_rep_spec.rb +1 -1
  625. data/spec/models/resolved_context_spec.rb +34 -0
  626. data/spec/models/resolved_image_spec.rb +46 -0
  627. data/spec/models/resolved_title_spec.rb +40 -0
  628. data/spec/models/resolved_ui_block_element_spec.rb +52 -0
  629. data/spec/models/resolved_ui_blocks_spec.rb +58 -0
  630. data/spec/models/resource_access_spec.rb +1 -1
  631. data/spec/models/resource_id_response_spec.rb +1 -1
  632. data/spec/models/review_output_rep_spec.rb +1 -1
  633. data/spec/models/review_response_spec.rb +1 -1
  634. data/spec/models/rollout_spec.rb +1 -1
  635. data/spec/models/rule_spec.rb +1 -1
  636. data/spec/models/schedule_condition_input_rep_spec.rb +19 -1
  637. data/spec/models/schedule_condition_output_rep_spec.rb +19 -1
  638. data/spec/models/sdk_list_rep_spec.rb +1 -1
  639. data/spec/models/sdk_version_list_rep_spec.rb +1 -1
  640. data/spec/models/sdk_version_rep_spec.rb +1 -1
  641. data/spec/models/segment_body_spec.rb +1 -1
  642. data/spec/models/segment_metadata_spec.rb +1 -1
  643. data/spec/models/segment_user_list_spec.rb +1 -1
  644. data/spec/models/segment_user_state_spec.rb +1 -1
  645. data/spec/models/series_list_rep_spec.rb +1 -1
  646. data/spec/models/source_env_spec.rb +40 -0
  647. data/spec/models/source_flag_spec.rb +1 -1
  648. data/spec/models/stage_input_rep_spec.rb +7 -1
  649. data/spec/models/stage_output_rep_spec.rb +1 -1
  650. data/spec/models/statement_post_data_spec.rb +1 -1
  651. data/spec/models/statement_post_spec.rb +1 -1
  652. data/spec/models/statement_rep_spec.rb +1 -1
  653. data/spec/models/statement_spec.rb +1 -1
  654. data/spec/models/statistic_collection_rep_spec.rb +1 -1
  655. data/spec/models/statistic_rep_spec.rb +7 -1
  656. data/spec/models/statistics_rep_spec.rb +40 -0
  657. data/spec/models/statistics_root_spec.rb +1 -1
  658. data/spec/models/status_conflict_error_rep_spec.rb +1 -1
  659. data/spec/models/subject_data_rep_spec.rb +1 -1
  660. data/spec/models/subscription_post_spec.rb +1 -1
  661. data/spec/models/tag_collection_spec.rb +46 -0
  662. data/spec/models/target_resource_rep_spec.rb +1 -1
  663. data/spec/models/target_spec.rb +1 -1
  664. data/spec/models/team_custom_role_spec.rb +52 -0
  665. data/spec/models/team_custom_roles_spec.rb +46 -0
  666. data/spec/models/team_imports_rep_spec.rb +1 -1
  667. data/spec/models/team_maintainers_spec.rb +46 -0
  668. data/spec/models/team_patch_input_spec.rb +1 -1
  669. data/spec/models/team_post_input_spec.rb +1 -1
  670. data/spec/models/team_projects_spec.rb +40 -0
  671. data/spec/models/team_spec.rb +76 -0
  672. data/spec/models/teams_spec.rb +46 -0
  673. data/spec/models/timestamp_rep_spec.rb +52 -0
  674. data/spec/models/title_rep_spec.rb +1 -1
  675. data/spec/models/token_data_rep_spec.rb +1 -1
  676. data/spec/models/token_spec.rb +1 -1
  677. data/spec/models/tokens_spec.rb +1 -1
  678. data/spec/models/treatment_input_spec.rb +52 -0
  679. data/spec/models/treatment_parameter_input_spec.rb +40 -0
  680. data/spec/models/treatment_rep_spec.rb +58 -0
  681. data/spec/models/trigger_post_spec.rb +1 -1
  682. data/spec/models/trigger_workflow_collection_rep_spec.rb +1 -1
  683. data/spec/models/trigger_workflow_rep_spec.rb +1 -1
  684. data/spec/models/unauthorized_error_rep_spec.rb +1 -1
  685. data/spec/models/url_post_spec.rb +1 -1
  686. data/spec/models/user_attribute_names_rep_spec.rb +1 -1
  687. data/spec/models/user_flag_setting_spec.rb +7 -1
  688. data/spec/models/user_flag_settings_spec.rb +1 -1
  689. data/spec/models/user_record_rep_spec.rb +1 -1
  690. data/spec/models/user_record_spec.rb +1 -1
  691. data/spec/models/user_segment_rule_spec.rb +1 -1
  692. data/spec/models/user_segment_spec.rb +1 -1
  693. data/spec/models/user_segments_spec.rb +1 -1
  694. data/spec/models/user_spec.rb +1 -7
  695. data/spec/models/users_rep_spec.rb +46 -0
  696. data/spec/models/users_spec.rb +1 -1
  697. data/spec/models/value_put_spec.rb +1 -1
  698. data/spec/models/variation_or_rollout_rep_spec.rb +1 -1
  699. data/spec/models/variation_spec.rb +1 -1
  700. data/spec/models/variation_summary_spec.rb +1 -1
  701. data/spec/models/versions_rep_spec.rb +1 -1
  702. data/spec/models/webhook_post_spec.rb +1 -1
  703. data/spec/models/webhook_spec.rb +1 -1
  704. data/spec/models/webhooks_spec.rb +1 -1
  705. data/spec/models/weighted_variation_spec.rb +1 -1
  706. data/spec/spec_helper.rb +1 -1
  707. metadata +300 -79
  708. data/docs/AccessRep.md +0 -18
  709. data/docs/DerivedAttribute.md +0 -20
  710. data/docs/ExpandedTeamRep.md +0 -44
  711. data/docs/PermissionGrantRep.md +0 -24
  712. data/docs/TeamRep.md +0 -40
  713. data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +0 -280
  714. data/lib/launchdarkly_api/models/access_denied_rep.rb +0 -237
  715. data/lib/launchdarkly_api/models/access_rep.rb +0 -225
  716. data/lib/launchdarkly_api/models/custom_roles_rep.rb +0 -247
  717. data/lib/launchdarkly_api/models/derived_attribute.rb +0 -228
  718. data/lib/launchdarkly_api/models/expanded_team_rep.rb +0 -349
  719. data/lib/launchdarkly_api/models/experiment_rep.rb +0 -249
  720. data/lib/launchdarkly_api/models/experiment_results_rep.rb +0 -280
  721. data/lib/launchdarkly_api/models/member_import_item_rep.rb +0 -246
  722. data/lib/launchdarkly_api/models/member_summary_rep.rb +0 -285
  723. data/lib/launchdarkly_api/models/permission_grant_rep.rb +0 -249
  724. data/lib/launchdarkly_api/models/team_collection_rep.rb +0 -240
  725. data/lib/launchdarkly_api/models/team_rep.rb +0 -327
  726. data/spec/models/access_denied_reason_rep_spec.rb +0 -64
  727. data/spec/models/access_denied_rep_spec.rb +0 -40
  728. data/spec/models/access_rep_spec.rb +0 -34
  729. data/spec/models/custom_roles_rep_spec.rb +0 -52
  730. data/spec/models/derived_attribute_spec.rb +0 -40
  731. data/spec/models/expanded_team_rep_spec.rb +0 -112
  732. data/spec/models/experiment_rep_spec.rb +0 -52
  733. data/spec/models/experiment_results_rep_spec.rb +0 -70
  734. data/spec/models/member_import_item_rep_spec.rb +0 -46
  735. data/spec/models/member_summary_rep_spec.rb +0 -64
  736. data/spec/models/permission_grant_rep_spec.rb +0 -52
  737. data/spec/models/team_collection_rep_spec.rb +0 -46
  738. data/spec/models/team_rep_spec.rb +0 -100
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #LaunchDarkly REST API
3
3
 
4
- ## Overview ## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > #### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ### Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ### Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. ## Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ### Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ### Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. ## Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ### Updates via JSON Patch [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ### Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ### Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ### Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsForSegment) ## Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ### HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | ## CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. ## Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ### Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ### Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ### IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. ## OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. ## Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). ## Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. ## Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ### Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` ## Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ### Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ### Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
4
+ ## Overview ## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > #### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ### Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ### Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. ## Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ### Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource, such as a single feature flag, you receive a _detailed representation_ of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. In most cases, the detailed representation contains all of the attributes of the resource. In a few cases, the detailed representation contains many, but not all, of the attributes of the resource. Typically this happens when an attribute of the requested resource is itself paginated. You can request that the response include a particular attribute by using the `expand` request parameter. ### Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. ### Expanding responses Sometimes the detailed representation of a resource does not include all of the attributes of the resource by default. If this is the case, the request method will clearly document this and describe which attributes you can include in an expanded response. To include the additional attributes, append the `expand` request parameter to your request and add a comma-separated list of the attributes to include. For example, when you append `?expand=members,roles` to the [Get team](/tag/Teams-(beta)#operation/getTeam) endpoint, the expanded response includes both of these attributes. ## Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ### Updates via JSON Patch [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ### Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ### Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ### Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsForSegment) ## Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ### HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | ## CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. ## Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ### Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ### Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ### IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. ## OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. ## Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). ## Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. ## Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Overview/Beta-resources). ### Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` ## Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ### Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20210729 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released in yyyymmdd format. In the example above the version `20210729` corresponds to July 29, 2021. ### Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing. ### API version changelog | Version | Changes | |---|---| | `20210729` | <ul><li>Changed the [create approval request](/tag/Approvals#operation/postApprovalRequest) return value. It now returns HTTP Status Code `201` instead of `200`.</li><li> Changed the [get users](/tag/Users#operation/getUser) return value. It now returns a user record, not a user. </li><li> Added additional optional fields to environment, segments, flags, members, and segments, including the ability to create Big Segments. </li><li> Added default values for flag variations when new environments are created. </li><li> Added filtering and pagination for getting flags and members, including `limit`, `number`, `filter`, and `sort` query parameters. </li><li> Added endpoints for expiring user targets for flags and segments, scheduled changes, access tokens, Relay Proxy configuration, integrations and subscriptions, and approvals. </li></ul> | | `20191212` | <ul><li>[List feature flags](/tag/Feature-flags#operation/getFeatureFlags) now defaults to sending summaries of feature flag configurations, equivalent to setting the query parameter `summary=true`. Summaries omit flag targeting rules and individual user targets from the payload. </li><li> Added endpoints for flags, flag status, projects, environments, users, audit logs, members, users, custom roles, segments, usage, streams, events, and data export. </li></ul> | | `20160426` | <ul><li>Initial versioning of API. Tokens created before versioning have their version set to this.</li></ul> |
5
5
 
6
6
  The version of the OpenAPI document: 2.0
7
7
  Contact: support@launchdarkly.com
@@ -21,41 +21,41 @@ module LaunchDarklyApi
21
21
  end
22
22
  # Delete segment
23
23
  # Delete a user segment.
24
- # @param proj_key [String] The project key.
25
- # @param env_key [String] The environment key.
26
- # @param key [String] The user segment key.
24
+ # @param project_key [String] The project key
25
+ # @param environment_key [String] The environment key
26
+ # @param segment_key [String] The segment key
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @return [nil]
29
- def delete_segment(proj_key, env_key, key, opts = {})
30
- delete_segment_with_http_info(proj_key, env_key, key, opts)
29
+ def delete_segment(project_key, environment_key, segment_key, opts = {})
30
+ delete_segment_with_http_info(project_key, environment_key, segment_key, opts)
31
31
  nil
32
32
  end
33
33
 
34
34
  # Delete segment
35
35
  # Delete a user segment.
36
- # @param proj_key [String] The project key.
37
- # @param env_key [String] The environment key.
38
- # @param key [String] The user segment key.
36
+ # @param project_key [String] The project key
37
+ # @param environment_key [String] The environment key
38
+ # @param segment_key [String] The segment key
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
41
- def delete_segment_with_http_info(proj_key, env_key, key, opts = {})
41
+ def delete_segment_with_http_info(project_key, environment_key, segment_key, opts = {})
42
42
  if @api_client.config.debugging
43
43
  @api_client.config.logger.debug 'Calling API: SegmentsApi.delete_segment ...'
44
44
  end
45
- # verify the required parameter 'proj_key' is set
46
- if @api_client.config.client_side_validation && proj_key.nil?
47
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.delete_segment"
45
+ # verify the required parameter 'project_key' is set
46
+ if @api_client.config.client_side_validation && project_key.nil?
47
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.delete_segment"
48
48
  end
49
- # verify the required parameter 'env_key' is set
50
- if @api_client.config.client_side_validation && env_key.nil?
51
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.delete_segment"
49
+ # verify the required parameter 'environment_key' is set
50
+ if @api_client.config.client_side_validation && environment_key.nil?
51
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.delete_segment"
52
52
  end
53
- # verify the required parameter 'key' is set
54
- if @api_client.config.client_side_validation && key.nil?
55
- fail ArgumentError, "Missing the required parameter 'key' when calling SegmentsApi.delete_segment"
53
+ # verify the required parameter 'segment_key' is set
54
+ if @api_client.config.client_side_validation && segment_key.nil?
55
+ fail ArgumentError, "Missing the required parameter 'segment_key' when calling SegmentsApi.delete_segment"
56
56
  end
57
57
  # resource path
58
- local_var_path = '/api/v2/segments/{projKey}/{envKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
58
+ local_var_path = '/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s))
59
59
 
60
60
  # query parameters
61
61
  query_params = opts[:query_params] || {}
@@ -96,41 +96,41 @@ module LaunchDarklyApi
96
96
 
97
97
  # Get expiring user targets for segment
98
98
  # Get a list of a segment's user targets that are scheduled for removal
99
- # @param proj_key [String] The project key.
100
- # @param env_key [String] The environment key.
101
- # @param segment_key [String] The segment key.
99
+ # @param project_key [String] The project key
100
+ # @param environment_key [String] The environment key
101
+ # @param segment_key [String] The segment key
102
102
  # @param [Hash] opts the optional parameters
103
103
  # @return [ExpiringUserTargetGetResponse]
104
- def get_expiring_user_targets_for_segment(proj_key, env_key, segment_key, opts = {})
105
- data, _status_code, _headers = get_expiring_user_targets_for_segment_with_http_info(proj_key, env_key, segment_key, opts)
104
+ def get_expiring_user_targets_for_segment(project_key, environment_key, segment_key, opts = {})
105
+ data, _status_code, _headers = get_expiring_user_targets_for_segment_with_http_info(project_key, environment_key, segment_key, opts)
106
106
  data
107
107
  end
108
108
 
109
109
  # Get expiring user targets for segment
110
110
  # Get a list of a segment&#39;s user targets that are scheduled for removal
111
- # @param proj_key [String] The project key.
112
- # @param env_key [String] The environment key.
113
- # @param segment_key [String] The segment key.
111
+ # @param project_key [String] The project key
112
+ # @param environment_key [String] The environment key
113
+ # @param segment_key [String] The segment key
114
114
  # @param [Hash] opts the optional parameters
115
115
  # @return [Array<(ExpiringUserTargetGetResponse, Integer, Hash)>] ExpiringUserTargetGetResponse data, response status code and response headers
116
- def get_expiring_user_targets_for_segment_with_http_info(proj_key, env_key, segment_key, opts = {})
116
+ def get_expiring_user_targets_for_segment_with_http_info(project_key, environment_key, segment_key, opts = {})
117
117
  if @api_client.config.debugging
118
118
  @api_client.config.logger.debug 'Calling API: SegmentsApi.get_expiring_user_targets_for_segment ...'
119
119
  end
120
- # verify the required parameter 'proj_key' is set
121
- if @api_client.config.client_side_validation && proj_key.nil?
122
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.get_expiring_user_targets_for_segment"
120
+ # verify the required parameter 'project_key' is set
121
+ if @api_client.config.client_side_validation && project_key.nil?
122
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.get_expiring_user_targets_for_segment"
123
123
  end
124
- # verify the required parameter 'env_key' is set
125
- if @api_client.config.client_side_validation && env_key.nil?
126
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.get_expiring_user_targets_for_segment"
124
+ # verify the required parameter 'environment_key' is set
125
+ if @api_client.config.client_side_validation && environment_key.nil?
126
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.get_expiring_user_targets_for_segment"
127
127
  end
128
128
  # verify the required parameter 'segment_key' is set
129
129
  if @api_client.config.client_side_validation && segment_key.nil?
130
130
  fail ArgumentError, "Missing the required parameter 'segment_key' when calling SegmentsApi.get_expiring_user_targets_for_segment"
131
131
  end
132
132
  # resource path
133
- local_var_path = '/api/v2/segments/{projKey}/{segmentKey}/expiring-user-targets/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s))
133
+ local_var_path = '/api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s))
134
134
 
135
135
  # query parameters
136
136
  query_params = opts[:query_params] || {}
@@ -171,41 +171,41 @@ module LaunchDarklyApi
171
171
 
172
172
  # Get segment
173
173
  # Get a single user segment by key
174
- # @param proj_key [String] The project key.
175
- # @param env_key [String] The environment key.
176
- # @param key [String] The segment key
174
+ # @param project_key [String] The project key
175
+ # @param environment_key [String] The environment key
176
+ # @param segment_key [String] The segment key
177
177
  # @param [Hash] opts the optional parameters
178
178
  # @return [UserSegment]
179
- def get_segment(proj_key, env_key, key, opts = {})
180
- data, _status_code, _headers = get_segment_with_http_info(proj_key, env_key, key, opts)
179
+ def get_segment(project_key, environment_key, segment_key, opts = {})
180
+ data, _status_code, _headers = get_segment_with_http_info(project_key, environment_key, segment_key, opts)
181
181
  data
182
182
  end
183
183
 
184
184
  # Get segment
185
185
  # Get a single user segment by key
186
- # @param proj_key [String] The project key.
187
- # @param env_key [String] The environment key.
188
- # @param key [String] The segment key
186
+ # @param project_key [String] The project key
187
+ # @param environment_key [String] The environment key
188
+ # @param segment_key [String] The segment key
189
189
  # @param [Hash] opts the optional parameters
190
190
  # @return [Array<(UserSegment, Integer, Hash)>] UserSegment data, response status code and response headers
191
- def get_segment_with_http_info(proj_key, env_key, key, opts = {})
191
+ def get_segment_with_http_info(project_key, environment_key, segment_key, opts = {})
192
192
  if @api_client.config.debugging
193
193
  @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment ...'
194
194
  end
195
- # verify the required parameter 'proj_key' is set
196
- if @api_client.config.client_side_validation && proj_key.nil?
197
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.get_segment"
195
+ # verify the required parameter 'project_key' is set
196
+ if @api_client.config.client_side_validation && project_key.nil?
197
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.get_segment"
198
198
  end
199
- # verify the required parameter 'env_key' is set
200
- if @api_client.config.client_side_validation && env_key.nil?
201
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.get_segment"
199
+ # verify the required parameter 'environment_key' is set
200
+ if @api_client.config.client_side_validation && environment_key.nil?
201
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.get_segment"
202
202
  end
203
- # verify the required parameter 'key' is set
204
- if @api_client.config.client_side_validation && key.nil?
205
- fail ArgumentError, "Missing the required parameter 'key' when calling SegmentsApi.get_segment"
203
+ # verify the required parameter 'segment_key' is set
204
+ if @api_client.config.client_side_validation && segment_key.nil?
205
+ fail ArgumentError, "Missing the required parameter 'segment_key' when calling SegmentsApi.get_segment"
206
206
  end
207
207
  # resource path
208
- local_var_path = '/api/v2/segments/{projKey}/{envKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
208
+ local_var_path = '/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s))
209
209
 
210
210
  # query parameters
211
211
  query_params = opts[:query_params] || {}
@@ -246,47 +246,47 @@ module LaunchDarklyApi
246
246
 
247
247
  # Get Big Segment membership for user
248
248
  # Returns the membership status (included/excluded) for a given user in this segment. This operation does not support basic Segments.
249
- # @param proj_key [String] The project key.
250
- # @param env_key [String] The environment key.
251
- # @param key [String] The segment key.
252
- # @param user_key [String] The user key.
249
+ # @param project_key [String] The project key
250
+ # @param environment_key [String] The environment key
251
+ # @param segment_key [String] The segment key
252
+ # @param user_key [String] The user key
253
253
  # @param [Hash] opts the optional parameters
254
254
  # @return [BigSegmentTarget]
255
- def get_segment_membership_for_user(proj_key, env_key, key, user_key, opts = {})
256
- data, _status_code, _headers = get_segment_membership_for_user_with_http_info(proj_key, env_key, key, user_key, opts)
255
+ def get_segment_membership_for_user(project_key, environment_key, segment_key, user_key, opts = {})
256
+ data, _status_code, _headers = get_segment_membership_for_user_with_http_info(project_key, environment_key, segment_key, user_key, opts)
257
257
  data
258
258
  end
259
259
 
260
260
  # Get Big Segment membership for user
261
261
  # Returns the membership status (included/excluded) for a given user in this segment. This operation does not support basic Segments.
262
- # @param proj_key [String] The project key.
263
- # @param env_key [String] The environment key.
264
- # @param key [String] The segment key.
265
- # @param user_key [String] The user key.
262
+ # @param project_key [String] The project key
263
+ # @param environment_key [String] The environment key
264
+ # @param segment_key [String] The segment key
265
+ # @param user_key [String] The user key
266
266
  # @param [Hash] opts the optional parameters
267
267
  # @return [Array<(BigSegmentTarget, Integer, Hash)>] BigSegmentTarget data, response status code and response headers
268
- def get_segment_membership_for_user_with_http_info(proj_key, env_key, key, user_key, opts = {})
268
+ def get_segment_membership_for_user_with_http_info(project_key, environment_key, segment_key, user_key, opts = {})
269
269
  if @api_client.config.debugging
270
270
  @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_membership_for_user ...'
271
271
  end
272
- # verify the required parameter 'proj_key' is set
273
- if @api_client.config.client_side_validation && proj_key.nil?
274
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.get_segment_membership_for_user"
272
+ # verify the required parameter 'project_key' is set
273
+ if @api_client.config.client_side_validation && project_key.nil?
274
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.get_segment_membership_for_user"
275
275
  end
276
- # verify the required parameter 'env_key' is set
277
- if @api_client.config.client_side_validation && env_key.nil?
278
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.get_segment_membership_for_user"
276
+ # verify the required parameter 'environment_key' is set
277
+ if @api_client.config.client_side_validation && environment_key.nil?
278
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.get_segment_membership_for_user"
279
279
  end
280
- # verify the required parameter 'key' is set
281
- if @api_client.config.client_side_validation && key.nil?
282
- fail ArgumentError, "Missing the required parameter 'key' when calling SegmentsApi.get_segment_membership_for_user"
280
+ # verify the required parameter 'segment_key' is set
281
+ if @api_client.config.client_side_validation && segment_key.nil?
282
+ fail ArgumentError, "Missing the required parameter 'segment_key' when calling SegmentsApi.get_segment_membership_for_user"
283
283
  end
284
284
  # verify the required parameter 'user_key' is set
285
285
  if @api_client.config.client_side_validation && user_key.nil?
286
286
  fail ArgumentError, "Missing the required parameter 'user_key' when calling SegmentsApi.get_segment_membership_for_user"
287
287
  end
288
288
  # resource path
289
- local_var_path = '/api/v2/segments/{projKey}/{envKey}/{key}/users/{userKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s)).sub('{' + 'userKey' + '}', CGI.escape(user_key.to_s))
289
+ local_var_path = '/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users/{userKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s)).sub('{' + 'userKey' + '}', CGI.escape(user_key.to_s))
290
290
 
291
291
  # query parameters
292
292
  query_params = opts[:query_params] || {}
@@ -327,35 +327,35 @@ module LaunchDarklyApi
327
327
 
328
328
  # List segments
329
329
  # Get a list of all user segments in the given project
330
- # @param proj_key [String] The project key.
331
- # @param env_key [String] The environment key.
330
+ # @param project_key [String] The project key
331
+ # @param environment_key [String] The environment key
332
332
  # @param [Hash] opts the optional parameters
333
333
  # @return [UserSegments]
334
- def get_segments(proj_key, env_key, opts = {})
335
- data, _status_code, _headers = get_segments_with_http_info(proj_key, env_key, opts)
334
+ def get_segments(project_key, environment_key, opts = {})
335
+ data, _status_code, _headers = get_segments_with_http_info(project_key, environment_key, opts)
336
336
  data
337
337
  end
338
338
 
339
339
  # List segments
340
340
  # Get a list of all user segments in the given project
341
- # @param proj_key [String] The project key.
342
- # @param env_key [String] The environment key.
341
+ # @param project_key [String] The project key
342
+ # @param environment_key [String] The environment key
343
343
  # @param [Hash] opts the optional parameters
344
344
  # @return [Array<(UserSegments, Integer, Hash)>] UserSegments data, response status code and response headers
345
- def get_segments_with_http_info(proj_key, env_key, opts = {})
345
+ def get_segments_with_http_info(project_key, environment_key, opts = {})
346
346
  if @api_client.config.debugging
347
347
  @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segments ...'
348
348
  end
349
- # verify the required parameter 'proj_key' is set
350
- if @api_client.config.client_side_validation && proj_key.nil?
351
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.get_segments"
349
+ # verify the required parameter 'project_key' is set
350
+ if @api_client.config.client_side_validation && project_key.nil?
351
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.get_segments"
352
352
  end
353
- # verify the required parameter 'env_key' is set
354
- if @api_client.config.client_side_validation && env_key.nil?
355
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.get_segments"
353
+ # verify the required parameter 'environment_key' is set
354
+ if @api_client.config.client_side_validation && environment_key.nil?
355
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.get_segments"
356
356
  end
357
357
  # resource path
358
- local_var_path = '/api/v2/segments/{projKey}/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s))
358
+ local_var_path = '/api/v2/segments/{projectKey}/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s))
359
359
 
360
360
  # query parameters
361
361
  query_params = opts[:query_params] || {}
@@ -396,36 +396,36 @@ module LaunchDarklyApi
396
396
 
397
397
  # Update expiring user targets for segment
398
398
  # Update the list of a segment's user targets that are scheduled for removal<br /><br />Requires a semantic patch representation of the desired changes to the resource. To learn more about semantic patches, read [Updates](/reference#updates-via-semantic-patches).<br /><br />If the request is well-formed but any of its instructions failed to process, this operation returns status code `200`. In this case, the response `errors` array will be non-empty.
399
- # @param proj_key [String] The project key.
400
- # @param env_key [String] The environment key.
401
- # @param segment_key [String] The user segment key.
399
+ # @param project_key [String] The project key
400
+ # @param environment_key [String] The environment key
401
+ # @param segment_key [String] The segment key
402
402
  # @param patch_segment_request [PatchSegmentRequest]
403
403
  # @param [Hash] opts the optional parameters
404
404
  # @return [ExpiringUserTargetPatchResponse]
405
- def patch_expiring_user_targets_for_segment(proj_key, env_key, segment_key, patch_segment_request, opts = {})
406
- data, _status_code, _headers = patch_expiring_user_targets_for_segment_with_http_info(proj_key, env_key, segment_key, patch_segment_request, opts)
405
+ def patch_expiring_user_targets_for_segment(project_key, environment_key, segment_key, patch_segment_request, opts = {})
406
+ data, _status_code, _headers = patch_expiring_user_targets_for_segment_with_http_info(project_key, environment_key, segment_key, patch_segment_request, opts)
407
407
  data
408
408
  end
409
409
 
410
410
  # Update expiring user targets for segment
411
411
  # Update the list of a segment&#39;s user targets that are scheduled for removal&lt;br /&gt;&lt;br /&gt;Requires a semantic patch representation of the desired changes to the resource. To learn more about semantic patches, read [Updates](/reference#updates-via-semantic-patches).&lt;br /&gt;&lt;br /&gt;If the request is well-formed but any of its instructions failed to process, this operation returns status code &#x60;200&#x60;. In this case, the response &#x60;errors&#x60; array will be non-empty.
412
- # @param proj_key [String] The project key.
413
- # @param env_key [String] The environment key.
414
- # @param segment_key [String] The user segment key.
412
+ # @param project_key [String] The project key
413
+ # @param environment_key [String] The environment key
414
+ # @param segment_key [String] The segment key
415
415
  # @param patch_segment_request [PatchSegmentRequest]
416
416
  # @param [Hash] opts the optional parameters
417
417
  # @return [Array<(ExpiringUserTargetPatchResponse, Integer, Hash)>] ExpiringUserTargetPatchResponse data, response status code and response headers
418
- def patch_expiring_user_targets_for_segment_with_http_info(proj_key, env_key, segment_key, patch_segment_request, opts = {})
418
+ def patch_expiring_user_targets_for_segment_with_http_info(project_key, environment_key, segment_key, patch_segment_request, opts = {})
419
419
  if @api_client.config.debugging
420
420
  @api_client.config.logger.debug 'Calling API: SegmentsApi.patch_expiring_user_targets_for_segment ...'
421
421
  end
422
- # verify the required parameter 'proj_key' is set
423
- if @api_client.config.client_side_validation && proj_key.nil?
424
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.patch_expiring_user_targets_for_segment"
422
+ # verify the required parameter 'project_key' is set
423
+ if @api_client.config.client_side_validation && project_key.nil?
424
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.patch_expiring_user_targets_for_segment"
425
425
  end
426
- # verify the required parameter 'env_key' is set
427
- if @api_client.config.client_side_validation && env_key.nil?
428
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.patch_expiring_user_targets_for_segment"
426
+ # verify the required parameter 'environment_key' is set
427
+ if @api_client.config.client_side_validation && environment_key.nil?
428
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.patch_expiring_user_targets_for_segment"
429
429
  end
430
430
  # verify the required parameter 'segment_key' is set
431
431
  if @api_client.config.client_side_validation && segment_key.nil?
@@ -436,7 +436,7 @@ module LaunchDarklyApi
436
436
  fail ArgumentError, "Missing the required parameter 'patch_segment_request' when calling SegmentsApi.patch_expiring_user_targets_for_segment"
437
437
  end
438
438
  # resource path
439
- local_var_path = '/api/v2/segments/{projKey}/{segmentKey}/expiring-user-targets/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s))
439
+ local_var_path = '/api/v2/segments/{projectKey}/{segmentKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s))
440
440
 
441
441
  # query parameters
442
442
  query_params = opts[:query_params] || {}
@@ -481,48 +481,48 @@ module LaunchDarklyApi
481
481
  end
482
482
 
483
483
  # Patch segment
484
- # Update a user segment. The request body must be a valid JSON patch or JSON merge patch document. To learn more about semantic patches, read [Updates](/#section/Overview/Updates).
485
- # @param proj_key [String] The project key.
486
- # @param env_key [String] The environment key.
487
- # @param key [String] The user segment key.
484
+ # Update a user segment. The request body must be a valid JSON patch, JSON merge patch, or semantic patch. ## Using semantic patches on a segment To use a [semantic patch](/reference#updates-via-semantic-patches) on a segment 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 segment will not be changed. In general, instructions will silently do nothing if the segment is already in the state requested by the patch instruction. For example, `addIncludedUsers` does nothing when the targets have already been included. Specific error conditions are noted in the instruction descriptions. ### Instructions #### `addIncludedUsers` Adds the user keys in `values` to the individual user targets included in the segment. Returns an error if this causes the same user key to be both included and excluded. ##### Parameters - `values`: list of user keys #### `addExcludedUsers` Adds the user keys in `values` to the individual user targets excluded from the segment. Returns an error if this causes the same user key to be both included and excluded. ##### Parameters - `values`: list of user keys #### `removeIncludedUsers` Removes the user keys in `values` from the individual user targets included in the segment. ##### Parameters - `values`: list of user keys #### `removeExcludedUsers` Removes the user keys in `values` from the individual user targets excluded from the segment. ##### Parameters - `values`: list of user keys #### `updateName` Updates the name of the segment to the string provided in `value`. ##### Parameters - `value`: string ## Using JSON patches on a segment If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch). For example, to update the description for a segment, use the following request body: ```json { \"patch\": [ { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"new description\" } ] } ``` To update fields in the segment that are arrays, set the `path` to the name of the field and then append `/<array index>`. Using `/0` adds the new entry to the beginning of the array. For example, to add a rule to a segment, use the following request body: ```json { \"patch\":[ { \"op\": \"add\", \"path\": \"/rules/0\", \"value\": { \"clauses\": [{ \"attribute\": \"email\", \"op\": \"endsWith\", \"values\": [\".edu\"], \"negate\": false }] } } ] } ``` To add or remove users from segments, we recommend using semantic patch. Semantic patch for segments includes specific `instructions` for adding and removing both included and excluded users.
485
+ # @param project_key [String] The project key
486
+ # @param environment_key [String] The environment key
487
+ # @param segment_key [String] The segment key
488
488
  # @param patch_with_comment [PatchWithComment]
489
489
  # @param [Hash] opts the optional parameters
490
490
  # @return [UserSegment]
491
- def patch_segment(proj_key, env_key, key, patch_with_comment, opts = {})
492
- data, _status_code, _headers = patch_segment_with_http_info(proj_key, env_key, key, patch_with_comment, opts)
491
+ def patch_segment(project_key, environment_key, segment_key, patch_with_comment, opts = {})
492
+ data, _status_code, _headers = patch_segment_with_http_info(project_key, environment_key, segment_key, patch_with_comment, opts)
493
493
  data
494
494
  end
495
495
 
496
496
  # Patch segment
497
- # Update a user segment. The request body must be a valid JSON patch or JSON merge patch document. To learn more about semantic patches, read [Updates](/#section/Overview/Updates).
498
- # @param proj_key [String] The project key.
499
- # @param env_key [String] The environment key.
500
- # @param key [String] The user segment key.
497
+ # Update a user segment. The request body must be a valid JSON patch, JSON merge patch, or semantic patch. ## Using semantic patches on a segment To use a [semantic patch](/reference#updates-via-semantic-patches) on a segment resource, you must include a header in the request. If you call a semantic patch resource without this header, you will receive a &#x60;400&#x60; response because your semantic patch will be interpreted as a JSON patch. Use this header: &#x60;&#x60;&#x60; Content-Type: application/json; domain-model&#x3D;launchdarkly.semanticpatch &#x60;&#x60;&#x60; The body of a semantic patch request takes the following three properties: 1. &#x60;comment&#x60; (string): (Optional) A description of the update. 1. &#x60;environmentKey&#x60; (string): (Required) The key of the LaunchDarkly environment. 1. &#x60;instructions&#x60; (array): (Required) The list of actions to be performed by the update. Each action in the list must be an object/hash table with a &#x60;kind&#x60; property that indicates the instruction. Depending on the &#x60;kind&#x60;, the API may require other parameters. When this is the case, add the parameters as additional fields to the instruction object. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the segment will not be changed. In general, instructions will silently do nothing if the segment is already in the state requested by the patch instruction. For example, &#x60;addIncludedUsers&#x60; does nothing when the targets have already been included. Specific error conditions are noted in the instruction descriptions. ### Instructions #### &#x60;addIncludedUsers&#x60; Adds the user keys in &#x60;values&#x60; to the individual user targets included in the segment. Returns an error if this causes the same user key to be both included and excluded. ##### Parameters - &#x60;values&#x60;: list of user keys #### &#x60;addExcludedUsers&#x60; Adds the user keys in &#x60;values&#x60; to the individual user targets excluded from the segment. Returns an error if this causes the same user key to be both included and excluded. ##### Parameters - &#x60;values&#x60;: list of user keys #### &#x60;removeIncludedUsers&#x60; Removes the user keys in &#x60;values&#x60; from the individual user targets included in the segment. ##### Parameters - &#x60;values&#x60;: list of user keys #### &#x60;removeExcludedUsers&#x60; Removes the user keys in &#x60;values&#x60; from the individual user targets excluded from the segment. ##### Parameters - &#x60;values&#x60;: list of user keys #### &#x60;updateName&#x60; Updates the name of the segment to the string provided in &#x60;value&#x60;. ##### Parameters - &#x60;value&#x60;: string ## Using JSON patches on a segment If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch). For example, to update the description for a segment, use the following request body: &#x60;&#x60;&#x60;json { \&quot;patch\&quot;: [ { \&quot;op\&quot;: \&quot;replace\&quot;, \&quot;path\&quot;: \&quot;/description\&quot;, \&quot;value\&quot;: \&quot;new description\&quot; } ] } &#x60;&#x60;&#x60; To update fields in the segment that are arrays, set the &#x60;path&#x60; to the name of the field and then append &#x60;/&lt;array index&gt;&#x60;. Using &#x60;/0&#x60; adds the new entry to the beginning of the array. For example, to add a rule to a segment, use the following request body: &#x60;&#x60;&#x60;json { \&quot;patch\&quot;:[ { \&quot;op\&quot;: \&quot;add\&quot;, \&quot;path\&quot;: \&quot;/rules/0\&quot;, \&quot;value\&quot;: { \&quot;clauses\&quot;: [{ \&quot;attribute\&quot;: \&quot;email\&quot;, \&quot;op\&quot;: \&quot;endsWith\&quot;, \&quot;values\&quot;: [\&quot;.edu\&quot;], \&quot;negate\&quot;: false }] } } ] } &#x60;&#x60;&#x60; To add or remove users from segments, we recommend using semantic patch. Semantic patch for segments includes specific &#x60;instructions&#x60; for adding and removing both included and excluded users.
498
+ # @param project_key [String] The project key
499
+ # @param environment_key [String] The environment key
500
+ # @param segment_key [String] The segment key
501
501
  # @param patch_with_comment [PatchWithComment]
502
502
  # @param [Hash] opts the optional parameters
503
503
  # @return [Array<(UserSegment, Integer, Hash)>] UserSegment data, response status code and response headers
504
- def patch_segment_with_http_info(proj_key, env_key, key, patch_with_comment, opts = {})
504
+ def patch_segment_with_http_info(project_key, environment_key, segment_key, patch_with_comment, opts = {})
505
505
  if @api_client.config.debugging
506
506
  @api_client.config.logger.debug 'Calling API: SegmentsApi.patch_segment ...'
507
507
  end
508
- # verify the required parameter 'proj_key' is set
509
- if @api_client.config.client_side_validation && proj_key.nil?
510
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.patch_segment"
508
+ # verify the required parameter 'project_key' is set
509
+ if @api_client.config.client_side_validation && project_key.nil?
510
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.patch_segment"
511
511
  end
512
- # verify the required parameter 'env_key' is set
513
- if @api_client.config.client_side_validation && env_key.nil?
514
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.patch_segment"
512
+ # verify the required parameter 'environment_key' is set
513
+ if @api_client.config.client_side_validation && environment_key.nil?
514
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.patch_segment"
515
515
  end
516
- # verify the required parameter 'key' is set
517
- if @api_client.config.client_side_validation && key.nil?
518
- fail ArgumentError, "Missing the required parameter 'key' when calling SegmentsApi.patch_segment"
516
+ # verify the required parameter 'segment_key' is set
517
+ if @api_client.config.client_side_validation && segment_key.nil?
518
+ fail ArgumentError, "Missing the required parameter 'segment_key' when calling SegmentsApi.patch_segment"
519
519
  end
520
520
  # verify the required parameter 'patch_with_comment' is set
521
521
  if @api_client.config.client_side_validation && patch_with_comment.nil?
522
522
  fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling SegmentsApi.patch_segment"
523
523
  end
524
524
  # resource path
525
- local_var_path = '/api/v2/segments/{projKey}/{envKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
525
+ local_var_path = '/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s))
526
526
 
527
527
  # query parameters
528
528
  query_params = opts[:query_params] || {}
@@ -568,41 +568,41 @@ module LaunchDarklyApi
568
568
 
569
569
  # Create segment
570
570
  # Create a new user segment
571
- # @param proj_key [String] The project key.
572
- # @param env_key [String] The environment key.
571
+ # @param project_key [String] The project key
572
+ # @param environment_key [String] The environment key
573
573
  # @param segment_body [SegmentBody]
574
574
  # @param [Hash] opts the optional parameters
575
575
  # @return [UserSegment]
576
- def post_segment(proj_key, env_key, segment_body, opts = {})
577
- data, _status_code, _headers = post_segment_with_http_info(proj_key, env_key, segment_body, opts)
576
+ def post_segment(project_key, environment_key, segment_body, opts = {})
577
+ data, _status_code, _headers = post_segment_with_http_info(project_key, environment_key, segment_body, opts)
578
578
  data
579
579
  end
580
580
 
581
581
  # Create segment
582
582
  # Create a new user segment
583
- # @param proj_key [String] The project key.
584
- # @param env_key [String] The environment key.
583
+ # @param project_key [String] The project key
584
+ # @param environment_key [String] The environment key
585
585
  # @param segment_body [SegmentBody]
586
586
  # @param [Hash] opts the optional parameters
587
587
  # @return [Array<(UserSegment, Integer, Hash)>] UserSegment data, response status code and response headers
588
- def post_segment_with_http_info(proj_key, env_key, segment_body, opts = {})
588
+ def post_segment_with_http_info(project_key, environment_key, segment_body, opts = {})
589
589
  if @api_client.config.debugging
590
590
  @api_client.config.logger.debug 'Calling API: SegmentsApi.post_segment ...'
591
591
  end
592
- # verify the required parameter 'proj_key' is set
593
- if @api_client.config.client_side_validation && proj_key.nil?
594
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.post_segment"
592
+ # verify the required parameter 'project_key' is set
593
+ if @api_client.config.client_side_validation && project_key.nil?
594
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.post_segment"
595
595
  end
596
- # verify the required parameter 'env_key' is set
597
- if @api_client.config.client_side_validation && env_key.nil?
598
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.post_segment"
596
+ # verify the required parameter 'environment_key' is set
597
+ if @api_client.config.client_side_validation && environment_key.nil?
598
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.post_segment"
599
599
  end
600
600
  # verify the required parameter 'segment_body' is set
601
601
  if @api_client.config.client_side_validation && segment_body.nil?
602
602
  fail ArgumentError, "Missing the required parameter 'segment_body' when calling SegmentsApi.post_segment"
603
603
  end
604
604
  # resource path
605
- local_var_path = '/api/v2/segments/{projKey}/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s))
605
+ local_var_path = '/api/v2/segments/{projectKey}/{environmentKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s))
606
606
 
607
607
  # query parameters
608
608
  query_params = opts[:query_params] || {}
@@ -648,47 +648,47 @@ module LaunchDarklyApi
648
648
 
649
649
  # Update targets on a Big Segment
650
650
  # Update targets included or excluded in a Big Segment
651
- # @param proj_key [String] The project key.
652
- # @param env_key [String] The environment key.
653
- # @param key [String] The segment key.
651
+ # @param project_key [String] The project key
652
+ # @param environment_key [String] The environment key
653
+ # @param segment_key [String] The segment key
654
654
  # @param segment_user_state [SegmentUserState]
655
655
  # @param [Hash] opts the optional parameters
656
656
  # @return [nil]
657
- def update_big_segment_targets(proj_key, env_key, key, segment_user_state, opts = {})
658
- update_big_segment_targets_with_http_info(proj_key, env_key, key, segment_user_state, opts)
657
+ def update_big_segment_targets(project_key, environment_key, segment_key, segment_user_state, opts = {})
658
+ update_big_segment_targets_with_http_info(project_key, environment_key, segment_key, segment_user_state, opts)
659
659
  nil
660
660
  end
661
661
 
662
662
  # Update targets on a Big Segment
663
663
  # Update targets included or excluded in a Big Segment
664
- # @param proj_key [String] The project key.
665
- # @param env_key [String] The environment key.
666
- # @param key [String] The segment key.
664
+ # @param project_key [String] The project key
665
+ # @param environment_key [String] The environment key
666
+ # @param segment_key [String] The segment key
667
667
  # @param segment_user_state [SegmentUserState]
668
668
  # @param [Hash] opts the optional parameters
669
669
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
670
- def update_big_segment_targets_with_http_info(proj_key, env_key, key, segment_user_state, opts = {})
670
+ def update_big_segment_targets_with_http_info(project_key, environment_key, segment_key, segment_user_state, opts = {})
671
671
  if @api_client.config.debugging
672
672
  @api_client.config.logger.debug 'Calling API: SegmentsApi.update_big_segment_targets ...'
673
673
  end
674
- # verify the required parameter 'proj_key' is set
675
- if @api_client.config.client_side_validation && proj_key.nil?
676
- fail ArgumentError, "Missing the required parameter 'proj_key' when calling SegmentsApi.update_big_segment_targets"
674
+ # verify the required parameter 'project_key' is set
675
+ if @api_client.config.client_side_validation && project_key.nil?
676
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling SegmentsApi.update_big_segment_targets"
677
677
  end
678
- # verify the required parameter 'env_key' is set
679
- if @api_client.config.client_side_validation && env_key.nil?
680
- fail ArgumentError, "Missing the required parameter 'env_key' when calling SegmentsApi.update_big_segment_targets"
678
+ # verify the required parameter 'environment_key' is set
679
+ if @api_client.config.client_side_validation && environment_key.nil?
680
+ fail ArgumentError, "Missing the required parameter 'environment_key' when calling SegmentsApi.update_big_segment_targets"
681
681
  end
682
- # verify the required parameter 'key' is set
683
- if @api_client.config.client_side_validation && key.nil?
684
- fail ArgumentError, "Missing the required parameter 'key' when calling SegmentsApi.update_big_segment_targets"
682
+ # verify the required parameter 'segment_key' is set
683
+ if @api_client.config.client_side_validation && segment_key.nil?
684
+ fail ArgumentError, "Missing the required parameter 'segment_key' when calling SegmentsApi.update_big_segment_targets"
685
685
  end
686
686
  # verify the required parameter 'segment_user_state' is set
687
687
  if @api_client.config.client_side_validation && segment_user_state.nil?
688
688
  fail ArgumentError, "Missing the required parameter 'segment_user_state' when calling SegmentsApi.update_big_segment_targets"
689
689
  end
690
690
  # resource path
691
- local_var_path = '/api/v2/segments/{projKey}/{envKey}/{key}/users'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
691
+ local_var_path = '/api/v2/segments/{projectKey}/{environmentKey}/{segmentKey}/users'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'environmentKey' + '}', CGI.escape(environment_key.to_s)).sub('{' + 'segmentKey' + '}', CGI.escape(segment_key.to_s))
692
692
 
693
693
  # query parameters
694
694
  query_params = opts[:query_params] || {}