launchdarkly_api 5.3.0 → 7.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (946) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/README.md +814 -260
  4. data/Rakefile +2 -0
  5. data/docs/AccessDeniedReasonRep.md +28 -0
  6. data/docs/AccessDeniedRep.md +20 -0
  7. data/docs/AccessRep.md +18 -0
  8. data/docs/AccessTokenPost.md +30 -0
  9. data/docs/AccessTokensApi.md +239 -126
  10. data/docs/AccountMembersApi.md +376 -0
  11. data/docs/AccountUsageBetaApi.md +647 -0
  12. data/docs/ActionInputRep.md +18 -0
  13. data/docs/ActionOutputRep.md +20 -0
  14. data/docs/ApprovalConditionInputRep.md +20 -0
  15. data/docs/ApprovalConditionOutputRep.md +26 -0
  16. data/docs/ApprovalSettings.md +32 -0
  17. data/docs/ApprovalsApi.md +554 -0
  18. data/docs/AuditLogApi.md +93 -55
  19. data/docs/AuditLogEntryListingRep.md +52 -0
  20. data/docs/AuditLogEntryListingRepCollection.md +20 -0
  21. data/docs/AuditLogEntryRep.md +64 -0
  22. data/docs/AuthorizedAppDataRep.md +26 -0
  23. data/docs/BigSegmentTarget.md +22 -0
  24. data/docs/BranchCollectionRep.md +20 -0
  25. data/docs/BranchRep.md +28 -0
  26. data/docs/Clause.md +21 -7
  27. data/docs/ClientSideAvailability.md +15 -4
  28. data/docs/ClientSideAvailabilityPost.md +20 -0
  29. data/docs/CodeReferencesApi.md +976 -0
  30. data/docs/ConditionBaseOutputRep.md +22 -0
  31. data/docs/ConditionInputRep.md +26 -0
  32. data/docs/ConditionOutputRep.md +34 -0
  33. data/docs/ConfidenceIntervalRep.md +20 -0
  34. data/docs/Conflict.md +20 -0
  35. data/docs/ConflictOutputRep.md +20 -0
  36. data/docs/CopiedFromEnv.md +20 -0
  37. data/docs/CreateCopyFlagConfigApprovalRequestRequest.md +28 -0
  38. data/docs/CreateFlagConfigApprovalRequestRequest.md +30 -0
  39. data/docs/CustomProperty.md +15 -4
  40. data/docs/CustomRole.md +27 -8
  41. data/docs/CustomRolePost.md +26 -0
  42. data/docs/CustomRolePostData.md +26 -0
  43. data/docs/CustomRoles.md +15 -4
  44. data/docs/CustomRolesApi.md +196 -100
  45. data/docs/CustomWorkflowInputRep.md +24 -0
  46. data/docs/CustomWorkflowMeta.md +20 -0
  47. data/docs/CustomWorkflowOutputRep.md +38 -0
  48. data/docs/CustomWorkflowStageMeta.md +20 -0
  49. data/docs/CustomWorkflowsListingOutputRep.md +18 -0
  50. data/docs/DataExportDestinationsApi.md +205 -117
  51. data/docs/DefaultClientSideAvailabilityPost.md +20 -0
  52. data/docs/Defaults.md +15 -4
  53. data/docs/DependentFlag.md +19 -6
  54. data/docs/DependentFlagEnvironment.md +19 -6
  55. data/docs/DependentFlagsByEnvironment.md +17 -5
  56. data/docs/DerivedAttribute.md +20 -0
  57. data/docs/Destination.md +27 -9
  58. data/docs/DestinationPost.md +24 -0
  59. data/docs/Destinations.md +15 -4
  60. data/docs/Environment.md +39 -16
  61. data/docs/EnvironmentPost.md +29 -11
  62. data/docs/EnvironmentsApi.md +246 -144
  63. data/docs/ExecutionOutputRep.md +18 -0
  64. data/docs/ExperimentAllocationRep.md +20 -0
  65. data/docs/ExperimentEnabledPeriodRep.md +20 -0
  66. data/docs/ExperimentEnvironmentSettingRep.md +22 -0
  67. data/docs/ExperimentInfoRep.md +20 -0
  68. data/docs/ExperimentMetadataRep.md +18 -0
  69. data/docs/ExperimentRep.md +24 -0
  70. data/docs/ExperimentResultsRep.md +30 -0
  71. data/docs/ExperimentStatsRep.md +24 -0
  72. data/docs/ExperimentTimeSeriesSlice.md +20 -0
  73. data/docs/ExperimentTimeSeriesVariationSlice.md +32 -0
  74. data/docs/ExperimentTotalsRep.md +32 -0
  75. data/docs/ExperimentsBetaApi.md +168 -0
  76. data/docs/ExpiringUserTargetError.md +20 -0
  77. data/docs/ExpiringUserTargetGetResponse.md +20 -0
  78. data/docs/ExpiringUserTargetItem.md +30 -0
  79. data/docs/ExpiringUserTargetPatchResponse.md +28 -0
  80. data/docs/Extinction.md +26 -0
  81. data/docs/ExtinctionCollectionRep.md +20 -0
  82. data/docs/FeatureFlag.md +55 -22
  83. data/docs/FeatureFlagBody.md +33 -11
  84. data/docs/FeatureFlagConfig.md +47 -17
  85. data/docs/FeatureFlagScheduledChange.md +27 -6
  86. data/docs/FeatureFlagScheduledChanges.md +15 -4
  87. data/docs/FeatureFlagStatus.md +17 -6
  88. data/docs/FeatureFlagStatusAcrossEnvironments.md +17 -5
  89. data/docs/FeatureFlagStatuses.md +15 -4
  90. data/docs/FeatureFlags.md +17 -5
  91. data/docs/FeatureFlagsApi.md +409 -1079
  92. data/docs/FeatureFlagsBetaApi.md +157 -0
  93. data/docs/FlagConfigApprovalRequestResponse.md +56 -0
  94. data/docs/FlagConfigApprovalRequestsResponse.md +20 -0
  95. data/docs/FlagCopyConfigEnvironment.md +20 -0
  96. data/docs/FlagCopyConfigPost.md +26 -0
  97. data/docs/FlagGlobalAttributesRep.md +58 -0
  98. data/docs/FlagListingRep.md +24 -0
  99. data/docs/FlagScheduledChangesInput.md +20 -0
  100. data/docs/FlagStatusRep.md +24 -0
  101. data/docs/FlagSummary.md +18 -0
  102. data/docs/ForbiddenErrorRep.md +20 -0
  103. data/docs/HunkRep.md +26 -0
  104. data/docs/IntegrationMetadata.md +24 -0
  105. data/docs/IntegrationStatus.md +20 -0
  106. data/docs/InvalidRequestErrorRep.md +20 -0
  107. data/docs/IpList.md +20 -0
  108. data/docs/LastSeenMetadata.md +18 -0
  109. data/docs/Link.md +15 -4
  110. data/docs/Member.md +47 -14
  111. data/docs/MemberDataRep.md +26 -0
  112. data/docs/MemberPermissionGrantSummaryRep.md +22 -0
  113. data/docs/MemberSummaryRep.md +28 -0
  114. data/docs/MemberTeamSummaryRep.md +22 -0
  115. data/docs/Members.md +17 -5
  116. data/docs/MethodNotAllowedErrorRep.md +20 -0
  117. data/docs/MetricCollectionRep.md +20 -0
  118. data/docs/MetricListingRep.md +52 -0
  119. data/docs/MetricPost.md +40 -0
  120. data/docs/MetricRep.md +62 -0
  121. data/docs/MetricSeen.md +20 -0
  122. data/docs/MetricsApi.md +376 -0
  123. data/docs/Modification.md +18 -0
  124. data/docs/MultiEnvironmentDependentFlag.md +17 -7
  125. data/docs/MultiEnvironmentDependentFlags.md +17 -5
  126. data/docs/NewMemberForm.md +28 -0
  127. data/docs/NotFoundErrorRep.md +20 -0
  128. data/docs/OtherApi.md +282 -0
  129. data/docs/ParentResourceRep.md +22 -0
  130. data/docs/PatchFailedErrorRep.md +20 -0
  131. data/docs/PatchOperation.md +17 -5
  132. data/docs/PatchSegmentInstruction.md +26 -0
  133. data/docs/PatchSegmentRequest.md +20 -0
  134. data/docs/PatchWithComment.md +20 -0
  135. data/docs/PermissionGrantInput.md +22 -0
  136. data/docs/PermissionGrantRep.md +24 -0
  137. data/docs/PostApprovalRequestApplyRequest.md +18 -0
  138. data/docs/PostApprovalRequestReviewRequest.md +20 -0
  139. data/docs/PostFlagScheduledChangesInput.md +22 -0
  140. data/docs/Prerequisite.md +15 -4
  141. data/docs/Project.md +27 -10
  142. data/docs/ProjectListingRep.md +30 -0
  143. data/docs/ProjectPost.md +28 -0
  144. data/docs/Projects.md +15 -4
  145. data/docs/ProjectsApi.md +196 -100
  146. data/docs/PubNubDetailRep.md +20 -0
  147. data/docs/PutBranch.md +26 -0
  148. data/docs/RateLimitedErrorRep.md +20 -0
  149. data/docs/ReferenceRep.md +22 -0
  150. data/docs/RelayAutoConfigCollectionRep.md +18 -0
  151. data/docs/RelayAutoConfigPost.md +20 -0
  152. data/docs/RelayAutoConfigRep.md +34 -0
  153. data/docs/RelayProxyConfigurationsApi.md +244 -129
  154. data/docs/RepositoryCollectionRep.md +20 -0
  155. data/docs/RepositoryPost.md +28 -0
  156. data/docs/RepositoryRep.md +38 -0
  157. data/docs/ResourceAccess.md +20 -0
  158. data/docs/ResourceIDResponse.md +26 -0
  159. data/docs/ReviewOutputRep.md +26 -0
  160. data/docs/ReviewResponse.md +26 -0
  161. data/docs/Rollout.md +19 -4
  162. data/docs/Rule.md +23 -8
  163. data/docs/ScheduleConditionInputRep.md +20 -0
  164. data/docs/ScheduleConditionOutputRep.md +18 -0
  165. data/docs/ScheduledChangesApi.md +404 -0
  166. data/docs/SdkListRep.md +20 -0
  167. data/docs/SdkVersionListRep.md +20 -0
  168. data/docs/SdkVersionRep.md +20 -0
  169. data/docs/SegmentBody.md +26 -0
  170. data/docs/SegmentMetadata.md +28 -0
  171. data/docs/SegmentUserList.md +20 -0
  172. data/docs/SegmentUserState.md +20 -0
  173. data/docs/SegmentsApi.md +695 -0
  174. data/docs/SeriesListRep.md +22 -0
  175. data/docs/SourceFlag.md +20 -0
  176. data/docs/StageInputRep.md +22 -0
  177. data/docs/StageOutputRep.md +26 -0
  178. data/docs/Statement.md +21 -7
  179. data/docs/StatementPost.md +26 -0
  180. data/docs/StatementPostData.md +26 -0
  181. data/docs/StatementRep.md +26 -0
  182. data/docs/StatisticCollectionRep.md +20 -0
  183. data/docs/StatisticRep.md +30 -0
  184. data/docs/StatisticsRoot.md +20 -0
  185. data/docs/StatusConflictErrorRep.md +20 -0
  186. data/docs/SubjectDataRep.md +22 -0
  187. data/docs/Target.md +15 -4
  188. data/docs/TargetResourceRep.md +22 -0
  189. data/docs/TeamCollectionRep.md +22 -0
  190. data/docs/TeamPatchInput.md +20 -0
  191. data/docs/TeamPostInput.md +28 -0
  192. data/docs/TeamRep.md +40 -0
  193. data/docs/TeamsBetaApi.md +374 -0
  194. data/docs/TitleRep.md +32 -0
  195. data/docs/Token.md +43 -17
  196. data/docs/TokenDataRep.md +26 -0
  197. data/docs/Tokens.md +15 -4
  198. data/docs/UnauthorizedErrorRep.md +20 -0
  199. data/docs/UrlPost.md +24 -0
  200. data/docs/User.md +37 -13
  201. data/docs/UserAttributeNamesRep.md +22 -0
  202. data/docs/UserFlagSetting.md +17 -5
  203. data/docs/UserFlagSettings.md +15 -4
  204. data/docs/UserRecord.md +25 -7
  205. data/docs/UserRecordRep.md +26 -0
  206. data/docs/UserSegment.md +49 -14
  207. data/docs/UserSegmentRule.md +19 -5
  208. data/docs/UserSegments.md +15 -4
  209. data/docs/UserSettingsApi.md +217 -137
  210. data/docs/Users.md +17 -5
  211. data/docs/UsersApi.md +187 -114
  212. data/docs/UsersBetaApi.md +81 -0
  213. data/docs/ValuePut.md +20 -0
  214. data/docs/Variation.md +19 -6
  215. data/docs/VariationOrRolloutRep.md +20 -0
  216. data/docs/VariationSummary.md +30 -0
  217. data/docs/VersionsRep.md +24 -0
  218. data/docs/Webhook.md +29 -10
  219. data/docs/WebhookPost.md +30 -0
  220. data/docs/Webhooks.md +15 -4
  221. data/docs/WebhooksApi.md +199 -103
  222. data/docs/WeightedVariation.md +17 -4
  223. data/docs/WorkflowsBetaApi.md +316 -0
  224. data/git_push.sh +13 -11
  225. data/launchdarkly_api.gemspec +8 -16
  226. data/lib/launchdarkly_api/api/access_tokens_api.rb +198 -122
  227. data/lib/launchdarkly_api/api/account_members_api.rb +359 -0
  228. data/lib/launchdarkly_api/api/account_usage_beta_api.rb +598 -0
  229. data/lib/launchdarkly_api/api/approvals_api.rb +615 -0
  230. data/lib/launchdarkly_api/api/audit_log_api.rb +72 -51
  231. data/lib/launchdarkly_api/api/code_references_api.rb +923 -0
  232. data/lib/launchdarkly_api/api/custom_roles_api.rb +170 -105
  233. data/lib/launchdarkly_api/api/data_export_destinations_api.rb +210 -145
  234. data/lib/launchdarkly_api/api/environments_api.rb +205 -132
  235. data/lib/launchdarkly_api/api/experiments_beta_api.rb +190 -0
  236. data/lib/launchdarkly_api/api/feature_flags_api.rb +504 -1327
  237. data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -0
  238. data/lib/launchdarkly_api/api/metrics_api.rb +377 -0
  239. data/lib/launchdarkly_api/api/other_api.rb +248 -0
  240. data/lib/launchdarkly_api/api/projects_api.rb +155 -90
  241. data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +203 -127
  242. data/lib/launchdarkly_api/api/scheduled_changes_api.rb +443 -0
  243. data/lib/launchdarkly_api/api/segments_api.rb +735 -0
  244. data/lib/launchdarkly_api/api/teams_beta_api.rb +356 -0
  245. data/lib/launchdarkly_api/api/user_settings_api.rb +245 -180
  246. data/lib/launchdarkly_api/api/users_api.rb +185 -135
  247. data/lib/launchdarkly_api/api/users_beta_api.rb +91 -0
  248. data/lib/launchdarkly_api/api/webhooks_api.rb +178 -113
  249. data/lib/launchdarkly_api/api/workflows_beta_api.rb +345 -0
  250. data/lib/launchdarkly_api/api_client.rb +90 -91
  251. data/lib/launchdarkly_api/api_error.rb +23 -4
  252. data/lib/launchdarkly_api/configuration.rb +85 -16
  253. data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +280 -0
  254. data/lib/launchdarkly_api/models/access_denied_rep.rb +237 -0
  255. data/lib/launchdarkly_api/models/access_rep.rb +225 -0
  256. data/lib/launchdarkly_api/models/access_token_post.rb +317 -0
  257. data/lib/launchdarkly_api/models/action_input_rep.rb +219 -0
  258. data/lib/launchdarkly_api/models/action_output_rep.rb +239 -0
  259. data/lib/launchdarkly_api/models/approval_condition_input_rep.rb +229 -0
  260. data/lib/launchdarkly_api/models/approval_condition_output_rep.rb +278 -0
  261. data/lib/launchdarkly_api/models/approval_settings.rb +331 -0
  262. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +420 -0
  263. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +241 -0
  264. data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +481 -0
  265. data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +256 -0
  266. data/lib/launchdarkly_api/models/big_segment_target.rb +254 -0
  267. data/lib/launchdarkly_api/models/branch_collection_rep.rb +242 -0
  268. data/lib/launchdarkly_api/models/branch_rep.rb +291 -0
  269. data/lib/launchdarkly_api/models/clause.rb +78 -24
  270. data/lib/launchdarkly_api/models/client_side_availability.rb +65 -33
  271. data/lib/launchdarkly_api/models/client_side_availability_post.rb +237 -0
  272. data/lib/launchdarkly_api/models/condition_base_output_rep.rb +246 -0
  273. data/lib/launchdarkly_api/models/condition_input_rep.rb +256 -0
  274. data/lib/launchdarkly_api/models/condition_output_rep.rb +324 -0
  275. data/lib/launchdarkly_api/models/confidence_interval_rep.rb +227 -0
  276. data/lib/launchdarkly_api/models/conflict.rb +230 -0
  277. data/lib/launchdarkly_api/models/conflict_output_rep.rb +237 -0
  278. data/lib/launchdarkly_api/models/copied_from_env.rb +233 -0
  279. data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +286 -0
  280. data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +297 -0
  281. data/lib/launchdarkly_api/models/custom_property.rb +59 -23
  282. data/lib/launchdarkly_api/models/custom_role.rb +125 -49
  283. data/lib/launchdarkly_api/models/custom_role_post.rb +274 -0
  284. data/lib/launchdarkly_api/models/custom_role_post_data.rb +274 -0
  285. data/lib/launchdarkly_api/models/custom_roles.rb +58 -22
  286. data/lib/launchdarkly_api/models/custom_workflow_input_rep.rb +252 -0
  287. data/lib/launchdarkly_api/models/custom_workflow_meta.rb +227 -0
  288. data/lib/launchdarkly_api/models/custom_workflow_output_rep.rb +354 -0
  289. data/lib/launchdarkly_api/models/custom_workflow_stage_meta.rb +227 -0
  290. data/lib/launchdarkly_api/models/custom_workflows_listing_output_rep.rb +225 -0
  291. data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +237 -0
  292. data/lib/launchdarkly_api/models/defaults.rb +56 -25
  293. data/lib/launchdarkly_api/models/dependent_flag.rb +76 -25
  294. data/lib/launchdarkly_api/models/dependent_flag_environment.rb +76 -25
  295. data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +75 -24
  296. data/lib/launchdarkly_api/models/derived_attribute.rb +228 -0
  297. data/lib/launchdarkly_api/models/destination.rb +88 -47
  298. data/lib/launchdarkly_api/models/destination_post.rb +281 -0
  299. data/lib/launchdarkly_api/models/destinations.rb +58 -22
  300. data/lib/launchdarkly_api/models/environment.rb +167 -68
  301. data/lib/launchdarkly_api/models/environment_post.rb +90 -56
  302. data/lib/launchdarkly_api/models/execution_output_rep.rb +223 -0
  303. data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +237 -0
  304. data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +227 -0
  305. data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +238 -0
  306. data/lib/launchdarkly_api/models/experiment_info_rep.rb +239 -0
  307. data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +219 -0
  308. data/lib/launchdarkly_api/models/experiment_rep.rb +249 -0
  309. data/lib/launchdarkly_api/models/experiment_results_rep.rb +280 -0
  310. data/lib/launchdarkly_api/models/experiment_stats_rep.rb +245 -0
  311. data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +229 -0
  312. data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +281 -0
  313. data/lib/launchdarkly_api/models/experiment_totals_rep.rb +281 -0
  314. data/lib/launchdarkly_api/models/expiring_user_target_error.rb +237 -0
  315. data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +236 -0
  316. data/lib/launchdarkly_api/models/expiring_user_target_item.rb +300 -0
  317. data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +274 -0
  318. data/lib/launchdarkly_api/models/extinction.rb +283 -0
  319. data/lib/launchdarkly_api/models/extinction_collection_rep.rb +242 -0
  320. data/lib/launchdarkly_api/models/feature_flag.rb +276 -123
  321. data/lib/launchdarkly_api/models/feature_flag_body.rb +104 -54
  322. data/lib/launchdarkly_api/models/feature_flag_config.rb +184 -55
  323. data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +142 -38
  324. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +73 -32
  325. data/lib/launchdarkly_api/models/feature_flag_status.rb +70 -71
  326. data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +71 -33
  327. data/lib/launchdarkly_api/models/feature_flag_statuses.rb +64 -23
  328. data/lib/launchdarkly_api/models/feature_flags.rb +78 -32
  329. data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +457 -0
  330. data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +242 -0
  331. data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +232 -0
  332. data/lib/launchdarkly_api/models/flag_copy_config_post.rb +290 -0
  333. data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +514 -0
  334. data/lib/launchdarkly_api/models/flag_listing_rep.rb +257 -0
  335. data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +234 -0
  336. data/lib/launchdarkly_api/models/flag_status_rep.rb +256 -0
  337. data/lib/launchdarkly_api/models/flag_summary.rb +223 -0
  338. data/lib/launchdarkly_api/models/forbidden_error_rep.rb +227 -0
  339. data/lib/launchdarkly_api/models/hunk_rep.rb +266 -0
  340. data/lib/launchdarkly_api/models/integration_metadata.rb +265 -0
  341. data/lib/launchdarkly_api/models/integration_status.rb +237 -0
  342. data/lib/launchdarkly_api/models/invalid_request_error_rep.rb +227 -0
  343. data/lib/launchdarkly_api/models/ip_list.rb +241 -0
  344. data/lib/launchdarkly_api/models/last_seen_metadata.rb +219 -0
  345. data/lib/launchdarkly_api/models/link.rb +54 -20
  346. data/lib/launchdarkly_api/models/member.rb +227 -67
  347. data/lib/launchdarkly_api/models/member_data_rep.rb +256 -0
  348. data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +253 -0
  349. data/lib/launchdarkly_api/models/member_summary_rep.rb +285 -0
  350. data/lib/launchdarkly_api/models/member_team_summary_rep.rb +253 -0
  351. data/lib/launchdarkly_api/models/members.rb +78 -32
  352. data/lib/launchdarkly_api/models/method_not_allowed_error_rep.rb +227 -0
  353. data/lib/launchdarkly_api/models/metric_collection_rep.rb +231 -0
  354. data/lib/launchdarkly_api/models/metric_listing_rep.rb +444 -0
  355. data/lib/launchdarkly_api/models/metric_post.rb +368 -0
  356. data/lib/launchdarkly_api/models/metric_rep.rb +493 -0
  357. data/lib/launchdarkly_api/models/metric_seen.rb +227 -0
  358. data/lib/launchdarkly_api/models/modification.rb +218 -0
  359. data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +69 -43
  360. data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +75 -24
  361. data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
  362. data/lib/launchdarkly_api/models/not_found_error_rep.rb +227 -0
  363. data/lib/launchdarkly_api/models/parent_resource_rep.rb +239 -0
  364. data/lib/launchdarkly_api/models/patch_failed_error_rep.rb +227 -0
  365. data/lib/launchdarkly_api/models/patch_operation.rb +59 -26
  366. data/lib/launchdarkly_api/models/patch_segment_instruction.rb +273 -0
  367. data/lib/launchdarkly_api/models/patch_segment_request.rb +236 -0
  368. data/lib/launchdarkly_api/models/patch_with_comment.rb +234 -0
  369. data/lib/launchdarkly_api/models/permission_grant_input.rb +240 -0
  370. data/lib/launchdarkly_api/models/permission_grant_rep.rb +249 -0
  371. data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +218 -0
  372. data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +227 -0
  373. data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +248 -0
  374. data/lib/launchdarkly_api/models/prerequisite.rb +64 -20
  375. data/lib/launchdarkly_api/models/project.rb +120 -50
  376. data/lib/launchdarkly_api/models/project_listing_rep.rb +306 -0
  377. data/lib/launchdarkly_api/models/project_post.rb +281 -0
  378. data/lib/launchdarkly_api/models/projects.rb +70 -22
  379. data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +227 -0
  380. data/lib/launchdarkly_api/models/put_branch.rb +275 -0
  381. data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +227 -0
  382. data/lib/launchdarkly_api/models/reference_rep.rb +250 -0
  383. data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +225 -0
  384. data/lib/launchdarkly_api/models/relay_auto_config_post.rb +240 -0
  385. data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +327 -0
  386. data/lib/launchdarkly_api/models/repository_collection_rep.rb +242 -0
  387. data/lib/launchdarkly_api/models/repository_post.rb +306 -0
  388. data/lib/launchdarkly_api/models/repository_rep.rb +385 -0
  389. data/lib/launchdarkly_api/models/resource_access.rb +228 -0
  390. data/lib/launchdarkly_api/models/resource_id_response.rb +254 -0
  391. data/lib/launchdarkly_api/models/review_output_rep.rb +264 -0
  392. data/lib/launchdarkly_api/models/review_response.rb +302 -0
  393. data/lib/launchdarkly_api/models/rollout.rb +89 -32
  394. data/lib/launchdarkly_api/models/rule.rb +77 -33
  395. data/lib/launchdarkly_api/models/schedule_condition_input_rep.rb +227 -0
  396. data/lib/launchdarkly_api/models/schedule_condition_output_rep.rb +218 -0
  397. data/lib/launchdarkly_api/models/sdk_list_rep.rb +241 -0
  398. data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +241 -0
  399. data/lib/launchdarkly_api/models/sdk_version_rep.rb +237 -0
  400. data/lib/launchdarkly_api/models/segment_body.rb +270 -0
  401. data/lib/launchdarkly_api/models/segment_metadata.rb +263 -0
  402. data/lib/launchdarkly_api/models/segment_user_list.rb +231 -0
  403. data/lib/launchdarkly_api/models/segment_user_state.rb +227 -0
  404. data/lib/launchdarkly_api/models/series_list_rep.rb +257 -0
  405. data/lib/launchdarkly_api/models/source_flag.rb +233 -0
  406. data/lib/launchdarkly_api/models/stage_input_rep.rb +238 -0
  407. data/lib/launchdarkly_api/models/stage_output_rep.rb +276 -0
  408. data/lib/launchdarkly_api/models/statement.rb +68 -61
  409. data/lib/launchdarkly_api/models/statement_post.rb +281 -0
  410. data/lib/launchdarkly_api/models/statement_post_data.rb +281 -0
  411. data/lib/launchdarkly_api/models/statement_rep.rb +271 -0
  412. data/lib/launchdarkly_api/models/statistic_collection_rep.rb +241 -0
  413. data/lib/launchdarkly_api/models/statistic_rep.rb +309 -0
  414. data/lib/launchdarkly_api/models/statistics_root.rb +229 -0
  415. data/lib/launchdarkly_api/models/status_conflict_error_rep.rb +227 -0
  416. data/lib/launchdarkly_api/models/subject_data_rep.rb +238 -0
  417. data/lib/launchdarkly_api/models/target.rb +64 -20
  418. data/lib/launchdarkly_api/models/target_resource_rep.rb +240 -0
  419. data/lib/launchdarkly_api/models/team_collection_rep.rb +240 -0
  420. data/lib/launchdarkly_api/models/team_patch_input.rb +229 -0
  421. data/lib/launchdarkly_api/models/team_post_input.rb +285 -0
  422. data/lib/launchdarkly_api/models/team_rep.rb +327 -0
  423. data/lib/launchdarkly_api/models/title_rep.rb +281 -0
  424. data/lib/launchdarkly_api/models/token.rb +159 -93
  425. data/lib/launchdarkly_api/models/token_data_rep.rb +256 -0
  426. data/lib/launchdarkly_api/models/tokens.rb +68 -32
  427. data/lib/launchdarkly_api/models/unauthorized_error_rep.rb +227 -0
  428. data/lib/launchdarkly_api/models/url_post.rb +279 -0
  429. data/lib/launchdarkly_api/models/user.rb +95 -37
  430. data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +245 -0
  431. data/lib/launchdarkly_api/models/user_flag_setting.rb +68 -27
  432. data/lib/launchdarkly_api/models/user_flag_settings.rb +78 -32
  433. data/lib/launchdarkly_api/models/user_record.rb +89 -34
  434. data/lib/launchdarkly_api/models/user_record_rep.rb +255 -0
  435. data/lib/launchdarkly_api/models/user_segment.rb +195 -69
  436. data/lib/launchdarkly_api/models/user_segment_rule.rb +71 -23
  437. data/lib/launchdarkly_api/models/user_segments.rb +78 -32
  438. data/lib/launchdarkly_api/models/users.rb +71 -25
  439. data/lib/launchdarkly_api/models/value_put.rb +229 -0
  440. data/lib/launchdarkly_api/models/variation.rb +70 -38
  441. data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +227 -0
  442. data/lib/launchdarkly_api/models/variation_summary.rb +287 -0
  443. data/lib/launchdarkly_api/models/versions_rep.rb +262 -0
  444. data/lib/launchdarkly_api/models/webhook.rb +120 -55
  445. data/lib/launchdarkly_api/models/webhook_post.rb +297 -0
  446. data/lib/launchdarkly_api/models/webhooks.rb +68 -22
  447. data/lib/launchdarkly_api/models/weighted_variation.rb +77 -24
  448. data/lib/launchdarkly_api/version.rb +5 -5
  449. data/lib/launchdarkly_api.rb +163 -95
  450. data/spec/api/access_tokens_api_spec.rb +23 -17
  451. data/spec/api/account_members_api_spec.rb +99 -0
  452. data/spec/api/account_usage_beta_api_spec.rb +156 -0
  453. data/spec/api/approvals_api_spec.rb +141 -0
  454. data/spec/api/audit_log_api_spec.rb +19 -17
  455. data/spec/api/code_references_api_spec.rb +206 -0
  456. data/spec/api/custom_roles_api_spec.rb +22 -17
  457. data/spec/api/data_export_destinations_api_spec.rb +30 -25
  458. data/spec/api/environments_api_spec.rb +31 -26
  459. data/spec/api/experiments_beta_api_spec.rb +67 -0
  460. data/spec/api/feature_flags_api_spec.rb +70 -253
  461. data/spec/api/feature_flags_beta_api_spec.rb +62 -0
  462. data/spec/api/metrics_api_spec.rb +100 -0
  463. data/spec/api/other_api_spec.rb +79 -0
  464. data/spec/api/projects_api_spec.rb +22 -17
  465. data/spec/api/relay_proxy_configurations_api_spec.rb +37 -31
  466. data/spec/api/scheduled_changes_api_spec.rb +112 -0
  467. data/spec/api/segments_api_spec.rb +164 -0
  468. data/spec/api/teams_beta_api_spec.rb +98 -0
  469. data/spec/api/user_settings_api_spec.rb +41 -36
  470. data/spec/api/users_api_spec.rb +34 -28
  471. data/spec/api/users_beta_api_spec.rb +48 -0
  472. data/spec/api/webhooks_api_spec.rb +27 -22
  473. data/spec/api/workflows_beta_api_spec.rb +94 -0
  474. data/spec/api_client_spec.rb +7 -24
  475. data/spec/configuration_spec.rb +7 -7
  476. data/spec/models/access_denied_reason_rep_spec.rb +64 -0
  477. data/spec/models/access_denied_rep_spec.rb +40 -0
  478. data/spec/models/access_rep_spec.rb +34 -0
  479. data/spec/models/access_token_post_spec.rb +74 -0
  480. data/spec/models/action_input_rep_spec.rb +34 -0
  481. data/spec/models/action_output_rep_spec.rb +40 -0
  482. data/spec/models/approval_condition_input_rep_spec.rb +40 -0
  483. data/spec/models/approval_condition_output_rep_spec.rb +58 -0
  484. data/spec/models/approval_settings_spec.rb +76 -0
  485. data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +40 -0
  486. data/spec/models/audit_log_entry_listing_rep_spec.rb +136 -0
  487. data/spec/models/audit_log_entry_rep_spec.rb +172 -0
  488. data/spec/models/authorized_app_data_rep_spec.rb +58 -0
  489. data/spec/models/big_segment_target_spec.rb +46 -0
  490. data/spec/models/branch_collection_rep_spec.rb +40 -0
  491. data/spec/models/branch_rep_spec.rb +64 -0
  492. data/spec/models/clause_spec.rb +8 -15
  493. data/spec/models/client_side_availability_post_spec.rb +40 -0
  494. data/spec/models/client_side_availability_spec.rb +10 -17
  495. data/spec/models/condition_base_output_rep_spec.rb +46 -0
  496. data/spec/models/condition_input_rep_spec.rb +58 -0
  497. data/spec/models/condition_output_rep_spec.rb +82 -0
  498. data/spec/models/confidence_interval_rep_spec.rb +40 -0
  499. data/spec/models/conflict_output_rep_spec.rb +40 -0
  500. data/spec/models/conflict_spec.rb +40 -0
  501. data/spec/models/copied_from_env_spec.rb +40 -0
  502. data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +64 -0
  503. data/spec/models/create_flag_config_approval_request_request_spec.rb +70 -0
  504. data/spec/models/custom_property_spec.rb +8 -15
  505. data/spec/models/custom_role_post_data_spec.rb +58 -0
  506. data/spec/models/custom_role_post_spec.rb +58 -0
  507. data/spec/models/custom_role_spec.rb +24 -19
  508. data/spec/models/custom_roles_spec.rb +8 -15
  509. data/spec/models/custom_workflow_input_rep_spec.rb +52 -0
  510. data/spec/models/custom_workflow_meta_spec.rb +40 -0
  511. data/spec/models/custom_workflow_output_rep_spec.rb +94 -0
  512. data/spec/models/custom_workflow_stage_meta_spec.rb +40 -0
  513. data/spec/models/custom_workflows_listing_output_rep_spec.rb +34 -0
  514. data/spec/models/default_client_side_availability_post_spec.rb +40 -0
  515. data/spec/models/defaults_spec.rb +8 -15
  516. data/spec/models/dependent_flag_environment_spec.rb +8 -15
  517. data/spec/models/dependent_flag_spec.rb +8 -15
  518. data/spec/models/dependent_flags_by_environment_spec.rb +8 -15
  519. data/spec/models/derived_attribute_spec.rb +40 -0
  520. data/spec/models/destination_post_spec.rb +56 -0
  521. data/spec/models/destination_spec.rb +19 -20
  522. data/spec/models/destinations_spec.rb +8 -15
  523. data/spec/models/environment_post_spec.rb +10 -17
  524. data/spec/models/environment_spec.rb +11 -18
  525. data/spec/models/execution_output_rep_spec.rb +34 -0
  526. data/spec/models/experiment_allocation_rep_spec.rb +40 -0
  527. data/spec/models/experiment_enabled_period_rep_spec.rb +40 -0
  528. data/spec/models/experiment_environment_setting_rep_spec.rb +46 -0
  529. data/spec/models/experiment_info_rep_spec.rb +40 -0
  530. data/spec/models/experiment_metadata_rep_spec.rb +34 -0
  531. data/spec/models/experiment_rep_spec.rb +52 -0
  532. data/spec/models/experiment_results_rep_spec.rb +70 -0
  533. data/spec/models/experiment_stats_rep_spec.rb +52 -0
  534. data/spec/models/experiment_time_series_slice_spec.rb +40 -0
  535. data/spec/models/experiment_time_series_variation_slice_spec.rb +76 -0
  536. data/spec/models/experiment_totals_rep_spec.rb +76 -0
  537. data/spec/models/expiring_user_target_error_spec.rb +40 -0
  538. data/spec/models/expiring_user_target_get_response_spec.rb +40 -0
  539. data/spec/models/expiring_user_target_item_spec.rb +70 -0
  540. data/spec/models/expiring_user_target_patch_response_spec.rb +64 -0
  541. data/spec/models/extinction_collection_rep_spec.rb +40 -0
  542. data/spec/models/extinction_spec.rb +58 -0
  543. data/spec/models/feature_flag_body_spec.rb +24 -19
  544. data/spec/models/feature_flag_config_spec.rb +28 -17
  545. data/spec/models/feature_flag_scheduled_change_spec.rb +34 -17
  546. data/spec/models/feature_flag_scheduled_changes_spec.rb +10 -17
  547. data/spec/models/feature_flag_spec.rb +39 -30
  548. data/spec/models/feature_flag_status_across_environments_spec.rb +10 -17
  549. data/spec/models/feature_flag_status_spec.rb +8 -25
  550. data/spec/models/feature_flag_statuses_spec.rb +8 -15
  551. data/spec/models/feature_flags_spec.rb +10 -17
  552. data/spec/models/flag_config_approval_request_response_spec.rb +148 -0
  553. data/spec/models/flag_config_approval_requests_response_spec.rb +40 -0
  554. data/spec/models/flag_copy_config_environment_spec.rb +40 -0
  555. data/spec/models/flag_copy_config_post_spec.rb +66 -0
  556. data/spec/models/flag_global_attributes_rep_spec.rb +158 -0
  557. data/spec/models/flag_listing_rep_spec.rb +52 -0
  558. data/spec/models/flag_scheduled_changes_input_spec.rb +40 -0
  559. data/spec/models/flag_status_rep_spec.rb +52 -0
  560. data/spec/models/flag_summary_spec.rb +34 -0
  561. data/spec/models/forbidden_error_rep_spec.rb +40 -0
  562. data/spec/models/hunk_rep_spec.rb +58 -0
  563. data/spec/models/integration_metadata_spec.rb +52 -0
  564. data/spec/models/integration_status_spec.rb +40 -0
  565. data/spec/models/invalid_request_error_rep_spec.rb +40 -0
  566. data/spec/models/ip_list_spec.rb +40 -0
  567. data/spec/models/last_seen_metadata_spec.rb +34 -0
  568. data/spec/models/link_spec.rb +8 -15
  569. data/spec/models/member_data_rep_spec.rb +58 -0
  570. data/spec/models/member_permission_grant_summary_rep_spec.rb +46 -0
  571. data/spec/models/member_spec.rb +50 -21
  572. data/spec/models/member_summary_rep_spec.rb +64 -0
  573. data/spec/models/member_team_summary_rep_spec.rb +46 -0
  574. data/spec/models/members_spec.rb +10 -17
  575. data/spec/models/method_not_allowed_error_rep_spec.rb +40 -0
  576. data/spec/models/metric_collection_rep_spec.rb +40 -0
  577. data/spec/models/metric_listing_rep_spec.rb +140 -0
  578. data/spec/models/metric_post_spec.rb +104 -0
  579. data/spec/models/metric_rep_spec.rb +170 -0
  580. data/spec/models/metric_seen_spec.rb +40 -0
  581. data/spec/models/modification_spec.rb +34 -0
  582. data/spec/models/multi_environment_dependent_flag_spec.rb +8 -27
  583. data/spec/models/multi_environment_dependent_flags_spec.rb +8 -15
  584. data/spec/models/new_member_form_spec.rb +64 -0
  585. data/spec/models/not_found_error_rep_spec.rb +40 -0
  586. data/spec/models/parent_resource_rep_spec.rb +46 -0
  587. data/spec/models/patch_failed_error_rep_spec.rb +40 -0
  588. data/spec/models/patch_operation_spec.rb +8 -15
  589. data/spec/models/patch_segment_instruction_spec.rb +58 -0
  590. data/spec/models/patch_segment_request_spec.rb +40 -0
  591. data/spec/models/patch_with_comment_spec.rb +40 -0
  592. data/spec/models/permission_grant_input_spec.rb +46 -0
  593. data/spec/models/permission_grant_rep_spec.rb +52 -0
  594. data/spec/models/post_approval_request_apply_request_spec.rb +34 -0
  595. data/spec/models/post_approval_request_review_request_spec.rb +40 -0
  596. data/spec/models/post_flag_scheduled_changes_input_spec.rb +46 -0
  597. data/spec/models/prerequisite_spec.rb +8 -15
  598. data/spec/models/project_listing_rep_spec.rb +70 -0
  599. data/spec/models/project_post_spec.rb +64 -0
  600. data/spec/models/project_spec.rb +12 -19
  601. data/spec/models/projects_spec.rb +8 -15
  602. data/spec/models/pub_nub_detail_rep_spec.rb +40 -0
  603. data/spec/models/put_branch_spec.rb +58 -0
  604. data/spec/models/rate_limited_error_rep_spec.rb +40 -0
  605. data/spec/models/reference_rep_spec.rb +46 -0
  606. data/spec/models/relay_auto_config_collection_rep_spec.rb +34 -0
  607. data/spec/models/relay_auto_config_post_spec.rb +40 -0
  608. data/spec/models/relay_auto_config_rep_spec.rb +82 -0
  609. data/spec/models/repository_collection_rep_spec.rb +40 -0
  610. data/spec/models/repository_post_spec.rb +68 -0
  611. data/spec/models/repository_rep_spec.rb +98 -0
  612. data/spec/models/resource_access_spec.rb +40 -0
  613. data/spec/models/resource_id_response_spec.rb +58 -0
  614. data/spec/models/review_output_rep_spec.rb +58 -0
  615. data/spec/models/review_response_spec.rb +62 -0
  616. data/spec/models/rollout_spec.rb +22 -17
  617. data/spec/models/rule_spec.rb +11 -18
  618. data/spec/models/schedule_condition_input_rep_spec.rb +40 -0
  619. data/spec/models/schedule_condition_output_rep_spec.rb +34 -0
  620. data/spec/models/sdk_list_rep_spec.rb +40 -0
  621. data/spec/models/sdk_version_list_rep_spec.rb +40 -0
  622. data/spec/models/sdk_version_rep_spec.rb +40 -0
  623. data/spec/models/segment_body_spec.rb +58 -0
  624. data/spec/models/segment_metadata_spec.rb +64 -0
  625. data/spec/models/segment_user_list_spec.rb +40 -0
  626. data/spec/models/segment_user_state_spec.rb +40 -0
  627. data/spec/models/series_list_rep_spec.rb +46 -0
  628. data/spec/models/source_flag_spec.rb +40 -0
  629. data/spec/models/stage_input_rep_spec.rb +46 -0
  630. data/spec/models/stage_output_rep_spec.rb +58 -0
  631. data/spec/models/statement_post_data_spec.rb +58 -0
  632. data/spec/models/statement_post_spec.rb +58 -0
  633. data/spec/models/statement_rep_spec.rb +58 -0
  634. data/spec/models/statement_spec.rb +8 -19
  635. data/spec/models/statistic_collection_rep_spec.rb +40 -0
  636. data/spec/models/statistic_rep_spec.rb +70 -0
  637. data/spec/models/statistics_root_spec.rb +40 -0
  638. data/spec/models/status_conflict_error_rep_spec.rb +40 -0
  639. data/spec/models/subject_data_rep_spec.rb +46 -0
  640. data/spec/models/target_resource_rep_spec.rb +46 -0
  641. data/spec/models/target_spec.rb +8 -15
  642. data/spec/models/team_collection_rep_spec.rb +46 -0
  643. data/spec/models/team_patch_input_spec.rb +40 -0
  644. data/spec/models/team_post_input_spec.rb +64 -0
  645. data/spec/models/team_rep_spec.rb +100 -0
  646. data/spec/models/title_rep_spec.rb +76 -0
  647. data/spec/models/token_data_rep_spec.rb +58 -0
  648. data/spec/models/token_spec.rb +27 -28
  649. data/spec/models/tokens_spec.rb +10 -17
  650. data/spec/models/unauthorized_error_rep_spec.rb +40 -0
  651. data/spec/models/url_post_spec.rb +56 -0
  652. data/spec/models/user_attribute_names_rep_spec.rb +46 -0
  653. data/spec/models/user_flag_setting_spec.rb +8 -15
  654. data/spec/models/user_flag_settings_spec.rb +10 -17
  655. data/spec/models/user_record_rep_spec.rb +58 -0
  656. data/spec/models/user_record_spec.rb +21 -16
  657. data/spec/models/user_segment_rule_spec.rb +14 -15
  658. data/spec/models/user_segment_spec.rb +58 -23
  659. data/spec/models/user_segments_spec.rb +10 -17
  660. data/spec/models/user_spec.rb +20 -15
  661. data/spec/models/users_spec.rb +8 -15
  662. data/spec/models/value_put_spec.rb +40 -0
  663. data/spec/models/variation_or_rollout_rep_spec.rb +40 -0
  664. data/spec/models/variation_spec.rb +10 -17
  665. data/spec/models/variation_summary_spec.rb +70 -0
  666. data/spec/models/versions_rep_spec.rb +52 -0
  667. data/spec/models/webhook_post_spec.rb +70 -0
  668. data/spec/models/webhook_spec.rb +18 -19
  669. data/spec/models/webhooks_spec.rb +8 -15
  670. data/spec/models/weighted_variation_spec.rb +14 -15
  671. data/spec/spec_helper.rb +4 -4
  672. metadata +953 -576
  673. data/docs/ApprovalRequest.md +0 -20
  674. data/docs/ApprovalRequestApplyConfigBody.md +0 -8
  675. data/docs/ApprovalRequestConfigBody.md +0 -13
  676. data/docs/ApprovalRequestReview.md +0 -11
  677. data/docs/ApprovalRequestReviewConfigBody.md +0 -9
  678. data/docs/ApprovalRequestReviewStatus.md +0 -7
  679. data/docs/ApprovalRequests.md +0 -9
  680. data/docs/AuditLogEntries.md +0 -9
  681. data/docs/AuditLogEntry.md +0 -19
  682. data/docs/AuditLogEntryTarget.md +0 -10
  683. data/docs/BigSegmentTargetChanges.md +0 -9
  684. data/docs/BigSegmentTargetsBody.md +0 -9
  685. data/docs/CopyActions.md +0 -7
  686. data/docs/CustomPropertyValues.md +0 -7
  687. data/docs/CustomRoleBody.md +0 -11
  688. data/docs/CustomerMetricsApi.md +0 -511
  689. data/docs/DependentFlagEnvironmentLinks.md +0 -9
  690. data/docs/DependentFlagLinks.md +0 -8
  691. data/docs/DependentFlagsLinks.md +0 -9
  692. data/docs/DestinationAmazonKinesis.md +0 -10
  693. data/docs/DestinationBody.md +0 -11
  694. data/docs/DestinationGooglePubSub.md +0 -9
  695. data/docs/DestinationMParticle.md +0 -11
  696. data/docs/DestinationSegment.md +0 -8
  697. data/docs/EnvironmentApprovalSettings.md +0 -13
  698. data/docs/EvaluationUsageError.md +0 -9
  699. data/docs/Events.md +0 -8
  700. data/docs/Fallthrough.md +0 -9
  701. data/docs/FeatureFlagCopyBody.md +0 -12
  702. data/docs/FeatureFlagCopyObject.md +0 -9
  703. data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
  704. data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
  705. data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
  706. data/docs/FeatureFlagStatusLinks.md +0 -9
  707. data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
  708. data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
  709. data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
  710. data/docs/FlagListItem.md +0 -11
  711. data/docs/HierarchicalLinks.md +0 -9
  712. data/docs/Id.md +0 -7
  713. data/docs/Integration.md +0 -9
  714. data/docs/IntegrationSubscription.md +0 -16
  715. data/docs/IntegrationSubscriptionStatus.md +0 -10
  716. data/docs/Integrations.md +0 -9
  717. data/docs/IntegrationsApi.md +0 -334
  718. data/docs/Links.md +0 -9
  719. data/docs/MAU.md +0 -10
  720. data/docs/MAUMetadata.md +0 -7
  721. data/docs/MAUbyCategory.md +0 -10
  722. data/docs/MemberLastSeenMetadata.md +0 -8
  723. data/docs/MembersBody.md +0 -13
  724. data/docs/PatchComment.md +0 -9
  725. data/docs/Policy.md +0 -12
  726. data/docs/ProjectBody.md +0 -13
  727. data/docs/RelayProxyConfig.md +0 -15
  728. data/docs/RelayProxyConfigBody.md +0 -9
  729. data/docs/RelayProxyConfigs.md +0 -8
  730. data/docs/Role.md +0 -7
  731. data/docs/RootApi.md +0 -56
  732. data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
  733. data/docs/SemanticPatchInstruction.md +0 -7
  734. data/docs/SemanticPatchInstructionInner.md +0 -8
  735. data/docs/SemanticPatchOperation.md +0 -9
  736. data/docs/Site.md +0 -9
  737. data/docs/Stream.md +0 -10
  738. data/docs/StreamBySDK.md +0 -10
  739. data/docs/StreamBySDKLinks.md +0 -9
  740. data/docs/StreamBySDKLinksMetadata.md +0 -10
  741. data/docs/StreamLinks.md +0 -10
  742. data/docs/StreamSDKVersion.md +0 -9
  743. data/docs/StreamSDKVersionData.md +0 -9
  744. data/docs/StreamUsageError.md +0 -9
  745. data/docs/StreamUsageLinks.md +0 -10
  746. data/docs/StreamUsageMetadata.md +0 -10
  747. data/docs/StreamUsageSeries.md +0 -9
  748. data/docs/Streams.md +0 -8
  749. data/docs/SubscriptionBody.md +0 -12
  750. data/docs/TeamMembersApi.md +0 -329
  751. data/docs/TokenBody.md +0 -13
  752. data/docs/Usage.md +0 -9
  753. data/docs/UsageError.md +0 -8
  754. data/docs/UsageLinks.md +0 -10
  755. data/docs/UserSegmentBody.md +0 -12
  756. data/docs/UserSegmentsApi.md +0 -488
  757. data/docs/UserSettingsBody.md +0 -8
  758. data/docs/UserTargetingExpirationForFlag.md +0 -14
  759. data/docs/UserTargetingExpirationForFlags.md +0 -9
  760. data/docs/UserTargetingExpirationForSegment.md +0 -14
  761. data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
  762. data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
  763. data/docs/WebhookBody.md +0 -14
  764. data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
  765. data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
  766. data/lib/launchdarkly_api/api/root_api.rb +0 -69
  767. data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
  768. data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
  769. data/lib/launchdarkly_api/models/approval_request.rb +0 -337
  770. data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
  771. data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
  772. data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
  773. data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
  774. data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
  775. data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
  776. data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
  777. data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
  778. data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
  779. data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
  780. data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
  781. data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
  782. data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
  783. data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
  784. data/lib/launchdarkly_api/models/dependent_flag__links.rb +0 -184
  785. data/lib/launchdarkly_api/models/dependent_flag_environment__links.rb +0 -193
  786. data/lib/launchdarkly_api/models/dependent_flags_links.rb +0 -193
  787. data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
  788. data/lib/launchdarkly_api/models/destination_body.rb +0 -264
  789. data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
  790. data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
  791. data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
  792. data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -272
  793. data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
  794. data/lib/launchdarkly_api/models/events.rb +0 -184
  795. data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
  796. data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
  797. data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
  798. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
  799. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
  800. data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
  801. data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
  802. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
  803. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
  804. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
  805. data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
  806. data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
  807. data/lib/launchdarkly_api/models/id.rb +0 -176
  808. data/lib/launchdarkly_api/models/integration.rb +0 -195
  809. data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
  810. data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
  811. data/lib/launchdarkly_api/models/integrations.rb +0 -196
  812. data/lib/launchdarkly_api/models/links.rb +0 -193
  813. data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
  814. data/lib/launchdarkly_api/models/mau.rb +0 -206
  815. data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
  816. data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
  817. data/lib/launchdarkly_api/models/members_body.rb +0 -238
  818. data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
  819. data/lib/launchdarkly_api/models/policy.rb +0 -231
  820. data/lib/launchdarkly_api/models/project_body.rb +0 -243
  821. data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
  822. data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
  823. data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
  824. data/lib/launchdarkly_api/models/role.rb +0 -32
  825. data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
  826. data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
  827. data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
  828. data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
  829. data/lib/launchdarkly_api/models/site.rb +0 -193
  830. data/lib/launchdarkly_api/models/stream.rb +0 -206
  831. data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
  832. data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
  833. data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
  834. data/lib/launchdarkly_api/models/stream_links.rb +0 -205
  835. data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
  836. data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
  837. data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
  838. data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
  839. data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
  840. data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
  841. data/lib/launchdarkly_api/models/streams.rb +0 -184
  842. data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
  843. data/lib/launchdarkly_api/models/token_body.rb +0 -238
  844. data/lib/launchdarkly_api/models/usage.rb +0 -195
  845. data/lib/launchdarkly_api/models/usage_error.rb +0 -184
  846. data/lib/launchdarkly_api/models/usage_links.rb +0 -205
  847. data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
  848. data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
  849. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
  850. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
  851. data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
  852. data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
  853. data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
  854. data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
  855. data/openapi.yml +0 -4851
  856. data/spec/api/customer_metrics_api_spec.rb +0 -141
  857. data/spec/api/integrations_api_spec.rb +0 -105
  858. data/spec/api/root_api_spec.rb +0 -45
  859. data/spec/api/team_members_api_spec.rb +0 -104
  860. data/spec/api/user_segments_api_spec.rb +0 -142
  861. data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
  862. data/spec/models/approval_request_config_body_spec.rb +0 -71
  863. data/spec/models/approval_request_review_config_body_spec.rb +0 -51
  864. data/spec/models/approval_request_review_spec.rb +0 -59
  865. data/spec/models/approval_request_review_status_spec.rb +0 -35
  866. data/spec/models/approval_request_spec.rb +0 -117
  867. data/spec/models/approval_requests_spec.rb +0 -47
  868. data/spec/models/audit_log_entries_spec.rb +0 -47
  869. data/spec/models/audit_log_entry_spec.rb +0 -107
  870. data/spec/models/audit_log_entry_target_spec.rb +0 -53
  871. data/spec/models/big_segment_target_changes_spec.rb +0 -47
  872. data/spec/models/big_segment_targets_body_spec.rb +0 -47
  873. data/spec/models/copy_actions_spec.rb +0 -35
  874. data/spec/models/custom_property_values_spec.rb +0 -35
  875. data/spec/models/custom_role_body_spec.rb +0 -59
  876. data/spec/models/dependent_flag__links_spec.rb +0 -41
  877. data/spec/models/dependent_flag_environment__links_spec.rb +0 -47
  878. data/spec/models/dependent_flags_links_spec.rb +0 -47
  879. data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
  880. data/spec/models/destination_body_spec.rb +0 -63
  881. data/spec/models/destination_google_pub_sub_spec.rb +0 -47
  882. data/spec/models/destination_m_particle_spec.rb +0 -59
  883. data/spec/models/destination_segment_spec.rb +0 -41
  884. data/spec/models/environment_approval_settings_spec.rb +0 -75
  885. data/spec/models/evaluation_usage_error_spec.rb +0 -47
  886. data/spec/models/events_spec.rb +0 -41
  887. data/spec/models/fallthrough_spec.rb +0 -47
  888. data/spec/models/feature_flag_copy_body_spec.rb +0 -65
  889. data/spec/models/feature_flag_copy_object_spec.rb +0 -47
  890. data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
  891. data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
  892. data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
  893. data/spec/models/feature_flag_status_links_spec.rb +0 -47
  894. data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
  895. data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
  896. data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
  897. data/spec/models/flag_list_item_spec.rb +0 -59
  898. data/spec/models/hierarchical_links_spec.rb +0 -47
  899. data/spec/models/id_spec.rb +0 -35
  900. data/spec/models/integration_spec.rb +0 -47
  901. data/spec/models/integration_subscription__status_spec.rb +0 -53
  902. data/spec/models/integration_subscription_spec.rb +0 -89
  903. data/spec/models/integrations_spec.rb +0 -47
  904. data/spec/models/links_spec.rb +0 -47
  905. data/spec/models/ma_uby_category_spec.rb +0 -53
  906. data/spec/models/mau_metadata_spec.rb +0 -35
  907. data/spec/models/mau_spec.rb +0 -53
  908. data/spec/models/member__last_seen_metadata_spec.rb +0 -41
  909. data/spec/models/members_body_spec.rb +0 -71
  910. data/spec/models/patch_comment_spec.rb +0 -47
  911. data/spec/models/policy_spec.rb +0 -65
  912. data/spec/models/project_body_spec.rb +0 -71
  913. data/spec/models/relay_proxy_config_body_spec.rb +0 -47
  914. data/spec/models/relay_proxy_config_spec.rb +0 -83
  915. data/spec/models/relay_proxy_configs_spec.rb +0 -41
  916. data/spec/models/role_spec.rb +0 -35
  917. data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +0 -47
  918. data/spec/models/semantic_patch_instruction_inner_spec.rb +0 -41
  919. data/spec/models/semantic_patch_instruction_spec.rb +0 -35
  920. data/spec/models/semantic_patch_operation_spec.rb +0 -47
  921. data/spec/models/site_spec.rb +0 -47
  922. data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
  923. data/spec/models/stream_by_sdk_links_spec.rb +0 -47
  924. data/spec/models/stream_by_sdk_spec.rb +0 -53
  925. data/spec/models/stream_links_spec.rb +0 -53
  926. data/spec/models/stream_sdk_version_data_spec.rb +0 -47
  927. data/spec/models/stream_sdk_version_spec.rb +0 -47
  928. data/spec/models/stream_spec.rb +0 -53
  929. data/spec/models/stream_usage_error_spec.rb +0 -47
  930. data/spec/models/stream_usage_links_spec.rb +0 -53
  931. data/spec/models/stream_usage_metadata_spec.rb +0 -53
  932. data/spec/models/stream_usage_series_spec.rb +0 -47
  933. data/spec/models/streams_spec.rb +0 -41
  934. data/spec/models/subscription_body_spec.rb +0 -65
  935. data/spec/models/token_body_spec.rb +0 -71
  936. data/spec/models/usage_error_spec.rb +0 -41
  937. data/spec/models/usage_links_spec.rb +0 -53
  938. data/spec/models/usage_spec.rb +0 -47
  939. data/spec/models/user_segment_body_spec.rb +0 -65
  940. data/spec/models/user_settings_body_spec.rb +0 -41
  941. data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
  942. data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
  943. data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
  944. data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
  945. data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
  946. data/spec/models/webhook_body_spec.rb +0 -77
