launchdarkly_api 5.4.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (850) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +3 -1
  3. data/README.md +304 -261
  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 +19 -6
  41. data/docs/DependentFlagEnvironment.md +19 -6
  42. data/docs/DependentFlagsByEnvironment.md +17 -5
  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 +451 -1184
  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 +17 -7
  110. data/docs/MultiEnvironmentDependentFlags.md +17 -5
  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 +487 -1390
  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 +76 -25
  245. data/lib/launchdarkly_api/models/dependent_flag_environment.rb +76 -25
  246. data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +75 -24
  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 +69 -43
  309. data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +75 -24
  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 +129 -97
  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 -267
  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 +8 -15
  434. data/spec/models/dependent_flag_spec.rb +8 -15
  435. data/spec/models/dependent_flags_by_environment_spec.rb +8 -15
  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 +8 -27
  498. data/spec/models/multi_environment_dependent_flags_spec.rb +8 -15
  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 +815 -582
  571. data/docs/ApprovalRequest.md +0 -21
  572. data/docs/ApprovalRequestApplyConfigBody.md +0 -8
  573. data/docs/ApprovalRequestConfigBody.md +0 -13
  574. data/docs/ApprovalRequestFlagConfigCopyBody.md +0 -13
  575. data/docs/ApprovalRequestReview.md +0 -11
  576. data/docs/ApprovalRequestReviewConfigBody.md +0 -9
  577. data/docs/ApprovalRequestReviewStatus.md +0 -7
  578. data/docs/ApprovalRequests.md +0 -9
  579. data/docs/AuditLogEntries.md +0 -9
  580. data/docs/AuditLogEntry.md +0 -19
  581. data/docs/AuditLogEntryTarget.md +0 -10
  582. data/docs/BigSegmentTargetChanges.md +0 -9
  583. data/docs/BigSegmentTargetsBody.md +0 -9
  584. data/docs/CopyActions.md +0 -7
  585. data/docs/CustomPropertyValues.md +0 -7
  586. data/docs/CustomRoleBody.md +0 -11
  587. data/docs/CustomerMetricsApi.md +0 -511
  588. data/docs/DependentFlagEnvironmentLinks.md +0 -9
  589. data/docs/DependentFlagLinks.md +0 -8
  590. data/docs/DependentFlagsLinks.md +0 -9
  591. data/docs/DestinationAmazonKinesis.md +0 -10
  592. data/docs/DestinationBody.md +0 -11
  593. data/docs/DestinationGooglePubSub.md +0 -9
  594. data/docs/DestinationMParticle.md +0 -11
  595. data/docs/DestinationSegment.md +0 -8
  596. data/docs/EnvironmentApprovalSettings.md +0 -13
  597. data/docs/EvaluationUsageError.md +0 -9
  598. data/docs/Events.md +0 -8
  599. data/docs/Fallthrough.md +0 -9
  600. data/docs/FeatureFlagCopyBody.md +0 -12
  601. data/docs/FeatureFlagCopyObject.md +0 -9
  602. data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
  603. data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
  604. data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
  605. data/docs/FeatureFlagStatusLinks.md +0 -9
  606. data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
  607. data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
  608. data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
  609. data/docs/FlagListItem.md +0 -11
  610. data/docs/HierarchicalLinks.md +0 -9
  611. data/docs/Id.md +0 -7
  612. data/docs/Integration.md +0 -9
  613. data/docs/IntegrationSubscription.md +0 -16
  614. data/docs/IntegrationSubscriptionStatus.md +0 -10
  615. data/docs/Integrations.md +0 -9
  616. data/docs/IntegrationsApi.md +0 -334
  617. data/docs/Links.md +0 -9
  618. data/docs/MAU.md +0 -10
  619. data/docs/MAUMetadata.md +0 -7
  620. data/docs/MAUbyCategory.md +0 -10
  621. data/docs/MemberLastSeenMetadata.md +0 -8
  622. data/docs/MembersBody.md +0 -13
  623. data/docs/PatchComment.md +0 -9
  624. data/docs/Policy.md +0 -12
  625. data/docs/ProjectBody.md +0 -13
  626. data/docs/RelayProxyConfig.md +0 -15
  627. data/docs/RelayProxyConfigBody.md +0 -9
  628. data/docs/RelayProxyConfigs.md +0 -8
  629. data/docs/Role.md +0 -7
  630. data/docs/RootApi.md +0 -56
  631. data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
  632. data/docs/SemanticPatchInstruction.md +0 -7
  633. data/docs/SemanticPatchInstructionInner.md +0 -8
  634. data/docs/SemanticPatchOperation.md +0 -9
  635. data/docs/Site.md +0 -9
  636. data/docs/Source.md +0 -9
  637. data/docs/Stream.md +0 -10
  638. data/docs/StreamBySDK.md +0 -10
  639. data/docs/StreamBySDKLinks.md +0 -9
  640. data/docs/StreamBySDKLinksMetadata.md +0 -10
  641. data/docs/StreamLinks.md +0 -10
  642. data/docs/StreamSDKVersion.md +0 -9
  643. data/docs/StreamSDKVersionData.md +0 -9
  644. data/docs/StreamUsageError.md +0 -9
  645. data/docs/StreamUsageLinks.md +0 -10
  646. data/docs/StreamUsageMetadata.md +0 -10
  647. data/docs/StreamUsageSeries.md +0 -9
  648. data/docs/Streams.md +0 -8
  649. data/docs/SubscriptionBody.md +0 -12
  650. data/docs/TeamMembersApi.md +0 -329
  651. data/docs/TokenBody.md +0 -13
  652. data/docs/Usage.md +0 -9
  653. data/docs/UsageError.md +0 -8
  654. data/docs/UsageLinks.md +0 -10
  655. data/docs/UserSegmentBody.md +0 -12
  656. data/docs/UserSegmentsApi.md +0 -488
  657. data/docs/UserSettingsBody.md +0 -8
  658. data/docs/UserTargetingExpirationForFlag.md +0 -14
  659. data/docs/UserTargetingExpirationForFlags.md +0 -9
  660. data/docs/UserTargetingExpirationForSegment.md +0 -14
  661. data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
  662. data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
  663. data/docs/WebhookBody.md +0 -14
  664. data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
  665. data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
  666. data/lib/launchdarkly_api/api/root_api.rb +0 -69
  667. data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
  668. data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
  669. data/lib/launchdarkly_api/models/approval_request.rb +0 -346
  670. data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
  671. data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
  672. data/lib/launchdarkly_api/models/approval_request_flag_config_copy_body.rb +0 -254
  673. data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
  674. data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
  675. data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
  676. data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
  677. data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
  678. data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
  679. data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
  680. data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
  681. data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
  682. data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
  683. data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
  684. data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
  685. data/lib/launchdarkly_api/models/dependent_flag__links.rb +0 -184
  686. data/lib/launchdarkly_api/models/dependent_flag_environment__links.rb +0 -193
  687. data/lib/launchdarkly_api/models/dependent_flags_links.rb +0 -193
  688. data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
  689. data/lib/launchdarkly_api/models/destination_body.rb +0 -264
  690. data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
  691. data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
  692. data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
  693. data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -272
  694. data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
  695. data/lib/launchdarkly_api/models/events.rb +0 -184
  696. data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
  697. data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
  698. data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
  699. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
  700. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
  701. data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
  702. data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
  703. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
  704. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
  705. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
  706. data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
  707. data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
  708. data/lib/launchdarkly_api/models/id.rb +0 -176
  709. data/lib/launchdarkly_api/models/integration.rb +0 -195
  710. data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
  711. data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
  712. data/lib/launchdarkly_api/models/integrations.rb +0 -196
  713. data/lib/launchdarkly_api/models/links.rb +0 -193
  714. data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
  715. data/lib/launchdarkly_api/models/mau.rb +0 -206
  716. data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
  717. data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
  718. data/lib/launchdarkly_api/models/members_body.rb +0 -238
  719. data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
  720. data/lib/launchdarkly_api/models/policy.rb +0 -231
  721. data/lib/launchdarkly_api/models/project_body.rb +0 -243
  722. data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
  723. data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
  724. data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
  725. data/lib/launchdarkly_api/models/role.rb +0 -32
  726. data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
  727. data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
  728. data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
  729. data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
  730. data/lib/launchdarkly_api/models/site.rb +0 -193
  731. data/lib/launchdarkly_api/models/source.rb +0 -195
  732. data/lib/launchdarkly_api/models/stream.rb +0 -206
  733. data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
  734. data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
  735. data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
  736. data/lib/launchdarkly_api/models/stream_links.rb +0 -205
  737. data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
  738. data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
  739. data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
  740. data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
  741. data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
  742. data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
  743. data/lib/launchdarkly_api/models/streams.rb +0 -184
  744. data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
  745. data/lib/launchdarkly_api/models/token_body.rb +0 -238
  746. data/lib/launchdarkly_api/models/usage.rb +0 -195
  747. data/lib/launchdarkly_api/models/usage_error.rb +0 -184
  748. data/lib/launchdarkly_api/models/usage_links.rb +0 -205
  749. data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
  750. data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
  751. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
  752. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
  753. data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
  754. data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
  755. data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
  756. data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
  757. data/openapi.yml +0 -4922
  758. data/spec/api/customer_metrics_api_spec.rb +0 -141
  759. data/spec/api/integrations_api_spec.rb +0 -105
  760. data/spec/api/root_api_spec.rb +0 -45
  761. data/spec/api/team_members_api_spec.rb +0 -104
  762. data/spec/api/user_segments_api_spec.rb +0 -142
  763. data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
  764. data/spec/models/approval_request_config_body_spec.rb +0 -71
  765. data/spec/models/approval_request_flag_config_copy_body_spec.rb +0 -71
  766. data/spec/models/approval_request_review_config_body_spec.rb +0 -51
  767. data/spec/models/approval_request_review_spec.rb +0 -59
  768. data/spec/models/approval_request_review_status_spec.rb +0 -35
  769. data/spec/models/approval_request_spec.rb +0 -123
  770. data/spec/models/approval_requests_spec.rb +0 -47
  771. data/spec/models/audit_log_entries_spec.rb +0 -47
  772. data/spec/models/audit_log_entry_spec.rb +0 -107
  773. data/spec/models/audit_log_entry_target_spec.rb +0 -53
  774. data/spec/models/big_segment_target_changes_spec.rb +0 -47
  775. data/spec/models/big_segment_targets_body_spec.rb +0 -47
  776. data/spec/models/copy_actions_spec.rb +0 -35
  777. data/spec/models/custom_property_values_spec.rb +0 -35
  778. data/spec/models/custom_role_body_spec.rb +0 -59
  779. data/spec/models/dependent_flag__links_spec.rb +0 -41
  780. data/spec/models/dependent_flag_environment__links_spec.rb +0 -47
  781. data/spec/models/dependent_flags_links_spec.rb +0 -47
  782. data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
  783. data/spec/models/destination_body_spec.rb +0 -63
  784. data/spec/models/destination_google_pub_sub_spec.rb +0 -47
  785. data/spec/models/destination_m_particle_spec.rb +0 -59
  786. data/spec/models/destination_segment_spec.rb +0 -41
  787. data/spec/models/environment_approval_settings_spec.rb +0 -75
  788. data/spec/models/evaluation_usage_error_spec.rb +0 -47
  789. data/spec/models/events_spec.rb +0 -41
  790. data/spec/models/fallthrough_spec.rb +0 -47
  791. data/spec/models/feature_flag_copy_body_spec.rb +0 -65
  792. data/spec/models/feature_flag_copy_object_spec.rb +0 -47
  793. data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
  794. data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
  795. data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
  796. data/spec/models/feature_flag_status_links_spec.rb +0 -47
  797. data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
  798. data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
  799. data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
  800. data/spec/models/flag_list_item_spec.rb +0 -59
  801. data/spec/models/hierarchical_links_spec.rb +0 -47
  802. data/spec/models/id_spec.rb +0 -35
  803. data/spec/models/integration_spec.rb +0 -47
  804. data/spec/models/integration_subscription__status_spec.rb +0 -53
  805. data/spec/models/integration_subscription_spec.rb +0 -89
  806. data/spec/models/integrations_spec.rb +0 -47
  807. data/spec/models/links_spec.rb +0 -47
  808. data/spec/models/ma_uby_category_spec.rb +0 -53
  809. data/spec/models/mau_metadata_spec.rb +0 -35
  810. data/spec/models/mau_spec.rb +0 -53
  811. data/spec/models/member__last_seen_metadata_spec.rb +0 -41
  812. data/spec/models/members_body_spec.rb +0 -71
  813. data/spec/models/patch_comment_spec.rb +0 -47
  814. data/spec/models/policy_spec.rb +0 -65
  815. data/spec/models/project_body_spec.rb +0 -71
  816. data/spec/models/relay_proxy_config_body_spec.rb +0 -47
  817. data/spec/models/relay_proxy_config_spec.rb +0 -83
  818. data/spec/models/relay_proxy_configs_spec.rb +0 -41
  819. data/spec/models/role_spec.rb +0 -35
  820. data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +0 -47
  821. data/spec/models/semantic_patch_instruction_inner_spec.rb +0 -41
  822. data/spec/models/semantic_patch_instruction_spec.rb +0 -35
  823. data/spec/models/semantic_patch_operation_spec.rb +0 -47
  824. data/spec/models/site_spec.rb +0 -47
  825. data/spec/models/source_spec.rb +0 -47
  826. data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
  827. data/spec/models/stream_by_sdk_links_spec.rb +0 -47
  828. data/spec/models/stream_by_sdk_spec.rb +0 -53
  829. data/spec/models/stream_links_spec.rb +0 -53
  830. data/spec/models/stream_sdk_version_data_spec.rb +0 -47
  831. data/spec/models/stream_sdk_version_spec.rb +0 -47
  832. data/spec/models/stream_spec.rb +0 -53
  833. data/spec/models/stream_usage_error_spec.rb +0 -47
  834. data/spec/models/stream_usage_links_spec.rb +0 -53
  835. data/spec/models/stream_usage_metadata_spec.rb +0 -53
  836. data/spec/models/stream_usage_series_spec.rb +0 -47
  837. data/spec/models/streams_spec.rb +0 -41
  838. data/spec/models/subscription_body_spec.rb +0 -65
  839. data/spec/models/token_body_spec.rb +0 -71
  840. data/spec/models/usage_error_spec.rb +0 -41
  841. data/spec/models/usage_links_spec.rb +0 -53
  842. data/spec/models/usage_spec.rb +0 -47
  843. data/spec/models/user_segment_body_spec.rb +0 -65
  844. data/spec/models/user_settings_body_spec.rb +0 -41
  845. data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
  846. data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
  847. data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
  848. data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
  849. data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
  850. data/spec/models/webhook_body_spec.rb +0 -77
