launchdarkly_api 5.0.3 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (838) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +3 -1
  3. data/README.md +304 -249
  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/DataExportDestinationsApi.md +205 -117
  38. data/docs/DefaultClientSideAvailabilityPost.md +20 -0
  39. data/docs/Defaults.md +15 -4
  40. data/docs/DependentFlag.md +24 -0
  41. data/docs/DependentFlagEnvironment.md +24 -0
  42. data/docs/DependentFlagsByEnvironment.md +22 -0
  43. data/docs/Destination.md +27 -9
  44. data/docs/DestinationPost.md +24 -0
  45. data/docs/Destinations.md +15 -4
  46. data/docs/Environment.md +35 -16
  47. data/docs/EnvironmentPost.md +29 -11
  48. data/docs/EnvironmentsApi.md +246 -144
  49. data/docs/ExperimentAllocationRep.md +20 -0
  50. data/docs/ExperimentEnabledPeriodRep.md +20 -0
  51. data/docs/ExperimentEnvironmentSettingRep.md +22 -0
  52. data/docs/ExperimentInfoRep.md +20 -0
  53. data/docs/ExperimentMetadataRep.md +18 -0
  54. data/docs/ExperimentRep.md +24 -0
  55. data/docs/ExperimentResultsRep.md +28 -0
  56. data/docs/ExperimentStatsRep.md +24 -0
  57. data/docs/ExperimentTimeSeriesSlice.md +20 -0
  58. data/docs/ExperimentTimeSeriesVariationSlice.md +32 -0
  59. data/docs/ExperimentTotalsRep.md +32 -0
  60. data/docs/ExperimentsBetaApi.md +168 -0
  61. data/docs/ExpiringUserTargetError.md +20 -0
  62. data/docs/ExpiringUserTargetGetResponse.md +20 -0
  63. data/docs/ExpiringUserTargetItem.md +30 -0
  64. data/docs/ExpiringUserTargetPatchResponse.md +28 -0
  65. data/docs/Extinction.md +26 -0
  66. data/docs/ExtinctionCollectionRep.md +20 -0
  67. data/docs/ExtinctionRep.md +26 -0
  68. data/docs/FeatureFlag.md +55 -22
  69. data/docs/FeatureFlagBody.md +33 -11
  70. data/docs/FeatureFlagConfig.md +47 -17
  71. data/docs/FeatureFlagScheduledChange.md +27 -6
  72. data/docs/FeatureFlagScheduledChanges.md +15 -4
  73. data/docs/FeatureFlagStatus.md +17 -6
  74. data/docs/FeatureFlagStatusAcrossEnvironments.md +17 -5
  75. data/docs/FeatureFlagStatuses.md +15 -4
  76. data/docs/FeatureFlags.md +17 -5
  77. data/docs/FeatureFlagsApi.md +414 -969
  78. data/docs/FeatureFlagsBetaApi.md +157 -0
  79. data/docs/FlagConfigApprovalRequestResponse.md +54 -0
  80. data/docs/FlagConfigApprovalRequestsResponse.md +20 -0
  81. data/docs/FlagCopyConfigEnvironment.md +20 -0
  82. data/docs/FlagCopyConfigPost.md +26 -0
  83. data/docs/FlagGlobalAttributesRep.md +58 -0
  84. data/docs/FlagListingRep.md +24 -0
  85. data/docs/FlagScheduledChangesInput.md +20 -0
  86. data/docs/FlagStatusRep.md +24 -0
  87. data/docs/FlagSummary.md +18 -0
  88. data/docs/HunkRep.md +26 -0
  89. data/docs/InlineObject.md +26 -0
  90. data/docs/InlineObject1.md +28 -0
  91. data/docs/InlineResponse200.md +20 -0
  92. data/docs/IntegrationMetadata.md +24 -0
  93. data/docs/IntegrationStatus.md +20 -0
  94. data/docs/IpList.md +20 -0
  95. data/docs/LastSeenMetadata.md +18 -0
  96. data/docs/Link.md +15 -4
  97. data/docs/Member.md +45 -14
  98. data/docs/MemberDataRep.md +26 -0
  99. data/docs/MemberPermissionGrantSummaryRep.md +22 -0
  100. data/docs/MemberSummaryRep.md +28 -0
  101. data/docs/MemberTeamSummaryRep.md +22 -0
  102. data/docs/Members.md +17 -5
  103. data/docs/MetricCollectionRep.md +20 -0
  104. data/docs/MetricListingRep.md +52 -0
  105. data/docs/MetricPost.md +40 -0
  106. data/docs/MetricRep.md +62 -0
  107. data/docs/MetricsApi.md +376 -0
  108. data/docs/Modification.md +18 -0
  109. data/docs/MultiEnvironmentDependentFlag.md +22 -0
  110. data/docs/MultiEnvironmentDependentFlags.md +22 -0
  111. data/docs/NewMemberForm.md +28 -0
  112. data/docs/OtherApi.md +282 -0
  113. data/docs/ParentResourceRep.md +22 -0
  114. data/docs/PatchOperation.md +17 -5
  115. data/docs/PatchSegmentInstruction.md +26 -0
  116. data/docs/PatchSegmentRequest.md +20 -0
  117. data/docs/PatchWithComment.md +20 -0
  118. data/docs/PostApprovalRequestApplyRequest.md +18 -0
  119. data/docs/PostApprovalRequestReviewRequest.md +20 -0
  120. data/docs/PostFlagScheduledChangesInput.md +22 -0
  121. data/docs/Prerequisite.md +15 -4
  122. data/docs/Project.md +27 -10
  123. data/docs/ProjectListingRep.md +30 -0
  124. data/docs/ProjectPost.md +28 -0
  125. data/docs/Projects.md +15 -4
  126. data/docs/ProjectsApi.md +196 -100
  127. data/docs/PubNubDetailRep.md +20 -0
  128. data/docs/ReferenceRep.md +22 -0
  129. data/docs/RelayAutoConfigCollectionRep.md +18 -0
  130. data/docs/RelayAutoConfigPost.md +20 -0
  131. data/docs/RelayAutoConfigRep.md +34 -0
  132. data/docs/RelayProxyConfigurationsApi.md +244 -129
  133. data/docs/RepositoryCollectionRep.md +20 -0
  134. data/docs/RepositoryPost.md +28 -0
  135. data/docs/RepositoryRep.md +38 -0
  136. data/docs/ResourceAccess.md +20 -0
  137. data/docs/ResourceIDResponse.md +26 -0
  138. data/docs/ReviewResponse.md +26 -0
  139. data/docs/Rollout.md +19 -4
  140. data/docs/Rule.md +23 -8
  141. data/docs/ScheduledChangesApi.md +404 -0
  142. data/docs/SdkListRep.md +20 -0
  143. data/docs/SdkVersionListRep.md +20 -0
  144. data/docs/SdkVersionRep.md +20 -0
  145. data/docs/SegmentBody.md +26 -0
  146. data/docs/SegmentMetadata.md +28 -0
  147. data/docs/SegmentUserList.md +20 -0
  148. data/docs/SegmentUserState.md +20 -0
  149. data/docs/SegmentsApi.md +695 -0
  150. data/docs/SeriesListRep.md +22 -0
  151. data/docs/SourceFlag.md +20 -0
  152. data/docs/Statement.md +21 -7
  153. data/docs/StatementPost.md +26 -0
  154. data/docs/StatementPostData.md +26 -0
  155. data/docs/StatementRep.md +26 -0
  156. data/docs/StatisticCollectionRep.md +20 -0
  157. data/docs/StatisticRep.md +30 -0
  158. data/docs/StatisticsRoot.md +20 -0
  159. data/docs/SubjectDataRep.md +22 -0
  160. data/docs/Target.md +15 -4
  161. data/docs/TargetResourceRep.md +22 -0
  162. data/docs/TitleRep.md +32 -0
  163. data/docs/Token.md +43 -17
  164. data/docs/TokenDataRep.md +26 -0
  165. data/docs/Tokens.md +15 -4
  166. data/docs/UrlPost.md +24 -0
  167. data/docs/User.md +25 -13
  168. data/docs/UserAttributeNamesRep.md +22 -0
  169. data/docs/UserFlagSetting.md +17 -5
  170. data/docs/UserFlagSettings.md +15 -4
  171. data/docs/UserRecord.md +21 -7
  172. data/docs/UserSegment.md +47 -14
  173. data/docs/UserSegmentRule.md +19 -5
  174. data/docs/UserSegments.md +15 -4
  175. data/docs/UserSettingsApi.md +217 -137
  176. data/docs/Users.md +17 -5
  177. data/docs/UsersApi.md +184 -115
  178. data/docs/UsersBetaApi.md +81 -0
  179. data/docs/ValuePut.md +20 -0
  180. data/docs/Variate.md +24 -0
  181. data/docs/Variation.md +19 -6
  182. data/docs/VariationOrRolloutRep.md +20 -0
  183. data/docs/VariationSummary.md +30 -0
  184. data/docs/VersionsRep.md +24 -0
  185. data/docs/Webhook.md +29 -10
  186. data/docs/WebhookPost.md +30 -0
  187. data/docs/Webhooks.md +15 -4
  188. data/docs/WebhooksApi.md +199 -103
  189. data/docs/WeightedVariation.md +17 -4
  190. data/git_push.sh +12 -10
  191. data/launchdarkly_api.gemspec +6 -14
  192. data/lib/launchdarkly_api/api/access_tokens_api.rb +190 -122
  193. data/lib/launchdarkly_api/api/account_members_api.rb +351 -0
  194. data/lib/launchdarkly_api/api/account_usage_beta_api.rb +598 -0
  195. data/lib/launchdarkly_api/api/approvals_api.rb +601 -0
  196. data/lib/launchdarkly_api/api/audit_log_api.rb +72 -51
  197. data/lib/launchdarkly_api/api/code_references_api.rb +898 -0
  198. data/lib/launchdarkly_api/api/custom_roles_api.rb +163 -106
  199. data/lib/launchdarkly_api/api/data_export_destinations_api.rb +202 -145
  200. data/lib/launchdarkly_api/api/environments_api.rb +197 -132
  201. data/lib/launchdarkly_api/api/experiments_beta_api.rb +188 -0
  202. data/lib/launchdarkly_api/api/feature_flags_api.rb +445 -1160
  203. data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -0
  204. data/lib/launchdarkly_api/api/metrics_api.rb +369 -0
  205. data/lib/launchdarkly_api/api/other_api.rb +248 -0
  206. data/lib/launchdarkly_api/api/projects_api.rb +147 -90
  207. data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +195 -127
  208. data/lib/launchdarkly_api/api/scheduled_changes_api.rb +435 -0
  209. data/lib/launchdarkly_api/api/segments_api.rb +719 -0
  210. data/lib/launchdarkly_api/api/user_settings_api.rb +237 -180
  211. data/lib/launchdarkly_api/api/users_api.rb +180 -138
  212. data/lib/launchdarkly_api/api/users_beta_api.rb +91 -0
  213. data/lib/launchdarkly_api/api/webhooks_api.rb +170 -113
  214. data/lib/launchdarkly_api/api_client.rb +87 -88
  215. data/lib/launchdarkly_api/api_error.rb +23 -4
  216. data/lib/launchdarkly_api/configuration.rb +83 -15
  217. data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +276 -0
  218. data/lib/launchdarkly_api/models/access_denied_rep.rb +237 -0
  219. data/lib/launchdarkly_api/models/access_rep.rb +225 -0
  220. data/lib/launchdarkly_api/models/access_token_post.rb +317 -0
  221. data/lib/launchdarkly_api/models/approval_settings.rb +331 -0
  222. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +420 -0
  223. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +241 -0
  224. data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +481 -0
  225. data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +256 -0
  226. data/lib/launchdarkly_api/models/big_segment_target.rb +254 -0
  227. data/lib/launchdarkly_api/models/branch_collection_rep.rb +241 -0
  228. data/lib/launchdarkly_api/models/branch_rep.rb +267 -0
  229. data/lib/launchdarkly_api/models/clause.rb +78 -24
  230. data/lib/launchdarkly_api/models/client_side_availability.rb +65 -33
  231. data/lib/launchdarkly_api/models/client_side_availability_post.rb +237 -0
  232. data/lib/launchdarkly_api/models/confidence_interval_rep.rb +227 -0
  233. data/lib/launchdarkly_api/models/conflict.rb +230 -0
  234. data/lib/launchdarkly_api/models/copied_from_env.rb +233 -0
  235. data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +281 -0
  236. data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +297 -0
  237. data/lib/launchdarkly_api/models/custom_property.rb +59 -23
  238. data/lib/launchdarkly_api/models/custom_role.rb +101 -34
  239. data/lib/launchdarkly_api/models/custom_role_post.rb +265 -0
  240. data/lib/launchdarkly_api/models/custom_role_post_data.rb +265 -0
  241. data/lib/launchdarkly_api/models/custom_roles.rb +58 -22
  242. data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +237 -0
  243. data/lib/launchdarkly_api/models/defaults.rb +56 -25
  244. data/lib/launchdarkly_api/models/dependent_flag.rb +262 -0
  245. data/lib/launchdarkly_api/models/dependent_flag_environment.rb +262 -0
  246. data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +255 -0
  247. data/lib/launchdarkly_api/models/destination.rb +88 -47
  248. data/lib/launchdarkly_api/models/destination_post.rb +281 -0
  249. data/lib/launchdarkly_api/models/destinations.rb +58 -22
  250. data/lib/launchdarkly_api/models/environment.rb +144 -73
  251. data/lib/launchdarkly_api/models/environment_post.rb +90 -56
  252. data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +237 -0
  253. data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +227 -0
  254. data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +238 -0
  255. data/lib/launchdarkly_api/models/experiment_info_rep.rb +239 -0
  256. data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +219 -0
  257. data/lib/launchdarkly_api/models/experiment_rep.rb +249 -0
  258. data/lib/launchdarkly_api/models/experiment_results_rep.rb +271 -0
  259. data/lib/launchdarkly_api/models/experiment_stats_rep.rb +245 -0
  260. data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +229 -0
  261. data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +281 -0
  262. data/lib/launchdarkly_api/models/experiment_totals_rep.rb +281 -0
  263. data/lib/launchdarkly_api/models/expiring_user_target_error.rb +237 -0
  264. data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +236 -0
  265. data/lib/launchdarkly_api/models/expiring_user_target_item.rb +300 -0
  266. data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +274 -0
  267. data/lib/launchdarkly_api/models/extinction.rb +274 -0
  268. data/lib/launchdarkly_api/models/extinction_collection_rep.rb +241 -0
  269. data/lib/launchdarkly_api/models/extinction_rep.rb +279 -0
  270. data/lib/launchdarkly_api/models/feature_flag.rb +276 -123
  271. data/lib/launchdarkly_api/models/feature_flag_body.rb +105 -55
  272. data/lib/launchdarkly_api/models/feature_flag_config.rb +184 -55
  273. data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +142 -38
  274. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +73 -32
  275. data/lib/launchdarkly_api/models/feature_flag_status.rb +70 -71
  276. data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +71 -33
  277. data/lib/launchdarkly_api/models/feature_flag_statuses.rb +64 -23
  278. data/lib/launchdarkly_api/models/feature_flags.rb +78 -32
  279. data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +448 -0
  280. data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +242 -0
  281. data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +232 -0
  282. data/lib/launchdarkly_api/models/flag_copy_config_post.rb +290 -0
  283. data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +514 -0
  284. data/lib/launchdarkly_api/models/flag_listing_rep.rb +257 -0
  285. data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +234 -0
  286. data/lib/launchdarkly_api/models/flag_status_rep.rb +256 -0
  287. data/lib/launchdarkly_api/models/flag_summary.rb +223 -0
  288. data/lib/launchdarkly_api/models/hunk_rep.rb +256 -0
  289. data/lib/launchdarkly_api/models/inline_object.rb +274 -0
  290. data/lib/launchdarkly_api/models/inline_object1.rb +276 -0
  291. data/lib/launchdarkly_api/models/inline_response200.rb +227 -0
  292. data/lib/launchdarkly_api/models/integration_metadata.rb +265 -0
  293. data/lib/launchdarkly_api/models/integration_status.rb +237 -0
  294. data/lib/launchdarkly_api/models/ip_list.rb +241 -0
  295. data/lib/launchdarkly_api/models/last_seen_metadata.rb +219 -0
  296. data/lib/launchdarkly_api/models/link.rb +54 -20
  297. data/lib/launchdarkly_api/models/member.rb +213 -67
  298. data/lib/launchdarkly_api/models/member_data_rep.rb +256 -0
  299. data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +253 -0
  300. data/lib/launchdarkly_api/models/member_summary_rep.rb +285 -0
  301. data/lib/launchdarkly_api/models/member_team_summary_rep.rb +253 -0
  302. data/lib/launchdarkly_api/models/members.rb +78 -32
  303. data/lib/launchdarkly_api/models/metric_collection_rep.rb +231 -0
  304. data/lib/launchdarkly_api/models/metric_listing_rep.rb +444 -0
  305. data/lib/launchdarkly_api/models/metric_post.rb +368 -0
  306. data/lib/launchdarkly_api/models/metric_rep.rb +493 -0
  307. data/lib/launchdarkly_api/models/modification.rb +218 -0
  308. data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +248 -0
  309. data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +255 -0
  310. data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
  311. data/lib/launchdarkly_api/models/parent_resource_rep.rb +239 -0
  312. data/lib/launchdarkly_api/models/patch_operation.rb +59 -26
  313. data/lib/launchdarkly_api/models/patch_segment_instruction.rb +273 -0
  314. data/lib/launchdarkly_api/models/patch_segment_request.rb +236 -0
  315. data/lib/launchdarkly_api/models/patch_with_comment.rb +234 -0
  316. data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +218 -0
  317. data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +227 -0
  318. data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +248 -0
  319. data/lib/launchdarkly_api/models/prerequisite.rb +64 -20
  320. data/lib/launchdarkly_api/models/project.rb +120 -50
  321. data/lib/launchdarkly_api/models/project_listing_rep.rb +306 -0
  322. data/lib/launchdarkly_api/models/project_post.rb +281 -0
  323. data/lib/launchdarkly_api/models/projects.rb +70 -22
  324. data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +227 -0
  325. data/lib/launchdarkly_api/models/reference_rep.rb +238 -0
  326. data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +225 -0
  327. data/lib/launchdarkly_api/models/relay_auto_config_post.rb +240 -0
  328. data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +327 -0
  329. data/lib/launchdarkly_api/models/repository_collection_rep.rb +241 -0
  330. data/lib/launchdarkly_api/models/repository_post.rb +304 -0
  331. data/lib/launchdarkly_api/models/repository_rep.rb +342 -0
  332. data/lib/launchdarkly_api/models/resource_access.rb +228 -0
  333. data/lib/launchdarkly_api/models/resource_id_response.rb +254 -0
  334. data/lib/launchdarkly_api/models/review_response.rb +302 -0
  335. data/lib/launchdarkly_api/models/rollout.rb +89 -32
  336. data/lib/launchdarkly_api/models/rule.rb +77 -33
  337. data/lib/launchdarkly_api/models/sdk_list_rep.rb +241 -0
  338. data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +241 -0
  339. data/lib/launchdarkly_api/models/sdk_version_rep.rb +237 -0
  340. data/lib/launchdarkly_api/models/segment_body.rb +270 -0
  341. data/lib/launchdarkly_api/models/segment_metadata.rb +263 -0
  342. data/lib/launchdarkly_api/models/segment_user_list.rb +231 -0
  343. data/lib/launchdarkly_api/models/segment_user_state.rb +227 -0
  344. data/lib/launchdarkly_api/models/series_list_rep.rb +257 -0
  345. data/lib/launchdarkly_api/models/source_flag.rb +233 -0
  346. data/lib/launchdarkly_api/models/statement.rb +66 -63
  347. data/lib/launchdarkly_api/models/statement_post.rb +271 -0
  348. data/lib/launchdarkly_api/models/statement_post_data.rb +271 -0
  349. data/lib/launchdarkly_api/models/statement_rep.rb +266 -0
  350. data/lib/launchdarkly_api/models/statistic_collection_rep.rb +241 -0
  351. data/lib/launchdarkly_api/models/statistic_rep.rb +309 -0
  352. data/lib/launchdarkly_api/models/statistics_root.rb +229 -0
  353. data/lib/launchdarkly_api/models/subject_data_rep.rb +238 -0
  354. data/lib/launchdarkly_api/models/target.rb +64 -20
  355. data/lib/launchdarkly_api/models/target_resource_rep.rb +240 -0
  356. data/lib/launchdarkly_api/models/title_rep.rb +281 -0
  357. data/lib/launchdarkly_api/models/token.rb +159 -93
  358. data/lib/launchdarkly_api/models/token_data_rep.rb +256 -0
  359. data/lib/launchdarkly_api/models/tokens.rb +68 -32
  360. data/lib/launchdarkly_api/models/url_post.rb +279 -0
  361. data/lib/launchdarkly_api/models/user.rb +97 -96
  362. data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +245 -0
  363. data/lib/launchdarkly_api/models/user_flag_setting.rb +68 -27
  364. data/lib/launchdarkly_api/models/user_flag_settings.rb +78 -32
  365. data/lib/launchdarkly_api/models/user_record.rb +69 -34
  366. data/lib/launchdarkly_api/models/user_segment.rb +186 -69
  367. data/lib/launchdarkly_api/models/user_segment_rule.rb +71 -23
  368. data/lib/launchdarkly_api/models/user_segments.rb +78 -32
  369. data/lib/launchdarkly_api/models/users.rb +72 -26
  370. data/lib/launchdarkly_api/models/value_put.rb +229 -0
  371. data/lib/launchdarkly_api/models/variate.rb +246 -0
  372. data/lib/launchdarkly_api/models/variation.rb +70 -38
  373. data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +227 -0
  374. data/lib/launchdarkly_api/models/variation_summary.rb +287 -0
  375. data/lib/launchdarkly_api/models/versions_rep.rb +262 -0
  376. data/lib/launchdarkly_api/models/webhook.rb +120 -55
  377. data/lib/launchdarkly_api/models/webhook_post.rb +297 -0
  378. data/lib/launchdarkly_api/models/webhooks.rb +68 -22
  379. data/lib/launchdarkly_api/models/weighted_variation.rb +77 -24
  380. data/lib/launchdarkly_api/version.rb +5 -5
  381. data/lib/launchdarkly_api.rb +134 -93
  382. data/spec/api/access_tokens_api_spec.rb +23 -17
  383. data/spec/api/account_members_api_spec.rb +99 -0
  384. data/spec/api/account_usage_beta_api_spec.rb +156 -0
  385. data/spec/api/approvals_api_spec.rb +141 -0
  386. data/spec/api/audit_log_api_spec.rb +19 -17
  387. data/spec/api/code_references_api_spec.rb +206 -0
  388. data/spec/api/custom_roles_api_spec.rb +23 -18
  389. data/spec/api/data_export_destinations_api_spec.rb +30 -25
  390. data/spec/api/environments_api_spec.rb +31 -26
  391. data/spec/api/experiments_beta_api_spec.rb +67 -0
  392. data/spec/api/feature_flags_api_spec.rb +70 -228
  393. data/spec/api/feature_flags_beta_api_spec.rb +62 -0
  394. data/spec/api/metrics_api_spec.rb +100 -0
  395. data/spec/api/other_api_spec.rb +79 -0
  396. data/spec/api/projects_api_spec.rb +22 -17
  397. data/spec/api/relay_proxy_configurations_api_spec.rb +37 -31
  398. data/spec/api/scheduled_changes_api_spec.rb +112 -0
  399. data/spec/api/segments_api_spec.rb +164 -0
  400. data/spec/api/user_settings_api_spec.rb +41 -36
  401. data/spec/api/users_api_spec.rb +33 -29
  402. data/spec/api/users_beta_api_spec.rb +48 -0
  403. data/spec/api/webhooks_api_spec.rb +27 -22
  404. data/spec/api_client_spec.rb +5 -22
  405. data/spec/configuration_spec.rb +7 -7
  406. data/spec/models/access_denied_reason_rep_spec.rb +64 -0
  407. data/spec/models/access_denied_rep_spec.rb +40 -0
  408. data/spec/models/access_rep_spec.rb +34 -0
  409. data/spec/models/access_token_post_spec.rb +74 -0
  410. data/spec/models/approval_settings_spec.rb +76 -0
  411. data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +40 -0
  412. data/spec/models/audit_log_entry_listing_rep_spec.rb +136 -0
  413. data/spec/models/audit_log_entry_rep_spec.rb +172 -0
  414. data/spec/models/authorized_app_data_rep_spec.rb +58 -0
  415. data/spec/models/big_segment_target_spec.rb +46 -0
  416. data/spec/models/branch_collection_rep_spec.rb +40 -0
  417. data/spec/models/branch_rep_spec.rb +64 -0
  418. data/spec/models/clause_spec.rb +8 -15
  419. data/spec/models/client_side_availability_post_spec.rb +40 -0
  420. data/spec/models/client_side_availability_spec.rb +10 -17
  421. data/spec/models/confidence_interval_rep_spec.rb +40 -0
  422. data/spec/models/conflict_spec.rb +40 -0
  423. data/spec/models/copied_from_env_spec.rb +40 -0
  424. data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +64 -0
  425. data/spec/models/create_flag_config_approval_request_request_spec.rb +70 -0
  426. data/spec/models/custom_property_spec.rb +8 -15
  427. data/spec/models/custom_role_post_data_spec.rb +52 -0
  428. data/spec/models/custom_role_post_spec.rb +52 -0
  429. data/spec/models/custom_role_spec.rb +14 -15
  430. data/spec/models/custom_roles_spec.rb +8 -15
  431. data/spec/models/default_client_side_availability_post_spec.rb +40 -0
  432. data/spec/models/defaults_spec.rb +8 -15
  433. data/spec/models/dependent_flag_environment_spec.rb +52 -0
  434. data/spec/models/dependent_flag_spec.rb +52 -0
  435. data/spec/models/dependent_flags_by_environment_spec.rb +46 -0
  436. data/spec/models/destination_post_spec.rb +56 -0
  437. data/spec/models/destination_spec.rb +19 -20
  438. data/spec/models/destinations_spec.rb +8 -15
  439. data/spec/models/environment_post_spec.rb +10 -17
  440. data/spec/models/environment_spec.rb +8 -27
  441. data/spec/models/experiment_allocation_rep_spec.rb +40 -0
  442. data/spec/models/experiment_enabled_period_rep_spec.rb +40 -0
  443. data/spec/models/experiment_environment_setting_rep_spec.rb +46 -0
  444. data/spec/models/experiment_info_rep_spec.rb +40 -0
  445. data/spec/models/experiment_metadata_rep_spec.rb +34 -0
  446. data/spec/models/experiment_rep_spec.rb +52 -0
  447. data/spec/models/experiment_results_rep_spec.rb +64 -0
  448. data/spec/models/experiment_stats_rep_spec.rb +52 -0
  449. data/spec/models/experiment_time_series_slice_spec.rb +40 -0
  450. data/spec/models/experiment_time_series_variation_slice_spec.rb +76 -0
  451. data/spec/models/experiment_totals_rep_spec.rb +76 -0
  452. data/spec/models/expiring_user_target_error_spec.rb +40 -0
  453. data/spec/models/expiring_user_target_get_response_spec.rb +40 -0
  454. data/spec/models/expiring_user_target_item_spec.rb +70 -0
  455. data/spec/models/expiring_user_target_patch_response_spec.rb +64 -0
  456. data/spec/models/extinction_collection_rep_spec.rb +40 -0
  457. data/spec/models/extinction_rep_spec.rb +58 -0
  458. data/spec/models/extinction_spec.rb +58 -0
  459. data/spec/models/feature_flag_body_spec.rb +24 -19
  460. data/spec/models/feature_flag_config_spec.rb +28 -17
  461. data/spec/models/feature_flag_scheduled_change_spec.rb +34 -17
  462. data/spec/models/feature_flag_scheduled_changes_spec.rb +10 -17
  463. data/spec/models/feature_flag_spec.rb +39 -30
  464. data/spec/models/feature_flag_status_across_environments_spec.rb +10 -17
  465. data/spec/models/feature_flag_status_spec.rb +8 -25
  466. data/spec/models/feature_flag_statuses_spec.rb +8 -15
  467. data/spec/models/feature_flags_spec.rb +10 -17
  468. data/spec/models/flag_config_approval_request_response_spec.rb +142 -0
  469. data/spec/models/flag_config_approval_requests_response_spec.rb +40 -0
  470. data/spec/models/flag_copy_config_environment_spec.rb +40 -0
  471. data/spec/models/flag_copy_config_post_spec.rb +66 -0
  472. data/spec/models/flag_global_attributes_rep_spec.rb +158 -0
  473. data/spec/models/flag_listing_rep_spec.rb +52 -0
  474. data/spec/models/flag_scheduled_changes_input_spec.rb +40 -0
  475. data/spec/models/flag_status_rep_spec.rb +52 -0
  476. data/spec/models/flag_summary_spec.rb +34 -0
  477. data/spec/models/hunk_rep_spec.rb +58 -0
  478. data/spec/models/inline_object1_spec.rb +64 -0
  479. data/spec/models/inline_object_spec.rb +58 -0
  480. data/spec/models/inline_response200_spec.rb +40 -0
  481. data/spec/models/integration_metadata_spec.rb +52 -0
  482. data/spec/models/integration_status_spec.rb +40 -0
  483. data/spec/models/ip_list_spec.rb +40 -0
  484. data/spec/models/last_seen_metadata_spec.rb +34 -0
  485. data/spec/models/link_spec.rb +8 -15
  486. data/spec/models/member_data_rep_spec.rb +58 -0
  487. data/spec/models/member_permission_grant_summary_rep_spec.rb +46 -0
  488. data/spec/models/member_spec.rb +44 -21
  489. data/spec/models/member_summary_rep_spec.rb +64 -0
  490. data/spec/models/member_team_summary_rep_spec.rb +46 -0
  491. data/spec/models/members_spec.rb +10 -17
  492. data/spec/models/metric_collection_rep_spec.rb +40 -0
  493. data/spec/models/metric_listing_rep_spec.rb +140 -0
  494. data/spec/models/metric_post_spec.rb +104 -0
  495. data/spec/models/metric_rep_spec.rb +170 -0
  496. data/spec/models/modification_spec.rb +34 -0
  497. data/spec/models/multi_environment_dependent_flag_spec.rb +46 -0
  498. data/spec/models/multi_environment_dependent_flags_spec.rb +46 -0
  499. data/spec/models/new_member_form_spec.rb +64 -0
  500. data/spec/models/parent_resource_rep_spec.rb +46 -0
  501. data/spec/models/patch_operation_spec.rb +8 -15
  502. data/spec/models/patch_segment_instruction_spec.rb +58 -0
  503. data/spec/models/patch_segment_request_spec.rb +40 -0
  504. data/spec/models/patch_with_comment_spec.rb +40 -0
  505. data/spec/models/post_approval_request_apply_request_spec.rb +34 -0
  506. data/spec/models/post_approval_request_review_request_spec.rb +40 -0
  507. data/spec/models/post_flag_scheduled_changes_input_spec.rb +46 -0
  508. data/spec/models/prerequisite_spec.rb +8 -15
  509. data/spec/models/project_listing_rep_spec.rb +70 -0
  510. data/spec/models/project_post_spec.rb +64 -0
  511. data/spec/models/project_spec.rb +12 -19
  512. data/spec/models/projects_spec.rb +8 -15
  513. data/spec/models/pub_nub_detail_rep_spec.rb +40 -0
  514. data/spec/models/reference_rep_spec.rb +46 -0
  515. data/spec/models/relay_auto_config_collection_rep_spec.rb +34 -0
  516. data/spec/models/relay_auto_config_post_spec.rb +40 -0
  517. data/spec/models/relay_auto_config_rep_spec.rb +82 -0
  518. data/spec/models/repository_collection_rep_spec.rb +40 -0
  519. data/spec/models/repository_post_spec.rb +68 -0
  520. data/spec/models/repository_rep_spec.rb +94 -0
  521. data/spec/models/resource_access_spec.rb +40 -0
  522. data/spec/models/resource_id_response_spec.rb +58 -0
  523. data/spec/models/review_response_spec.rb +62 -0
  524. data/spec/models/rollout_spec.rb +22 -17
  525. data/spec/models/rule_spec.rb +11 -18
  526. data/spec/models/sdk_list_rep_spec.rb +40 -0
  527. data/spec/models/sdk_version_list_rep_spec.rb +40 -0
  528. data/spec/models/sdk_version_rep_spec.rb +40 -0
  529. data/spec/models/segment_body_spec.rb +58 -0
  530. data/spec/models/segment_metadata_spec.rb +64 -0
  531. data/spec/models/segment_user_list_spec.rb +40 -0
  532. data/spec/models/segment_user_state_spec.rb +40 -0
  533. data/spec/models/series_list_rep_spec.rb +46 -0
  534. data/spec/models/source_flag_spec.rb +40 -0
  535. data/spec/models/statement_post_data_spec.rb +58 -0
  536. data/spec/models/statement_post_spec.rb +58 -0
  537. data/spec/models/statement_rep_spec.rb +58 -0
  538. data/spec/models/statement_spec.rb +8 -19
  539. data/spec/models/statistic_collection_rep_spec.rb +40 -0
  540. data/spec/models/statistic_rep_spec.rb +70 -0
  541. data/spec/models/statistics_root_spec.rb +40 -0
  542. data/spec/models/subject_data_rep_spec.rb +46 -0
  543. data/spec/models/target_resource_rep_spec.rb +46 -0
  544. data/spec/models/target_spec.rb +8 -15
  545. data/spec/models/title_rep_spec.rb +76 -0
  546. data/spec/models/token_data_rep_spec.rb +58 -0
  547. data/spec/models/token_spec.rb +27 -28
  548. data/spec/models/tokens_spec.rb +10 -17
  549. data/spec/models/url_post_spec.rb +56 -0
  550. data/spec/models/user_attribute_names_rep_spec.rb +46 -0
  551. data/spec/models/user_flag_setting_spec.rb +8 -15
  552. data/spec/models/user_flag_settings_spec.rb +10 -17
  553. data/spec/models/user_record_spec.rb +9 -16
  554. data/spec/models/user_segment_rule_spec.rb +14 -15
  555. data/spec/models/user_segment_spec.rb +52 -23
  556. data/spec/models/user_segments_spec.rb +10 -17
  557. data/spec/models/user_spec.rb +15 -46
  558. data/spec/models/users_spec.rb +8 -15
  559. data/spec/models/value_put_spec.rb +40 -0
  560. data/spec/models/variate_spec.rb +52 -0
  561. data/spec/models/variation_or_rollout_rep_spec.rb +40 -0
  562. data/spec/models/variation_spec.rb +10 -17
  563. data/spec/models/variation_summary_spec.rb +70 -0
  564. data/spec/models/versions_rep_spec.rb +52 -0
  565. data/spec/models/webhook_post_spec.rb +70 -0
  566. data/spec/models/webhook_spec.rb +18 -19
  567. data/spec/models/webhooks_spec.rb +8 -15
  568. data/spec/models/weighted_variation_spec.rb +14 -15
  569. data/spec/spec_helper.rb +4 -4
  570. metadata +831 -562
  571. data/docs/ApprovalRequest.md +0 -20
  572. data/docs/ApprovalRequestApplyConfigBody.md +0 -8
  573. data/docs/ApprovalRequestConfigBody.md +0 -13
  574. data/docs/ApprovalRequestReview.md +0 -11
  575. data/docs/ApprovalRequestReviewConfigBody.md +0 -9
  576. data/docs/ApprovalRequestReviewStatus.md +0 -7
  577. data/docs/ApprovalRequests.md +0 -9
  578. data/docs/AuditLogEntries.md +0 -9
  579. data/docs/AuditLogEntry.md +0 -19
  580. data/docs/AuditLogEntryTarget.md +0 -10
  581. data/docs/BigSegmentTargetChanges.md +0 -9
  582. data/docs/BigSegmentTargetsBody.md +0 -9
  583. data/docs/CopyActions.md +0 -7
  584. data/docs/CustomPropertyValues.md +0 -7
  585. data/docs/CustomRoleBody.md +0 -11
  586. data/docs/CustomerMetricsApi.md +0 -511
  587. data/docs/DestinationAmazonKinesis.md +0 -10
  588. data/docs/DestinationBody.md +0 -11
  589. data/docs/DestinationGooglePubSub.md +0 -9
  590. data/docs/DestinationMParticle.md +0 -11
  591. data/docs/DestinationSegment.md +0 -8
  592. data/docs/EnvironmentApprovalSettings.md +0 -12
  593. data/docs/EvaluationUsageError.md +0 -9
  594. data/docs/Events.md +0 -8
  595. data/docs/Fallthrough.md +0 -9
  596. data/docs/FeatureFlagCopyBody.md +0 -12
  597. data/docs/FeatureFlagCopyObject.md +0 -9
  598. data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
  599. data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
  600. data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
  601. data/docs/FeatureFlagStatusLinks.md +0 -9
  602. data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
  603. data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
  604. data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
  605. data/docs/FlagListItem.md +0 -11
  606. data/docs/HierarchicalLinks.md +0 -9
  607. data/docs/Id.md +0 -7
  608. data/docs/Integration.md +0 -9
  609. data/docs/IntegrationLinks.md +0 -8
  610. data/docs/IntegrationSubscription.md +0 -16
  611. data/docs/IntegrationSubscriptionStatus.md +0 -10
  612. data/docs/Integrations.md +0 -9
  613. data/docs/IntegrationsApi.md +0 -334
  614. data/docs/Links.md +0 -9
  615. data/docs/MAU.md +0 -10
  616. data/docs/MAUMetadata.md +0 -7
  617. data/docs/MAUbyCategory.md +0 -10
  618. data/docs/MemberLastSeenMetadata.md +0 -8
  619. data/docs/MembersBody.md +0 -13
  620. data/docs/PatchComment.md +0 -9
  621. data/docs/Policy.md +0 -12
  622. data/docs/ProjectBody.md +0 -13
  623. data/docs/RelayProxyConfig.md +0 -15
  624. data/docs/RelayProxyConfigBody.md +0 -9
  625. data/docs/RelayProxyConfigs.md +0 -8
  626. data/docs/Role.md +0 -7
  627. data/docs/RootApi.md +0 -56
  628. data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
  629. data/docs/SemanticPatchInstruction.md +0 -7
  630. data/docs/SemanticPatchInstructionInner.md +0 -8
  631. data/docs/SemanticPatchOperation.md +0 -9
  632. data/docs/Site.md +0 -9
  633. data/docs/Stream.md +0 -10
  634. data/docs/StreamBySDK.md +0 -10
  635. data/docs/StreamBySDKLinks.md +0 -9
  636. data/docs/StreamBySDKLinksMetadata.md +0 -10
  637. data/docs/StreamLinks.md +0 -10
  638. data/docs/StreamSDKVersion.md +0 -9
  639. data/docs/StreamSDKVersionData.md +0 -9
  640. data/docs/StreamUsageError.md +0 -9
  641. data/docs/StreamUsageLinks.md +0 -10
  642. data/docs/StreamUsageMetadata.md +0 -10
  643. data/docs/StreamUsageSeries.md +0 -9
  644. data/docs/Streams.md +0 -8
  645. data/docs/SubscriptionBody.md +0 -12
  646. data/docs/TeamMembersApi.md +0 -329
  647. data/docs/TokenBody.md +0 -13
  648. data/docs/Usage.md +0 -9
  649. data/docs/UsageError.md +0 -8
  650. data/docs/UsageLinks.md +0 -10
  651. data/docs/UserSegmentBody.md +0 -12
  652. data/docs/UserSegmentsApi.md +0 -488
  653. data/docs/UserSettingsBody.md +0 -8
  654. data/docs/UserTargetingExpirationForFlag.md +0 -14
  655. data/docs/UserTargetingExpirationForFlags.md +0 -9
  656. data/docs/UserTargetingExpirationForSegment.md +0 -14
  657. data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
  658. data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
  659. data/docs/WebhookBody.md +0 -14
  660. data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
  661. data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
  662. data/lib/launchdarkly_api/api/root_api.rb +0 -69
  663. data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
  664. data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
  665. data/lib/launchdarkly_api/models/approval_request.rb +0 -337
  666. data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
  667. data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
  668. data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
  669. data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
  670. data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
  671. data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
  672. data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
  673. data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
  674. data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
  675. data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
  676. data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
  677. data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
  678. data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
  679. data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
  680. data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
  681. data/lib/launchdarkly_api/models/destination_body.rb +0 -264
  682. data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
  683. data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
  684. data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
  685. data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -260
  686. data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
  687. data/lib/launchdarkly_api/models/events.rb +0 -184
  688. data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
  689. data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
  690. data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
  691. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
  692. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
  693. data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
  694. data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
  695. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
  696. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
  697. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
  698. data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
  699. data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
  700. data/lib/launchdarkly_api/models/id.rb +0 -176
  701. data/lib/launchdarkly_api/models/integration.rb +0 -195
  702. data/lib/launchdarkly_api/models/integration__links.rb +0 -184
  703. data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
  704. data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
  705. data/lib/launchdarkly_api/models/integrations.rb +0 -196
  706. data/lib/launchdarkly_api/models/links.rb +0 -193
  707. data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
  708. data/lib/launchdarkly_api/models/mau.rb +0 -206
  709. data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
  710. data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
  711. data/lib/launchdarkly_api/models/members_body.rb +0 -238
  712. data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
  713. data/lib/launchdarkly_api/models/policy.rb +0 -231
  714. data/lib/launchdarkly_api/models/project_body.rb +0 -243
  715. data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
  716. data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
  717. data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
  718. data/lib/launchdarkly_api/models/role.rb +0 -32
  719. data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
  720. data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
  721. data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
  722. data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
  723. data/lib/launchdarkly_api/models/site.rb +0 -193
  724. data/lib/launchdarkly_api/models/stream.rb +0 -206
  725. data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
  726. data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
  727. data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
  728. data/lib/launchdarkly_api/models/stream_links.rb +0 -205
  729. data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
  730. data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
  731. data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
  732. data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
  733. data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
  734. data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
  735. data/lib/launchdarkly_api/models/streams.rb +0 -184
  736. data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
  737. data/lib/launchdarkly_api/models/token_body.rb +0 -238
  738. data/lib/launchdarkly_api/models/usage.rb +0 -195
  739. data/lib/launchdarkly_api/models/usage_error.rb +0 -184
  740. data/lib/launchdarkly_api/models/usage_links.rb +0 -205
  741. data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
  742. data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
  743. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
  744. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
  745. data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
  746. data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
  747. data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
  748. data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
  749. data/openapi.yml +0 -4719
  750. data/spec/api/customer_metrics_api_spec.rb +0 -141
  751. data/spec/api/integrations_api_spec.rb +0 -105
  752. data/spec/api/root_api_spec.rb +0 -45
  753. data/spec/api/team_members_api_spec.rb +0 -104
  754. data/spec/api/user_segments_api_spec.rb +0 -142
  755. data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
  756. data/spec/models/approval_request_config_body_spec.rb +0 -71
  757. data/spec/models/approval_request_review_config_body_spec.rb +0 -51
  758. data/spec/models/approval_request_review_spec.rb +0 -59
  759. data/spec/models/approval_request_review_status_spec.rb +0 -35
  760. data/spec/models/approval_request_spec.rb +0 -117
  761. data/spec/models/approval_requests_spec.rb +0 -47
  762. data/spec/models/audit_log_entries_spec.rb +0 -47
  763. data/spec/models/audit_log_entry_spec.rb +0 -107
  764. data/spec/models/audit_log_entry_target_spec.rb +0 -53
  765. data/spec/models/big_segment_target_changes_spec.rb +0 -47
  766. data/spec/models/big_segment_targets_body_spec.rb +0 -47
  767. data/spec/models/copy_actions_spec.rb +0 -35
  768. data/spec/models/custom_property_values_spec.rb +0 -35
  769. data/spec/models/custom_role_body_spec.rb +0 -59
  770. data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
  771. data/spec/models/destination_body_spec.rb +0 -63
  772. data/spec/models/destination_google_pub_sub_spec.rb +0 -47
  773. data/spec/models/destination_m_particle_spec.rb +0 -59
  774. data/spec/models/destination_segment_spec.rb +0 -41
  775. data/spec/models/environment_approval_settings_spec.rb +0 -69
  776. data/spec/models/evaluation_usage_error_spec.rb +0 -47
  777. data/spec/models/events_spec.rb +0 -41
  778. data/spec/models/fallthrough_spec.rb +0 -47
  779. data/spec/models/feature_flag_copy_body_spec.rb +0 -65
  780. data/spec/models/feature_flag_copy_object_spec.rb +0 -47
  781. data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
  782. data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
  783. data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
  784. data/spec/models/feature_flag_status_links_spec.rb +0 -47
  785. data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
  786. data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
  787. data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
  788. data/spec/models/flag_list_item_spec.rb +0 -59
  789. data/spec/models/hierarchical_links_spec.rb +0 -47
  790. data/spec/models/id_spec.rb +0 -35
  791. data/spec/models/integration__links_spec.rb +0 -41
  792. data/spec/models/integration_spec.rb +0 -47
  793. data/spec/models/integration_subscription__status_spec.rb +0 -53
  794. data/spec/models/integration_subscription_spec.rb +0 -89
  795. data/spec/models/integrations_spec.rb +0 -47
  796. data/spec/models/links_spec.rb +0 -47
  797. data/spec/models/ma_uby_category_spec.rb +0 -53
  798. data/spec/models/mau_metadata_spec.rb +0 -35
  799. data/spec/models/mau_spec.rb +0 -53
  800. data/spec/models/member__last_seen_metadata_spec.rb +0 -41
  801. data/spec/models/members_body_spec.rb +0 -71
  802. data/spec/models/patch_comment_spec.rb +0 -47
  803. data/spec/models/policy_spec.rb +0 -65
  804. data/spec/models/project_body_spec.rb +0 -71
  805. data/spec/models/relay_proxy_config_body_spec.rb +0 -47
  806. data/spec/models/relay_proxy_config_spec.rb +0 -83
  807. data/spec/models/relay_proxy_configs_spec.rb +0 -41
  808. data/spec/models/role_spec.rb +0 -35
  809. data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +0 -47
  810. data/spec/models/semantic_patch_instruction_inner_spec.rb +0 -41
  811. data/spec/models/semantic_patch_instruction_spec.rb +0 -35
  812. data/spec/models/semantic_patch_operation_spec.rb +0 -47
  813. data/spec/models/site_spec.rb +0 -47
  814. data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
  815. data/spec/models/stream_by_sdk_links_spec.rb +0 -47
  816. data/spec/models/stream_by_sdk_spec.rb +0 -53
  817. data/spec/models/stream_links_spec.rb +0 -53
  818. data/spec/models/stream_sdk_version_data_spec.rb +0 -47
  819. data/spec/models/stream_sdk_version_spec.rb +0 -47
  820. data/spec/models/stream_spec.rb +0 -53
  821. data/spec/models/stream_usage_error_spec.rb +0 -47
  822. data/spec/models/stream_usage_links_spec.rb +0 -53
  823. data/spec/models/stream_usage_metadata_spec.rb +0 -53
  824. data/spec/models/stream_usage_series_spec.rb +0 -47
  825. data/spec/models/streams_spec.rb +0 -41
  826. data/spec/models/subscription_body_spec.rb +0 -65
  827. data/spec/models/token_body_spec.rb +0 -71
  828. data/spec/models/usage_error_spec.rb +0 -41
  829. data/spec/models/usage_links_spec.rb +0 -53
  830. data/spec/models/usage_spec.rb +0 -47
  831. data/spec/models/user_segment_body_spec.rb +0 -65
  832. data/spec/models/user_settings_body_spec.rb +0 -41
  833. data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
  834. data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
  835. data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
  836. data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
  837. data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
  838. data/spec/models/webhook_body_spec.rb +0 -77