@@ -0,0 +1,735 @@
1
+ =begin
2
+ #LaunchDarkly REST API
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.
5
+
6
+ The version of the OpenAPI document: 2.0
7
+ Contact: support@launchdarkly.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module LaunchDarklyApi
16
+ class SegmentsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Delete segment
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.
27
+ # @param [Hash] opts the optional parameters
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)
31
+ nil
32
+ end
33
+
34
+ # Delete segment
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.
39
+ # @param [Hash] opts the optional parameters
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 = {})
42
+ if @api_client.config.debugging
43
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.delete_segment ...'
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"
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"
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"
56
+ end
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))
59
+
60
+ # query parameters
61
+ query_params = opts[:query_params] || {}
62
+
63
+ # header parameters
64
+ header_params = opts[:header_params] || {}
65
+ # HTTP header 'Accept' (if needed)
66
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
67
+
68
+ # form parameters
69
+ form_params = opts[:form_params] || {}
70
+
71
+ # http body (model)
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type]
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"SegmentsApi.delete_segment",
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: SegmentsApi#delete_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+
97
+ # Get expiring user targets for segment
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.
102
+ # @param [Hash] opts the optional parameters
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)
106
+ data
107
+ end
108
+
109
+ # Get expiring user targets for segment
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.
114
+ # @param [Hash] opts the optional parameters
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 = {})
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_expiring_user_targets_for_segment ...'
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"
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"
127
+ end
128
+ # verify the required parameter 'segment_key' is set
129
+ if @api_client.config.client_side_validation && segment_key.nil?
130
+ fail ArgumentError, "Missing the required parameter 'segment_key' when calling SegmentsApi.get_expiring_user_targets_for_segment"
131
+ end
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))
134
+
135
+ # query parameters
136
+ query_params = opts[:query_params] || {}
137
+
138
+ # header parameters
139
+ header_params = opts[:header_params] || {}
140
+ # HTTP header 'Accept' (if needed)
141
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
142
+
143
+ # form parameters
144
+ form_params = opts[:form_params] || {}
145
+
146
+ # http body (model)
147
+ post_body = opts[:debug_body]
148
+
149
+ # return_type
150
+ return_type = opts[:debug_return_type] || 'ExpiringUserTargetGetResponse'
151
+
152
+ # auth_names
153
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
154
+
155
+ new_options = opts.merge(
156
+ :operation => :"SegmentsApi.get_expiring_user_targets_for_segment",
157
+ :header_params => header_params,
158
+ :query_params => query_params,
159
+ :form_params => form_params,
160
+ :body => post_body,
161
+ :auth_names => auth_names,
162
+ :return_type => return_type
163
+ )
164
+
165
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
166
+ if @api_client.config.debugging
167
+ @api_client.config.logger.debug "API called: SegmentsApi#get_expiring_user_targets_for_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
168
+ end
169
+ return data, status_code, headers
170
+ end
171
+
172
+ # Get segment
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
177
+ # @param [Hash] opts the optional parameters
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)
181
+ data
182
+ end
183
+
184
+ # Get segment
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
189
+ # @param [Hash] opts the optional parameters
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 = {})
192
+ if @api_client.config.debugging
193
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment ...'
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"
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"
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"
206
+ end
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))
209
+
210
+ # query parameters
211
+ query_params = opts[:query_params] || {}
212
+
213
+ # header parameters
214
+ header_params = opts[:header_params] || {}
215
+ # HTTP header 'Accept' (if needed)
216
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
217
+
218
+ # form parameters
219
+ form_params = opts[:form_params] || {}
220
+
221
+ # http body (model)
222
+ post_body = opts[:debug_body]
223
+
224
+ # return_type
225
+ return_type = opts[:debug_return_type] || 'UserSegment'
226
+
227
+ # auth_names
228
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
229
+
230
+ new_options = opts.merge(
231
+ :operation => :"SegmentsApi.get_segment",
232
+ :header_params => header_params,
233
+ :query_params => query_params,
234
+ :form_params => form_params,
235
+ :body => post_body,
236
+ :auth_names => auth_names,
237
+ :return_type => return_type
238
+ )
239
+
240
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
241
+ if @api_client.config.debugging
242
+ @api_client.config.logger.debug "API called: SegmentsApi#get_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
243
+ end
244
+ return data, status_code, headers
245
+ end
246
+
247
+ # Get Big Segment membership for user
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.
253
+ # @param [Hash] opts the optional parameters
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)
257
+ data
258
+ end
259
+
260
+ # Get Big Segment membership for user
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.
266
+ # @param [Hash] opts the optional parameters
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 = {})
269
+ if @api_client.config.debugging
270
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segment_membership_for_user ...'
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"
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"
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"
283
+ end
284
+ # verify the required parameter 'user_key' is set
285
+ if @api_client.config.client_side_validation && user_key.nil?
286
+ fail ArgumentError, "Missing the required parameter 'user_key' when calling SegmentsApi.get_segment_membership_for_user"
287
+ end
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))
290
+
291
+ # query parameters
292
+ query_params = opts[:query_params] || {}
293
+
294
+ # header parameters
295
+ header_params = opts[:header_params] || {}
296
+ # HTTP header 'Accept' (if needed)
297
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
298
+
299
+ # form parameters
300
+ form_params = opts[:form_params] || {}
301
+
302
+ # http body (model)
303
+ post_body = opts[:debug_body]
304
+
305
+ # return_type
306
+ return_type = opts[:debug_return_type] || 'BigSegmentTarget'
307
+
308
+ # auth_names
309
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
310
+
311
+ new_options = opts.merge(
312
+ :operation => :"SegmentsApi.get_segment_membership_for_user",
313
+ :header_params => header_params,
314
+ :query_params => query_params,
315
+ :form_params => form_params,
316
+ :body => post_body,
317
+ :auth_names => auth_names,
318
+ :return_type => return_type
319
+ )
320
+
321
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug "API called: SegmentsApi#get_segment_membership_for_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
324
+ end
325
+ return data, status_code, headers
326
+ end
327
+
328
+ # List segments
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.
332
+ # @param [Hash] opts the optional parameters
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)
336
+ data
337
+ end
338
+
339
+ # List segments
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.
343
+ # @param [Hash] opts the optional parameters
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 = {})
346
+ if @api_client.config.debugging
347
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.get_segments ...'
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"
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"
356
+ end
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))
359
+
360
+ # query parameters
361
+ query_params = opts[:query_params] || {}
362
+
363
+ # header parameters
364
+ header_params = opts[:header_params] || {}
365
+ # HTTP header 'Accept' (if needed)
366
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
367
+
368
+ # form parameters
369
+ form_params = opts[:form_params] || {}
370
+
371
+ # http body (model)
372
+ post_body = opts[:debug_body]
373
+
374
+ # return_type
375
+ return_type = opts[:debug_return_type] || 'UserSegments'
376
+
377
+ # auth_names
378
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
379
+
380
+ new_options = opts.merge(
381
+ :operation => :"SegmentsApi.get_segments",
382
+ :header_params => header_params,
383
+ :query_params => query_params,
384
+ :form_params => form_params,
385
+ :body => post_body,
386
+ :auth_names => auth_names,
387
+ :return_type => return_type
388
+ )
389
+
390
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
391
+ if @api_client.config.debugging
392
+ @api_client.config.logger.debug "API called: SegmentsApi#get_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
393
+ end
394
+ return data, status_code, headers
395
+ end
396
+
397
+ # Update expiring user targets for segment
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](/#section/Updates/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.
402
+ # @param patch_segment_request [PatchSegmentRequest]
403
+ # @param [Hash] opts the optional parameters
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)
407
+ data
408
+ end
409
+
410
+ # Update expiring user targets for segment
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](/#section/Updates/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.
415
+ # @param patch_segment_request [PatchSegmentRequest]
416
+ # @param [Hash] opts the optional parameters
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 = {})
419
+ if @api_client.config.debugging
420
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.patch_expiring_user_targets_for_segment ...'
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"
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"
429
+ end
430
+ # verify the required parameter 'segment_key' is set
431
+ if @api_client.config.client_side_validation && segment_key.nil?
432
+ fail ArgumentError, "Missing the required parameter 'segment_key' when calling SegmentsApi.patch_expiring_user_targets_for_segment"
433
+ end
434
+ # verify the required parameter 'patch_segment_request' is set
435
+ if @api_client.config.client_side_validation && patch_segment_request.nil?
436
+ fail ArgumentError, "Missing the required parameter 'patch_segment_request' when calling SegmentsApi.patch_expiring_user_targets_for_segment"
437
+ end
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))
440
+
441
+ # query parameters
442
+ query_params = opts[:query_params] || {}
443
+
444
+ # header parameters
445
+ header_params = opts[:header_params] || {}
446
+ # HTTP header 'Accept' (if needed)
447
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
448
+ # HTTP header 'Content-Type'
449
+ content_type = @api_client.select_header_content_type(['application/json'])
450
+ if !content_type.nil?
451
+ header_params['Content-Type'] = content_type
452
+ end
453
+
454
+ # form parameters
455
+ form_params = opts[:form_params] || {}
456
+
457
+ # http body (model)
458
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_segment_request)
459
+
460
+ # return_type
461
+ return_type = opts[:debug_return_type] || 'ExpiringUserTargetPatchResponse'
462
+
463
+ # auth_names
464
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
465
+
466
+ new_options = opts.merge(
467
+ :operation => :"SegmentsApi.patch_expiring_user_targets_for_segment",
468
+ :header_params => header_params,
469
+ :query_params => query_params,
470
+ :form_params => form_params,
471
+ :body => post_body,
472
+ :auth_names => auth_names,
473
+ :return_type => return_type
474
+ )
475
+
476
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
477
+ if @api_client.config.debugging
478
+ @api_client.config.logger.debug "API called: SegmentsApi#patch_expiring_user_targets_for_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
479
+ end
480
+ return data, status_code, headers
481
+ end
482
+
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/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.
488
+ # @param patch_with_comment [PatchWithComment]
489
+ # @param [Hash] opts the optional parameters
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)
493
+ data
494
+ end
495
+
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/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.
501
+ # @param patch_with_comment [PatchWithComment]
502
+ # @param [Hash] opts the optional parameters
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 = {})
505
+ if @api_client.config.debugging
506
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.patch_segment ...'
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"
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"
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"
519
+ end
520
+ # verify the required parameter 'patch_with_comment' is set
521
+ if @api_client.config.client_side_validation && patch_with_comment.nil?
522
+ fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling SegmentsApi.patch_segment"
523
+ end
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))
526
+
527
+ # query parameters
528
+ query_params = opts[:query_params] || {}
529
+
530
+ # header parameters
531
+ header_params = opts[:header_params] || {}
532
+ # HTTP header 'Accept' (if needed)
533
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
534
+ # HTTP header 'Content-Type'
535
+ content_type = @api_client.select_header_content_type(['application/json'])
536
+ if !content_type.nil?
537
+ header_params['Content-Type'] = content_type
538
+ end
539
+
540
+ # form parameters
541
+ form_params = opts[:form_params] || {}
542
+
543
+ # http body (model)
544
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_with_comment)
545
+
546
+ # return_type
547
+ return_type = opts[:debug_return_type] || 'UserSegment'
548
+
549
+ # auth_names
550
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
551
+
552
+ new_options = opts.merge(
553
+ :operation => :"SegmentsApi.patch_segment",
554
+ :header_params => header_params,
555
+ :query_params => query_params,
556
+ :form_params => form_params,
557
+ :body => post_body,
558
+ :auth_names => auth_names,
559
+ :return_type => return_type
560
+ )
561
+
562
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
563
+ if @api_client.config.debugging
564
+ @api_client.config.logger.debug "API called: SegmentsApi#patch_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
565
+ end
566
+ return data, status_code, headers
567
+ end
568
+
569
+ # Create segment
570
+ # Create a new user segment
571
+ # @param proj_key [String] The project key.
572
+ # @param env_key [String] The environment key.
573
+ # @param segment_body [SegmentBody]
574
+ # @param [Hash] opts the optional parameters
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)
578
+ data
579
+ end
580
+
581
+ # Create segment
582
+ # Create a new user segment
583
+ # @param proj_key [String] The project key.
584
+ # @param env_key [String] The environment key.
585
+ # @param segment_body [SegmentBody]
586
+ # @param [Hash] opts the optional parameters
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 = {})
589
+ if @api_client.config.debugging
590
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.post_segment ...'
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"
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"
599
+ end
600
+ # verify the required parameter 'segment_body' is set
601
+ if @api_client.config.client_side_validation && segment_body.nil?
602
+ fail ArgumentError, "Missing the required parameter 'segment_body' when calling SegmentsApi.post_segment"
603
+ end
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))
606
+
607
+ # query parameters
608
+ query_params = opts[:query_params] || {}
609
+
610
+ # header parameters
611
+ header_params = opts[:header_params] || {}
612
+ # HTTP header 'Accept' (if needed)
613
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
614
+ # HTTP header 'Content-Type'
615
+ content_type = @api_client.select_header_content_type(['application/json'])
616
+ if !content_type.nil?
617
+ header_params['Content-Type'] = content_type
618
+ end
619
+
620
+ # form parameters
621
+ form_params = opts[:form_params] || {}
622
+
623
+ # http body (model)
624
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(segment_body)
625
+
626
+ # return_type
627
+ return_type = opts[:debug_return_type] || 'UserSegment'
628
+
629
+ # auth_names
630
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
631
+
632
+ new_options = opts.merge(
633
+ :operation => :"SegmentsApi.post_segment",
634
+ :header_params => header_params,
635
+ :query_params => query_params,
636
+ :form_params => form_params,
637
+ :body => post_body,
638
+ :auth_names => auth_names,
639
+ :return_type => return_type
640
+ )
641
+
642
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
643
+ if @api_client.config.debugging
644
+ @api_client.config.logger.debug "API called: SegmentsApi#post_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
645
+ end
646
+ return data, status_code, headers
647
+ end
648
+
649
+ # Update targets on a Big Segment
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.
654
+ # @param segment_user_state [SegmentUserState]
655
+ # @param [Hash] opts the optional parameters
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)
659
+ nil
660
+ end
661
+
662
+ # Update targets on a Big Segment
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.
667
+ # @param segment_user_state [SegmentUserState]
668
+ # @param [Hash] opts the optional parameters
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 = {})
671
+ if @api_client.config.debugging
672
+ @api_client.config.logger.debug 'Calling API: SegmentsApi.update_big_segment_targets ...'
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"
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"
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"
685
+ end
686
+ # verify the required parameter 'segment_user_state' is set
687
+ if @api_client.config.client_side_validation && segment_user_state.nil?
688
+ fail ArgumentError, "Missing the required parameter 'segment_user_state' when calling SegmentsApi.update_big_segment_targets"
689
+ end
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))
692
+
693
+ # query parameters
694
+ query_params = opts[:query_params] || {}
695
+
696
+ # header parameters
697
+ header_params = opts[:header_params] || {}
698
+ # HTTP header 'Accept' (if needed)
699
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
700
+ # HTTP header 'Content-Type'
701
+ content_type = @api_client.select_header_content_type(['application/json'])
702
+ if !content_type.nil?
703
+ header_params['Content-Type'] = content_type
704
+ end
705
+
706
+ # form parameters
707
+ form_params = opts[:form_params] || {}
708
+
709
+ # http body (model)
710
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(segment_user_state)
711
+
712
+ # return_type
713
+ return_type = opts[:debug_return_type]
714
+
715
+ # auth_names
716
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
717
+
718
+ new_options = opts.merge(
719
+ :operation => :"SegmentsApi.update_big_segment_targets",
720
+ :header_params => header_params,
721
+ :query_params => query_params,
722
+ :form_params => form_params,
723
+ :body => post_body,
724
+ :auth_names => auth_names,
725
+ :return_type => return_type
726
+ )
727
+
728
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
729
+ if @api_client.config.debugging
730
+ @api_client.config.logger.debug "API called: SegmentsApi#update_big_segment_targets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
731
+ end
732
+ return data, status_code, headers
733
+ end
734
+ end
735
+ end