@@ -1,9 +1,22 @@
1
1
  # LaunchDarklyApi::WeightedVariation
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **variation** | **Integer** | | [optional]
7
- **weight** | **Integer** | | [optional]
8
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **variation** | **Integer** | | |
8
+ | **weight** | **Integer** | | |
9
+ | **_untracked** | **Boolean** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'launchdarkly_api'
15
+
16
+ instance = LaunchDarklyApi::WeightedVariation.new(
17
+ variation: null,
18
+ weight: null,
19
+ _untracked: null
20
+ )
21
+ ```
9
22
 
data/git_push.sh CHANGED
@@ -1,22 +1,25 @@
1
1
  #!/bin/sh
2
- #
3
- # Generated by: https://github.com/swagger-api/swagger-codegen.git
4
- #
5
2
  # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
6
3
  #
7
- # Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
4
+ # Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
8
5
 
9
6
  git_user_id=$1
10
7
  git_repo_id=$2
11
8
  release_note=$3
9
+ git_host=$4
10
+
11
+ if [ "$git_host" = "" ]; then
12
+ git_host="github.com"
13
+ echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14
+ fi
12
15
 
13
16
  if [ "$git_user_id" = "" ]; then
14
- git_user_id="GIT_USER_ID"
17
+ git_user_id="launchdarkly"
15
18
  echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
16
19
  fi
17
20
 
18
21
  if [ "$git_repo_id" = "" ]; then
19
- git_repo_id="GIT_REPO_ID"
22
+ git_repo_id="api-client-ruby"
20
23
  echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
21
24
  fi
22
25
 
@@ -40,9 +43,9 @@ if [ "$git_remote" = "" ]; then # git remote not defined
40
43
 
41
44
  if [ "$GIT_TOKEN" = "" ]; then
42
45
  echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
43
- git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
46
+ git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
44
47
  else
45
- git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
48
+ git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
46
49
  fi
47
50
 
48
51
  fi
@@ -50,6 +53,5 @@ fi
50
53
  git pull origin master
51
54
 
52
55
  # Pushes (Forces) the changes in the local repository up to the remote repository
53
- echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
56
+ echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
54
57
  git push origin master 2>&1 | grep -v 'To https'
55
-
@@ -3,12 +3,12 @@
3
3
  =begin
4
4
  #LaunchDarkly REST API
5
5
 
6
- #Build custom integrations with the LaunchDarkly REST API
6
+ ## 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.
7
7
 
8
- OpenAPI spec version: 5.4.0
8
+ The version of the OpenAPI document: 2.0
9
9
  Contact: support@launchdarkly.com
10
- Generated by: https://github.com/swagger-api/swagger-codegen.git
11
- Swagger Codegen version: 2.4.17
10
+ Generated by: https://openapi-generator.tech
11
+ OpenAPI Generator version: 5.3.0-SNAPSHOT
12
12
 
13
13
  =end
14
14
 
@@ -23,21 +23,13 @@ Gem::Specification.new do |s|
23
23
  s.email = ["support@launchdarkly.com"]
24
24
  s.homepage = "https://github.com/launchdarkly/api-client-ruby"
25
25
  s.summary = "LaunchDarkly REST API Ruby Gem"
26
- s.description = "Build custom integrations with the LaunchDarkly REST API"
26
+ s.description = "# 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. "
27
27
  s.license = "Unlicense"
28
- s.required_ruby_version = ">= 1.9"
28
+ s.required_ruby_version = ">= 2.4"
29
29
 
30
30
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
- s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
32
- s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.0'
33
31
 
34
32
  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
35
- s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
36
- s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
37
- s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
38
- s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
39
- s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
40
- s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
41
33
 
42
34
  s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
43
35
  s.test_files = `find spec/*`.split("\n")
@@ -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.4.0
6
+ The version of the OpenAPI document: 2.0
7
7
  Contact: support@launchdarkly.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.17
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
- require 'uri'
13
+ require 'cgi'
14
14
 
15
15
  module LaunchDarklyApi
16
16
  class AccessTokensApi
@@ -19,318 +19,386 @@ module LaunchDarklyApi
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Delete access token
22
23
  # Delete an access token by ID.
23
- # @param token_id The access token ID.
24
+ # @param id [String] The ID of the access token to update
24
25
  # @param [Hash] opts the optional parameters
25
26
  # @return [nil]
26
- def delete_token(token_id, opts = {})
27
- delete_token_with_http_info(token_id, opts)
27
+ def delete_token(id, opts = {})
28
+ delete_token_with_http_info(id, opts)
28
29
  nil
29
30
  end
30
31
 
32
+ # Delete access token
31
33
  # Delete an access token by ID.
32
- # @param token_id The access token ID.
34
+ # @param id [String] The ID of the access token to update
33
35
  # @param [Hash] opts the optional parameters
34
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
35
- def delete_token_with_http_info(token_id, opts = {})
36
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
+ def delete_token_with_http_info(id, opts = {})
36
38
  if @api_client.config.debugging
37
39
  @api_client.config.logger.debug 'Calling API: AccessTokensApi.delete_token ...'
38
40
  end
39
- # verify the required parameter 'token_id' is set
40
- if @api_client.config.client_side_validation && token_id.nil?
41
- fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.delete_token"
41
+ # verify the required parameter 'id' is set
42
+ if @api_client.config.client_side_validation && id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccessTokensApi.delete_token"
42
44
  end
43
45
  # resource path
44
- local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)
46
+ local_var_path = '/api/v2/tokens/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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 => :"AccessTokensApi.delete_token",
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: AccessTokensApi#delete_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
70
79
  end
71
80
  return data, status_code, headers
72
81
  end
82
+
83
+ # Get access token
73
84
  # Get a single access token by ID.
74
- # @param token_id The access token ID.
85
+ # @param id [String] The ID of the access token
75
86
  # @param [Hash] opts the optional parameters
76
87
  # @return [Token]
77
- def get_token(token_id, opts = {})
78
- data, _status_code, _headers = get_token_with_http_info(token_id, opts)
88
+ def get_token(id, opts = {})
89
+ data, _status_code, _headers = get_token_with_http_info(id, opts)
79
90
  data
80
91
  end
81
92
 
93
+ # Get access token
82
94
  # Get a single access token by ID.
83
- # @param token_id The access token ID.
95
+ # @param id [String] The ID of the access token
84
96
  # @param [Hash] opts the optional parameters
85
- # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
86
- def get_token_with_http_info(token_id, opts = {})
97
+ # @return [Array<(Token, Integer, Hash)>] Token data, response status code and response headers
98
+ def get_token_with_http_info(id, opts = {})
87
99
  if @api_client.config.debugging
88
100
  @api_client.config.logger.debug 'Calling API: AccessTokensApi.get_token ...'
89
101
  end
90
- # verify the required parameter 'token_id' is set
91
- if @api_client.config.client_side_validation && token_id.nil?
92
- fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.get_token"
102
+ # verify the required parameter 'id' is set
103
+ if @api_client.config.client_side_validation && id.nil?
104
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccessTokensApi.get_token"
93
105
  end
94
106
  # resource path
95
- local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)
107
+ local_var_path = '/api/v2/tokens/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'Token'
125
+
126
+ # auth_names
127
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
128
+
129
+ new_options = opts.merge(
130
+ :operation => :"AccessTokensApi.get_token",
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 => 'Token')
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: AccessTokensApi#get_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
122
142
  end
123
143
  return data, status_code, headers
124
144
  end
125
- # Returns a list of tokens in the account.
145
+
146
+ # List access tokens
147
+ # Fetch a list of all access tokens.
126
148
  # @param [Hash] opts the optional parameters
127
- # @option opts [BOOLEAN] :show_all If set to true, and the authentication access token has the \&quot;Admin\&quot; role, personal access tokens for all members will be retrieved.
149
+ # @option opts [Boolean] :show_all If set to true, and the authentication access token has the &#39;Admin&#39; role, personal access tokens for all members will be retrieved.
128
150
  # @return [Tokens]
129
151
  def get_tokens(opts = {})
130
152
  data, _status_code, _headers = get_tokens_with_http_info(opts)
131
153
  data
132
154
  end
133
155
 
134
- # Returns a list of tokens in the account.
156
+ # List access tokens
157
+ # Fetch a list of all access tokens.
135
158
  # @param [Hash] opts the optional parameters
136
- # @option opts [BOOLEAN] :show_all If set to true, and the authentication access token has the \&quot;Admin\&quot; role, personal access tokens for all members will be retrieved.
137
- # @return [Array<(Tokens, Fixnum, Hash)>] Tokens data, response status code and response headers
159
+ # @option opts [Boolean] :show_all If set to true, and the authentication access token has the &#39;Admin&#39; role, personal access tokens for all members will be retrieved.
160
+ # @return [Array<(Tokens, Integer, Hash)>] Tokens data, response status code and response headers
138
161
  def get_tokens_with_http_info(opts = {})
139
162
  if @api_client.config.debugging
140
163
  @api_client.config.logger.debug 'Calling API: AccessTokensApi.get_tokens ...'
141
164
  end
142
165
  # resource path
143
- local_var_path = '/tokens'
166
+ local_var_path = '/api/v2/tokens'
144
167
 
145
168
  # query parameters
146
- query_params = {}
169
+ query_params = opts[:query_params] || {}
147
170
  query_params[:'showAll'] = opts[:'show_all'] if !opts[:'show_all'].nil?
148
171
 
149
172
  # header parameters
150
- header_params = {}
173
+ header_params = opts[:header_params] || {}
151
174
  # HTTP header 'Accept' (if needed)
152
175
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
153
- # HTTP header 'Content-Type'
154
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
155
176
 
156
177
  # form parameters
157
- form_params = {}
178
+ form_params = opts[:form_params] || {}
158
179
 
159
180
  # http body (model)
160
- post_body = nil
161
- auth_names = ['Token']
162
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
181
+ post_body = opts[:debug_body]
182
+
183
+ # return_type
184
+ return_type = opts[:debug_return_type] || 'Tokens'
185
+
186
+ # auth_names
187
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
188
+
189
+ new_options = opts.merge(
190
+ :operation => :"AccessTokensApi.get_tokens",
163
191
  :header_params => header_params,
164
192
  :query_params => query_params,
165
193
  :form_params => form_params,
166
194
  :body => post_body,
167
195
  :auth_names => auth_names,
168
- :return_type => 'Tokens')
196
+ :return_type => return_type
197
+ )
198
+
199
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
169
200
  if @api_client.config.debugging
170
201
  @api_client.config.logger.debug "API called: AccessTokensApi#get_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
171
202
  end
172
203
  return data, status_code, headers
173
204
  end
174
- # Modify an access token by ID.
175
- # @param token_id The access token ID.
176
- # @param patch_delta Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39;
205
+
206
+ # Patch access token
207
+ # Update an access token's settings. The request should be a valid JSON Patch document describing the changes to be made to the access token.
208
+ # @param id [String] The ID of the access token to update
209
+ # @param patch_operation [Array<PatchOperation>]
177
210
  # @param [Hash] opts the optional parameters
178
211
  # @return [Token]
179
- def patch_token(token_id, patch_delta, opts = {})
180
- data, _status_code, _headers = patch_token_with_http_info(token_id, patch_delta, opts)
212
+ def patch_token(id, patch_operation, opts = {})
213
+ data, _status_code, _headers = patch_token_with_http_info(id, patch_operation, opts)
181
214
  data
182
215
  end
183
216
 
184
- # Modify an access token by ID.
185
- # @param token_id The access token ID.
186
- # @param patch_delta Requires a JSON Patch representation of the desired changes to the project. &#39;http://jsonpatch.com/&#39;
217
+ # Patch access token
218
+ # Update an access token&#39;s settings. The request should be a valid JSON Patch document describing the changes to be made to the access token.
219
+ # @param id [String] The ID of the access token to update
220
+ # @param patch_operation [Array<PatchOperation>]
187
221
  # @param [Hash] opts the optional parameters
188
- # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
189
- def patch_token_with_http_info(token_id, patch_delta, opts = {})
222
+ # @return [Array<(Token, Integer, Hash)>] Token data, response status code and response headers
223
+ def patch_token_with_http_info(id, patch_operation, opts = {})
190
224
  if @api_client.config.debugging
191
225
  @api_client.config.logger.debug 'Calling API: AccessTokensApi.patch_token ...'
192
226
  end
193
- # verify the required parameter 'token_id' is set
194
- if @api_client.config.client_side_validation && token_id.nil?
195
- fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.patch_token"
227
+ # verify the required parameter 'id' is set
228
+ if @api_client.config.client_side_validation && id.nil?
229
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccessTokensApi.patch_token"
196
230
  end
197
- # verify the required parameter 'patch_delta' is set
198
- if @api_client.config.client_side_validation && patch_delta.nil?
199
- fail ArgumentError, "Missing the required parameter 'patch_delta' when calling AccessTokensApi.patch_token"
231
+ # verify the required parameter 'patch_operation' is set
232
+ if @api_client.config.client_side_validation && patch_operation.nil?
233
+ fail ArgumentError, "Missing the required parameter 'patch_operation' when calling AccessTokensApi.patch_token"
200
234
  end
201
235
  # resource path
202
- local_var_path = '/tokens/{tokenId}'.sub('{' + 'tokenId' + '}', token_id.to_s)
236
+ local_var_path = '/api/v2/tokens/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
203
237
 
204
238
  # query parameters
205
- query_params = {}
239
+ query_params = opts[:query_params] || {}
206
240
 
207
241
  # header parameters
208
- header_params = {}
242
+ header_params = opts[:header_params] || {}
209
243
  # HTTP header 'Accept' (if needed)
210
244
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
211
245
  # HTTP header 'Content-Type'
212
246
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
213
247
 
214
248
  # form parameters
215
- form_params = {}
249
+ form_params = opts[:form_params] || {}
216
250
 
217
251
  # http body (model)
218
- post_body = @api_client.object_to_http_body(patch_delta)
219
- auth_names = ['Token']
220
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
252
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)
253
+
254
+ # return_type
255
+ return_type = opts[:debug_return_type] || 'Token'
256
+
257
+ # auth_names
258
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
259
+
260
+ new_options = opts.merge(
261
+ :operation => :"AccessTokensApi.patch_token",
221
262
  :header_params => header_params,
222
263
  :query_params => query_params,
223
264
  :form_params => form_params,
224
265
  :body => post_body,
225
266
  :auth_names => auth_names,
226
- :return_type => 'Token')
267
+ :return_type => return_type
268
+ )
269
+
270
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
227
271
  if @api_client.config.debugging
228
272
  @api_client.config.logger.debug "API called: AccessTokensApi#patch_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
229
273
  end
230
274
  return data, status_code, headers
231
275
  end
232
- # Create a new token.
233
- # @param token_body Create a new access token.
276
+
277
+ # Create access token
278
+ # Create a new access token.
279
+ # @param access_token_post [AccessTokenPost]
234
280
  # @param [Hash] opts the optional parameters
235
281
  # @return [Token]
236
- def post_token(token_body, opts = {})
237
- data, _status_code, _headers = post_token_with_http_info(token_body, opts)
282
+ def post_token(access_token_post, opts = {})
283
+ data, _status_code, _headers = post_token_with_http_info(access_token_post, opts)
238
284
  data
239
285
  end
240
286
 
241
- # Create a new token.
242
- # @param token_body Create a new access token.
287
+ # Create access token
288
+ # Create a new access token.
289
+ # @param access_token_post [AccessTokenPost]
243
290
  # @param [Hash] opts the optional parameters
244
- # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
245
- def post_token_with_http_info(token_body, opts = {})
291
+ # @return [Array<(Token, Integer, Hash)>] Token data, response status code and response headers
292
+ def post_token_with_http_info(access_token_post, opts = {})
246
293
  if @api_client.config.debugging
247
294
  @api_client.config.logger.debug 'Calling API: AccessTokensApi.post_token ...'
248
295
  end
249
- # verify the required parameter 'token_body' is set
250
- if @api_client.config.client_side_validation && token_body.nil?
251
- fail ArgumentError, "Missing the required parameter 'token_body' when calling AccessTokensApi.post_token"
296
+ # verify the required parameter 'access_token_post' is set
297
+ if @api_client.config.client_side_validation && access_token_post.nil?
298
+ fail ArgumentError, "Missing the required parameter 'access_token_post' when calling AccessTokensApi.post_token"
252
299
  end
253
300
  # resource path
254
- local_var_path = '/tokens'
301
+ local_var_path = '/api/v2/tokens'
255
302
 
256
303
  # query parameters
257
- query_params = {}
304
+ query_params = opts[:query_params] || {}
258
305
 
259
306
  # header parameters
260
- header_params = {}
307
+ header_params = opts[:header_params] || {}
261
308
  # HTTP header 'Accept' (if needed)
262
309
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
263
310
  # HTTP header 'Content-Type'
264
311
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
265
312
 
266
313
  # form parameters
267
- form_params = {}
314
+ form_params = opts[:form_params] || {}
268
315
 
269
316
  # http body (model)
270
- post_body = @api_client.object_to_http_body(token_body)
271
- auth_names = ['Token']
272
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
317
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(access_token_post)
318
+
319
+ # return_type
320
+ return_type = opts[:debug_return_type] || 'Token'
321
+
322
+ # auth_names
323
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
324
+
325
+ new_options = opts.merge(
326
+ :operation => :"AccessTokensApi.post_token",
273
327
  :header_params => header_params,
274
328
  :query_params => query_params,
275
329
  :form_params => form_params,
276
330
  :body => post_body,
277
331
  :auth_names => auth_names,
278
- :return_type => 'Token')
332
+ :return_type => return_type
333
+ )
334
+
335
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
279
336
  if @api_client.config.debugging
280
337
  @api_client.config.logger.debug "API called: AccessTokensApi#post_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
281
338
  end
282
339
  return data, status_code, headers
283
340
  end
341
+
342
+ # Reset access token
284
343
  # Reset an access token's secret key with an optional expiry time for the old key.
285
- # @param token_id The access token ID.
344
+ # @param id [String] The ID of the access token to update
286
345
  # @param [Hash] opts the optional parameters
287
346
  # @option opts [Integer] :expiry An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
288
347
  # @return [Token]
289
- def reset_token(token_id, opts = {})
290
- data, _status_code, _headers = reset_token_with_http_info(token_id, opts)
348
+ def reset_token(id, opts = {})
349
+ data, _status_code, _headers = reset_token_with_http_info(id, opts)
291
350
  data
292
351
  end
293
352
 
353
+ # Reset access token
294
354
  # Reset an access token&#39;s secret key with an optional expiry time for the old key.
295
- # @param token_id The access token ID.
355
+ # @param id [String] The ID of the access token to update
296
356
  # @param [Hash] opts the optional parameters
297
357
  # @option opts [Integer] :expiry An expiration time for the old token key, expressed as a Unix epoch time in milliseconds. By default, the token will expire immediately.
298
- # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
299
- def reset_token_with_http_info(token_id, opts = {})
358
+ # @return [Array<(Token, Integer, Hash)>] Token data, response status code and response headers
359
+ def reset_token_with_http_info(id, opts = {})
300
360
  if @api_client.config.debugging
301
361
  @api_client.config.logger.debug 'Calling API: AccessTokensApi.reset_token ...'
302
362
  end
303
- # verify the required parameter 'token_id' is set
304
- if @api_client.config.client_side_validation && token_id.nil?
305
- fail ArgumentError, "Missing the required parameter 'token_id' when calling AccessTokensApi.reset_token"
363
+ # verify the required parameter 'id' is set
364
+ if @api_client.config.client_side_validation && id.nil?
365
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccessTokensApi.reset_token"
306
366
  end
307
367
  # resource path
308
- local_var_path = '/tokens/{tokenId}/reset'.sub('{' + 'tokenId' + '}', token_id.to_s)
368
+ local_var_path = '/api/v2/tokens/{id}/reset'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
309
369
 
310
370
  # query parameters
311
- query_params = {}
371
+ query_params = opts[:query_params] || {}
312
372
  query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?
313
373
 
314
374
  # header parameters
315
- header_params = {}
375
+ header_params = opts[:header_params] || {}
316
376
  # HTTP header 'Accept' (if needed)
317
377
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
318
- # HTTP header 'Content-Type'
319
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
320
378
 
321
379
  # form parameters
322
- form_params = {}
380
+ form_params = opts[:form_params] || {}
323
381
 
324
382
  # http body (model)
325
- post_body = nil
326
- auth_names = ['Token']
327
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
383
+ post_body = opts[:debug_body]
384
+
385
+ # return_type
386
+ return_type = opts[:debug_return_type] || 'Token'
387
+
388
+ # auth_names
389
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
390
+
391
+ new_options = opts.merge(
392
+ :operation => :"AccessTokensApi.reset_token",
328
393
  :header_params => header_params,
329
394
  :query_params => query_params,
330
395
  :form_params => form_params,
331
396
  :body => post_body,
332
397
  :auth_names => auth_names,
333
- :return_type => 'Token')
398
+ :return_type => return_type
399
+ )
400
+
401
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
334
402
  if @api_client.config.debugging
335
403
  @api_client.config.logger.debug "API called: AccessTokensApi#reset_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
336
404
  end