@@ -1,16 +1,16 @@
1
1
  =begin
2
2
  #LaunchDarkly REST API
3
3
 
4
- #Build custom integrations with the LaunchDarkly REST API
4
+ ## 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/patchExpiringUserTargetsOnSegment) # 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.0.3
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
- require 'uri'
13
+ require 'cgi'
14
14
 
15
15
  module LaunchDarklyApi
16
16
  class CustomRolesApi
@@ -19,110 +19,132 @@ module LaunchDarklyApi
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete a custom role by key.
23
- # @param custom_role_key The custom role key.
22
+ # Delete custom role
23
+ # Delete a custom role by key
24
+ # @param key [String] The key of the custom role to delete
24
25
  # @param [Hash] opts the optional parameters
25
26
  # @return [nil]
26
- def delete_custom_role(custom_role_key, opts = {})
27
- delete_custom_role_with_http_info(custom_role_key, opts)
27
+ def delete_custom_role(key, opts = {})
28
+ delete_custom_role_with_http_info(key, opts)
28
29
  nil
29
30
  end
30
31
 
31
- # Delete a custom role by key.
32
- # @param custom_role_key The custom role key.
32
+ # Delete custom role
33
+ # Delete a custom role by key
34
+ # @param key [String] The key of the custom role to delete
33
35
  # @param [Hash] opts the optional parameters
