launchdarkly_api 5.1.0 → 6.0.1

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