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,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 AuditLogApi
@@ -19,36 +19,38 @@ module LaunchDarklyApi
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Get a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.
22
+ # List audit log feature flag entries
23
+ # Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query.
23
24
  # @param [Hash] opts the optional parameters
24
- # @option opts [Integer] :before A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have before this timestamp.
25
- # @option opts [Integer] :after A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp.
26
- # @option opts [String] :q Text to search for. You can search for the full or partial name of the resource involved or full or partial email address of the member who made the change.
27
- # @option opts [Float] :limit A limit on the number of audit log entries to be returned, between 1 and 20.
28
- # @option opts [String] :spec A resource specifier, allowing you to filter audit log listings by resource.
29
- # @return [AuditLogEntries]
25
+ # @option opts [Integer] :before A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp.
26
+ # @option opts [Integer] :after A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp.
27
+ # @option opts [String] :q Text to search for. You can search for the full or partial name of the resource, or full or partial email address of the member who made a change.
28
+ # @option opts [Integer] :limit A limit on the number of audit log entries that return. Set between 1 and 20.
29
+ # @option opts [String] :spec A resource specifier that lets you filter audit log listings by resource
30
+ # @return [AuditLogEntryListingRepCollection]
30
31
  def get_audit_log_entries(opts = {})
31
32
  data, _status_code, _headers = get_audit_log_entries_with_http_info(opts)
32
33
  data
33
34
  end
34
35
 
35
- # Get a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.
36
+ # List audit log feature flag entries
37
+ # Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query.
36
38
  # @param [Hash] opts the optional parameters
37
- # @option opts [Integer] :before A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have before this timestamp.
38
- # @option opts [Integer] :after A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp.
39
- # @option opts [String] :q Text to search for. You can search for the full or partial name of the resource involved or full or partial email address of the member who made the change.
40
- # @option opts [Float] :limit A limit on the number of audit log entries to be returned, between 1 and 20.
41
- # @option opts [String] :spec A resource specifier, allowing you to filter audit log listings by resource.
42
- # @return [Array<(AuditLogEntries, Fixnum, Hash)>] AuditLogEntries data, response status code and response headers
39
+ # @option opts [Integer] :before A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred before the timestamp.
40
+ # @option opts [Integer] :after A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp.
41
+ # @option opts [String] :q Text to search for. You can search for the full or partial name of the resource, or full or partial email address of the member who made a change.
42
+ # @option opts [Integer] :limit A limit on the number of audit log entries that return. Set between 1 and 20.
43
+ # @option opts [String] :spec A resource specifier that lets you filter audit log listings by resource
44
+ # @return [Array<(AuditLogEntryListingRepCollection, Integer, Hash)>] AuditLogEntryListingRepCollection data, response status code and response headers
43
45
  def get_audit_log_entries_with_http_info(opts = {})
44
46
  if @api_client.config.debugging
45
47
  @api_client.config.logger.debug 'Calling API: AuditLogApi.get_audit_log_entries ...'
46
48
  end
47
49
  # resource path
48
- local_var_path = '/auditlog'
50
+ local_var_path = '/api/v2/auditlog'
49
51
 
50
52
  # query parameters
51
- query_params = {}
53
+ query_params = opts[:query_params] || {}
52
54
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
53
55
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
54
56
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
@@ -56,77 +58,96 @@ module LaunchDarklyApi
56
58
  query_params[:'spec'] = opts[:'spec'] if !opts[:'spec'].nil?
57
59
 
58
60
  # header parameters
59
- header_params = {}
61
+ header_params = opts[:header_params] || {}
60
62
  # HTTP header 'Accept' (if needed)
61
63
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
62
- # HTTP header 'Content-Type'
63
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
64
64
 
65
65
  # form parameters
66
- form_params = {}
66
+ form_params = opts[:form_params] || {}
67
67
 
68
68
  # http body (model)
69
- post_body = nil
70
- auth_names = ['Token']
71
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
69
+ post_body = opts[:debug_body]
70
+
71
+ # return_type
72
+ return_type = opts[:debug_return_type] || 'AuditLogEntryListingRepCollection'
73
+
74
+ # auth_names
75
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
76
+
77
+ new_options = opts.merge(
78
+ :operation => :"AuditLogApi.get_audit_log_entries",
72
79
  :header_params => header_params,
73
80
  :query_params => query_params,
74
81
  :form_params => form_params,
75
82
  :body => post_body,
76
83
  :auth_names => auth_names,
77
- :return_type => 'AuditLogEntries')
84
+ :return_type => return_type
85
+ )
86
+
87
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
78
88
  if @api_client.config.debugging
79
89
  @api_client.config.logger.debug "API called: AuditLogApi#get_audit_log_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
90
  end
81
91
  return data, status_code, headers
82
92
  end
83
- # Use this endpoint to fetch a single audit log entry by its resouce ID.
84
- # @param resource_id The resource ID.
93
+
94
+ # Get audit log entry
95
+ # Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation: - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity
96
+ # @param id [String] The ID of the audit log entry
85
97
  # @param [Hash] opts the optional parameters
86
- # @return [AuditLogEntry]
87
- def get_audit_log_entry(resource_id, opts = {})
88
- data, _status_code, _headers = get_audit_log_entry_with_http_info(resource_id, opts)
98
+ # @return [AuditLogEntryRep]
99
+ def get_audit_log_entry(id, opts = {})
100
+ data, _status_code, _headers = get_audit_log_entry_with_http_info(id, opts)
89
101
  data
90
102
  end