34
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
35
- def delete_custom_role_with_http_info(custom_role_key, opts = {})
36
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
+ def delete_custom_role_with_http_info(key, opts = {})
36
38
  if @api_client.config.debugging
37
39
  @api_client.config.logger.debug 'Calling API: CustomRolesApi.delete_custom_role ...'
38
40
  end
39
- # verify the required parameter 'custom_role_key' is set
40
- if @api_client.config.client_side_validation && custom_role_key.nil?
41
- fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.delete_custom_role"
41
+ # verify the required parameter 'key' is set
42
+ if @api_client.config.client_side_validation && key.nil?
43
+ fail ArgumentError, "Missing the required parameter 'key' when calling CustomRolesApi.delete_custom_role"
42
44
  end
43
45
  # resource path
44
- local_var_path = '/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', custom_role_key.to_s)
46
+ local_var_path = '/api/v2/roles/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
45
47
 
46
48
  # query parameters
47
- query_params = {}
49
+ query_params = opts[:query_params] || {}
48
50
 
49
51
  # header parameters
50
- header_params = {}
51
- # HTTP header 'Accept' (if needed)
52
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
- # HTTP header 'Content-Type'
54
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
52
+ header_params = opts[:header_params] || {}
55
53
 
56
54
  # form parameters
57
- form_params = {}
55
+ form_params = opts[:form_params] || {}
58
56
 
59
57
  # http body (model)
60
- post_body = nil
61
- auth_names = ['Token']
62
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
58
+ post_body = opts[:debug_body]
59
+
60
+ # return_type
61
+ return_type = opts[:debug_return_type]
62
+
63
+ # auth_names
64
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
65
+
66
+ new_options = opts.merge(
67
+ :operation => :"CustomRolesApi.delete_custom_role",
63
68
  :header_params => header_params,
64
69
  :query_params => query_params,
65
70
  :form_params => form_params,
66
71
  :body => post_body,
67
- :auth_names => auth_names)
72
+ :auth_names => auth_names,
73
+ :return_type => return_type
74
+ )
75
+
76
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
68
77
  if @api_client.config.debugging
69
78
  @api_client.config.logger.debug "API called: CustomRolesApi#delete_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
70
79
  end
71
80
  return data, status_code, headers
72
81
  end
73
- # Get one custom role by key.
74
- # @param custom_role_key The custom role key.
82
+
83
+ # Get custom role
84
+ # Get a single custom role by key or ID
85
+ # @param key [String] The custom role&#39;s key or ID
75
86
  # @param [Hash] opts the optional parameters
76
- # @return [CustomRole]
77
- def get_custom_role(custom_role_key, opts = {})
78
- data, _status_code, _headers = get_custom_role_with_http_info(custom_role_key, opts)
87
+ # @return [CustomRolePost]
88
+ def get_custom_role(key, opts = {})
89
+ data, _status_code, _headers = get_custom_role_with_http_info(key, opts)
79
90
  data