91
103
 
92
- # Use this endpoint to fetch a single audit log entry by its resouce ID.
93
- # @param resource_id The resource ID.
104
+ # Get audit log entry
105
+ # Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation: - &#x60;delta&#x60;: the JSON patch body that was used in the request to update the entity - &#x60;previousVersion&#x60;: a JSON representation of the previous version of the entity - &#x60;currentVersion&#x60;: a JSON representation of the current version of the entity
106
+ # @param id [String] The ID of the audit log entry
94
107
  # @param [Hash] opts the optional parameters
95
- # @return [Array<(AuditLogEntry, Fixnum, Hash)>] AuditLogEntry data, response status code and response headers
96
- def get_audit_log_entry_with_http_info(resource_id, opts = {})
108
+ # @return [Array<(AuditLogEntryRep, Integer, Hash)>] AuditLogEntryRep data, response status code and response headers
109
+ def get_audit_log_entry_with_http_info(id, opts = {})
97
110
  if @api_client.config.debugging
98
111
  @api_client.config.logger.debug 'Calling API: AuditLogApi.get_audit_log_entry ...'
99
112
  end
100
- # verify the required parameter 'resource_id' is set
101
- if @api_client.config.client_side_validation && resource_id.nil?
102
- fail ArgumentError, "Missing the required parameter 'resource_id' when calling AuditLogApi.get_audit_log_entry"
113
+ # verify the required parameter 'id' is set
114
+ if @api_client.config.client_side_validation && id.nil?
115
+ fail ArgumentError, "Missing the required parameter 'id' when calling AuditLogApi.get_audit_log_entry"
103
116
  end
104
117
  # resource path
105
- local_var_path = '/auditlog/{resourceId}'.sub('{' + 'resourceId' + '}', resource_id.to_s)
118
+ local_var_path = '/api/v2/auditlog/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
106
119
 
107
120
  # query parameters
108
- query_params = {}
121
+ query_params = opts[:query_params] || {}
109
122
 
110
123
  # header parameters
111
- header_params = {}
124
+ header_params = opts[:header_params] || {}
112
125
  # HTTP header 'Accept' (if needed)
113
126
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
114
- # HTTP header 'Content-Type'
115
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
116
127
 
117
128
  # form parameters
118
- form_params = {}
129
+ form_params = opts[:form_params] || {}
119
130
 
120
131
  # http body (model)
121
- post_body = nil
122
- auth_names = ['Token']
123
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
132
+ post_body = opts[:debug_body]
133
+
134
+ # return_type
135
+ return_type = opts[:debug_return_type] || 'AuditLogEntryRep'
136
+
137
+ # auth_names
138
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
139
+
140
+ new_options = opts.merge(
141
+ :operation => :"AuditLogApi.get_audit_log_entry",
124
142
  :header_params => header_params,
125
143
  :query_params => query_params,
126
144
  :form_params => form_params,
127
145
  :body => post_body,
128
146
  :auth_names => auth_names,
129
- :return_type => 'AuditLogEntry')
147
+ :return_type => return_type
148
+ )
149
+
150
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
130
151
  if @api_client.config.debugging
131
152
  @api_client.config.logger.debug "API called: AuditLogApi#get_audit_log_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
132
153
  end