80
91
  end
81
92
 
82
- # Get one custom role by key.
83
- # @param custom_role_key The custom role key.
93
+ # Get custom role
94
+ # Get a single custom role by key or ID
95
+ # @param key [String] The custom role&#39;s key or ID
84
96
  # @param [Hash] opts the optional parameters
85
- # @return [Array<(CustomRole, Fixnum, Hash)>] CustomRole data, response status code and response headers
86
- def get_custom_role_with_http_info(custom_role_key, opts = {})
97
+ # @return [Array<(CustomRolePost, Integer, Hash)>] CustomRolePost data, response status code and response headers
98
+ def get_custom_role_with_http_info(key, opts = {})
87
99
  if @api_client.config.debugging
88
100
  @api_client.config.logger.debug 'Calling API: CustomRolesApi.get_custom_role ...'
89
101
  end
90
- # verify the required parameter 'custom_role_key' is set
91
- if @api_client.config.client_side_validation && custom_role_key.nil?
92
- fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.get_custom_role"
102
+ # verify the required parameter 'key' is set
103
+ if @api_client.config.client_side_validation && key.nil?
104
+ fail ArgumentError, "Missing the required parameter 'key' when calling CustomRolesApi.get_custom_role"
93
105
  end
94
106
  # resource path
95
- local_var_path = '/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', custom_role_key.to_s)
107
+ local_var_path = '/api/v2/roles/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
96
108
 
97
109
  # query parameters
98
- query_params = {}
110
+ query_params = opts[:query_params] || {}
99
111
 
100
112
  # header parameters
101
- header_params = {}
113
+ header_params = opts[:header_params] || {}
102
114
  # HTTP header 'Accept' (if needed)
103
115
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
104
- # HTTP header 'Content-Type'
105
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
106
116
 
107
117
  # form parameters
108
- form_params = {}
118
+ form_params = opts[:form_params] || {}
109
119
 
110
120
  # http body (model)
111
- post_body = nil
112
- auth_names = ['Token']
113
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
121
+ post_body = opts[:debug_body]
122
+
123
+ # return_type
124
+ return_type = opts[:debug_return_type] || 'CustomRolePost'
125
+
126
+ # auth_names
127
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
128
+
129
+ new_options = opts.merge(
130
+ :operation => :"CustomRolesApi.get_custom_role",
114
131
  :header_params => header_params,
115
132
  :query_params => query_params,
116
133
  :form_params => form_params,
117
134
  :body => post_body,
118
135
  :auth_names => auth_names,
119
- :return_type => 'CustomRole')
136
+ :return_type => return_type
137
+ )
138
+
139
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
120
140
  if @api_client.config.debugging
121
141
  @api_client.config.logger.debug "API called: CustomRolesApi#get_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
122
142
  end
123
143
  return data, status_code, headers
124
144
  end
125
- # Return a complete list of custom roles.
145
+
146
+ # List custom roles
147
+ # Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it's possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you're interested in learning more about our enterprise plans, contact sales@launchdarkly.com.
126
148
  # @param [Hash] opts the optional parameters
127
149
  # @return [CustomRoles]
128
150
  def get_custom_roles(opts = {})
@@ -130,149 +152,184 @@ module LaunchDarklyApi
130
152
  data
131
153
  end
132
154
 
133
- # Return a complete list of custom roles.
155
+ # List custom roles
156
+ # Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it&#39;s possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you&#39;re interested in learning more about our enterprise plans, contact sales@launchdarkly.com.
134
157
  # @param [Hash] opts the optional parameters
135
- # @return [Array<(CustomRoles, Fixnum, Hash)>] CustomRoles data, response status code and response headers
158
+ # @return [Array<(CustomRoles, Integer, Hash)>] CustomRoles data, response status code and response headers
136
159
  def get_custom_roles_with_http_info(opts = {})
137
160
  if @api_client.config.debugging
138
161
  @api_client.config.logger.debug 'Calling API: CustomRolesApi.get_custom_roles ...'
139
162
  end
140
163
  # resource path
141
- local_var_path = '/roles'
164
+ local_var_path = '/api/v2/roles'
142
165
 
143
166
  # query parameters
144
- query_params = {}
167
+ query_params = opts[:query_params] || {}
145
168
 
146
169
  # header parameters
147
- header_params = {}
170
+ header_params = opts[:header_params] || {}
148
171
  # HTTP header 'Accept' (if needed)
149
172
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
150
- # HTTP header 'Content-Type'
151
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
152
173
 
153
174
  # form parameters
154
- form_params = {}
175
+ form_params = opts[:form_params] || {}
155
176
 
156
177
  # http body (model)
157
- post_body = nil
158
- auth_names = ['Token']
159
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
178
+ post_body = opts[:debug_body]
179
+
180
+ # return_type
181
+ return_type = opts[:debug_return_type] || 'CustomRoles'
182
+
183
+ # auth_names
184
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
185
+
186
+ new_options = opts.merge(
187
+ :operation => :"CustomRolesApi.get_custom_roles",
160
188
  :header_params => header_params,
161
189
  :query_params => query_params,
162
190
  :form_params => form_params,
163
191
  :body => post_body,
164
192
  :auth_names => auth_names,
165
- :return_type => 'CustomRoles')
193
+ :return_type => return_type
194
+ )
195
+
196
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
166
197
  if @api_client.config.debugging
167
198
  @api_client.config.logger.debug "API called: CustomRolesApi#get_custom_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
168
199
  end
169
200
  return data, status_code, headers
170
201
  end
171
- # Modify a custom role by key.
172
- # @param custom_role_key The custom role key.
173
- # @param patch_delta Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39;
202
+
203
+ # Update custom role
204
+ # Update a single custom role. The request must be a valid JSON Patch document describing the changes to be made to the custom role.
205
+ # @param key [String] The key of the custom role to update
206
+ # @param patch_with_comment [PatchWithComment]
174
207
  # @param [Hash] opts the optional parameters
175
208
  # @return [CustomRole]
176
- def patch_custom_role(custom_role_key, patch_delta, opts = {})
177
- data, _status_code, _headers = patch_custom_role_with_http_info(custom_role_key, patch_delta, opts)
209
+ def patch_custom_role(key, patch_with_comment, opts = {})
210
+ data, _status_code, _headers = patch_custom_role_with_http_info(key, patch_with_comment, opts)
178
211
  data
179
212
  end
180
213
 
181
- # Modify a custom role by key.
182
- # @param custom_role_key The custom role key.
183
- # @param patch_delta Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39;
214
+ # Update custom role
215
+ # Update a single custom role. The request must be a valid JSON Patch document describing the changes to be made to the custom role.
216
+ # @param key [String] The key of the custom role to update
217
+ # @param patch_with_comment [PatchWithComment]
184
218
  # @param [Hash] opts the optional parameters
185
- # @return [Array<(CustomRole, Fixnum, Hash)>] CustomRole data, response status code and response headers
186
- def patch_custom_role_with_http_info(custom_role_key, patch_delta, opts = {})
219
+ # @return [Array<(CustomRole, Integer, Hash)>] CustomRole data, response status code and response headers
220
+ def patch_custom_role_with_http_info(key, patch_with_comment, opts = {})
187
221
  if @api_client.config.debugging
188
222
  @api_client.config.logger.debug 'Calling API: CustomRolesApi.patch_custom_role ...'
189
223
  end
190
- # verify the required parameter 'custom_role_key' is set
191
- if @api_client.config.client_side_validation && custom_role_key.nil?
192
- fail ArgumentError, "Missing the required parameter 'custom_role_key' when calling CustomRolesApi.patch_custom_role"
224
+ # verify the required parameter 'key' is set
225
+ if @api_client.config.client_side_validation && key.nil?
226
+ fail ArgumentError, "Missing the required parameter 'key' when calling CustomRolesApi.patch_custom_role"
193
227
  end
194
- # verify the required parameter 'patch_delta' is set
195
- if @api_client.config.client_side_validation && patch_delta.nil?
196
- fail ArgumentError, "Missing the required parameter 'patch_delta' when calling CustomRolesApi.patch_custom_role"
228
+ # verify the required parameter 'patch_with_comment' is set
229
+ if @api_client.config.client_side_validation && patch_with_comment.nil?
230
+ fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling CustomRolesApi.patch_custom_role"
197
231
  end
198
232
  # resource path
199
- local_var_path = '/roles/{customRoleKey}'.sub('{' + 'customRoleKey' + '}', custom_role_key.to_s)
233
+ local_var_path = '/api/v2/roles/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
200
234
 
201
235
  # query parameters
202
- query_params = {}
236
+ query_params = opts[:query_params] || {}
203
237
 
204
238
  # header parameters
205
- header_params = {}
239
+ header_params = opts[:header_params] || {}
206
240
  # HTTP header 'Accept' (if needed)
207
241
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
208
242
  # HTTP header 'Content-Type'
209
243
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
210
244
 
211
245
  # form parameters
212
- form_params = {}
246
+ form_params = opts[:form_params] || {}
213
247
 
214
248
  # http body (model)
215
- post_body = @api_client.object_to_http_body(patch_delta)
216
- auth_names = ['Token']
217
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
249
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_with_comment)
250
+
251
+ # return_type
252
+ return_type = opts[:debug_return_type] || 'CustomRole'
253
+
254
+ # auth_names
255
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
256
+
257
+ new_options = opts.merge(
258
+ :operation => :"CustomRolesApi.patch_custom_role",
218
259
  :header_params => header_params,
219
260
  :query_params => query_params,
220
261
  :form_params => form_params,
221
262
  :body => post_body,
222
263
  :auth_names => auth_names,
223
- :return_type => 'CustomRole')
264
+ :return_type => return_type
265
+ )
266
+
267
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
224
268
  if @api_client.config.debugging
225
269
  @api_client.config.logger.debug "API called: CustomRolesApi#patch_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
226
270
  end
227
271
  return data, status_code, headers
228
272
  end
229
- # Create a new custom role.
230
- # @param custom_role_body New role or roles to create.
273
+
274
+ # Create custom role
275
+ # Create a new custom role
276
+ # @param statement_post [Array<StatementPost>]
231
277
  # @param [Hash] opts the optional parameters
232
278
  # @return [CustomRole]
233
- def post_custom_role(custom_role_body, opts = {})
234
- data, _status_code, _headers = post_custom_role_with_http_info(custom_role_body, opts)
279
+ def post_custom_role(statement_post, opts = {})
280
+ data, _status_code, _headers = post_custom_role_with_http_info(statement_post, opts)
235
281
  data
236
282
  end
237
283
 
238
- # Create a new custom role.
239
- # @param custom_role_body New role or roles to create.
284
+ # Create custom role
285
+ # Create a new custom role
286
+ # @param statement_post [Array<StatementPost>]
240
287
  # @param [Hash] opts the optional parameters
241
- # @return [Array<(CustomRole, Fixnum, Hash)>] CustomRole data, response status code and response headers
242
- def post_custom_role_with_http_info(custom_role_body, opts = {})
288
+ # @return [Array<(CustomRole, Integer, Hash)>] CustomRole data, response status code and response headers
289
+ def post_custom_role_with_http_info(statement_post, opts = {})
243
290
  if @api_client.config.debugging
244
291
  @api_client.config.logger.debug 'Calling API: CustomRolesApi.post_custom_role ...'
245
292
  end
246
- # verify the required parameter 'custom_role_body' is set
247
- if @api_client.config.client_side_validation && custom_role_body.nil?
248
- fail ArgumentError, "Missing the required parameter 'custom_role_body' when calling CustomRolesApi.post_custom_role"
293
+ # verify the required parameter 'statement_post' is set
294
+ if @api_client.config.client_side_validation && statement_post.nil?
295
+ fail ArgumentError, "Missing the required parameter 'statement_post' when calling CustomRolesApi.post_custom_role"
249
296
  end
250
297
  # resource path
251
- local_var_path = '/roles'
298
+ local_var_path = '/api/v2/roles'
252
299
 
253
300
  # query parameters
254
- query_params = {}
301
+ query_params = opts[:query_params] || {}
255
302
 
256
303
  # header parameters
257
- header_params = {}
304
+ header_params = opts[:header_params] || {}
258
305
  # HTTP header 'Accept' (if needed)
259
306
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
260
307
  # HTTP header 'Content-Type'
261
308
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
262
309
 
263
310
  # form parameters
264
- form_params = {}
311
+ form_params = opts[:form_params] || {}
265
312
 
266
313
  # http body (model)
267
- post_body = @api_client.object_to_http_body(custom_role_body)
268
- auth_names = ['Token']
269
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
314
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(statement_post)
315
+
316
+ # return_type
317
+ return_type = opts[:debug_return_type] || 'CustomRole'
318
+
319
+ # auth_names
320
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
321
+
322
+ new_options = opts.merge(
323
+ :operation => :"CustomRolesApi.post_custom_role",
270
324
  :header_params => header_params,
271
325
  :query_params => query_params,
272
326
  :form_params => form_params,
273
327
  :body => post_body,
274
328
  :auth_names => auth_names,
275
- :return_type => 'CustomRole')
329
+ :return_type => return_type
330
+ )
331
+
332
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
276
333
  if @api_client.config.debugging
277
334
  @api_client.config.logger.debug "API called: CustomRolesApi#post_custom_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
278
335
  end
@@ -1,16 +1,16 @@
1
1
  =begin
2
2
  #LaunchDarkly REST API
3
3
 