@@ -0,0 +1,898 @@
1
+ =begin
2
+ #LaunchDarkly REST API
3
+
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
+
6
+ The version of the OpenAPI document: 2.0
7
+ Contact: support@launchdarkly.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module LaunchDarklyApi
16
+ class CodeReferencesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Delete branches
23
+ # Asynchronously delete a number of branches.
24
+ # @param repo [String] The repository name to delete branches for.
25
+ # @param request_body [Array<String>]
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [nil]
28
+ def delete_branches(repo, request_body, opts = {})
29
+ delete_branches_with_http_info(repo, request_body, opts)
30
+ nil
31
+ end
32
+
33
+ # Delete branches
34
+ # Asynchronously delete a number of branches.
35
+ # @param repo [String] The repository name to delete branches for.
36
+ # @param request_body [Array<String>]
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
39
+ def delete_branches_with_http_info(repo, request_body, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.delete_branches ...'
42
+ end
43
+ # verify the required parameter 'repo' is set
44
+ if @api_client.config.client_side_validation && repo.nil?
45
+ fail ArgumentError, "Missing the required parameter 'repo' when calling CodeReferencesApi.delete_branches"
46
+ end
47
+ # verify the required parameter 'request_body' is set
48
+ if @api_client.config.client_side_validation && request_body.nil?
49
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling CodeReferencesApi.delete_branches"
50
+ end
51
+ # resource path
52
+ local_var_path = '/api/v2/code-refs/repositories/{repo}/branch-delete-tasks'.sub('{' + 'repo' + '}', CGI.escape(repo.to_s))
53
+
54
+ # query parameters
55
+ query_params = opts[:query_params] || {}
56
+
57
+ # header parameters
58
+ header_params = opts[:header_params] || {}
59
+ # HTTP header 'Content-Type'
60
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
61
+
62
+ # form parameters
63
+ form_params = opts[:form_params] || {}
64
+
65
+ # http body (model)
66
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
67
+
68
+ # return_type
69
+ return_type = opts[:debug_return_type]
70
+
71
+ # auth_names
72
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
73
+
74
+ new_options = opts.merge(
75
+ :operation => :"CodeReferencesApi.delete_branches",
76
+ :header_params => header_params,
77
+ :query_params => query_params,
78
+ :form_params => form_params,
79
+ :body => post_body,
80
+ :auth_names => auth_names,
81
+ :return_type => return_type
82
+ )
83
+
84
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: CodeReferencesApi#delete_branches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+
91
+ # Delete repository
92
+ # Delete a repository with the specified name
93
+ # @param repo [String] The repository name
94
+ # @param [Hash] opts the optional parameters
95
+ # @return [nil]
96
+ def delete_repository(repo, opts = {})
97
+ delete_repository_with_http_info(repo, opts)
98
+ nil
99
+ end
100
+
101
+ # Delete repository
102
+ # Delete a repository with the specified name
103
+ # @param repo [String] The repository name
104
+ # @param [Hash] opts the optional parameters
105
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
106
+ def delete_repository_with_http_info(repo, opts = {})
107
+ if @api_client.config.debugging
108
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.delete_repository ...'
109
+ end
110
+ # verify the required parameter 'repo' is set
111
+ if @api_client.config.client_side_validation && repo.nil?
112
+ fail ArgumentError, "Missing the required parameter 'repo' when calling CodeReferencesApi.delete_repository"
113
+ end
114
+ # resource path
115
+ local_var_path = '/api/v2/code-refs/repositories/{repo}'.sub('{' + 'repo' + '}', CGI.escape(repo.to_s))
116
+
117
+ # query parameters
118
+ query_params = opts[:query_params] || {}
119
+
120
+ # header parameters
121
+ header_params = opts[:header_params] || {}
122
+
123
+ # form parameters
124
+ form_params = opts[:form_params] || {}
125
+
126
+ # http body (model)
127
+ post_body = opts[:debug_body]
128
+
129
+ # return_type
130
+ return_type = opts[:debug_return_type]
131
+
132
+ # auth_names
133
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
134
+
135
+ new_options = opts.merge(
136
+ :operation => :"CodeReferencesApi.delete_repository",
137
+ :header_params => header_params,
138
+ :query_params => query_params,
139
+ :form_params => form_params,
140
+ :body => post_body,
141
+ :auth_names => auth_names,
142
+ :return_type => return_type
143
+ )
144
+
145
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug "API called: CodeReferencesApi#delete_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
+ end
149
+ return data, status_code, headers
150
+ end
151
+
152
+ # Get branch
153
+ # Get a specific branch in a repository
154
+ # @param repo [String] The repository name
155
+ # @param branch [String] The url-encoded branch name
156
+ # @param [Hash] opts the optional parameters
157
+ # @option opts [String] :proj_key Filter results to a specific project
158
+ # @option opts [String] :flag_key Filter results to a specific flag key
159
+ # @return [BranchRep]
160
+ def get_branch(repo, branch, opts = {})
161
+ data, _status_code, _headers = get_branch_with_http_info(repo, branch, opts)
162
+ data
163
+ end
164
+
165
+ # Get branch
166
+ # Get a specific branch in a repository
167
+ # @param repo [String] The repository name
168
+ # @param branch [String] The url-encoded branch name
169
+ # @param [Hash] opts the optional parameters
170
+ # @option opts [String] :proj_key Filter results to a specific project
171
+ # @option opts [String] :flag_key Filter results to a specific flag key
172
+ # @return [Array<(BranchRep, Integer, Hash)>] BranchRep data, response status code and response headers
173
+ def get_branch_with_http_info(repo, branch, opts = {})
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.get_branch ...'
176
+ end
177
+ # verify the required parameter 'repo' is set
178
+ if @api_client.config.client_side_validation && repo.nil?
179
+ fail ArgumentError, "Missing the required parameter 'repo' when calling CodeReferencesApi.get_branch"
180
+ end
181
+ # verify the required parameter 'branch' is set
182
+ if @api_client.config.client_side_validation && branch.nil?
183
+ fail ArgumentError, "Missing the required parameter 'branch' when calling CodeReferencesApi.get_branch"
184
+ end
185
+ # resource path
186
+ local_var_path = '/api/v2/code-refs/repositories/{repo}/branches/{branch}'.sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'branch' + '}', CGI.escape(branch.to_s))
187
+
188
+ # query parameters
189
+ query_params = opts[:query_params] || {}
190
+ query_params[:'projKey'] = opts[:'proj_key'] if !opts[:'proj_key'].nil?
191
+ query_params[:'flagKey'] = opts[:'flag_key'] if !opts[:'flag_key'].nil?
192
+
193
+ # header parameters
194
+ header_params = opts[:header_params] || {}
195
+ # HTTP header 'Accept' (if needed)
196
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
197
+
198
+ # form parameters
199
+ form_params = opts[:form_params] || {}
200
+
201
+ # http body (model)
202
+ post_body = opts[:debug_body]
203
+
204
+ # return_type
205
+ return_type = opts[:debug_return_type] || 'BranchRep'
206
+
207
+ # auth_names
208
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
209
+
210
+ new_options = opts.merge(
211
+ :operation => :"CodeReferencesApi.get_branch",
212
+ :header_params => header_params,
213
+ :query_params => query_params,
214
+ :form_params => form_params,
215
+ :body => post_body,
216
+ :auth_names => auth_names,
217
+ :return_type => return_type
218
+ )
219
+
220
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
221
+ if @api_client.config.debugging
222
+ @api_client.config.logger.debug "API called: CodeReferencesApi#get_branch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
223
+ end
224
+ return data, status_code, headers
225
+ end
226
+
227
+ # List branches
228
+ # Get a list of branches.
229
+ # @param repo [String] The repository name
230
+ # @param [Hash] opts the optional parameters
231
+ # @return [BranchCollectionRep]
232
+ def get_branches(repo, opts = {})
233
+ data, _status_code, _headers = get_branches_with_http_info(repo, opts)
234
+ data
235
+ end
236
+
237
+ # List branches
238
+ # Get a list of branches.
239
+ # @param repo [String] The repository name
240
+ # @param [Hash] opts the optional parameters
241
+ # @return [Array<(BranchCollectionRep, Integer, Hash)>] BranchCollectionRep data, response status code and response headers
242
+ def get_branches_with_http_info(repo, opts = {})
243
+ if @api_client.config.debugging
244
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.get_branches ...'
245
+ end
246
+ # verify the required parameter 'repo' is set
247
+ if @api_client.config.client_side_validation && repo.nil?
248
+ fail ArgumentError, "Missing the required parameter 'repo' when calling CodeReferencesApi.get_branches"
249
+ end
250
+ # resource path
251
+ local_var_path = '/api/v2/code-refs/repositories/{repo}/branches'.sub('{' + 'repo' + '}', CGI.escape(repo.to_s))
252
+
253
+ # query parameters
254
+ query_params = opts[:query_params] || {}
255
+
256
+ # header parameters
257
+ header_params = opts[:header_params] || {}
258
+ # HTTP header 'Accept' (if needed)
259
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
260
+
261
+ # form parameters
262
+ form_params = opts[:form_params] || {}
263
+
264
+ # http body (model)
265
+ post_body = opts[:debug_body]
266
+
267
+ # return_type
268
+ return_type = opts[:debug_return_type] || 'BranchCollectionRep'
269
+
270
+ # auth_names
271
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
272
+
273
+ new_options = opts.merge(
274
+ :operation => :"CodeReferencesApi.get_branches",
275
+ :header_params => header_params,
276
+ :query_params => query_params,
277
+ :form_params => form_params,
278
+ :body => post_body,
279
+ :auth_names => auth_names,
280
+ :return_type => return_type
281
+ )
282
+
283
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
284
+ if @api_client.config.debugging
285
+ @api_client.config.logger.debug "API called: CodeReferencesApi#get_branches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
286
+ end
287
+ return data, status_code, headers
288
+ end
289
+
290
+ # List extinctions
291
+ # Get a list of all extinctions.
292
+ # @param [Hash] opts the optional parameters
293
+ # @option opts [String] :repo_name Filter results to a specific repository
294
+ # @option opts [String] :branch_name Filter results to a specific branch
295
+ # @option opts [String] :proj_key Filter results to a specific project
296
+ # @option opts [String] :flag_key Filter results to a specific flag key
297
+ # @return [ExtinctionCollectionRep]
298
+ def get_extinctions(opts = {})
299
+ data, _status_code, _headers = get_extinctions_with_http_info(opts)
300
+ data
301
+ end
302
+
303
+ # List extinctions
304
+ # Get a list of all extinctions.
305
+ # @param [Hash] opts the optional parameters
306
+ # @option opts [String] :repo_name Filter results to a specific repository
307
+ # @option opts [String] :branch_name Filter results to a specific branch
308
+ # @option opts [String] :proj_key Filter results to a specific project
309
+ # @option opts [String] :flag_key Filter results to a specific flag key
310
+ # @return [Array<(ExtinctionCollectionRep, Integer, Hash)>] ExtinctionCollectionRep data, response status code and response headers
311
+ def get_extinctions_with_http_info(opts = {})
312
+ if @api_client.config.debugging
313
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.get_extinctions ...'
314
+ end
315
+ # resource path
316
+ local_var_path = '/api/v2/code-refs/extinctions'
317
+
318
+ # query parameters
319
+ query_params = opts[:query_params] || {}
320
+ query_params[:'repoName'] = opts[:'repo_name'] if !opts[:'repo_name'].nil?
321
+ query_params[:'branchName'] = opts[:'branch_name'] if !opts[:'branch_name'].nil?
322
+ query_params[:'projKey'] = opts[:'proj_key'] if !opts[:'proj_key'].nil?
323
+ query_params[:'flagKey'] = opts[:'flag_key'] if !opts[:'flag_key'].nil?
324
+
325
+ # header parameters
326
+ header_params = opts[:header_params] || {}
327
+ # HTTP header 'Accept' (if needed)
328
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
329
+
330
+ # form parameters
331
+ form_params = opts[:form_params] || {}
332
+
333
+ # http body (model)
334
+ post_body = opts[:debug_body]
335
+
336
+ # return_type
337
+ return_type = opts[:debug_return_type] || 'ExtinctionCollectionRep'
338
+
339
+ # auth_names
340
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
341
+
342
+ new_options = opts.merge(
343
+ :operation => :"CodeReferencesApi.get_extinctions",
344
+ :header_params => header_params,
345
+ :query_params => query_params,
346
+ :form_params => form_params,
347
+ :body => post_body,
348
+ :auth_names => auth_names,
349
+ :return_type => return_type
350
+ )
351
+
352
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
353
+ if @api_client.config.debugging
354
+ @api_client.config.logger.debug "API called: CodeReferencesApi#get_extinctions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
355
+ end
356
+ return data, status_code, headers
357
+ end
358
+
359
+ # List repositories
360
+ # Get a list of connected repositories. Optionally, you can include branch metadata with the `withBranches` query parameter. Embed references for the default branch with `ReferencesForDefaultBranch`. You can also filter the list of code references by project key and flag key.
361
+ # @param [Hash] opts the optional parameters
362
+ # @option opts [String] :with_branches If set to any value, the endpoint returns repositories with associated branch data
363
+ # @option opts [String] :with_references_for_default_branch If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch
364
+ # @option opts [String] :proj_key A LaunchDarkly project key. If provided, this filters code reference results to the specified project.
365
+ # @option opts [String] :flag_key If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch
366
+ # @return [RepositoryCollectionRep]
367
+ def get_repositories(opts = {})
368
+ data, _status_code, _headers = get_repositories_with_http_info(opts)
369
+ data
370
+ end
371
+
372
+ # List repositories
373
+ # Get a list of connected repositories. Optionally, you can include branch metadata with the &#x60;withBranches&#x60; query parameter. Embed references for the default branch with &#x60;ReferencesForDefaultBranch&#x60;. You can also filter the list of code references by project key and flag key.
374
+ # @param [Hash] opts the optional parameters
375
+ # @option opts [String] :with_branches If set to any value, the endpoint returns repositories with associated branch data
376
+ # @option opts [String] :with_references_for_default_branch If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch
377
+ # @option opts [String] :proj_key A LaunchDarkly project key. If provided, this filters code reference results to the specified project.
378
+ # @option opts [String] :flag_key If set to any value, the endpoint returns repositories with associated branch data, as well as code references for the default git branch
379
+ # @return [Array<(RepositoryCollectionRep, Integer, Hash)>] RepositoryCollectionRep data, response status code and response headers
380
+ def get_repositories_with_http_info(opts = {})
381
+ if @api_client.config.debugging
382
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.get_repositories ...'
383
+ end
384
+ # resource path
385
+ local_var_path = '/api/v2/code-refs/repositories'
386
+
387
+ # query parameters
388
+ query_params = opts[:query_params] || {}
389
+ query_params[:'withBranches'] = opts[:'with_branches'] if !opts[:'with_branches'].nil?
390
+ query_params[:'withReferencesForDefaultBranch'] = opts[:'with_references_for_default_branch'] if !opts[:'with_references_for_default_branch'].nil?
391
+ query_params[:'projKey'] = opts[:'proj_key'] if !opts[:'proj_key'].nil?
392
+ query_params[:'flagKey'] = opts[:'flag_key'] if !opts[:'flag_key'].nil?
393
+
394
+ # header parameters
395
+ header_params = opts[:header_params] || {}
396
+ # HTTP header 'Accept' (if needed)
397
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
398
+
399
+ # form parameters
400
+ form_params = opts[:form_params] || {}
401
+
402
+ # http body (model)
403
+ post_body = opts[:debug_body]
404
+
405
+ # return_type
406
+ return_type = opts[:debug_return_type] || 'RepositoryCollectionRep'
407
+
408
+ # auth_names
409
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
410
+
411
+ new_options = opts.merge(
412
+ :operation => :"CodeReferencesApi.get_repositories",
413
+ :header_params => header_params,
414
+ :query_params => query_params,
415
+ :form_params => form_params,
416
+ :body => post_body,
417
+ :auth_names => auth_names,
418
+ :return_type => return_type
419
+ )
420
+
421
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
422
+ if @api_client.config.debugging
423
+ @api_client.config.logger.debug "API called: CodeReferencesApi#get_repositories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
424
+ end
425
+ return data, status_code, headers
426
+ end
427
+
428
+ # Get repository
429
+ # Get a single repository by name.
430
+ # @param repo [String] The repository name
431
+ # @param [Hash] opts the optional parameters
432
+ # @return [RepositoryRep]
433
+ def get_repository(repo, opts = {})
434
+ data, _status_code, _headers = get_repository_with_http_info(repo, opts)
435
+ data
436
+ end
437
+
438
+ # Get repository
439
+ # Get a single repository by name.
440
+ # @param repo [String] The repository name
441
+ # @param [Hash] opts the optional parameters
442
+ # @return [Array<(RepositoryRep, Integer, Hash)>] RepositoryRep data, response status code and response headers
443
+ def get_repository_with_http_info(repo, opts = {})
444
+ if @api_client.config.debugging
445
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.get_repository ...'
446
+ end
447
+ # verify the required parameter 'repo' is set
448
+ if @api_client.config.client_side_validation && repo.nil?
449
+ fail ArgumentError, "Missing the required parameter 'repo' when calling CodeReferencesApi.get_repository"
450
+ end
451
+ # resource path
452
+ local_var_path = '/api/v2/code-refs/repositories/{repo}'.sub('{' + 'repo' + '}', CGI.escape(repo.to_s))
453
+
454
+ # query parameters
455
+ query_params = opts[:query_params] || {}
456
+
457
+ # header parameters
458
+ header_params = opts[:header_params] || {}
459
+ # HTTP header 'Accept' (if needed)
460
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
461
+
462
+ # form parameters
463
+ form_params = opts[:form_params] || {}
464
+
465
+ # http body (model)
466
+ post_body = opts[:debug_body]
467
+
468
+ # return_type
469
+ return_type = opts[:debug_return_type] || 'RepositoryRep'
470
+
471
+ # auth_names
472
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
473
+
474
+ new_options = opts.merge(
475
+ :operation => :"CodeReferencesApi.get_repository",
476
+ :header_params => header_params,
477
+ :query_params => query_params,
478
+ :form_params => form_params,
479
+ :body => post_body,
480
+ :auth_names => auth_names,
481
+ :return_type => return_type
482
+ )
483
+
484
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
485
+ if @api_client.config.debugging
486
+ @api_client.config.logger.debug "API called: CodeReferencesApi#get_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
487
+ end
488
+ return data, status_code, headers
489
+ end
490
+
491
+ # Get number of code references for flags
492
+ # Get links for all projects that have Code References.
493
+ # @param [Hash] opts the optional parameters
494
+ # @return [StatisticsRoot]
495
+ def get_root_statistic(opts = {})
496
+ data, _status_code, _headers = get_root_statistic_with_http_info(opts)
497
+ data
498
+ end
499
+
500
+ # Get number of code references for flags
501
+ # Get links for all projects that have Code References.
502
+ # @param [Hash] opts the optional parameters
503
+ # @return [Array<(StatisticsRoot, Integer, Hash)>] StatisticsRoot data, response status code and response headers
504
+ def get_root_statistic_with_http_info(opts = {})
505
+ if @api_client.config.debugging
506
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.get_root_statistic ...'
507
+ end
508
+ # resource path
509
+ local_var_path = '/api/v2/code-refs/statistics'
510
+
511
+ # query parameters
512
+ query_params = opts[:query_params] || {}
513
+
514
+ # header parameters
515
+ header_params = opts[:header_params] || {}
516
+ # HTTP header 'Accept' (if needed)
517
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
518
+
519
+ # form parameters
520
+ form_params = opts[:form_params] || {}
521
+
522
+ # http body (model)
523
+ post_body = opts[:debug_body]
524
+
525
+ # return_type
526
+ return_type = opts[:debug_return_type] || 'StatisticsRoot'
527
+
528
+ # auth_names
529
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
530
+
531
+ new_options = opts.merge(
532
+ :operation => :"CodeReferencesApi.get_root_statistic",
533
+ :header_params => header_params,
534
+ :query_params => query_params,
535
+ :form_params => form_params,
536
+ :body => post_body,
537
+ :auth_names => auth_names,
538
+ :return_type => return_type
539
+ )
540
+
541
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
542
+ if @api_client.config.debugging
543
+ @api_client.config.logger.debug "API called: CodeReferencesApi#get_root_statistic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
544
+ end
545
+ return data, status_code, headers
546
+ end
547
+
548
+ # Get number of code references for flags
549
+ # Get the number of code references across repositories for all flags in your project that have code references in the default branch (for example: master). You can optionally include the `flagKey` query parameter to get the number of code references across repositories for a single flag. This endpoint returns the number of times your flag keys are referenced in your repositories. You can filter to a single flag with by passing in a flag key.
550
+ # @param proj_key [String] The project key
551
+ # @param [Hash] opts the optional parameters
552
+ # @option opts [String] :flag_key Filter results to a specific flag key
553
+ # @return [StatisticCollectionRep]
554
+ def get_statistics(proj_key, opts = {})
555
+ data, _status_code, _headers = get_statistics_with_http_info(proj_key, opts)
556
+ data
557
+ end
558
+
559
+ # Get number of code references for flags
560
+ # Get the number of code references across repositories for all flags in your project that have code references in the default branch (for example: master). You can optionally include the &#x60;flagKey&#x60; query parameter to get the number of code references across repositories for a single flag. This endpoint returns the number of times your flag keys are referenced in your repositories. You can filter to a single flag with by passing in a flag key.
561
+ # @param proj_key [String] The project key
562
+ # @param [Hash] opts the optional parameters
563
+ # @option opts [String] :flag_key Filter results to a specific flag key
564
+ # @return [Array<(StatisticCollectionRep, Integer, Hash)>] StatisticCollectionRep data, response status code and response headers
565
+ def get_statistics_with_http_info(proj_key, opts = {})
566
+ if @api_client.config.debugging
567
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.get_statistics ...'
568
+ end
569
+ # verify the required parameter 'proj_key' is set
570
+ if @api_client.config.client_side_validation && proj_key.nil?
571
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling CodeReferencesApi.get_statistics"
572
+ end
573
+ # resource path
574
+ local_var_path = '/api/v2/code-refs/statistics/{projKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s))
575
+
576
+ # query parameters
577
+ query_params = opts[:query_params] || {}
578
+ query_params[:'flagKey'] = opts[:'flag_key'] if !opts[:'flag_key'].nil?
579
+
580
+ # header parameters
581
+ header_params = opts[:header_params] || {}
582
+ # HTTP header 'Accept' (if needed)
583
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
584
+
585
+ # form parameters
586
+ form_params = opts[:form_params] || {}
587
+
588
+ # http body (model)
589
+ post_body = opts[:debug_body]
590
+
591
+ # return_type
592
+ return_type = opts[:debug_return_type] || 'StatisticCollectionRep'
593
+
594
+ # auth_names
595
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
596
+
597
+ new_options = opts.merge(
598
+ :operation => :"CodeReferencesApi.get_statistics",
599
+ :header_params => header_params,
600
+ :query_params => query_params,
601
+ :form_params => form_params,
602
+ :body => post_body,
603
+ :auth_names => auth_names,
604
+ :return_type => return_type
605
+ )
606
+
607
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
608
+ if @api_client.config.debugging
609
+ @api_client.config.logger.debug "API called: CodeReferencesApi#get_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
610
+ end
611
+ return data, status_code, headers
612
+ end
613
+
614
+ # Update repository
615
+ # Update a repository's settings. The request must be a valid JSON Patch document describing the changes to be made to the repository.
616
+ # @param repo [String] The repository name
617
+ # @param patch_operation [Array<PatchOperation>]
618
+ # @param [Hash] opts the optional parameters
619
+ # @return [RepositoryRep]
620
+ def patch_repository(repo, patch_operation, opts = {})
621
+ data, _status_code, _headers = patch_repository_with_http_info(repo, patch_operation, opts)
622
+ data
623
+ end
624
+
625
+ # Update repository
626
+ # Update a repository&#39;s settings. The request must be a valid JSON Patch document describing the changes to be made to the repository.
627
+ # @param repo [String] The repository name
628
+ # @param patch_operation [Array<PatchOperation>]
629
+ # @param [Hash] opts the optional parameters
630
+ # @return [Array<(RepositoryRep, Integer, Hash)>] RepositoryRep data, response status code and response headers
631
+ def patch_repository_with_http_info(repo, patch_operation, opts = {})
632
+ if @api_client.config.debugging
633
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.patch_repository ...'
634
+ end
635
+ # verify the required parameter 'repo' is set
636
+ if @api_client.config.client_side_validation && repo.nil?
637
+ fail ArgumentError, "Missing the required parameter 'repo' when calling CodeReferencesApi.patch_repository"
638
+ end
639
+ # verify the required parameter 'patch_operation' is set
640
+ if @api_client.config.client_side_validation && patch_operation.nil?
641
+ fail ArgumentError, "Missing the required parameter 'patch_operation' when calling CodeReferencesApi.patch_repository"
642
+ end
643
+ # resource path
644
+ local_var_path = '/api/v2/code-refs/repositories/{repo}'.sub('{' + 'repo' + '}', CGI.escape(repo.to_s))
645
+
646
+ # query parameters
647
+ query_params = opts[:query_params] || {}
648
+
649
+ # header parameters
650
+ header_params = opts[:header_params] || {}
651
+ # HTTP header 'Accept' (if needed)
652
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
653
+ # HTTP header 'Content-Type'
654
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
655
+
656
+ # form parameters
657
+ form_params = opts[:form_params] || {}
658
+
659
+ # http body (model)
660
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)
661
+
662
+ # return_type
663
+ return_type = opts[:debug_return_type] || 'RepositoryRep'
664
+
665
+ # auth_names
666
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
667
+
668
+ new_options = opts.merge(
669
+ :operation => :"CodeReferencesApi.patch_repository",
670
+ :header_params => header_params,
671
+ :query_params => query_params,
672
+ :form_params => form_params,
673
+ :body => post_body,
674
+ :auth_names => auth_names,
675
+ :return_type => return_type
676
+ )
677
+
678
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
679
+ if @api_client.config.debugging
680
+ @api_client.config.logger.debug "API called: CodeReferencesApi#patch_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
681
+ end
682
+ return data, status_code, headers
683
+ end
684
+
685
+ # Create extinction
686
+ # Create a new extinction
687
+ # @param repo [String] The repository name
688
+ # @param branch [String] The url-encoded branch name
689
+ # @param inline_object [Array<InlineObject>]
690
+ # @param [Hash] opts the optional parameters
691
+ # @return [nil]
692
+ def post_extinction(repo, branch, inline_object, opts = {})
693
+ post_extinction_with_http_info(repo, branch, inline_object, opts)
694
+ nil
695
+ end
696
+
697
+ # Create extinction
698
+ # Create a new extinction
699
+ # @param repo [String] The repository name
700
+ # @param branch [String] The url-encoded branch name
701
+ # @param inline_object [Array<InlineObject>]
702
+ # @param [Hash] opts the optional parameters
703
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
704
+ def post_extinction_with_http_info(repo, branch, inline_object, opts = {})
705
+ if @api_client.config.debugging
706
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.post_extinction ...'
707
+ end
708
+ # verify the required parameter 'repo' is set
709
+ if @api_client.config.client_side_validation && repo.nil?
710
+ fail ArgumentError, "Missing the required parameter 'repo' when calling CodeReferencesApi.post_extinction"
711
+ end
712
+ # verify the required parameter 'branch' is set
713
+ if @api_client.config.client_side_validation && branch.nil?
714
+ fail ArgumentError, "Missing the required parameter 'branch' when calling CodeReferencesApi.post_extinction"
715
+ end
716
+ # verify the required parameter 'inline_object' is set
717
+ if @api_client.config.client_side_validation && inline_object.nil?
718
+ fail ArgumentError, "Missing the required parameter 'inline_object' when calling CodeReferencesApi.post_extinction"
719
+ end
720
+ # resource path
721
+ local_var_path = '/api/v2/code-refs/repositories/{repo}/branches/{branch}'.sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'branch' + '}', CGI.escape(branch.to_s))
722
+
723
+ # query parameters
724
+ query_params = opts[:query_params] || {}
725
+
726
+ # header parameters
727
+ header_params = opts[:header_params] || {}
728
+ # HTTP header 'Content-Type'
729
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
730
+
731
+ # form parameters
732
+ form_params = opts[:form_params] || {}
733
+
734
+ # http body (model)
735
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(inline_object)
736
+
737
+ # return_type
738
+ return_type = opts[:debug_return_type]
739
+
740
+ # auth_names
741
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
742
+
743
+ new_options = opts.merge(
744
+ :operation => :"CodeReferencesApi.post_extinction",
745
+ :header_params => header_params,
746
+ :query_params => query_params,
747
+ :form_params => form_params,
748
+ :body => post_body,
749
+ :auth_names => auth_names,
750
+ :return_type => return_type
751
+ )
752
+
753
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
754
+ if @api_client.config.debugging
755
+ @api_client.config.logger.debug "API called: CodeReferencesApi#post_extinction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
756
+ end
757
+ return data, status_code, headers
758
+ end
759
+
760
+ # Create repository
761
+ # Create a repository with the specified name.
762
+ # @param repository_post [RepositoryPost]
763
+ # @param [Hash] opts the optional parameters
764
+ # @return [nil]
765
+ def post_repository(repository_post, opts = {})
766
+ post_repository_with_http_info(repository_post, opts)
767
+ nil
768
+ end
769
+
770
+ # Create repository
771
+ # Create a repository with the specified name.
772
+ # @param repository_post [RepositoryPost]
773
+ # @param [Hash] opts the optional parameters
774
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
775
+ def post_repository_with_http_info(repository_post, opts = {})
776
+ if @api_client.config.debugging
777
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.post_repository ...'
778
+ end
779
+ # verify the required parameter 'repository_post' is set
780
+ if @api_client.config.client_side_validation && repository_post.nil?
781
+ fail ArgumentError, "Missing the required parameter 'repository_post' when calling CodeReferencesApi.post_repository"
782
+ end
783
+ # resource path
784
+ local_var_path = '/api/v2/code-refs/repositories'
785
+
786
+ # query parameters
787
+ query_params = opts[:query_params] || {}
788
+
789
+ # header parameters
790
+ header_params = opts[:header_params] || {}
791
+ # HTTP header 'Content-Type'
792
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
793
+
794
+ # form parameters
795
+ form_params = opts[:form_params] || {}
796
+
797
+ # http body (model)
798
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(repository_post)
799
+
800
+ # return_type
801
+ return_type = opts[:debug_return_type]
802
+
803
+ # auth_names
804
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
805
+
806
+ new_options = opts.merge(
807
+ :operation => :"CodeReferencesApi.post_repository",
808
+ :header_params => header_params,
809
+ :query_params => query_params,
810
+ :form_params => form_params,
811
+ :body => post_body,
812
+ :auth_names => auth_names,
813
+ :return_type => return_type
814
+ )
815
+
816
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
817
+ if @api_client.config.debugging
818
+ @api_client.config.logger.debug "API called: CodeReferencesApi#post_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
819
+ end
820
+ return data, status_code, headers
821
+ end
822
+
823
+ # Upsert branch
824
+ # Create a new branch if it doesn't exist, or updates the branch if it already exists.
825
+ # @param repo [String] The repository name
826
+ # @param branch [String] The url-encoded branch name
827
+ # @param branch_rep [BranchRep]
828
+ # @param [Hash] opts the optional parameters
829
+ # @return [nil]
830
+ def put_branch(repo, branch, branch_rep, opts = {})
831
+ put_branch_with_http_info(repo, branch, branch_rep, opts)
832
+ nil
833
+ end
834
+
835
+ # Upsert branch
836
+ # Create a new branch if it doesn&#39;t exist, or updates the branch if it already exists.
837
+ # @param repo [String] The repository name
838
+ # @param branch [String] The url-encoded branch name
839
+ # @param branch_rep [BranchRep]
840
+ # @param [Hash] opts the optional parameters
841
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
842
+ def put_branch_with_http_info(repo, branch, branch_rep, opts = {})
843
+ if @api_client.config.debugging
844
+ @api_client.config.logger.debug 'Calling API: CodeReferencesApi.put_branch ...'
845
+ end
846
+ # verify the required parameter 'repo' is set
847
+ if @api_client.config.client_side_validation && repo.nil?
848
+ fail ArgumentError, "Missing the required parameter 'repo' when calling CodeReferencesApi.put_branch"
849
+ end
850
+ # verify the required parameter 'branch' is set
851
+ if @api_client.config.client_side_validation && branch.nil?
852
+ fail ArgumentError, "Missing the required parameter 'branch' when calling CodeReferencesApi.put_branch"
853
+ end
854
+ # verify the required parameter 'branch_rep' is set
855
+ if @api_client.config.client_side_validation && branch_rep.nil?
856
+ fail ArgumentError, "Missing the required parameter 'branch_rep' when calling CodeReferencesApi.put_branch"
857
+ end
858
+ # resource path
859
+ local_var_path = '/api/v2/code-refs/repositories/{repo}/branches/{branch}'.sub('{' + 'repo' + '}', CGI.escape(repo.to_s)).sub('{' + 'branch' + '}', CGI.escape(branch.to_s))
860
+
861
+ # query parameters
862
+ query_params = opts[:query_params] || {}
863
+
864
+ # header parameters
865
+ header_params = opts[:header_params] || {}
866
+ # HTTP header 'Content-Type'
867
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
868
+
869
+ # form parameters
870
+ form_params = opts[:form_params] || {}
871
+
872
+ # http body (model)
873
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(branch_rep)
874
+
875
+ # return_type
876
+ return_type = opts[:debug_return_type]
877
+
878
+ # auth_names
879
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
880
+
881
+ new_options = opts.merge(
882
+ :operation => :"CodeReferencesApi.put_branch",
883
+ :header_params => header_params,
884
+ :query_params => query_params,
885
+ :form_params => form_params,
886
+ :body => post_body,
887
+ :auth_names => auth_names,
888
+ :return_type => return_type
889
+ )
890
+
891
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
892
+ if @api_client.config.debugging
893
+ @api_client.config.logger.debug "API called: CodeReferencesApi#put_branch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
894
+ end
895
+ return data, status_code, headers
896
+ end
897
+ end
898
+ end