4
- #Build custom integrations with the LaunchDarkly REST API
4
+ ## 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/patchExpiringUserTargetsOnSegment) # 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.0.3
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
- require 'uri'
13
+ require 'cgi'
14
14
 
15
15
  module LaunchDarklyApi
16
16
  class DataExportDestinationsApi
@@ -19,134 +19,156 @@ module LaunchDarklyApi
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Get a single data export destination by ID
23
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
24
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
25
- # @param destination_id The data export destination ID.
22
+ # Delete Data Export destination
23
+ # Delete Data Export destination by ID
24
+ # @param proj_key [String] The project key
25
+ # @param env_key [String] The environment key
26
+ # @param id [String] The Data Export destination ID
26
27
  # @param [Hash] opts the optional parameters
27
28
  # @return [nil]
28
- def delete_destination(project_key, environment_key, destination_id, opts = {})
29
- delete_destination_with_http_info(project_key, environment_key, destination_id, opts)
29
+ def delete_destination(proj_key, env_key, id, opts = {})
30
+ delete_destination_with_http_info(proj_key, env_key, id, opts)
30
31
  nil
31
32
  end
32
33
 
33
- # Get a single data export destination by ID
34
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
35
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
36
- # @param destination_id The data export destination ID.
34
+ # Delete Data Export destination
35
+ # Delete Data Export destination by ID
36
+ # @param proj_key [String] The project key
37
+ # @param env_key [String] The environment key
38
+ # @param id [String] The Data Export destination ID
37
39
  # @param [Hash] opts the optional parameters
38
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
39
- def delete_destination_with_http_info(project_key, environment_key, destination_id, opts = {})
40
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
41
+ def delete_destination_with_http_info(proj_key, env_key, id, opts = {})
40
42
  if @api_client.config.debugging
41
43
  @api_client.config.logger.debug 'Calling API: DataExportDestinationsApi.delete_destination ...'
42
44
  end
43
- # verify the required parameter 'project_key' is set
44
- if @api_client.config.client_side_validation && project_key.nil?
45
- fail ArgumentError, "Missing the required parameter 'project_key' when calling DataExportDestinationsApi.delete_destination"
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 DataExportDestinationsApi.delete_destination"
46
48
  end
47
- # verify the required parameter 'environment_key' is set
48
- if @api_client.config.client_side_validation && environment_key.nil?
49
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling DataExportDestinationsApi.delete_destination"
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 DataExportDestinationsApi.delete_destination"
50
52
  end
51
- # verify the required parameter 'destination_id' is set
52
- if @api_client.config.client_side_validation && destination_id.nil?
53
- fail ArgumentError, "Missing the required parameter 'destination_id' when calling DataExportDestinationsApi.delete_destination"
53
+ # verify the required parameter 'id' is set
54
+ if @api_client.config.client_side_validation && id.nil?
55
+ fail ArgumentError, "Missing the required parameter 'id' when calling DataExportDestinationsApi.delete_destination"
54
56
  end
55
57
  # resource path
56
- local_var_path = '/destinations/{projectKey}/{environmentKey}/{destinationId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'destinationId' + '}', destination_id.to_s)
58
+ local_var_path = '/api/v2/destinations/{projKey}/{envKey}/{id}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
57
59
 
58
60
  # query parameters
59
- query_params = {}
61
+ query_params = opts[:query_params] || {}
60
62
 
61
63
  # header parameters
62
- header_params = {}
63
- # HTTP header 'Accept' (if needed)
64
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
- # HTTP header 'Content-Type'
66
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
64
+ header_params = opts[:header_params] || {}
67
65
 
68
66
  # form parameters
69
- form_params = {}
67
+ form_params = opts[:form_params] || {}
70
68
 
71
69
  # http body (model)
72
- post_body = nil
73
- auth_names = ['Token']
74
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
70
+ post_body = opts[:debug_body]
71
+
72
+ # return_type
73
+ return_type = opts[:debug_return_type]
74
+
75
+ # auth_names
76
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
77
+
78
+ new_options = opts.merge(
79
+ :operation => :"DataExportDestinationsApi.delete_destination",
75
80
  :header_params => header_params,
76
81
  :query_params => query_params,
77
82
  :form_params => form_params,
78
83
  :body => post_body,
79
- :auth_names => auth_names)
84
+ :auth_names => auth_names,
85
+ :return_type => return_type
86
+ )
87
+
88
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
80
89
  if @api_client.config.debugging
81
90
  @api_client.config.logger.debug "API called: DataExportDestinationsApi#delete_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
91
  end
83
92
  return data, status_code, headers
84
93
  end
85
- # Get a single data export destination by ID
86
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
87
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
88
- # @param destination_id The data export destination ID.
94
+
95
+ # Get destination
96
+ # Get a single Data Export destination by ID
97
+ # @param proj_key [String] The project key
98
+ # @param env_key [String] The environment key
99
+ # @param id [String] The Data Export destination ID
89
100
  # @param [Hash] opts the optional parameters
90
101
  # @return [Destination]
91
- def get_destination(project_key, environment_key, destination_id, opts = {})
92
- data, _status_code, _headers = get_destination_with_http_info(project_key, environment_key, destination_id, opts)
102
+ def get_destination(proj_key, env_key, id, opts = {})
103
+ data, _status_code, _headers = get_destination_with_http_info(proj_key, env_key, id, opts)
93
104
  data
94
105
  end
95
106
 
96
- # Get a single data export destination by ID
97
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
98
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
99
- # @param destination_id The data export destination ID.
107
+ # Get destination
108
+ # Get a single Data Export destination by ID
109
+ # @param proj_key [String] The project key
110
+ # @param env_key [String] The environment key
111
+ # @param id [String] The Data Export destination ID
100
112
  # @param [Hash] opts the optional parameters
101
- # @return [Array<(Destination, Fixnum, Hash)>] Destination data, response status code and response headers
102
- def get_destination_with_http_info(project_key, environment_key, destination_id, opts = {})
113
+ # @return [Array<(Destination, Integer, Hash)>] Destination data, response status code and response headers
114
+ def get_destination_with_http_info(proj_key, env_key, id, opts = {})
103
115
  if @api_client.config.debugging
104
116
  @api_client.config.logger.debug 'Calling API: DataExportDestinationsApi.get_destination ...'
105
117
  end
106
- # verify the required parameter 'project_key' is set
107
- if @api_client.config.client_side_validation && project_key.nil?
108
- fail ArgumentError, "Missing the required parameter 'project_key' when calling DataExportDestinationsApi.get_destination"
118
+ # verify the required parameter 'proj_key' is set
119
+ if @api_client.config.client_side_validation && proj_key.nil?
120
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling DataExportDestinationsApi.get_destination"
109
121
  end
110
- # verify the required parameter 'environment_key' is set
111
- if @api_client.config.client_side_validation && environment_key.nil?
112
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling DataExportDestinationsApi.get_destination"
122
+ # verify the required parameter 'env_key' is set
123
+ if @api_client.config.client_side_validation && env_key.nil?
124
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling DataExportDestinationsApi.get_destination"
113
125
  end
114
- # verify the required parameter 'destination_id' is set
115
- if @api_client.config.client_side_validation && destination_id.nil?
116
- fail ArgumentError, "Missing the required parameter 'destination_id' when calling DataExportDestinationsApi.get_destination"
126
+ # verify the required parameter 'id' is set
127
+ if @api_client.config.client_side_validation && id.nil?
128
+ fail ArgumentError, "Missing the required parameter 'id' when calling DataExportDestinationsApi.get_destination"
117
129
  end
118
130
  # resource path
119
- local_var_path = '/destinations/{projectKey}/{environmentKey}/{destinationId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'destinationId' + '}', destination_id.to_s)
131
+ local_var_path = '/api/v2/destinations/{projKey}/{envKey}/{id}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
120
132
 
121
133
  # query parameters
122
- query_params = {}
134
+ query_params = opts[:query_params] || {}
123
135
 
124
136
  # header parameters
125
- header_params = {}
137
+ header_params = opts[:header_params] || {}
126
138
  # HTTP header 'Accept' (if needed)
127
139
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
128
- # HTTP header 'Content-Type'
129
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
130
140
 
131
141
  # form parameters
132
- form_params = {}
142
+ form_params = opts[:form_params] || {}
133
143
 
134
144
  # http body (model)
135
- post_body = nil
136
- auth_names = ['Token']
137
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
145
+ post_body = opts[:debug_body]
146
+
147
+ # return_type
148
+ return_type = opts[:debug_return_type] || 'Destination'
149
+
150
+ # auth_names
151
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
152
+
153
+ new_options = opts.merge(
154
+ :operation => :"DataExportDestinationsApi.get_destination",
138
155
  :header_params => header_params,
139
156
  :query_params => query_params,
140
157
  :form_params => form_params,
141
158
  :body => post_body,
142
159
  :auth_names => auth_names,
143
- :return_type => 'Destination')
160
+ :return_type => return_type
161
+ )
162
+
163
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
144
164
  if @api_client.config.debugging
145
165
  @api_client.config.logger.debug "API called: DataExportDestinationsApi#get_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
146
166
  end
147
167
  return data, status_code, headers
148
168
  end
149
- # Returns a list of all data export destinations.
169
+
170
+ # List destinations
171
+ # Get a list of Data Export destinations configured across all projects and environments.
150
172
  # @param [Hash] opts the optional parameters
151
173
  # @return [Destinations]
152
174
  def get_destinations(opts = {})
@@ -154,173 +176,208 @@ module LaunchDarklyApi
154
176
  data
155
177
  end
156
178
 
157
- # Returns a list of all data export destinations.
179
+ # List destinations
180
+ # Get a list of Data Export destinations configured across all projects and environments.
158
181
  # @param [Hash] opts the optional parameters
159
- # @return [Array<(Destinations, Fixnum, Hash)>] Destinations data, response status code and response headers
182
+ # @return [Array<(Destinations, Integer, Hash)>] Destinations data, response status code and response headers
160
183
  def get_destinations_with_http_info(opts = {})
161
184
  if @api_client.config.debugging
162
185
  @api_client.config.logger.debug 'Calling API: DataExportDestinationsApi.get_destinations ...'
163
186
  end
164
187
  # resource path
165
- local_var_path = '/destinations'
188
+ local_var_path = '/api/v2/destinations'
166
189
 
167
190
  # query parameters
168
- query_params = {}
191
+ query_params = opts[:query_params] || {}
169
192
 
170
193
  # header parameters
171
- header_params = {}
194
+ header_params = opts[:header_params] || {}
172
195
  # HTTP header 'Accept' (if needed)
173
196
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
174
- # HTTP header 'Content-Type'
175
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
176
197
 
177
198
  # form parameters
178
- form_params = {}
199
+ form_params = opts[:form_params] || {}
179
200
 
180
201
  # http body (model)
181
- post_body = nil
182
- auth_names = ['Token']
183
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
202
+ post_body = opts[:debug_body]
203
+
204
+ # return_type
205
+ return_type = opts[:debug_return_type] || 'Destinations'
206
+
207
+ # auth_names
208
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
209
+
210
+ new_options = opts.merge(
211
+ :operation => :"DataExportDestinationsApi.get_destinations",
184
212
  :header_params => header_params,
185
213
  :query_params => query_params,
186
214
  :form_params => form_params,
187
215
  :body => post_body,
188
216
  :auth_names => auth_names,
189
- :return_type => 'Destinations')
217
+ :return_type => return_type
218
+ )
219
+
220
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
190
221
  if @api_client.config.debugging
191
222
  @api_client.config.logger.debug "API called: DataExportDestinationsApi#get_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
192
223
  end
193
224
  return data, status_code, headers
194
225
  end
195
- # Perform a partial update to a data export destination.
196
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
197
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
198
- # @param destination_id The data export destination ID.
199
- # @param patch_only Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; Feature flag patches also support JSON Merge Patch format. &#39;https://tools.ietf.org/html/rfc7386&#39; The addition of comments is also supported.
226
+
227
+ # Update Data Export destination
228
+ # Update a Data Export destination. This requires a JSON Patch representation of the modified destination.
229
+ # @param proj_key [String] The project key
230
+ # @param env_key [String] The environment key
231
+ # @param id [String] The Data Export destination ID
232
+ # @param patch_operation [Array<PatchOperation>]
200
233
  # @param [Hash] opts the optional parameters
201
234
  # @return [Destination]
202
- def patch_destination(project_key, environment_key, destination_id, patch_only, opts = {})
203
- data, _status_code, _headers = patch_destination_with_http_info(project_key, environment_key, destination_id, patch_only, opts)
235
+ def patch_destination(proj_key, env_key, id, patch_operation, opts = {})
236
+ data, _status_code, _headers = patch_destination_with_http_info(proj_key, env_key, id, patch_operation, opts)
204
237
  data
205
238
  end
206
239
 
207
- # Perform a partial update to a data export destination.
208
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
209
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
210
- # @param destination_id The data export destination ID.
211
- # @param patch_only Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39; Feature flag patches also support JSON Merge Patch format. &#39;https://tools.ietf.org/html/rfc7386&#39; The addition of comments is also supported.
240
+ # Update Data Export destination
241
+ # Update a Data Export destination. This requires a JSON Patch representation of the modified destination.
242
+ # @param proj_key [String] The project key
243
+ # @param env_key [String] The environment key
244
+ # @param id [String] The Data Export destination ID
245
+ # @param patch_operation [Array<PatchOperation>]
212
246
  # @param [Hash] opts the optional parameters
213
- # @return [Array<(Destination, Fixnum, Hash)>] Destination data, response status code and response headers
214
- def patch_destination_with_http_info(project_key, environment_key, destination_id, patch_only, opts = {})
247
+ # @return [Array<(Destination, Integer, Hash)>] Destination data, response status code and response headers
248
+ def patch_destination_with_http_info(proj_key, env_key, id, patch_operation, opts = {})
215
249
  if @api_client.config.debugging
216
250
  @api_client.config.logger.debug 'Calling API: DataExportDestinationsApi.patch_destination ...'
217
251
  end
218
- # verify the required parameter 'project_key' is set
219
- if @api_client.config.client_side_validation && project_key.nil?
220
- fail ArgumentError, "Missing the required parameter 'project_key' when calling DataExportDestinationsApi.patch_destination"
252
+ # verify the required parameter 'proj_key' is set
253
+ if @api_client.config.client_side_validation && proj_key.nil?
254
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling DataExportDestinationsApi.patch_destination"
221
255
  end
222
- # verify the required parameter 'environment_key' is set
223
- if @api_client.config.client_side_validation && environment_key.nil?
224
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling DataExportDestinationsApi.patch_destination"
256
+ # verify the required parameter 'env_key' is set
257
+ if @api_client.config.client_side_validation && env_key.nil?
258
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling DataExportDestinationsApi.patch_destination"
225
259
  end
226
- # verify the required parameter 'destination_id' is set
227
- if @api_client.config.client_side_validation && destination_id.nil?
228
- fail ArgumentError, "Missing the required parameter 'destination_id' when calling DataExportDestinationsApi.patch_destination"
260
+ # verify the required parameter 'id' is set
261
+ if @api_client.config.client_side_validation && id.nil?
262
+ fail ArgumentError, "Missing the required parameter 'id' when calling DataExportDestinationsApi.patch_destination"
229
263
  end
230
- # verify the required parameter 'patch_only' is set
231
- if @api_client.config.client_side_validation && patch_only.nil?
232
- fail ArgumentError, "Missing the required parameter 'patch_only' when calling DataExportDestinationsApi.patch_destination"
264
+ # verify the required parameter 'patch_operation' is set
265
+ if @api_client.config.client_side_validation && patch_operation.nil?
266
+ fail ArgumentError, "Missing the required parameter 'patch_operation' when calling DataExportDestinationsApi.patch_destination"
233
267
  end
234
268
  # resource path
235
- local_var_path = '/destinations/{projectKey}/{environmentKey}/{destinationId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'destinationId' + '}', destination_id.to_s)
269
+ local_var_path = '/api/v2/destinations/{projKey}/{envKey}/{id}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
236
270
 
237
271
  # query parameters
238
- query_params = {}
272
+ query_params = opts[:query_params] || {}
239
273
 
240
274
  # header parameters
241
- header_params = {}
275
+ header_params = opts[:header_params] || {}
242
276
  # HTTP header 'Accept' (if needed)
243
277
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
244
278
  # HTTP header 'Content-Type'
245
279
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
246
280
 
247
281
  # form parameters
248
- form_params = {}
282
+ form_params = opts[:form_params] || {}
249
283
 
250
284
  # http body (model)
251
- post_body = @api_client.object_to_http_body(patch_only)
252
- auth_names = ['Token']
253
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
285
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)
286
+
287
+ # return_type
288
+ return_type = opts[:debug_return_type] || 'Destination'
289
+
290
+ # auth_names
291
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
292
+
293
+ new_options = opts.merge(
294
+ :operation => :"DataExportDestinationsApi.patch_destination",
254
295
  :header_params => header_params,
255
296
  :query_params => query_params,
256
297
  :form_params => form_params,
257
298
  :body => post_body,
258
299
  :auth_names => auth_names,
259
- :return_type => 'Destination')
300
+ :return_type => return_type
301
+ )
302
+
303
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
260
304
  if @api_client.config.debugging
261
305
  @api_client.config.logger.debug "API called: DataExportDestinationsApi#patch_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
262
306
  end
263
307
  return data, status_code, headers
264
308
  end
265
- # Create a new data export destination
266
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
267
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
268
- # @param destination_body Create a new data export destination.
309
+
310
+ # Create data export destination
311
+ # Create a new destination. The `config` body parameter represents the configuration parameters required for a destination type.
312
+ # @param proj_key [String] The project key
313
+ # @param env_key [String] The environment key
314
+ # @param destination_post [DestinationPost]
269
315
  # @param [Hash] opts the optional parameters
270
316
  # @return [Destination]
271
- def post_destination(project_key, environment_key, destination_body, opts = {})
272
- data, _status_code, _headers = post_destination_with_http_info(project_key, environment_key, destination_body, opts)
317
+ def post_destination(proj_key, env_key, destination_post, opts = {})
318
+ data, _status_code, _headers = post_destination_with_http_info(proj_key, env_key, destination_post, opts)
273
319
  data
274
320
  end
275
321
 
276
- # Create a new data export destination
277
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
278
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
279
- # @param destination_body Create a new data export destination.
322
+ # Create data export destination
323
+ # Create a new destination. The &#x60;config&#x60; body parameter represents the configuration parameters required for a destination type.
324
+ # @param proj_key [String] The project key
325
+ # @param env_key [String] The environment key
326
+ # @param destination_post [DestinationPost]
280
327
  # @param [Hash] opts the optional parameters
281
- # @return [Array<(Destination, Fixnum, Hash)>] Destination data, response status code and response headers
282
- def post_destination_with_http_info(project_key, environment_key, destination_body, opts = {})
328
+ # @return [Array<(Destination, Integer, Hash)>] Destination data, response status code and response headers
329
+ def post_destination_with_http_info(proj_key, env_key, destination_post, opts = {})
283
330
  if @api_client.config.debugging
284
331
  @api_client.config.logger.debug 'Calling API: DataExportDestinationsApi.post_destination ...'
285
332
  end
286
- # verify the required parameter 'project_key' is set
287
- if @api_client.config.client_side_validation && project_key.nil?
288
- fail ArgumentError, "Missing the required parameter 'project_key' when calling DataExportDestinationsApi.post_destination"
333
+ # verify the required parameter 'proj_key' is set
334
+ if @api_client.config.client_side_validation && proj_key.nil?
335
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling DataExportDestinationsApi.post_destination"
289
336
  end
290
- # verify the required parameter 'environment_key' is set
291
- if @api_client.config.client_side_validation && environment_key.nil?
292
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling DataExportDestinationsApi.post_destination"
337
+ # verify the required parameter 'env_key' is set
338
+ if @api_client.config.client_side_validation && env_key.nil?
339
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling DataExportDestinationsApi.post_destination"
293
340
  end
294
- # verify the required parameter 'destination_body' is set
295
- if @api_client.config.client_side_validation && destination_body.nil?
296
- fail ArgumentError, "Missing the required parameter 'destination_body' when calling DataExportDestinationsApi.post_destination"
341
+ # verify the required parameter 'destination_post' is set
342
+ if @api_client.config.client_side_validation && destination_post.nil?
343
+ fail ArgumentError, "Missing the required parameter 'destination_post' when calling DataExportDestinationsApi.post_destination"
297
344
  end
298
345
  # resource path
299
- local_var_path = '/destinations/{projectKey}/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)
346
+ local_var_path = '/api/v2/destinations/{projKey}/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s))
300
347
 
301
348
  # query parameters
302
- query_params = {}
349
+ query_params = opts[:query_params] || {}
303
350
 
304
351
  # header parameters
305
- header_params = {}
352
+ header_params = opts[:header_params] || {}
306
353
  # HTTP header 'Accept' (if needed)
307
354
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
308
355
  # HTTP header 'Content-Type'
309
356
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
310
357
 
311
358
  # form parameters
312
- form_params = {}
359
+ form_params = opts[:form_params] || {}
313
360
 
314
361
  # http body (model)
315
- post_body = @api_client.object_to_http_body(destination_body)
316
- auth_names = ['Token']
317
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
362
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(destination_post)
363
+
364
+ # return_type
365
+ return_type = opts[:debug_return_type] || 'Destination'
366
+
367
+ # auth_names
368
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
369
+
370
+ new_options = opts.merge(
371
+ :operation => :"DataExportDestinationsApi.post_destination",
318
372
  :header_params => header_params,
319
373
  :query_params => query_params,
320
374
  :form_params => form_params,
321
375
  :body => post_body,
322
376
  :auth_names => auth_names,
323
- :return_type => 'Destination')
377
+ :return_type => return_type
378
+ )
379
+
380
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
324
381
  if @api_client.config.debugging
325
382
  @api_client.config.logger.debug "API called: DataExportDestinationsApi#post_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
326
383
  end