launchdarkly_api 5.0.3 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (838) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +3 -1
  3. data/README.md +304 -249
  4. data/Rakefile +2 -0
  5. data/docs/AccessDeniedReasonRep.md +28 -0
  6. data/docs/AccessDeniedRep.md +20 -0
  7. data/docs/AccessRep.md +18 -0
  8. data/docs/AccessTokenPost.md +30 -0
  9. data/docs/AccessTokensApi.md +239 -126
  10. data/docs/AccountMembersApi.md +376 -0
  11. data/docs/AccountUsageBetaApi.md +647 -0
  12. data/docs/ApprovalSettings.md +32 -0
  13. data/docs/ApprovalsApi.md +554 -0
  14. data/docs/AuditLogApi.md +93 -55
  15. data/docs/AuditLogEntryListingRep.md +52 -0
  16. data/docs/AuditLogEntryListingRepCollection.md +20 -0
  17. data/docs/AuditLogEntryRep.md +64 -0
  18. data/docs/AuthorizedAppDataRep.md +26 -0
  19. data/docs/BigSegmentTarget.md +22 -0
  20. data/docs/BranchCollectionRep.md +20 -0
  21. data/docs/BranchRep.md +28 -0
  22. data/docs/Clause.md +21 -7
  23. data/docs/ClientSideAvailability.md +15 -4
  24. data/docs/ClientSideAvailabilityPost.md +20 -0
  25. data/docs/CodeReferencesApi.md +975 -0
  26. data/docs/ConfidenceIntervalRep.md +20 -0
  27. data/docs/Conflict.md +20 -0
  28. data/docs/CopiedFromEnv.md +20 -0
  29. data/docs/CreateCopyFlagConfigApprovalRequestRequest.md +28 -0
  30. data/docs/CreateFlagConfigApprovalRequestRequest.md +30 -0
  31. data/docs/CustomProperty.md +15 -4
  32. data/docs/CustomRole.md +25 -8
  33. data/docs/CustomRolePost.md +24 -0
  34. data/docs/CustomRolePostData.md +24 -0
  35. data/docs/CustomRoles.md +15 -4
  36. data/docs/CustomRolesApi.md +197 -101
  37. data/docs/DataExportDestinationsApi.md +205 -117
  38. data/docs/DefaultClientSideAvailabilityPost.md +20 -0
  39. data/docs/Defaults.md +15 -4
  40. data/docs/DependentFlag.md +24 -0
  41. data/docs/DependentFlagEnvironment.md +24 -0
  42. data/docs/DependentFlagsByEnvironment.md +22 -0
  43. data/docs/Destination.md +27 -9
  44. data/docs/DestinationPost.md +24 -0
  45. data/docs/Destinations.md +15 -4
  46. data/docs/Environment.md +35 -16
  47. data/docs/EnvironmentPost.md +29 -11
  48. data/docs/EnvironmentsApi.md +246 -144
  49. data/docs/ExperimentAllocationRep.md +20 -0
  50. data/docs/ExperimentEnabledPeriodRep.md +20 -0
  51. data/docs/ExperimentEnvironmentSettingRep.md +22 -0
  52. data/docs/ExperimentInfoRep.md +20 -0
  53. data/docs/ExperimentMetadataRep.md +18 -0
  54. data/docs/ExperimentRep.md +24 -0
  55. data/docs/ExperimentResultsRep.md +28 -0
  56. data/docs/ExperimentStatsRep.md +24 -0
  57. data/docs/ExperimentTimeSeriesSlice.md +20 -0
  58. data/docs/ExperimentTimeSeriesVariationSlice.md +32 -0
  59. data/docs/ExperimentTotalsRep.md +32 -0
  60. data/docs/ExperimentsBetaApi.md +168 -0
  61. data/docs/ExpiringUserTargetError.md +20 -0
  62. data/docs/ExpiringUserTargetGetResponse.md +20 -0
  63. data/docs/ExpiringUserTargetItem.md +30 -0
  64. data/docs/ExpiringUserTargetPatchResponse.md +28 -0
  65. data/docs/Extinction.md +26 -0
  66. data/docs/ExtinctionCollectionRep.md +20 -0
  67. data/docs/ExtinctionRep.md +26 -0
  68. data/docs/FeatureFlag.md +55 -22
  69. data/docs/FeatureFlagBody.md +33 -11
  70. data/docs/FeatureFlagConfig.md +47 -17
  71. data/docs/FeatureFlagScheduledChange.md +27 -6
  72. data/docs/FeatureFlagScheduledChanges.md +15 -4
  73. data/docs/FeatureFlagStatus.md +17 -6
  74. data/docs/FeatureFlagStatusAcrossEnvironments.md +17 -5
  75. data/docs/FeatureFlagStatuses.md +15 -4
  76. data/docs/FeatureFlags.md +17 -5
  77. data/docs/FeatureFlagsApi.md +414 -969
  78. data/docs/FeatureFlagsBetaApi.md +157 -0
  79. data/docs/FlagConfigApprovalRequestResponse.md +54 -0
  80. data/docs/FlagConfigApprovalRequestsResponse.md +20 -0
  81. data/docs/FlagCopyConfigEnvironment.md +20 -0
  82. data/docs/FlagCopyConfigPost.md +26 -0
  83. data/docs/FlagGlobalAttributesRep.md +58 -0
  84. data/docs/FlagListingRep.md +24 -0
  85. data/docs/FlagScheduledChangesInput.md +20 -0
  86. data/docs/FlagStatusRep.md +24 -0
  87. data/docs/FlagSummary.md +18 -0
  88. data/docs/HunkRep.md +26 -0
  89. data/docs/InlineObject.md +26 -0
  90. data/docs/InlineObject1.md +28 -0
  91. data/docs/InlineResponse200.md +20 -0
  92. data/docs/IntegrationMetadata.md +24 -0
  93. data/docs/IntegrationStatus.md +20 -0
  94. data/docs/IpList.md +20 -0
  95. data/docs/LastSeenMetadata.md +18 -0
  96. data/docs/Link.md +15 -4
  97. data/docs/Member.md +45 -14
  98. data/docs/MemberDataRep.md +26 -0
  99. data/docs/MemberPermissionGrantSummaryRep.md +22 -0
  100. data/docs/MemberSummaryRep.md +28 -0
  101. data/docs/MemberTeamSummaryRep.md +22 -0
  102. data/docs/Members.md +17 -5
  103. data/docs/MetricCollectionRep.md +20 -0
  104. data/docs/MetricListingRep.md +52 -0
  105. data/docs/MetricPost.md +40 -0
  106. data/docs/MetricRep.md +62 -0
  107. data/docs/MetricsApi.md +376 -0
  108. data/docs/Modification.md +18 -0
  109. data/docs/MultiEnvironmentDependentFlag.md +22 -0
  110. data/docs/MultiEnvironmentDependentFlags.md +22 -0
  111. data/docs/NewMemberForm.md +28 -0
  112. data/docs/OtherApi.md +282 -0
  113. data/docs/ParentResourceRep.md +22 -0
  114. data/docs/PatchOperation.md +17 -5
  115. data/docs/PatchSegmentInstruction.md +26 -0
  116. data/docs/PatchSegmentRequest.md +20 -0
  117. data/docs/PatchWithComment.md +20 -0
  118. data/docs/PostApprovalRequestApplyRequest.md +18 -0
  119. data/docs/PostApprovalRequestReviewRequest.md +20 -0
  120. data/docs/PostFlagScheduledChangesInput.md +22 -0
  121. data/docs/Prerequisite.md +15 -4
  122. data/docs/Project.md +27 -10
  123. data/docs/ProjectListingRep.md +30 -0
  124. data/docs/ProjectPost.md +28 -0
  125. data/docs/Projects.md +15 -4
  126. data/docs/ProjectsApi.md +196 -100
  127. data/docs/PubNubDetailRep.md +20 -0
  128. data/docs/ReferenceRep.md +22 -0
  129. data/docs/RelayAutoConfigCollectionRep.md +18 -0
  130. data/docs/RelayAutoConfigPost.md +20 -0
  131. data/docs/RelayAutoConfigRep.md +34 -0
  132. data/docs/RelayProxyConfigurationsApi.md +244 -129
  133. data/docs/RepositoryCollectionRep.md +20 -0
  134. data/docs/RepositoryPost.md +28 -0
  135. data/docs/RepositoryRep.md +38 -0
  136. data/docs/ResourceAccess.md +20 -0
  137. data/docs/ResourceIDResponse.md +26 -0
  138. data/docs/ReviewResponse.md +26 -0
  139. data/docs/Rollout.md +19 -4
  140. data/docs/Rule.md +23 -8
  141. data/docs/ScheduledChangesApi.md +404 -0
  142. data/docs/SdkListRep.md +20 -0
  143. data/docs/SdkVersionListRep.md +20 -0
  144. data/docs/SdkVersionRep.md +20 -0
  145. data/docs/SegmentBody.md +26 -0
  146. data/docs/SegmentMetadata.md +28 -0
  147. data/docs/SegmentUserList.md +20 -0
  148. data/docs/SegmentUserState.md +20 -0
  149. data/docs/SegmentsApi.md +695 -0
  150. data/docs/SeriesListRep.md +22 -0
  151. data/docs/SourceFlag.md +20 -0
  152. data/docs/Statement.md +21 -7
  153. data/docs/StatementPost.md +26 -0
  154. data/docs/StatementPostData.md +26 -0
  155. data/docs/StatementRep.md +26 -0
  156. data/docs/StatisticCollectionRep.md +20 -0
  157. data/docs/StatisticRep.md +30 -0
  158. data/docs/StatisticsRoot.md +20 -0
  159. data/docs/SubjectDataRep.md +22 -0
  160. data/docs/Target.md +15 -4
  161. data/docs/TargetResourceRep.md +22 -0
  162. data/docs/TitleRep.md +32 -0
  163. data/docs/Token.md +43 -17
  164. data/docs/TokenDataRep.md +26 -0
  165. data/docs/Tokens.md +15 -4
  166. data/docs/UrlPost.md +24 -0
  167. data/docs/User.md +25 -13
  168. data/docs/UserAttributeNamesRep.md +22 -0
  169. data/docs/UserFlagSetting.md +17 -5
  170. data/docs/UserFlagSettings.md +15 -4
  171. data/docs/UserRecord.md +21 -7
  172. data/docs/UserSegment.md +47 -14
  173. data/docs/UserSegmentRule.md +19 -5
  174. data/docs/UserSegments.md +15 -4
  175. data/docs/UserSettingsApi.md +217 -137
  176. data/docs/Users.md +17 -5
  177. data/docs/UsersApi.md +184 -115
  178. data/docs/UsersBetaApi.md +81 -0
  179. data/docs/ValuePut.md +20 -0
  180. data/docs/Variate.md +24 -0
  181. data/docs/Variation.md +19 -6
  182. data/docs/VariationOrRolloutRep.md +20 -0
  183. data/docs/VariationSummary.md +30 -0
  184. data/docs/VersionsRep.md +24 -0
  185. data/docs/Webhook.md +29 -10
  186. data/docs/WebhookPost.md +30 -0
  187. data/docs/Webhooks.md +15 -4
  188. data/docs/WebhooksApi.md +199 -103
  189. data/docs/WeightedVariation.md +17 -4
  190. data/git_push.sh +12 -10
  191. data/launchdarkly_api.gemspec +6 -14
  192. data/lib/launchdarkly_api/api/access_tokens_api.rb +190 -122
  193. data/lib/launchdarkly_api/api/account_members_api.rb +351 -0
  194. data/lib/launchdarkly_api/api/account_usage_beta_api.rb +598 -0
  195. data/lib/launchdarkly_api/api/approvals_api.rb +601 -0
  196. data/lib/launchdarkly_api/api/audit_log_api.rb +72 -51
  197. data/lib/launchdarkly_api/api/code_references_api.rb +898 -0
  198. data/lib/launchdarkly_api/api/custom_roles_api.rb +163 -106
  199. data/lib/launchdarkly_api/api/data_export_destinations_api.rb +202 -145
  200. data/lib/launchdarkly_api/api/environments_api.rb +197 -132
  201. data/lib/launchdarkly_api/api/experiments_beta_api.rb +188 -0
  202. data/lib/launchdarkly_api/api/feature_flags_api.rb +445 -1160
  203. data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -0
  204. data/lib/launchdarkly_api/api/metrics_api.rb +369 -0
  205. data/lib/launchdarkly_api/api/other_api.rb +248 -0
  206. data/lib/launchdarkly_api/api/projects_api.rb +147 -90
  207. data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +195 -127
  208. data/lib/launchdarkly_api/api/scheduled_changes_api.rb +435 -0
  209. data/lib/launchdarkly_api/api/segments_api.rb +719 -0
  210. data/lib/launchdarkly_api/api/user_settings_api.rb +237 -180
  211. data/lib/launchdarkly_api/api/users_api.rb +180 -138
  212. data/lib/launchdarkly_api/api/users_beta_api.rb +91 -0
  213. data/lib/launchdarkly_api/api/webhooks_api.rb +170 -113
  214. data/lib/launchdarkly_api/api_client.rb +87 -88
  215. data/lib/launchdarkly_api/api_error.rb +23 -4
  216. data/lib/launchdarkly_api/configuration.rb +83 -15
  217. data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +276 -0
  218. data/lib/launchdarkly_api/models/access_denied_rep.rb +237 -0
  219. data/lib/launchdarkly_api/models/access_rep.rb +225 -0
  220. data/lib/launchdarkly_api/models/access_token_post.rb +317 -0
  221. data/lib/launchdarkly_api/models/approval_settings.rb +331 -0
  222. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +420 -0
  223. data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +241 -0
  224. data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +481 -0
  225. data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +256 -0
  226. data/lib/launchdarkly_api/models/big_segment_target.rb +254 -0
  227. data/lib/launchdarkly_api/models/branch_collection_rep.rb +241 -0
  228. data/lib/launchdarkly_api/models/branch_rep.rb +267 -0
  229. data/lib/launchdarkly_api/models/clause.rb +78 -24
  230. data/lib/launchdarkly_api/models/client_side_availability.rb +65 -33
  231. data/lib/launchdarkly_api/models/client_side_availability_post.rb +237 -0
  232. data/lib/launchdarkly_api/models/confidence_interval_rep.rb +227 -0
  233. data/lib/launchdarkly_api/models/conflict.rb +230 -0
  234. data/lib/launchdarkly_api/models/copied_from_env.rb +233 -0
  235. data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +281 -0
  236. data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +297 -0
  237. data/lib/launchdarkly_api/models/custom_property.rb +59 -23
  238. data/lib/launchdarkly_api/models/custom_role.rb +101 -34
  239. data/lib/launchdarkly_api/models/custom_role_post.rb +265 -0
  240. data/lib/launchdarkly_api/models/custom_role_post_data.rb +265 -0
  241. data/lib/launchdarkly_api/models/custom_roles.rb +58 -22
  242. data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +237 -0
  243. data/lib/launchdarkly_api/models/defaults.rb +56 -25
  244. data/lib/launchdarkly_api/models/dependent_flag.rb +262 -0
  245. data/lib/launchdarkly_api/models/dependent_flag_environment.rb +262 -0
  246. data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +255 -0
  247. data/lib/launchdarkly_api/models/destination.rb +88 -47
  248. data/lib/launchdarkly_api/models/destination_post.rb +281 -0
  249. data/lib/launchdarkly_api/models/destinations.rb +58 -22
  250. data/lib/launchdarkly_api/models/environment.rb +144 -73
  251. data/lib/launchdarkly_api/models/environment_post.rb +90 -56
  252. data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +237 -0
  253. data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +227 -0
  254. data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +238 -0
  255. data/lib/launchdarkly_api/models/experiment_info_rep.rb +239 -0
  256. data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +219 -0
  257. data/lib/launchdarkly_api/models/experiment_rep.rb +249 -0
  258. data/lib/launchdarkly_api/models/experiment_results_rep.rb +271 -0
  259. data/lib/launchdarkly_api/models/experiment_stats_rep.rb +245 -0
  260. data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +229 -0
  261. data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +281 -0
  262. data/lib/launchdarkly_api/models/experiment_totals_rep.rb +281 -0
  263. data/lib/launchdarkly_api/models/expiring_user_target_error.rb +237 -0
  264. data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +236 -0
  265. data/lib/launchdarkly_api/models/expiring_user_target_item.rb +300 -0
  266. data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +274 -0
  267. data/lib/launchdarkly_api/models/extinction.rb +274 -0
  268. data/lib/launchdarkly_api/models/extinction_collection_rep.rb +241 -0
  269. data/lib/launchdarkly_api/models/extinction_rep.rb +279 -0
  270. data/lib/launchdarkly_api/models/feature_flag.rb +276 -123
  271. data/lib/launchdarkly_api/models/feature_flag_body.rb +105 -55
  272. data/lib/launchdarkly_api/models/feature_flag_config.rb +184 -55
  273. data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +142 -38
  274. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +73 -32
  275. data/lib/launchdarkly_api/models/feature_flag_status.rb +70 -71
  276. data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +71 -33
  277. data/lib/launchdarkly_api/models/feature_flag_statuses.rb +64 -23
  278. data/lib/launchdarkly_api/models/feature_flags.rb +78 -32
  279. data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +448 -0
  280. data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +242 -0
  281. data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +232 -0
  282. data/lib/launchdarkly_api/models/flag_copy_config_post.rb +290 -0
  283. data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +514 -0
  284. data/lib/launchdarkly_api/models/flag_listing_rep.rb +257 -0
  285. data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +234 -0
  286. data/lib/launchdarkly_api/models/flag_status_rep.rb +256 -0
  287. data/lib/launchdarkly_api/models/flag_summary.rb +223 -0
  288. data/lib/launchdarkly_api/models/hunk_rep.rb +256 -0
  289. data/lib/launchdarkly_api/models/inline_object.rb +274 -0
  290. data/lib/launchdarkly_api/models/inline_object1.rb +276 -0
  291. data/lib/launchdarkly_api/models/inline_response200.rb +227 -0
  292. data/lib/launchdarkly_api/models/integration_metadata.rb +265 -0
  293. data/lib/launchdarkly_api/models/integration_status.rb +237 -0
  294. data/lib/launchdarkly_api/models/ip_list.rb +241 -0
  295. data/lib/launchdarkly_api/models/last_seen_metadata.rb +219 -0
  296. data/lib/launchdarkly_api/models/link.rb +54 -20
  297. data/lib/launchdarkly_api/models/member.rb +213 -67
  298. data/lib/launchdarkly_api/models/member_data_rep.rb +256 -0
  299. data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +253 -0
  300. data/lib/launchdarkly_api/models/member_summary_rep.rb +285 -0
  301. data/lib/launchdarkly_api/models/member_team_summary_rep.rb +253 -0
  302. data/lib/launchdarkly_api/models/members.rb +78 -32
  303. data/lib/launchdarkly_api/models/metric_collection_rep.rb +231 -0
  304. data/lib/launchdarkly_api/models/metric_listing_rep.rb +444 -0
  305. data/lib/launchdarkly_api/models/metric_post.rb +368 -0
  306. data/lib/launchdarkly_api/models/metric_rep.rb +493 -0
  307. data/lib/launchdarkly_api/models/modification.rb +218 -0
  308. data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +248 -0
  309. data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +255 -0
  310. data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
  311. data/lib/launchdarkly_api/models/parent_resource_rep.rb +239 -0
  312. data/lib/launchdarkly_api/models/patch_operation.rb +59 -26
  313. data/lib/launchdarkly_api/models/patch_segment_instruction.rb +273 -0
  314. data/lib/launchdarkly_api/models/patch_segment_request.rb +236 -0
  315. data/lib/launchdarkly_api/models/patch_with_comment.rb +234 -0
  316. data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +218 -0
  317. data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +227 -0
  318. data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +248 -0
  319. data/lib/launchdarkly_api/models/prerequisite.rb +64 -20
  320. data/lib/launchdarkly_api/models/project.rb +120 -50
  321. data/lib/launchdarkly_api/models/project_listing_rep.rb +306 -0
  322. data/lib/launchdarkly_api/models/project_post.rb +281 -0
  323. data/lib/launchdarkly_api/models/projects.rb +70 -22
  324. data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +227 -0
  325. data/lib/launchdarkly_api/models/reference_rep.rb +238 -0
  326. data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +225 -0
  327. data/lib/launchdarkly_api/models/relay_auto_config_post.rb +240 -0
  328. data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +327 -0
  329. data/lib/launchdarkly_api/models/repository_collection_rep.rb +241 -0
  330. data/lib/launchdarkly_api/models/repository_post.rb +304 -0
  331. data/lib/launchdarkly_api/models/repository_rep.rb +342 -0
  332. data/lib/launchdarkly_api/models/resource_access.rb +228 -0
  333. data/lib/launchdarkly_api/models/resource_id_response.rb +254 -0
  334. data/lib/launchdarkly_api/models/review_response.rb +302 -0
  335. data/lib/launchdarkly_api/models/rollout.rb +89 -32
  336. data/lib/launchdarkly_api/models/rule.rb +77 -33
  337. data/lib/launchdarkly_api/models/sdk_list_rep.rb +241 -0
  338. data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +241 -0
  339. data/lib/launchdarkly_api/models/sdk_version_rep.rb +237 -0
  340. data/lib/launchdarkly_api/models/segment_body.rb +270 -0
  341. data/lib/launchdarkly_api/models/segment_metadata.rb +263 -0
  342. data/lib/launchdarkly_api/models/segment_user_list.rb +231 -0
  343. data/lib/launchdarkly_api/models/segment_user_state.rb +227 -0
  344. data/lib/launchdarkly_api/models/series_list_rep.rb +257 -0
  345. data/lib/launchdarkly_api/models/source_flag.rb +233 -0
  346. data/lib/launchdarkly_api/models/statement.rb +66 -63
  347. data/lib/launchdarkly_api/models/statement_post.rb +271 -0
  348. data/lib/launchdarkly_api/models/statement_post_data.rb +271 -0
  349. data/lib/launchdarkly_api/models/statement_rep.rb +266 -0
  350. data/lib/launchdarkly_api/models/statistic_collection_rep.rb +241 -0
  351. data/lib/launchdarkly_api/models/statistic_rep.rb +309 -0
  352. data/lib/launchdarkly_api/models/statistics_root.rb +229 -0
  353. data/lib/launchdarkly_api/models/subject_data_rep.rb +238 -0
  354. data/lib/launchdarkly_api/models/target.rb +64 -20
  355. data/lib/launchdarkly_api/models/target_resource_rep.rb +240 -0
  356. data/lib/launchdarkly_api/models/title_rep.rb +281 -0
  357. data/lib/launchdarkly_api/models/token.rb +159 -93
  358. data/lib/launchdarkly_api/models/token_data_rep.rb +256 -0
  359. data/lib/launchdarkly_api/models/tokens.rb +68 -32
  360. data/lib/launchdarkly_api/models/url_post.rb +279 -0
  361. data/lib/launchdarkly_api/models/user.rb +97 -96
  362. data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +245 -0
  363. data/lib/launchdarkly_api/models/user_flag_setting.rb +68 -27
  364. data/lib/launchdarkly_api/models/user_flag_settings.rb +78 -32
  365. data/lib/launchdarkly_api/models/user_record.rb +69 -34
  366. data/lib/launchdarkly_api/models/user_segment.rb +186 -69
  367. data/lib/launchdarkly_api/models/user_segment_rule.rb +71 -23
  368. data/lib/launchdarkly_api/models/user_segments.rb +78 -32
  369. data/lib/launchdarkly_api/models/users.rb +72 -26
  370. data/lib/launchdarkly_api/models/value_put.rb +229 -0
  371. data/lib/launchdarkly_api/models/variate.rb +246 -0
  372. data/lib/launchdarkly_api/models/variation.rb +70 -38
  373. data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +227 -0
  374. data/lib/launchdarkly_api/models/variation_summary.rb +287 -0
  375. data/lib/launchdarkly_api/models/versions_rep.rb +262 -0
  376. data/lib/launchdarkly_api/models/webhook.rb +120 -55
  377. data/lib/launchdarkly_api/models/webhook_post.rb +297 -0
  378. data/lib/launchdarkly_api/models/webhooks.rb +68 -22
  379. data/lib/launchdarkly_api/models/weighted_variation.rb +77 -24
  380. data/lib/launchdarkly_api/version.rb +5 -5
  381. data/lib/launchdarkly_api.rb +134 -93
  382. data/spec/api/access_tokens_api_spec.rb +23 -17
  383. data/spec/api/account_members_api_spec.rb +99 -0
  384. data/spec/api/account_usage_beta_api_spec.rb +156 -0
  385. data/spec/api/approvals_api_spec.rb +141 -0
  386. data/spec/api/audit_log_api_spec.rb +19 -17
  387. data/spec/api/code_references_api_spec.rb +206 -0
  388. data/spec/api/custom_roles_api_spec.rb +23 -18
  389. data/spec/api/data_export_destinations_api_spec.rb +30 -25
  390. data/spec/api/environments_api_spec.rb +31 -26
  391. data/spec/api/experiments_beta_api_spec.rb +67 -0
  392. data/spec/api/feature_flags_api_spec.rb +70 -228
  393. data/spec/api/feature_flags_beta_api_spec.rb +62 -0
  394. data/spec/api/metrics_api_spec.rb +100 -0
  395. data/spec/api/other_api_spec.rb +79 -0
  396. data/spec/api/projects_api_spec.rb +22 -17
  397. data/spec/api/relay_proxy_configurations_api_spec.rb +37 -31
  398. data/spec/api/scheduled_changes_api_spec.rb +112 -0
  399. data/spec/api/segments_api_spec.rb +164 -0
  400. data/spec/api/user_settings_api_spec.rb +41 -36
  401. data/spec/api/users_api_spec.rb +33 -29
  402. data/spec/api/users_beta_api_spec.rb +48 -0
  403. data/spec/api/webhooks_api_spec.rb +27 -22
  404. data/spec/api_client_spec.rb +5 -22
  405. data/spec/configuration_spec.rb +7 -7
  406. data/spec/models/access_denied_reason_rep_spec.rb +64 -0
  407. data/spec/models/access_denied_rep_spec.rb +40 -0
  408. data/spec/models/access_rep_spec.rb +34 -0
  409. data/spec/models/access_token_post_spec.rb +74 -0
  410. data/spec/models/approval_settings_spec.rb +76 -0
  411. data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +40 -0
  412. data/spec/models/audit_log_entry_listing_rep_spec.rb +136 -0
  413. data/spec/models/audit_log_entry_rep_spec.rb +172 -0
  414. data/spec/models/authorized_app_data_rep_spec.rb +58 -0
  415. data/spec/models/big_segment_target_spec.rb +46 -0
  416. data/spec/models/branch_collection_rep_spec.rb +40 -0
  417. data/spec/models/branch_rep_spec.rb +64 -0
  418. data/spec/models/clause_spec.rb +8 -15
  419. data/spec/models/client_side_availability_post_spec.rb +40 -0
  420. data/spec/models/client_side_availability_spec.rb +10 -17
  421. data/spec/models/confidence_interval_rep_spec.rb +40 -0
  422. data/spec/models/conflict_spec.rb +40 -0
  423. data/spec/models/copied_from_env_spec.rb +40 -0
  424. data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +64 -0
  425. data/spec/models/create_flag_config_approval_request_request_spec.rb +70 -0
  426. data/spec/models/custom_property_spec.rb +8 -15
  427. data/spec/models/custom_role_post_data_spec.rb +52 -0
  428. data/spec/models/custom_role_post_spec.rb +52 -0
  429. data/spec/models/custom_role_spec.rb +14 -15
  430. data/spec/models/custom_roles_spec.rb +8 -15
  431. data/spec/models/default_client_side_availability_post_spec.rb +40 -0
  432. data/spec/models/defaults_spec.rb +8 -15
  433. data/spec/models/dependent_flag_environment_spec.rb +52 -0
  434. data/spec/models/dependent_flag_spec.rb +52 -0
  435. data/spec/models/dependent_flags_by_environment_spec.rb +46 -0
  436. data/spec/models/destination_post_spec.rb +56 -0
  437. data/spec/models/destination_spec.rb +19 -20
  438. data/spec/models/destinations_spec.rb +8 -15
  439. data/spec/models/environment_post_spec.rb +10 -17
  440. data/spec/models/environment_spec.rb +8 -27
  441. data/spec/models/experiment_allocation_rep_spec.rb +40 -0
  442. data/spec/models/experiment_enabled_period_rep_spec.rb +40 -0
  443. data/spec/models/experiment_environment_setting_rep_spec.rb +46 -0
  444. data/spec/models/experiment_info_rep_spec.rb +40 -0
  445. data/spec/models/experiment_metadata_rep_spec.rb +34 -0
  446. data/spec/models/experiment_rep_spec.rb +52 -0
  447. data/spec/models/experiment_results_rep_spec.rb +64 -0
  448. data/spec/models/experiment_stats_rep_spec.rb +52 -0
  449. data/spec/models/experiment_time_series_slice_spec.rb +40 -0
  450. data/spec/models/experiment_time_series_variation_slice_spec.rb +76 -0
  451. data/spec/models/experiment_totals_rep_spec.rb +76 -0
  452. data/spec/models/expiring_user_target_error_spec.rb +40 -0
  453. data/spec/models/expiring_user_target_get_response_spec.rb +40 -0
  454. data/spec/models/expiring_user_target_item_spec.rb +70 -0
  455. data/spec/models/expiring_user_target_patch_response_spec.rb +64 -0
  456. data/spec/models/extinction_collection_rep_spec.rb +40 -0
  457. data/spec/models/extinction_rep_spec.rb +58 -0
  458. data/spec/models/extinction_spec.rb +58 -0
  459. data/spec/models/feature_flag_body_spec.rb +24 -19
  460. data/spec/models/feature_flag_config_spec.rb +28 -17
  461. data/spec/models/feature_flag_scheduled_change_spec.rb +34 -17
  462. data/spec/models/feature_flag_scheduled_changes_spec.rb +10 -17
  463. data/spec/models/feature_flag_spec.rb +39 -30
  464. data/spec/models/feature_flag_status_across_environments_spec.rb +10 -17
  465. data/spec/models/feature_flag_status_spec.rb +8 -25
  466. data/spec/models/feature_flag_statuses_spec.rb +8 -15
  467. data/spec/models/feature_flags_spec.rb +10 -17
  468. data/spec/models/flag_config_approval_request_response_spec.rb +142 -0
  469. data/spec/models/flag_config_approval_requests_response_spec.rb +40 -0
  470. data/spec/models/flag_copy_config_environment_spec.rb +40 -0
  471. data/spec/models/flag_copy_config_post_spec.rb +66 -0
  472. data/spec/models/flag_global_attributes_rep_spec.rb +158 -0
  473. data/spec/models/flag_listing_rep_spec.rb +52 -0
  474. data/spec/models/flag_scheduled_changes_input_spec.rb +40 -0
  475. data/spec/models/flag_status_rep_spec.rb +52 -0
  476. data/spec/models/flag_summary_spec.rb +34 -0
  477. data/spec/models/hunk_rep_spec.rb +58 -0
  478. data/spec/models/inline_object1_spec.rb +64 -0
  479. data/spec/models/inline_object_spec.rb +58 -0
  480. data/spec/models/inline_response200_spec.rb +40 -0
  481. data/spec/models/integration_metadata_spec.rb +52 -0
  482. data/spec/models/integration_status_spec.rb +40 -0
  483. data/spec/models/ip_list_spec.rb +40 -0
  484. data/spec/models/last_seen_metadata_spec.rb +34 -0
  485. data/spec/models/link_spec.rb +8 -15
  486. data/spec/models/member_data_rep_spec.rb +58 -0
  487. data/spec/models/member_permission_grant_summary_rep_spec.rb +46 -0
  488. data/spec/models/member_spec.rb +44 -21
  489. data/spec/models/member_summary_rep_spec.rb +64 -0
  490. data/spec/models/member_team_summary_rep_spec.rb +46 -0
  491. data/spec/models/members_spec.rb +10 -17
  492. data/spec/models/metric_collection_rep_spec.rb +40 -0
  493. data/spec/models/metric_listing_rep_spec.rb +140 -0
  494. data/spec/models/metric_post_spec.rb +104 -0
  495. data/spec/models/metric_rep_spec.rb +170 -0
  496. data/spec/models/modification_spec.rb +34 -0
  497. data/spec/models/multi_environment_dependent_flag_spec.rb +46 -0
  498. data/spec/models/multi_environment_dependent_flags_spec.rb +46 -0
  499. data/spec/models/new_member_form_spec.rb +64 -0
  500. data/spec/models/parent_resource_rep_spec.rb +46 -0
  501. data/spec/models/patch_operation_spec.rb +8 -15
  502. data/spec/models/patch_segment_instruction_spec.rb +58 -0
  503. data/spec/models/patch_segment_request_spec.rb +40 -0
  504. data/spec/models/patch_with_comment_spec.rb +40 -0
  505. data/spec/models/post_approval_request_apply_request_spec.rb +34 -0
  506. data/spec/models/post_approval_request_review_request_spec.rb +40 -0
  507. data/spec/models/post_flag_scheduled_changes_input_spec.rb +46 -0
  508. data/spec/models/prerequisite_spec.rb +8 -15
  509. data/spec/models/project_listing_rep_spec.rb +70 -0
  510. data/spec/models/project_post_spec.rb +64 -0
  511. data/spec/models/project_spec.rb +12 -19
  512. data/spec/models/projects_spec.rb +8 -15
  513. data/spec/models/pub_nub_detail_rep_spec.rb +40 -0
  514. data/spec/models/reference_rep_spec.rb +46 -0
  515. data/spec/models/relay_auto_config_collection_rep_spec.rb +34 -0
  516. data/spec/models/relay_auto_config_post_spec.rb +40 -0
  517. data/spec/models/relay_auto_config_rep_spec.rb +82 -0
  518. data/spec/models/repository_collection_rep_spec.rb +40 -0
  519. data/spec/models/repository_post_spec.rb +68 -0
  520. data/spec/models/repository_rep_spec.rb +94 -0
  521. data/spec/models/resource_access_spec.rb +40 -0
  522. data/spec/models/resource_id_response_spec.rb +58 -0
  523. data/spec/models/review_response_spec.rb +62 -0
  524. data/spec/models/rollout_spec.rb +22 -17
  525. data/spec/models/rule_spec.rb +11 -18
  526. data/spec/models/sdk_list_rep_spec.rb +40 -0
  527. data/spec/models/sdk_version_list_rep_spec.rb +40 -0
  528. data/spec/models/sdk_version_rep_spec.rb +40 -0
  529. data/spec/models/segment_body_spec.rb +58 -0
  530. data/spec/models/segment_metadata_spec.rb +64 -0
  531. data/spec/models/segment_user_list_spec.rb +40 -0
  532. data/spec/models/segment_user_state_spec.rb +40 -0
  533. data/spec/models/series_list_rep_spec.rb +46 -0
  534. data/spec/models/source_flag_spec.rb +40 -0
  535. data/spec/models/statement_post_data_spec.rb +58 -0
  536. data/spec/models/statement_post_spec.rb +58 -0
  537. data/spec/models/statement_rep_spec.rb +58 -0
  538. data/spec/models/statement_spec.rb +8 -19
  539. data/spec/models/statistic_collection_rep_spec.rb +40 -0
  540. data/spec/models/statistic_rep_spec.rb +70 -0
  541. data/spec/models/statistics_root_spec.rb +40 -0
  542. data/spec/models/subject_data_rep_spec.rb +46 -0
  543. data/spec/models/target_resource_rep_spec.rb +46 -0
  544. data/spec/models/target_spec.rb +8 -15
  545. data/spec/models/title_rep_spec.rb +76 -0
  546. data/spec/models/token_data_rep_spec.rb +58 -0
  547. data/spec/models/token_spec.rb +27 -28
  548. data/spec/models/tokens_spec.rb +10 -17
  549. data/spec/models/url_post_spec.rb +56 -0
  550. data/spec/models/user_attribute_names_rep_spec.rb +46 -0
  551. data/spec/models/user_flag_setting_spec.rb +8 -15
  552. data/spec/models/user_flag_settings_spec.rb +10 -17
  553. data/spec/models/user_record_spec.rb +9 -16
  554. data/spec/models/user_segment_rule_spec.rb +14 -15
  555. data/spec/models/user_segment_spec.rb +52 -23
  556. data/spec/models/user_segments_spec.rb +10 -17
  557. data/spec/models/user_spec.rb +15 -46
  558. data/spec/models/users_spec.rb +8 -15
  559. data/spec/models/value_put_spec.rb +40 -0
  560. data/spec/models/variate_spec.rb +52 -0
  561. data/spec/models/variation_or_rollout_rep_spec.rb +40 -0
  562. data/spec/models/variation_spec.rb +10 -17
  563. data/spec/models/variation_summary_spec.rb +70 -0
  564. data/spec/models/versions_rep_spec.rb +52 -0
  565. data/spec/models/webhook_post_spec.rb +70 -0
  566. data/spec/models/webhook_spec.rb +18 -19
  567. data/spec/models/webhooks_spec.rb +8 -15
  568. data/spec/models/weighted_variation_spec.rb +14 -15
  569. data/spec/spec_helper.rb +4 -4
  570. metadata +831 -562
  571. data/docs/ApprovalRequest.md +0 -20
  572. data/docs/ApprovalRequestApplyConfigBody.md +0 -8
  573. data/docs/ApprovalRequestConfigBody.md +0 -13
  574. data/docs/ApprovalRequestReview.md +0 -11
  575. data/docs/ApprovalRequestReviewConfigBody.md +0 -9
  576. data/docs/ApprovalRequestReviewStatus.md +0 -7
  577. data/docs/ApprovalRequests.md +0 -9
  578. data/docs/AuditLogEntries.md +0 -9
  579. data/docs/AuditLogEntry.md +0 -19
  580. data/docs/AuditLogEntryTarget.md +0 -10
  581. data/docs/BigSegmentTargetChanges.md +0 -9
  582. data/docs/BigSegmentTargetsBody.md +0 -9
  583. data/docs/CopyActions.md +0 -7
  584. data/docs/CustomPropertyValues.md +0 -7
  585. data/docs/CustomRoleBody.md +0 -11
  586. data/docs/CustomerMetricsApi.md +0 -511
  587. data/docs/DestinationAmazonKinesis.md +0 -10
  588. data/docs/DestinationBody.md +0 -11
  589. data/docs/DestinationGooglePubSub.md +0 -9
  590. data/docs/DestinationMParticle.md +0 -11
  591. data/docs/DestinationSegment.md +0 -8
  592. data/docs/EnvironmentApprovalSettings.md +0 -12
  593. data/docs/EvaluationUsageError.md +0 -9
  594. data/docs/Events.md +0 -8
  595. data/docs/Fallthrough.md +0 -9
  596. data/docs/FeatureFlagCopyBody.md +0 -12
  597. data/docs/FeatureFlagCopyObject.md +0 -9
  598. data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
  599. data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
  600. data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
  601. data/docs/FeatureFlagStatusLinks.md +0 -9
  602. data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
  603. data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
  604. data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
  605. data/docs/FlagListItem.md +0 -11
  606. data/docs/HierarchicalLinks.md +0 -9
  607. data/docs/Id.md +0 -7
  608. data/docs/Integration.md +0 -9
  609. data/docs/IntegrationLinks.md +0 -8
  610. data/docs/IntegrationSubscription.md +0 -16
  611. data/docs/IntegrationSubscriptionStatus.md +0 -10
  612. data/docs/Integrations.md +0 -9
  613. data/docs/IntegrationsApi.md +0 -334
  614. data/docs/Links.md +0 -9
  615. data/docs/MAU.md +0 -10
  616. data/docs/MAUMetadata.md +0 -7
  617. data/docs/MAUbyCategory.md +0 -10
  618. data/docs/MemberLastSeenMetadata.md +0 -8
  619. data/docs/MembersBody.md +0 -13
  620. data/docs/PatchComment.md +0 -9
  621. data/docs/Policy.md +0 -12
  622. data/docs/ProjectBody.md +0 -13
  623. data/docs/RelayProxyConfig.md +0 -15
  624. data/docs/RelayProxyConfigBody.md +0 -9
  625. data/docs/RelayProxyConfigs.md +0 -8
  626. data/docs/Role.md +0 -7
  627. data/docs/RootApi.md +0 -56
  628. data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
  629. data/docs/SemanticPatchInstruction.md +0 -7
  630. data/docs/SemanticPatchInstructionInner.md +0 -8
  631. data/docs/SemanticPatchOperation.md +0 -9
  632. data/docs/Site.md +0 -9
  633. data/docs/Stream.md +0 -10
  634. data/docs/StreamBySDK.md +0 -10
  635. data/docs/StreamBySDKLinks.md +0 -9
  636. data/docs/StreamBySDKLinksMetadata.md +0 -10
  637. data/docs/StreamLinks.md +0 -10
  638. data/docs/StreamSDKVersion.md +0 -9
  639. data/docs/StreamSDKVersionData.md +0 -9
  640. data/docs/StreamUsageError.md +0 -9
  641. data/docs/StreamUsageLinks.md +0 -10
  642. data/docs/StreamUsageMetadata.md +0 -10
  643. data/docs/StreamUsageSeries.md +0 -9
  644. data/docs/Streams.md +0 -8
  645. data/docs/SubscriptionBody.md +0 -12
  646. data/docs/TeamMembersApi.md +0 -329
  647. data/docs/TokenBody.md +0 -13
  648. data/docs/Usage.md +0 -9
  649. data/docs/UsageError.md +0 -8
  650. data/docs/UsageLinks.md +0 -10
  651. data/docs/UserSegmentBody.md +0 -12
  652. data/docs/UserSegmentsApi.md +0 -488
  653. data/docs/UserSettingsBody.md +0 -8
  654. data/docs/UserTargetingExpirationForFlag.md +0 -14
  655. data/docs/UserTargetingExpirationForFlags.md +0 -9
  656. data/docs/UserTargetingExpirationForSegment.md +0 -14
  657. data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
  658. data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
  659. data/docs/WebhookBody.md +0 -14
  660. data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
  661. data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
  662. data/lib/launchdarkly_api/api/root_api.rb +0 -69
  663. data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
  664. data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
  665. data/lib/launchdarkly_api/models/approval_request.rb +0 -337
  666. data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
  667. data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
  668. data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
  669. data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
  670. data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
  671. data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
  672. data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
  673. data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
  674. data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
  675. data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
  676. data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
  677. data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
  678. data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
  679. data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
  680. data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
  681. data/lib/launchdarkly_api/models/destination_body.rb +0 -264
  682. data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
  683. data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
  684. data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
  685. data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -260
  686. data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
  687. data/lib/launchdarkly_api/models/events.rb +0 -184
  688. data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
  689. data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
  690. data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
  691. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
  692. data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
  693. data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
  694. data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
  695. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
  696. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
  697. data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
  698. data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
  699. data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
  700. data/lib/launchdarkly_api/models/id.rb +0 -176
  701. data/lib/launchdarkly_api/models/integration.rb +0 -195
  702. data/lib/launchdarkly_api/models/integration__links.rb +0 -184
  703. data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
  704. data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
  705. data/lib/launchdarkly_api/models/integrations.rb +0 -196
  706. data/lib/launchdarkly_api/models/links.rb +0 -193
  707. data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
  708. data/lib/launchdarkly_api/models/mau.rb +0 -206
  709. data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
  710. data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
  711. data/lib/launchdarkly_api/models/members_body.rb +0 -238
  712. data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
  713. data/lib/launchdarkly_api/models/policy.rb +0 -231
  714. data/lib/launchdarkly_api/models/project_body.rb +0 -243
  715. data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
  716. data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
  717. data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
  718. data/lib/launchdarkly_api/models/role.rb +0 -32
  719. data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
  720. data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
  721. data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
  722. data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
  723. data/lib/launchdarkly_api/models/site.rb +0 -193
  724. data/lib/launchdarkly_api/models/stream.rb +0 -206
  725. data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
  726. data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
  727. data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
  728. data/lib/launchdarkly_api/models/stream_links.rb +0 -205
  729. data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
  730. data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
  731. data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
  732. data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
  733. data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
  734. data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
  735. data/lib/launchdarkly_api/models/streams.rb +0 -184
  736. data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
  737. data/lib/launchdarkly_api/models/token_body.rb +0 -238
  738. data/lib/launchdarkly_api/models/usage.rb +0 -195
  739. data/lib/launchdarkly_api/models/usage_error.rb +0 -184
  740. data/lib/launchdarkly_api/models/usage_links.rb +0 -205
  741. data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
  742. data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
  743. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
  744. data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
  745. data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
  746. data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
  747. data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
  748. data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
  749. data/openapi.yml +0 -4719
  750. data/spec/api/customer_metrics_api_spec.rb +0 -141
  751. data/spec/api/integrations_api_spec.rb +0 -105
  752. data/spec/api/root_api_spec.rb +0 -45
  753. data/spec/api/team_members_api_spec.rb +0 -104
  754. data/spec/api/user_segments_api_spec.rb +0 -142
  755. data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
  756. data/spec/models/approval_request_config_body_spec.rb +0 -71
  757. data/spec/models/approval_request_review_config_body_spec.rb +0 -51
  758. data/spec/models/approval_request_review_spec.rb +0 -59
  759. data/spec/models/approval_request_review_status_spec.rb +0 -35
  760. data/spec/models/approval_request_spec.rb +0 -117
  761. data/spec/models/approval_requests_spec.rb +0 -47
  762. data/spec/models/audit_log_entries_spec.rb +0 -47
  763. data/spec/models/audit_log_entry_spec.rb +0 -107
  764. data/spec/models/audit_log_entry_target_spec.rb +0 -53
  765. data/spec/models/big_segment_target_changes_spec.rb +0 -47
  766. data/spec/models/big_segment_targets_body_spec.rb +0 -47
  767. data/spec/models/copy_actions_spec.rb +0 -35
  768. data/spec/models/custom_property_values_spec.rb +0 -35
  769. data/spec/models/custom_role_body_spec.rb +0 -59
  770. data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
  771. data/spec/models/destination_body_spec.rb +0 -63
  772. data/spec/models/destination_google_pub_sub_spec.rb +0 -47
  773. data/spec/models/destination_m_particle_spec.rb +0 -59
  774. data/spec/models/destination_segment_spec.rb +0 -41
  775. data/spec/models/environment_approval_settings_spec.rb +0 -69
  776. data/spec/models/evaluation_usage_error_spec.rb +0 -47
  777. data/spec/models/events_spec.rb +0 -41
  778. data/spec/models/fallthrough_spec.rb +0 -47
  779. data/spec/models/feature_flag_copy_body_spec.rb +0 -65
  780. data/spec/models/feature_flag_copy_object_spec.rb +0 -47
  781. data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
  782. data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
  783. data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
  784. data/spec/models/feature_flag_status_links_spec.rb +0 -47
  785. data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
  786. data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
  787. data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
  788. data/spec/models/flag_list_item_spec.rb +0 -59
  789. data/spec/models/hierarchical_links_spec.rb +0 -47
  790. data/spec/models/id_spec.rb +0 -35
  791. data/spec/models/integration__links_spec.rb +0 -41
  792. data/spec/models/integration_spec.rb +0 -47
  793. data/spec/models/integration_subscription__status_spec.rb +0 -53
  794. data/spec/models/integration_subscription_spec.rb +0 -89
  795. data/spec/models/integrations_spec.rb +0 -47
  796. data/spec/models/links_spec.rb +0 -47
  797. data/spec/models/ma_uby_category_spec.rb +0 -53
  798. data/spec/models/mau_metadata_spec.rb +0 -35
  799. data/spec/models/mau_spec.rb +0 -53
  800. data/spec/models/member__last_seen_metadata_spec.rb +0 -41
  801. data/spec/models/members_body_spec.rb +0 -71
  802. data/spec/models/patch_comment_spec.rb +0 -47
  803. data/spec/models/policy_spec.rb +0 -65
  804. data/spec/models/project_body_spec.rb +0 -71
  805. data/spec/models/relay_proxy_config_body_spec.rb +0 -47
  806. data/spec/models/relay_proxy_config_spec.rb +0 -83
  807. data/spec/models/relay_proxy_configs_spec.rb +0 -41
  808. data/spec/models/role_spec.rb +0 -35
  809. data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +0 -47
  810. data/spec/models/semantic_patch_instruction_inner_spec.rb +0 -41
  811. data/spec/models/semantic_patch_instruction_spec.rb +0 -35
  812. data/spec/models/semantic_patch_operation_spec.rb +0 -47
  813. data/spec/models/site_spec.rb +0 -47
  814. data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
  815. data/spec/models/stream_by_sdk_links_spec.rb +0 -47
  816. data/spec/models/stream_by_sdk_spec.rb +0 -53
  817. data/spec/models/stream_links_spec.rb +0 -53
  818. data/spec/models/stream_sdk_version_data_spec.rb +0 -47
  819. data/spec/models/stream_sdk_version_spec.rb +0 -47
  820. data/spec/models/stream_spec.rb +0 -53
  821. data/spec/models/stream_usage_error_spec.rb +0 -47
  822. data/spec/models/stream_usage_links_spec.rb +0 -53
  823. data/spec/models/stream_usage_metadata_spec.rb +0 -53
  824. data/spec/models/stream_usage_series_spec.rb +0 -47
  825. data/spec/models/streams_spec.rb +0 -41
  826. data/spec/models/subscription_body_spec.rb +0 -65
  827. data/spec/models/token_body_spec.rb +0 -71
  828. data/spec/models/usage_error_spec.rb +0 -41
  829. data/spec/models/usage_links_spec.rb +0 -53
  830. data/spec/models/usage_spec.rb +0 -47
  831. data/spec/models/user_segment_body_spec.rb +0 -65
  832. data/spec/models/user_settings_body_spec.rb +0 -41
  833. data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
  834. data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
  835. data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
  836. data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
  837. data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
  838. data/spec/models/webhook_body_spec.rb +0 -77
@@ -0,0 +1,188 @@
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 ExperimentsBetaApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get experiment results
23
+ # Get detailed experiment result data
24
+ # @param proj_key [String] The project key
25
+ # @param flag_key [String] The flag key
26
+ # @param env_key [String] The environment key
27
+ # @param metric_key [String] The metric key
28
+ # @param [Hash] opts the optional parameters
29
+ # @option opts [Integer] :from A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds.
30
+ # @option opts [Integer] :to A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds.
31
+ # @return [ExperimentResultsRep]
32
+ def get_experiment(proj_key, flag_key, env_key, metric_key, opts = {})
33
+ data, _status_code, _headers = get_experiment_with_http_info(proj_key, flag_key, env_key, metric_key, opts)
34
+ data
35
+ end
36
+
37
+ # Get experiment results
38
+ # Get detailed experiment result data
39
+ # @param proj_key [String] The project key
40
+ # @param flag_key [String] The flag key
41
+ # @param env_key [String] The environment key
42
+ # @param metric_key [String] The metric key
43
+ # @param [Hash] opts the optional parameters
44
+ # @option opts [Integer] :from A timestamp denoting the start of the data collection period, expressed as a Unix epoch time in milliseconds.
45
+ # @option opts [Integer] :to A timestamp denoting the end of the data collection period, expressed as a Unix epoch time in milliseconds.
46
+ # @return [Array<(ExperimentResultsRep, Integer, Hash)>] ExperimentResultsRep data, response status code and response headers
47
+ def get_experiment_with_http_info(proj_key, flag_key, env_key, metric_key, opts = {})
48
+ if @api_client.config.debugging
49
+ @api_client.config.logger.debug 'Calling API: ExperimentsBetaApi.get_experiment ...'
50
+ end
51
+ # verify the required parameter 'proj_key' is set
52
+ if @api_client.config.client_side_validation && proj_key.nil?
53
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling ExperimentsBetaApi.get_experiment"
54
+ end
55
+ # verify the required parameter 'flag_key' is set
56
+ if @api_client.config.client_side_validation && flag_key.nil?
57
+ fail ArgumentError, "Missing the required parameter 'flag_key' when calling ExperimentsBetaApi.get_experiment"
58
+ end
59
+ # verify the required parameter 'env_key' is set
60
+ if @api_client.config.client_side_validation && env_key.nil?
61
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling ExperimentsBetaApi.get_experiment"
62
+ end
63
+ # verify the required parameter 'metric_key' is set
64
+ if @api_client.config.client_side_validation && metric_key.nil?
65
+ fail ArgumentError, "Missing the required parameter 'metric_key' when calling ExperimentsBetaApi.get_experiment"
66
+ end
67
+ # resource path
68
+ local_var_path = '/api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'metricKey' + '}', CGI.escape(metric_key.to_s))
69
+
70
+ # query parameters
71
+ query_params = opts[:query_params] || {}
72
+ query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
73
+ query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
74
+
75
+ # header parameters
76
+ header_params = opts[:header_params] || {}
77
+ # HTTP header 'Accept' (if needed)
78
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
79
+
80
+ # form parameters
81
+ form_params = opts[:form_params] || {}
82
+
83
+ # http body (model)
84
+ post_body = opts[:debug_body]
85
+
86
+ # return_type
87
+ return_type = opts[:debug_return_type] || 'ExperimentResultsRep'
88
+
89
+ # auth_names
90
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
91
+
92
+ new_options = opts.merge(
93
+ :operation => :"ExperimentsBetaApi.get_experiment",
94
+ :header_params => header_params,
95
+ :query_params => query_params,
96
+ :form_params => form_params,
97
+ :body => post_body,
98
+ :auth_names => auth_names,
99
+ :return_type => return_type
100
+ )
101
+
102
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
103
+ if @api_client.config.debugging
104
+ @api_client.config.logger.debug "API called: ExperimentsBetaApi#get_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
105
+ end
106
+ return data, status_code, headers
107
+ end
108
+
109
+ # Reset experiment results
110
+ # Reset all experiment results by deleting all existing data for an experiment
111
+ # @param proj_key [String] The project key
112
+ # @param flag_key [String] The feature flag&#39;s key
113
+ # @param env_key [String] The environment key
114
+ # @param metric_key [String] The metric&#39;s key
115
+ # @param [Hash] opts the optional parameters
116
+ # @return [nil]
117
+ def reset_experiment(proj_key, flag_key, env_key, metric_key, opts = {})
118
+ reset_experiment_with_http_info(proj_key, flag_key, env_key, metric_key, opts)
119
+ nil
120
+ end
121
+
122
+ # Reset experiment results
123
+ # Reset all experiment results by deleting all existing data for an experiment
124
+ # @param proj_key [String] The project key
125
+ # @param flag_key [String] The feature flag&#39;s key
126
+ # @param env_key [String] The environment key
127
+ # @param metric_key [String] The metric&#39;s key
128
+ # @param [Hash] opts the optional parameters
129
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
130
+ def reset_experiment_with_http_info(proj_key, flag_key, env_key, metric_key, opts = {})
131
+ if @api_client.config.debugging
132
+ @api_client.config.logger.debug 'Calling API: ExperimentsBetaApi.reset_experiment ...'
133
+ end
134
+ # verify the required parameter 'proj_key' is set
135
+ if @api_client.config.client_side_validation && proj_key.nil?
136
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling ExperimentsBetaApi.reset_experiment"
137
+ end
138
+ # verify the required parameter 'flag_key' is set
139
+ if @api_client.config.client_side_validation && flag_key.nil?
140
+ fail ArgumentError, "Missing the required parameter 'flag_key' when calling ExperimentsBetaApi.reset_experiment"
141
+ end
142
+ # verify the required parameter 'env_key' is set
143
+ if @api_client.config.client_side_validation && env_key.nil?
144
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling ExperimentsBetaApi.reset_experiment"
145
+ end
146
+ # verify the required parameter 'metric_key' is set
147
+ if @api_client.config.client_side_validation && metric_key.nil?
148
+ fail ArgumentError, "Missing the required parameter 'metric_key' when calling ExperimentsBetaApi.reset_experiment"
149
+ end
150
+ # resource path
151
+ local_var_path = '/api/v2/flags/{projKey}/{flagKey}/experiments/{envKey}/{metricKey}/results'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'metricKey' + '}', CGI.escape(metric_key.to_s))
152
+
153
+ # query parameters
154
+ query_params = opts[:query_params] || {}
155
+
156
+ # header parameters
157
+ header_params = opts[:header_params] || {}
158
+
159
+ # form parameters
160
+ form_params = opts[:form_params] || {}
161
+
162
+ # http body (model)
163
+ post_body = opts[:debug_body]
164
+
165
+ # return_type
166
+ return_type = opts[:debug_return_type]
167
+
168
+ # auth_names
169
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
170
+
171
+ new_options = opts.merge(
172
+ :operation => :"ExperimentsBetaApi.reset_experiment",
173
+ :header_params => header_params,
174
+ :query_params => query_params,
175
+ :form_params => form_params,
176
+ :body => post_body,
177
+ :auth_names => auth_names,
178
+ :return_type => return_type
179
+ )
180
+
181
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
182
+ if @api_client.config.debugging
183
+ @api_client.config.logger.debug "API called: ExperimentsBetaApi#reset_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
184
+ end
185
+ return data, status_code, headers
186
+ end
187
+ end
188
+ end
@@ -1,16 +1,16 @@
1
1
  =begin
2
2
  #LaunchDarkly REST API
3
3
 
4
- #Build custom integrations with the LaunchDarkly REST API
4
+ ## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > ### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ## Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. # Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ## Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ## Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. # Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](http://tools.ietf.org/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ## Updates via JSON Patch [JSON Patch](http://tools.ietf.org/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ## Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ## Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ## Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-Settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsOnSegment) # Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ## HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | # CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. # Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ## Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ## IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. # OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. # Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). # Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. # Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ## Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` # Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ## Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ## Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
5
5
 
6
- OpenAPI spec version: 5.0.3
6
+ The version of the OpenAPI document: 2.0
7
7
  Contact: support@launchdarkly.com
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.17
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.3.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
- require 'uri'
13
+ require 'cgi'
14
14
 
15
15
  module LaunchDarklyApi
16
16
  class FeatureFlagsApi
@@ -19,1548 +19,833 @@ module LaunchDarklyApi
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Copies the feature flag configuration from one environment to the same feature flag in another environment.
23
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
24
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
25
- # @param feature_flag_copy_body Copy feature flag configurations between environments.
22
+ # Copy feature flag
23
+ # The includedActions and excludedActions define the parts of the flag configuration that are copied or not copied. By default, the entire flag configuration is copied. You can have either `includedActions` or `excludedActions` but not both. Valid `includedActions` and `excludedActions` include: - `updateOn` - `updatePrerequisites` - `updateTargets` - `updateRules` - `updateFallthrough` - `updateOffVariation` The `source` and `target` must be JSON objects if using curl, specifying the environment key and (optional) current flag configuration version in that environment. For example: ```json { \"key\": \"production\", \"currentVersion\": 3 } ``` If target is specified as above, the API will test to ensure that the current flag version in the `production` environment is `3`, and reject attempts to copy settings to `production` otherwise. You can use this to enforce optimistic locking on copy attempts.
24
+ # @param proj_key [String] The project key.
25
+ # @param feature_flag_key [String] The feature flag&#39;s key. The key identifies the flag in your code.
26
+ # @param flag_copy_config_post [FlagCopyConfigPost]
26
27
  # @param [Hash] opts the optional parameters
27
28
  # @return [FeatureFlag]
28
- def copy_feature_flag(project_key, feature_flag_key, feature_flag_copy_body, opts = {})
29
- data, _status_code, _headers = copy_feature_flag_with_http_info(project_key, feature_flag_key, feature_flag_copy_body, opts)
29
+ def copy_feature_flag(proj_key, feature_flag_key, flag_copy_config_post, opts = {})
30
+ data, _status_code, _headers = copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post, opts)
30
31
  data
31
32
  end
32
33
 
33
- # Copies the feature flag configuration from one environment to the same feature flag in another environment.
34
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
35
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
36
- # @param feature_flag_copy_body Copy feature flag configurations between environments.
34
+ # Copy feature flag
35
+ # The includedActions and excludedActions define the parts of the flag configuration that are copied or not copied. By default, the entire flag configuration is copied. You can have either &#x60;includedActions&#x60; or &#x60;excludedActions&#x60; but not both. Valid &#x60;includedActions&#x60; and &#x60;excludedActions&#x60; include: - &#x60;updateOn&#x60; - &#x60;updatePrerequisites&#x60; - &#x60;updateTargets&#x60; - &#x60;updateRules&#x60; - &#x60;updateFallthrough&#x60; - &#x60;updateOffVariation&#x60; The &#x60;source&#x60; and &#x60;target&#x60; must be JSON objects if using curl, specifying the environment key and (optional) current flag configuration version in that environment. For example: &#x60;&#x60;&#x60;json { \&quot;key\&quot;: \&quot;production\&quot;, \&quot;currentVersion\&quot;: 3 } &#x60;&#x60;&#x60; If target is specified as above, the API will test to ensure that the current flag version in the &#x60;production&#x60; environment is &#x60;3&#x60;, and reject attempts to copy settings to &#x60;production&#x60; otherwise. You can use this to enforce optimistic locking on copy attempts.
36
+ # @param proj_key [String] The project key.
37
+ # @param feature_flag_key [String] The feature flag&#39;s key. The key identifies the flag in your code.
38
+ # @param flag_copy_config_post [FlagCopyConfigPost]
37
39
  # @param [Hash] opts the optional parameters
38
- # @return [Array<(FeatureFlag, Fixnum, Hash)>] FeatureFlag data, response status code and response headers
39
- def copy_feature_flag_with_http_info(project_key, feature_flag_key, feature_flag_copy_body, opts = {})
40
+ # @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
41
+ def copy_feature_flag_with_http_info(proj_key, feature_flag_key, flag_copy_config_post, opts = {})
40
42
  if @api_client.config.debugging
41
43
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.copy_feature_flag ...'
42
44
  end
43
- # verify the required parameter 'project_key' is set
44
- if @api_client.config.client_side_validation && project_key.nil?
45
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.copy_feature_flag"
45
+ # verify the required parameter 'proj_key' is set
46
+ if @api_client.config.client_side_validation && proj_key.nil?
47
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.copy_feature_flag"
46
48
  end
47
49
  # verify the required parameter 'feature_flag_key' is set
48
50
  if @api_client.config.client_side_validation && feature_flag_key.nil?
49
51
  fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.copy_feature_flag"
50
52
  end
51
- # verify the required parameter 'feature_flag_copy_body' is set
52
- if @api_client.config.client_side_validation && feature_flag_copy_body.nil?
53
- fail ArgumentError, "Missing the required parameter 'feature_flag_copy_body' when calling FeatureFlagsApi.copy_feature_flag"
53
+ # verify the required parameter 'flag_copy_config_post' is set
54
+ if @api_client.config.client_side_validation && flag_copy_config_post.nil?
55
+ fail ArgumentError, "Missing the required parameter 'flag_copy_config_post' when calling FeatureFlagsApi.copy_feature_flag"
54
56
  end
55
57
  # resource path
56
- local_var_path = '/flags/{projectKey}/{featureFlagKey}/copy'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
58
+ local_var_path = '/api/v2/flags/{projKey}/{featureFlagKey}/copy'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'featureFlagKey' + '}', CGI.escape(feature_flag_key.to_s))
57
59
 
58
60
  # query parameters
59
- query_params = {}
61
+ query_params = opts[:query_params] || {}
60
62
 
61
63
  # header parameters
62
- header_params = {}
64
+ header_params = opts[:header_params] || {}
63
65
  # HTTP header 'Accept' (if needed)
64
66
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
65
67
  # HTTP header 'Content-Type'
66
68
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
67
69
 
68
70
  # form parameters
69
- form_params = {}
71
+ form_params = opts[:form_params] || {}
70
72
 
71
73
  # http body (model)
72
- post_body = @api_client.object_to_http_body(feature_flag_copy_body)
73
- auth_names = ['Token']
74
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
75
- :header_params => header_params,
76
- :query_params => query_params,
77
- :form_params => form_params,
78
- :body => post_body,
79
- :auth_names => auth_names,
80
- :return_type => 'FeatureFlag')
81
- if @api_client.config.debugging
82
- @api_client.config.logger.debug "API called: FeatureFlagsApi#copy_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
83
- end
84
- return data, status_code, headers
85
- end
86
- # Delete an approval request for a feature flag config
87
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
88
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
89
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
90
- # @param approval_request_id The approval request ID
91
- # @param [Hash] opts the optional parameters
92
- # @option opts [ApprovalRequestConfigBody] :approval_request_config_body Create a new approval request
93
- # @return [nil]
94
- def delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, opts = {})
95
- delete_approval_request_with_http_info(project_key, environment_key, feature_flag_key, approval_request_id, opts)
96
- nil
97
- end
98
-
99
- # Delete an approval request for a feature flag config
100
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
101
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
102
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
103
- # @param approval_request_id The approval request ID
104
- # @param [Hash] opts the optional parameters
105
- # @option opts [ApprovalRequestConfigBody] :approval_request_config_body Create a new approval request
106
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
107
- def delete_approval_request_with_http_info(project_key, environment_key, feature_flag_key, approval_request_id, opts = {})
108
- if @api_client.config.debugging
109
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.delete_approval_request ...'
110
- end
111
- # verify the required parameter 'project_key' is set
112
- if @api_client.config.client_side_validation && project_key.nil?
113
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.delete_approval_request"
114
- end
115
- # verify the required parameter 'environment_key' is set
116
- if @api_client.config.client_side_validation && environment_key.nil?
117
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.delete_approval_request"
118
- end
119
- # verify the required parameter 'feature_flag_key' is set
120
- if @api_client.config.client_side_validation && feature_flag_key.nil?
121
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.delete_approval_request"
122
- end
123
- # verify the required parameter 'approval_request_id' is set
124
- if @api_client.config.client_side_validation && approval_request_id.nil?
125
- fail ArgumentError, "Missing the required parameter 'approval_request_id' when calling FeatureFlagsApi.delete_approval_request"
126
- end
127
- # resource path
128
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'approvalRequestId' + '}', approval_request_id.to_s)
129
-
130
- # query parameters
131
- query_params = {}
74
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(flag_copy_config_post)
132
75
 
133
- # header parameters
134
- header_params = {}
135
- # HTTP header 'Accept' (if needed)
136
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
137
- # HTTP header 'Content-Type'
138
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
76
+ # return_type
77
+ return_type = opts[:debug_return_type] || 'FeatureFlag'
139
78
 
140
- # form parameters
141
- form_params = {}
79
+ # auth_names
80
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
142
81
 
143
- # http body (model)
144
- post_body = @api_client.object_to_http_body(opts[:'approval_request_config_body'])
145
- auth_names = ['Token']
146
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
82
+ new_options = opts.merge(
83
+ :operation => :"FeatureFlagsApi.copy_feature_flag",
147
84
  :header_params => header_params,
148
85
  :query_params => query_params,
149
86
  :form_params => form_params,
150
87
  :body => post_body,
151
- :auth_names => auth_names)
152
- if @api_client.config.debugging
153
- @api_client.config.logger.debug "API called: FeatureFlagsApi#delete_approval_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
- end
155
- return data, status_code, headers
156
- end
157
- # Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
158
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
159
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
160
- # @param [Hash] opts the optional parameters
161
- # @return [nil]
162
- def delete_feature_flag(project_key, feature_flag_key, opts = {})
163
- delete_feature_flag_with_http_info(project_key, feature_flag_key, opts)
164
- nil
165
- end
166
-
167
- # Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
168
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
169
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
170
- # @param [Hash] opts the optional parameters
171
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
172
- def delete_feature_flag_with_http_info(project_key, feature_flag_key, opts = {})
173
- if @api_client.config.debugging
174
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.delete_feature_flag ...'
175
- end
176
- # verify the required parameter 'project_key' is set
177
- if @api_client.config.client_side_validation && project_key.nil?
178
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.delete_feature_flag"
179
- end
180
- # verify the required parameter 'feature_flag_key' is set
181
- if @api_client.config.client_side_validation && feature_flag_key.nil?
182
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.delete_feature_flag"
183
- end
184
- # resource path
185
- local_var_path = '/flags/{projectKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
186
-
187
- # query parameters
188
- query_params = {}
189
-
190
- # header parameters
191
- header_params = {}
192
- # HTTP header 'Accept' (if needed)
193
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
194
- # HTTP header 'Content-Type'
195
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
196
-
197
- # form parameters
198
- form_params = {}
88
+ :auth_names => auth_names,
89
+ :return_type => return_type
90
+ )
199
91
 
200
- # http body (model)
201
- post_body = nil
202
- auth_names = ['Token']
203
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
204
- :header_params => header_params,
205
- :query_params => query_params,
206
- :form_params => form_params,
207
- :body => post_body,
208
- :auth_names => auth_names)
92
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
209
93
  if @api_client.config.debugging
210
- @api_client.config.logger.debug "API called: FeatureFlagsApi#delete_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
94
+ @api_client.config.logger.debug "API called: FeatureFlagsApi#copy_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
211
95
  end
212
96
  return data, status_code, headers
213
97
  end
214
- # Delete a scheduled change on a feature flag in an environment.
215
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
216
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
217
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
218
- # @param scheduled_change_id The id of the scheduled change
98
+
99
+ # Delete feature flag
100
+ # Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
101
+ # @param proj_key [String] The project key.
102
+ # @param key [String] The feature flag&#39;s key. The key identifies the flag in your code.
219
103
  # @param [Hash] opts the optional parameters
220
104
  # @return [nil]
221
- def delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id, opts = {})
222
- delete_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key, scheduled_change_id, opts)
105
+ def delete_feature_flag(proj_key, key, opts = {})
106
+ delete_feature_flag_with_http_info(proj_key, key, opts)
223
107
  nil
224
108
  end
225
109
 
226
- # Delete a scheduled change on a feature flag in an environment.
227
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
228
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
229
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
230
- # @param scheduled_change_id The id of the scheduled change
110
+ # Delete feature flag
111
+ # Delete a feature flag in all environments. Use with caution: only delete feature flags your application no longer uses.
112
+ # @param proj_key [String] The project key.
113
+ # @param key [String] The feature flag&#39;s key. The key identifies the flag in your code.
231
114
  # @param [Hash] opts the optional parameters
232
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
233
- def delete_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key, scheduled_change_id, opts = {})
115
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
116
+ def delete_feature_flag_with_http_info(proj_key, key, opts = {})
234
117
  if @api_client.config.debugging
235
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.delete_flag_config_scheduled_changes ...'
236
- end
237
- # verify the required parameter 'project_key' is set
238
- if @api_client.config.client_side_validation && project_key.nil?
239
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.delete_flag_config_scheduled_changes"
240
- end
241
- # verify the required parameter 'feature_flag_key' is set
242
- if @api_client.config.client_side_validation && feature_flag_key.nil?
243
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.delete_flag_config_scheduled_changes"
118
+ @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.delete_feature_flag ...'
244
119
  end
245
- # verify the required parameter 'environment_key' is set
246
- if @api_client.config.client_side_validation && environment_key.nil?
247
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.delete_flag_config_scheduled_changes"
120
+ # verify the required parameter 'proj_key' is set
121
+ if @api_client.config.client_side_validation && proj_key.nil?
122
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.delete_feature_flag"
248
123
  end
249
- # verify the required parameter 'scheduled_change_id' is set
250
- if @api_client.config.client_side_validation && scheduled_change_id.nil?
251
- fail ArgumentError, "Missing the required parameter 'scheduled_change_id' when calling FeatureFlagsApi.delete_flag_config_scheduled_changes"
124
+ # verify the required parameter 'key' is set
125
+ if @api_client.config.client_side_validation && key.nil?
126
+ fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.delete_feature_flag"
252
127
  end
253
128
  # resource path
254
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'scheduledChangeId' + '}', scheduled_change_id.to_s)
129
+ local_var_path = '/api/v2/flags/{projKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
255
130
 
256
131
  # query parameters
257
- query_params = {}
132
+ query_params = opts[:query_params] || {}
258
133
 
259
134
  # header parameters
260
- header_params = {}
261
- # HTTP header 'Accept' (if needed)
262
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
263
- # HTTP header 'Content-Type'
264
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
135
+ header_params = opts[:header_params] || {}
265
136
 
266
137
  # form parameters
267
- form_params = {}
138
+ form_params = opts[:form_params] || {}
268
139
 
269
140
  # http body (model)
270
- post_body = nil
271
- auth_names = ['Token']
272
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
273
- :header_params => header_params,
274
- :query_params => query_params,
275
- :form_params => form_params,
276
- :body => post_body,
277
- :auth_names => auth_names)
278
- if @api_client.config.debugging
279
- @api_client.config.logger.debug "API called: FeatureFlagsApi#delete_flag_config_scheduled_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
280
- end
281
- return data, status_code, headers
282
- end
283
- # Get a single approval request for a feature flag config
284
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
285
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
286
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
287
- # @param approval_request_id The approval request ID
288
- # @param [Hash] opts the optional parameters
289
- # @return [ApprovalRequests]
290
- def get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, opts = {})
291
- data, _status_code, _headers = get_approval_request_with_http_info(project_key, feature_flag_key, environment_key, approval_request_id, opts)
292
- data
293
- end
141
+ post_body = opts[:debug_body]
294
142
 
295
- # Get a single approval request for a feature flag config
296
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
297
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
298
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
299
- # @param approval_request_id The approval request ID
300
- # @param [Hash] opts the optional parameters
301
- # @return [Array<(ApprovalRequests, Fixnum, Hash)>] ApprovalRequests data, response status code and response headers
302
- def get_approval_request_with_http_info(project_key, feature_flag_key, environment_key, approval_request_id, opts = {})
303
- if @api_client.config.debugging
304
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_approval_request ...'
305
- end
306
- # verify the required parameter 'project_key' is set
307
- if @api_client.config.client_side_validation && project_key.nil?
308
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_approval_request"
309
- end
310
- # verify the required parameter 'feature_flag_key' is set
311
- if @api_client.config.client_side_validation && feature_flag_key.nil?
312
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_approval_request"
313
- end
314
- # verify the required parameter 'environment_key' is set
315
- if @api_client.config.client_side_validation && environment_key.nil?
316
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_approval_request"
317
- end
318
- # verify the required parameter 'approval_request_id' is set
319
- if @api_client.config.client_side_validation && approval_request_id.nil?
320
- fail ArgumentError, "Missing the required parameter 'approval_request_id' when calling FeatureFlagsApi.get_approval_request"
321
- end
322
- # resource path
323
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'approvalRequestId' + '}', approval_request_id.to_s)
324
-
325
- # query parameters
326
- query_params = {}
327
-
328
- # header parameters
329
- header_params = {}
330
- # HTTP header 'Accept' (if needed)
331
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
332
- # HTTP header 'Content-Type'
333
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
143
+ # return_type
144
+ return_type = opts[:debug_return_type]
334
145
 
335
- # form parameters
336
- form_params = {}
146
+ # auth_names
147
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
337
148
 
338
- # http body (model)
339
- post_body = nil
340
- auth_names = ['Token']
341
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
149
+ new_options = opts.merge(
150
+ :operation => :"FeatureFlagsApi.delete_feature_flag",
342
151
  :header_params => header_params,
343
152
  :query_params => query_params,
344
153
  :form_params => form_params,
345
154
  :body => post_body,
346
155
  :auth_names => auth_names,
347
- :return_type => 'ApprovalRequests')
348
- if @api_client.config.debugging
349
- @api_client.config.logger.debug "API called: FeatureFlagsApi#get_approval_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
350
- end
351
- return data, status_code, headers
352
- end
353
- # Get all approval requests for a feature flag config
354
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
355
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
356
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
357
- # @param [Hash] opts the optional parameters
358
- # @return [ApprovalRequests]
359
- def get_approval_requests(project_key, feature_flag_key, environment_key, opts = {})
360
- data, _status_code, _headers = get_approval_requests_with_http_info(project_key, feature_flag_key, environment_key, opts)
361
- data
362
- end
363
-
364
- # Get all approval requests for a feature flag config
365
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
366
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
367
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
368
- # @param [Hash] opts the optional parameters
369
- # @return [Array<(ApprovalRequests, Fixnum, Hash)>] ApprovalRequests data, response status code and response headers
370
- def get_approval_requests_with_http_info(project_key, feature_flag_key, environment_key, opts = {})
371
- if @api_client.config.debugging
372
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_approval_requests ...'
373
- end
374
- # verify the required parameter 'project_key' is set
375
- if @api_client.config.client_side_validation && project_key.nil?
376
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_approval_requests"
377
- end
378
- # verify the required parameter 'feature_flag_key' is set
379
- if @api_client.config.client_side_validation && feature_flag_key.nil?
380
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_approval_requests"
381
- end
382
- # verify the required parameter 'environment_key' is set
383
- if @api_client.config.client_side_validation && environment_key.nil?
384
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_approval_requests"
385
- end
386
- # resource path
387
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)
388
-
389
- # query parameters
390
- query_params = {}
391
-
392
- # header parameters
393
- header_params = {}
394
- # HTTP header 'Accept' (if needed)
395
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
396
- # HTTP header 'Content-Type'
397
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
398
-
399
- # form parameters
400
- form_params = {}
156
+ :return_type => return_type
157
+ )
401
158
 
402
- # http body (model)
403
- post_body = nil
404
- auth_names = ['Token']
405
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
406
- :header_params => header_params,
407
- :query_params => query_params,
408
- :form_params => form_params,
409
- :body => post_body,
410
- :auth_names => auth_names,
411
- :return_type => 'ApprovalRequests')
159
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
412
160
  if @api_client.config.debugging
413
- @api_client.config.logger.debug "API called: FeatureFlagsApi#get_approval_requests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
161
+ @api_client.config.logger.debug "API called: FeatureFlagsApi#delete_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
414
162
  end
415
163
  return data, status_code, headers
416
164
  end
165
+
417
166
  # Get expiring user targets for feature flag
418
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
419
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
420
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
421
- # @param [Hash] opts the optional parameters
422
- # @return [UserTargetingExpirationForFlags]
423
- def get_expiring_user_targets(project_key, environment_key, feature_flag_key, opts = {})
424
- data, _status_code, _headers = get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, opts)
167
+ # Get a list of user targets on a feature flag that are scheduled for removal.
168
+ # @param proj_key [String] The project key.
169
+ # @param env_key [String] The environment key.
170
+ # @param flag_key [String] The feature flag key.
171
+ # @param [Hash] opts the optional parameters
172
+ # @return [ExpiringUserTargetGetResponse]
173
+ def get_expiring_user_targets(proj_key, env_key, flag_key, opts = {})
174
+ data, _status_code, _headers = get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, opts)
425
175
  data
426
176
  end
427
177
 
428
178
  # Get expiring user targets for feature flag
429
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
430
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
431
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
179
+ # Get a list of user targets on a feature flag that are scheduled for removal.
180
+ # @param proj_key [String] The project key.
181
+ # @param env_key [String] The environment key.
182
+ # @param flag_key [String] The feature flag key.
432
183
  # @param [Hash] opts the optional parameters
433
- # @return [Array<(UserTargetingExpirationForFlags, Fixnum, Hash)>] UserTargetingExpirationForFlags data, response status code and response headers
434
- def get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, opts = {})
184
+ # @return [Array<(ExpiringUserTargetGetResponse, Integer, Hash)>] ExpiringUserTargetGetResponse data, response status code and response headers
185
+ def get_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, opts = {})
435
186
  if @api_client.config.debugging
436
187
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_expiring_user_targets ...'
437
188
  end
438
- # verify the required parameter 'project_key' is set
439
- if @api_client.config.client_side_validation && project_key.nil?
440
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_expiring_user_targets"
189
+ # verify the required parameter 'proj_key' is set
190
+ if @api_client.config.client_side_validation && proj_key.nil?
191
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_expiring_user_targets"
441
192
  end
442
- # verify the required parameter 'environment_key' is set
443
- if @api_client.config.client_side_validation && environment_key.nil?
444
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_expiring_user_targets"
193
+ # verify the required parameter 'env_key' is set
194
+ if @api_client.config.client_side_validation && env_key.nil?
195
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling FeatureFlagsApi.get_expiring_user_targets"
445
196
  end
446
- # verify the required parameter 'feature_flag_key' is set
447
- if @api_client.config.client_side_validation && feature_flag_key.nil?
448
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_expiring_user_targets"
197
+ # verify the required parameter 'flag_key' is set
198
+ if @api_client.config.client_side_validation && flag_key.nil?
199
+ fail ArgumentError, "Missing the required parameter 'flag_key' when calling FeatureFlagsApi.get_expiring_user_targets"
449
200
  end
450
201
  # resource path
451
- local_var_path = '/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
202
+ local_var_path = '/api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_key.to_s))
452
203
 
453
204
  # query parameters
454
- query_params = {}
205
+ query_params = opts[:query_params] || {}
455
206
 
456
207
  # header parameters
457
- header_params = {}
208
+ header_params = opts[:header_params] || {}
458
209
  # HTTP header 'Accept' (if needed)
459
210
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
460
- # HTTP header 'Content-Type'
461
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
462
211
 
463
212
  # form parameters
464
- form_params = {}
213
+ form_params = opts[:form_params] || {}
465
214
 
466
215
  # http body (model)
467
- post_body = nil
468
- auth_names = ['Token']
469
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
216
+ post_body = opts[:debug_body]
217
+
218
+ # return_type
219
+ return_type = opts[:debug_return_type] || 'ExpiringUserTargetGetResponse'
220
+
221
+ # auth_names
222
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
223
+
224
+ new_options = opts.merge(
225
+ :operation => :"FeatureFlagsApi.get_expiring_user_targets",
470
226
  :header_params => header_params,
471
227
  :query_params => query_params,
472
228
  :form_params => form_params,
473
229
  :body => post_body,
474
230
  :auth_names => auth_names,
475
- :return_type => 'UserTargetingExpirationForFlags')
231
+ :return_type => return_type
232
+ )
233
+
234
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
476
235
  if @api_client.config.debugging
477
236
  @api_client.config.logger.debug "API called: FeatureFlagsApi#get_expiring_user_targets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
478
237
  end
479
238
  return data, status_code, headers
480
239
  end
481
- # Get a single feature flag by key.
482
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
483
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
240
+
241
+ # Get feature flag
242
+ # Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just the `production` environment.
243
+ # @param proj_key [String] The project key
244
+ # @param key [String] The feature flag key
484
245
  # @param [Hash] opts the optional parameters
485
- # @option opts [Array<String>] :env By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env&#x3D;[\&quot;production\&quot;] will restrict the returned configurations to just your production environment.
246
+ # @option opts [String] :env Filter configurations by environment
486
247
  # @return [FeatureFlag]
487
- def get_feature_flag(project_key, feature_flag_key, opts = {})
488
- data, _status_code, _headers = get_feature_flag_with_http_info(project_key, feature_flag_key, opts)
248
+ def get_feature_flag(proj_key, key, opts = {})
249
+ data, _status_code, _headers = get_feature_flag_with_http_info(proj_key, key, opts)
489
250
  data
490
251
  end
491
252
 
492
- # Get a single feature flag by key.
493
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
494
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
253
+ # Get feature flag
254
+ # Get a single feature flag by key. By default, this returns the configurations for all environments. You can filter environments with the &#x60;env&#x60; query parameter. For example, setting &#x60;env&#x3D;production&#x60; restricts the returned configurations to just the &#x60;production&#x60; environment.
255
+ # @param proj_key [String] The project key
256
+ # @param key [String] The feature flag key
495
257
  # @param [Hash] opts the optional parameters
496
- # @option opts [Array<String>] :env By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env&#x3D;[\&quot;production\&quot;] will restrict the returned configurations to just your production environment.
497
- # @return [Array<(FeatureFlag, Fixnum, Hash)>] FeatureFlag data, response status code and response headers
498
- def get_feature_flag_with_http_info(project_key, feature_flag_key, opts = {})
258
+ # @option opts [String] :env Filter configurations by environment
259
+ # @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
260
+ def get_feature_flag_with_http_info(proj_key, key, opts = {})
499
261
  if @api_client.config.debugging
500
262
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flag ...'
501
263
  end
502
- # verify the required parameter 'project_key' is set
503
- if @api_client.config.client_side_validation && project_key.nil?
504
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flag"
264
+ # verify the required parameter 'proj_key' is set
265
+ if @api_client.config.client_side_validation && proj_key.nil?
266
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flag"
505
267
  end
506
- # verify the required parameter 'feature_flag_key' is set
507
- if @api_client.config.client_side_validation && feature_flag_key.nil?
508
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_feature_flag"
268
+ # verify the required parameter 'key' is set
269
+ if @api_client.config.client_side_validation && key.nil?
270
+ fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.get_feature_flag"
509
271
  end
510
272
  # resource path
511
- local_var_path = '/flags/{projectKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
273
+ local_var_path = '/api/v2/flags/{projKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
512
274
 
513
275
  # query parameters
514
- query_params = {}
515
- query_params[:'env'] = @api_client.build_collection_param(opts[:'env'], :multi) if !opts[:'env'].nil?
276
+ query_params = opts[:query_params] || {}
277
+ query_params[:'env'] = opts[:'env'] if !opts[:'env'].nil?
516
278
 
517
279
  # header parameters
518
- header_params = {}
280
+ header_params = opts[:header_params] || {}
519
281
  # HTTP header 'Accept' (if needed)
520
282
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
521
- # HTTP header 'Content-Type'
522
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
523
283
 
524
284
  # form parameters
525
- form_params = {}
285
+ form_params = opts[:form_params] || {}
526
286
 
527
287
  # http body (model)
528
- post_body = nil
529
- auth_names = ['Token']
530
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
288
+ post_body = opts[:debug_body]
289
+
290
+ # return_type
291
+ return_type = opts[:debug_return_type] || 'FeatureFlag'
292
+
293
+ # auth_names
294
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
295
+
296
+ new_options = opts.merge(
297
+ :operation => :"FeatureFlagsApi.get_feature_flag",
531
298
  :header_params => header_params,
532
299
  :query_params => query_params,
533
300
  :form_params => form_params,
534
301
  :body => post_body,
535
302
  :auth_names => auth_names,
536
- :return_type => 'FeatureFlag')
303
+ :return_type => return_type
304
+ )
305
+
306
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
537
307
  if @api_client.config.debugging
538
308
  @api_client.config.logger.debug "API called: FeatureFlagsApi#get_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
539
309
  end
540
310
  return data, status_code, headers
541
311
  end
312
+
313
+ # Get feature flag status
542
314
  # Get the status for a particular feature flag.
543
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
544
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
545
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
315
+ # @param proj_key [String] The project key
316
+ # @param env_key [String] The environment key
317
+ # @param key [String] The feature flag key
546
318
  # @param [Hash] opts the optional parameters
547
- # @return [FeatureFlagStatus]
548
- def get_feature_flag_status(project_key, environment_key, feature_flag_key, opts = {})
549
- data, _status_code, _headers = get_feature_flag_status_with_http_info(project_key, environment_key, feature_flag_key, opts)
319
+ # @return [FlagStatusRep]
320
+ def get_feature_flag_status(proj_key, env_key, key, opts = {})
321
+ data, _status_code, _headers = get_feature_flag_status_with_http_info(proj_key, env_key, key, opts)
550
322
  data
551
323
  end
552
324
 
325
+ # Get feature flag status
553
326
  # Get the status for a particular feature flag.
554
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
555
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
556
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
327
+ # @param proj_key [String] The project key
328
+ # @param env_key [String] The environment key
329
+ # @param key [String] The feature flag key
557
330
  # @param [Hash] opts the optional parameters
558
- # @return [Array<(FeatureFlagStatus, Fixnum, Hash)>] FeatureFlagStatus data, response status code and response headers
559
- def get_feature_flag_status_with_http_info(project_key, environment_key, feature_flag_key, opts = {})
331
+ # @return [Array<(FlagStatusRep, Integer, Hash)>] FlagStatusRep data, response status code and response headers
332
+ def get_feature_flag_status_with_http_info(proj_key, env_key, key, opts = {})
560
333
  if @api_client.config.debugging
561
334
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flag_status ...'
562
335
  end
563
- # verify the required parameter 'project_key' is set
564
- if @api_client.config.client_side_validation && project_key.nil?
565
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flag_status"
336
+ # verify the required parameter 'proj_key' is set
337
+ if @api_client.config.client_side_validation && proj_key.nil?
338
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flag_status"
566
339
  end
567
- # verify the required parameter 'environment_key' is set
568
- if @api_client.config.client_side_validation && environment_key.nil?
569
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_feature_flag_status"
340
+ # verify the required parameter 'env_key' is set
341
+ if @api_client.config.client_side_validation && env_key.nil?
342
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling FeatureFlagsApi.get_feature_flag_status"
570
343
  end
571
- # verify the required parameter 'feature_flag_key' is set
572
- if @api_client.config.client_side_validation && feature_flag_key.nil?
573
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_feature_flag_status"
344
+ # verify the required parameter 'key' is set
345
+ if @api_client.config.client_side_validation && key.nil?
346
+ fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.get_feature_flag_status"
574
347
  end
575
348
  # resource path
576
- local_var_path = '/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
349
+ local_var_path = '/api/v2/flag-statuses/{projKey}/{envKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
577
350
 
578
351
  # query parameters
579
- query_params = {}
352
+ query_params = opts[:query_params] || {}
580
353
 
581
354
  # header parameters
582
- header_params = {}
355
+ header_params = opts[:header_params] || {}
583
356
  # HTTP header 'Accept' (if needed)
584
357
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
585
- # HTTP header 'Content-Type'
586
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
587
358
 
588
359
  # form parameters
589
- form_params = {}
360
+ form_params = opts[:form_params] || {}
590
361
 
591
362
  # http body (model)
592
- post_body = nil
593
- auth_names = ['Token']
594
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
363
+ post_body = opts[:debug_body]
364
+
365
+ # return_type
366
+ return_type = opts[:debug_return_type] || 'FlagStatusRep'
367
+
368
+ # auth_names
369
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
370
+
371
+ new_options = opts.merge(
372
+ :operation => :"FeatureFlagsApi.get_feature_flag_status",
595
373
  :header_params => header_params,
596
374
  :query_params => query_params,
597
375
  :form_params => form_params,
598
376
  :body => post_body,
599
377
  :auth_names => auth_names,
600
- :return_type => 'FeatureFlagStatus')
378
+ :return_type => return_type
379
+ )
380
+
381
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
601
382
  if @api_client.config.debugging
602
383
  @api_client.config.logger.debug "API called: FeatureFlagsApi#get_feature_flag_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
603
384
  end
604
385
  return data, status_code, headers
605
386
  end
606
- # Get the status for a particular feature flag across environments
607
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
608
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
387
+
388
+ # Get flag status across environments
389
+ # Get the status for a particular feature flag across environments.
390
+ # @param proj_key [String] The project key
391
+ # @param key [String] The feature flag key
609
392
  # @param [Hash] opts the optional parameters
393
+ # @option opts [String] :env Optional environment filter
610
394
  # @return [FeatureFlagStatusAcrossEnvironments]
611
- def get_feature_flag_status_across_environments(project_key, feature_flag_key, opts = {})
612
- data, _status_code, _headers = get_feature_flag_status_across_environments_with_http_info(project_key, feature_flag_key, opts)
395
+ def get_feature_flag_status_across_environments(proj_key, key, opts = {})
396
+ data, _status_code, _headers = get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts)
613
397
  data
614
398
  end
615
399
 
616
- # Get the status for a particular feature flag across environments
617
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
618
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
400
+ # Get flag status across environments
401
+ # Get the status for a particular feature flag across environments.
402
+ # @param proj_key [String] The project key
403
+ # @param key [String] The feature flag key
619
404
  # @param [Hash] opts the optional parameters
620
- # @return [Array<(FeatureFlagStatusAcrossEnvironments, Fixnum, Hash)>] FeatureFlagStatusAcrossEnvironments data, response status code and response headers
621
- def get_feature_flag_status_across_environments_with_http_info(project_key, feature_flag_key, opts = {})
405
+ # @option opts [String] :env Optional environment filter
406
+ # @return [Array<(FeatureFlagStatusAcrossEnvironments, Integer, Hash)>] FeatureFlagStatusAcrossEnvironments data, response status code and response headers
407
+ def get_feature_flag_status_across_environments_with_http_info(proj_key, key, opts = {})
622
408
  if @api_client.config.debugging
623
409
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flag_status_across_environments ...'
624
410
  end
625
- # verify the required parameter 'project_key' is set
626
- if @api_client.config.client_side_validation && project_key.nil?
627
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flag_status_across_environments"
411
+ # verify the required parameter 'proj_key' is set
412
+ if @api_client.config.client_side_validation && proj_key.nil?
413
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flag_status_across_environments"
628
414
  end
629
- # verify the required parameter 'feature_flag_key' is set
630
- if @api_client.config.client_side_validation && feature_flag_key.nil?
631
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_feature_flag_status_across_environments"
415
+ # verify the required parameter 'key' is set
416
+ if @api_client.config.client_side_validation && key.nil?
417
+ fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.get_feature_flag_status_across_environments"
632
418
  end
633
419
  # resource path
634
- local_var_path = '/flag-status/{projectKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
420
+ local_var_path = '/api/v2/flag-status/{projKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
635
421
 
636
422
  # query parameters
637
- query_params = {}
423
+ query_params = opts[:query_params] || {}
424
+ query_params[:'env'] = opts[:'env'] if !opts[:'env'].nil?
638
425
 
639
426
  # header parameters
640
- header_params = {}
427
+ header_params = opts[:header_params] || {}
641
428
  # HTTP header 'Accept' (if needed)
642
429
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
643
- # HTTP header 'Content-Type'
644
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
645
430
 
646
431
  # form parameters
647
- form_params = {}
432
+ form_params = opts[:form_params] || {}
648
433
 
649
434
  # http body (model)
650
- post_body = nil
651
- auth_names = ['Token']
652
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
435
+ post_body = opts[:debug_body]
436
+
437
+ # return_type
438
+ return_type = opts[:debug_return_type] || 'FeatureFlagStatusAcrossEnvironments'
439
+
440
+ # auth_names
441
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
442
+
443
+ new_options = opts.merge(
444
+ :operation => :"FeatureFlagsApi.get_feature_flag_status_across_environments",
653
445
  :header_params => header_params,
654
446
  :query_params => query_params,
655
447
  :form_params => form_params,
656
448
  :body => post_body,
657
449
  :auth_names => auth_names,
658
- :return_type => 'FeatureFlagStatusAcrossEnvironments')
450
+ :return_type => return_type
451
+ )
452
+
453
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
659
454
  if @api_client.config.debugging
660
455
  @api_client.config.logger.debug "API called: FeatureFlagsApi#get_feature_flag_status_across_environments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
661
456
  end
662
457
  return data, status_code, headers
663
458
  end
664
- # Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
665
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
666
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
459
+
460
+ # List feature flag statuses
461
+ # Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - `new`: the feature flag was created within the last seven days, and has not been requested yet - `active`: the feature flag was requested by your servers or clients within the last seven days - `inactive`: the feature flag was created more than seven days ago, and hasn't been requested by your servers or clients within the past seven days - `launched`: one variation of the feature flag has been rolled out to all your users for at least 7 days
462
+ # @param proj_key [String] The project key
463
+ # @param env_key [String] Filter configurations by environment
667
464
  # @param [Hash] opts the optional parameters
668
465
  # @return [FeatureFlagStatuses]
669
- def get_feature_flag_statuses(project_key, environment_key, opts = {})
670
- data, _status_code, _headers = get_feature_flag_statuses_with_http_info(project_key, environment_key, opts)
466
+ def get_feature_flag_statuses(proj_key, env_key, opts = {})
467
+ data, _status_code, _headers = get_feature_flag_statuses_with_http_info(proj_key, env_key, opts)
671
468
  data
672
469
  end
673
470
 
674
- # Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
675
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
676
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
471
+ # List feature flag statuses
472
+ # Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as a state, which is one of the following: - &#x60;new&#x60;: the feature flag was created within the last seven days, and has not been requested yet - &#x60;active&#x60;: the feature flag was requested by your servers or clients within the last seven days - &#x60;inactive&#x60;: the feature flag was created more than seven days ago, and hasn&#39;t been requested by your servers or clients within the past seven days - &#x60;launched&#x60;: one variation of the feature flag has been rolled out to all your users for at least 7 days
473
+ # @param proj_key [String] The project key
474
+ # @param env_key [String] Filter configurations by environment
677
475
  # @param [Hash] opts the optional parameters
678
- # @return [Array<(FeatureFlagStatuses, Fixnum, Hash)>] FeatureFlagStatuses data, response status code and response headers
679
- def get_feature_flag_statuses_with_http_info(project_key, environment_key, opts = {})
476
+ # @return [Array<(FeatureFlagStatuses, Integer, Hash)>] FeatureFlagStatuses data, response status code and response headers
477
+ def get_feature_flag_statuses_with_http_info(proj_key, env_key, opts = {})
680
478
  if @api_client.config.debugging
681
479
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flag_statuses ...'
682
480
  end
683
- # verify the required parameter 'project_key' is set
684
- if @api_client.config.client_side_validation && project_key.nil?
685
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flag_statuses"
481
+ # verify the required parameter 'proj_key' is set
482
+ if @api_client.config.client_side_validation && proj_key.nil?
483
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flag_statuses"
686
484
  end
687
- # verify the required parameter 'environment_key' is set
688
- if @api_client.config.client_side_validation && environment_key.nil?
689
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_feature_flag_statuses"
485
+ # verify the required parameter 'env_key' is set
486
+ if @api_client.config.client_side_validation && env_key.nil?
487
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling FeatureFlagsApi.get_feature_flag_statuses"
690
488
  end
691
489
  # resource path
692
- local_var_path = '/flag-statuses/{projectKey}/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)
490
+ local_var_path = '/api/v2/flag-statuses/{projKey}/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s))
693
491
 
694
492
  # query parameters
695
- query_params = {}
493
+ query_params = opts[:query_params] || {}
696
494
 
697
495
  # header parameters
698
- header_params = {}
496
+ header_params = opts[:header_params] || {}
699
497
  # HTTP header 'Accept' (if needed)
700
498
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
701
- # HTTP header 'Content-Type'
702
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
703
499
 
704
500
  # form parameters
705
- form_params = {}
501
+ form_params = opts[:form_params] || {}
706
502
 
707
503
  # http body (model)
708
- post_body = nil
709
- auth_names = ['Token']
710
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
504
+ post_body = opts[:debug_body]
505
+
506
+ # return_type
507
+ return_type = opts[:debug_return_type] || 'FeatureFlagStatuses'
508
+
509
+ # auth_names
510
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
511
+
512
+ new_options = opts.merge(
513
+ :operation => :"FeatureFlagsApi.get_feature_flag_statuses",
711
514
  :header_params => header_params,
712
515
  :query_params => query_params,
713
516
  :form_params => form_params,
714
517
  :body => post_body,
715
518
  :auth_names => auth_names,
716
- :return_type => 'FeatureFlagStatuses')
519
+ :return_type => return_type
520
+ )
521
+
522
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
717
523
  if @api_client.config.debugging
718
524
  @api_client.config.logger.debug "API called: FeatureFlagsApi#get_feature_flag_statuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
719
525
  end
720
526
  return data, status_code, headers
721
527
  end
722
- # Get a list of all features in the given project.
723
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
528
+
529
+ # List feature flags
530
+ # Get a list of all features in the given project. By default, each feature includes configurations for each environment. You can filter environments with the env query parameter. For example, setting `env=production` restricts the returned configurations to just your production environment. You can also filter feature flags by tag with the tag query parameter. We support the following fields for filters: - `query` is a string that matches against the flags' keys and names. It is not case sensitive. - `archived` is a boolean to filter the list to archived flags. When this is absent, only unarchived flags are returned. - `type` is a string allowing filtering to `temporary` or `permanent` flags. - `status` is a string allowing filtering to `new`, `inactive`, `active`, or `launched` flags in the specified environment. This filter also requires a `filterEnv` field to be set to a valid environment. For example: `filter=status:active,filterEnv:production`. - `tags` is a + separated list of tags. It filters the list to members who have all of the tags in the list. - `hasExperiment` is a boolean with values of true or false and returns any flags that have an attached metric. - `hasDataExport` is a boolean with values of true or false and returns any flags that are currently exporting data in the specified environment. This includes flags that are exporting data via Experimentation. This filter also requires a `filterEnv` field to be set to a valid environment key. e.g. `filter=hasExperiment:true,filterEnv:production` - `evaluated` is an object that contains a key of `after` and a value in Unix time in milliseconds. This returns all flags that have been evaluated since the time you specify in the environment provided. This filter also requires a `filterEnv` field to be set to a valid environment. For example: `filter=evaluated:{\"after\": 1590768455282},filterEnv:production`. - `filterEnv` is a string with the key of a valid environment. The filterEnv field is used for filters that are environment specific. If there are multiple environment specific filters you should only declare this parameter once. For example: `filter=evaluated:{\"after\": 1590768455282},filterEnv:production,status:active`. An example filter is `query:abc,tags:foo+bar`. This matches flags with the string `abc` in their key or name, ignoring case, which also have the tags `foo` and `bar`. By default, this returns all flags. You can page through the list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links will not be present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page.
531
+ # @param proj_key [String] The project key
724
532
  # @param [Hash] opts the optional parameters
725
- # @option opts [Array<String>] :env By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env&#x3D;[\&quot;production\&quot;] will restrict the returned configurations to just your production environment.
726
- # @option opts [BOOLEAN] :summary By default in api version &gt;&#x3D; 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary&#x3D;0 to include these fields for each flag returned.
727
- # @option opts [BOOLEAN] :archived When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags.
728
- # @option opts [Float] :limit The number of objects to return. Defaults to -1, which returns everything.
729
- # @option opts [Float] :offset Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
730
- # @option opts [String] :filter A comma-separated list of filters. Each filter is of the form field:value.
731
- # @option opts [String] :sort A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
732
- # @option opts [String] :tag Filter by tag. A tag can be used to group flags across projects.
533
+ # @option opts [String] :env Filter configurations by environment
534
+ # @option opts [String] :tag Filter feature flags by tag
535
+ # @option opts [Integer] :limit The number of feature flags to return. Defaults to -1, which returns all flags
536
+ # @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next limit items
537
+ # @option opts [String] :query A string that matches against the flags&#39; keys and names. It is not case sensitive
538
+ # @option opts [Boolean] :archived A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned
539
+ # @option opts [Boolean] :summary By default in API version &gt;&#x3D; 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary&#x3D;0 to include these fields for each flag returned
540
+ # @option opts [String] :filter A comma-separated list of filters. Each filter is of the form field:value
541
+ # @option opts [String] :sort A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
733
542
  # @return [FeatureFlags]
734
- def get_feature_flags(project_key, opts = {})
735
- data, _status_code, _headers = get_feature_flags_with_http_info(project_key, opts)
543
+ def get_feature_flags(proj_key, opts = {})
544
+ data, _status_code, _headers = get_feature_flags_with_http_info(proj_key, opts)
736
545
  data
737
546
  end
738
547
 
739
- # Get a list of all features in the given project.
740
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
548
+ # List feature flags
549
+ # Get a list of all features in the given project. By default, each feature includes configurations for each environment. You can filter environments with the env query parameter. For example, setting &#x60;env&#x3D;production&#x60; restricts the returned configurations to just your production environment. You can also filter feature flags by tag with the tag query parameter. We support the following fields for filters: - &#x60;query&#x60; is a string that matches against the flags&#39; keys and names. It is not case sensitive. - &#x60;archived&#x60; is a boolean to filter the list to archived flags. When this is absent, only unarchived flags are returned. - &#x60;type&#x60; is a string allowing filtering to &#x60;temporary&#x60; or &#x60;permanent&#x60; flags. - &#x60;status&#x60; is a string allowing filtering to &#x60;new&#x60;, &#x60;inactive&#x60;, &#x60;active&#x60;, or &#x60;launched&#x60; flags in the specified environment. This filter also requires a &#x60;filterEnv&#x60; field to be set to a valid environment. For example: &#x60;filter&#x3D;status:active,filterEnv:production&#x60;. - &#x60;tags&#x60; is a + separated list of tags. It filters the list to members who have all of the tags in the list. - &#x60;hasExperiment&#x60; is a boolean with values of true or false and returns any flags that have an attached metric. - &#x60;hasDataExport&#x60; is a boolean with values of true or false and returns any flags that are currently exporting data in the specified environment. This includes flags that are exporting data via Experimentation. This filter also requires a &#x60;filterEnv&#x60; field to be set to a valid environment key. e.g. &#x60;filter&#x3D;hasExperiment:true,filterEnv:production&#x60; - &#x60;evaluated&#x60; is an object that contains a key of &#x60;after&#x60; and a value in Unix time in milliseconds. This returns all flags that have been evaluated since the time you specify in the environment provided. This filter also requires a &#x60;filterEnv&#x60; field to be set to a valid environment. For example: &#x60;filter&#x3D;evaluated:{\&quot;after\&quot;: 1590768455282},filterEnv:production&#x60;. - &#x60;filterEnv&#x60; is a string with the key of a valid environment. The filterEnv field is used for filters that are environment specific. If there are multiple environment specific filters you should only declare this parameter once. For example: &#x60;filter&#x3D;evaluated:{\&quot;after\&quot;: 1590768455282},filterEnv:production,status:active&#x60;. An example filter is &#x60;query:abc,tags:foo+bar&#x60;. This matches flags with the string &#x60;abc&#x60; in their key or name, ignoring case, which also have the tags &#x60;foo&#x60; and &#x60;bar&#x60;. By default, this returns all flags. You can page through the list with the &#x60;limit&#x60; parameter and by following the &#x60;first&#x60;, &#x60;prev&#x60;, &#x60;next&#x60;, and &#x60;last&#x60; links in the returned &#x60;_links&#x60; field. These links will not be present if the pages they refer to don&#39;t exist. For example, the &#x60;first&#x60; and &#x60;prev&#x60; links will be missing from the response on the first page.
550
+ # @param proj_key [String] The project key
741
551
  # @param [Hash] opts the optional parameters
742
- # @option opts [Array<String>] :env By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env&#x3D;[\&quot;production\&quot;] will restrict the returned configurations to just your production environment.
743
- # @option opts [BOOLEAN] :summary By default in api version &gt;&#x3D; 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary&#x3D;0 to include these fields for each flag returned.
744
- # @option opts [BOOLEAN] :archived When set to 1, only archived flags will be included in the list of flags returned. By default, archived flags are not included in the list of flags.
745
- # @option opts [Float] :limit The number of objects to return. Defaults to -1, which returns everything.
746
- # @option opts [Float] :offset Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
747
- # @option opts [String] :filter A comma-separated list of filters. Each filter is of the form field:value.
748
- # @option opts [String] :sort A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
749
- # @option opts [String] :tag Filter by tag. A tag can be used to group flags across projects.
750
- # @return [Array<(FeatureFlags, Fixnum, Hash)>] FeatureFlags data, response status code and response headers
751
- def get_feature_flags_with_http_info(project_key, opts = {})
552
+ # @option opts [String] :env Filter configurations by environment
553
+ # @option opts [String] :tag Filter feature flags by tag
554
+ # @option opts [Integer] :limit The number of feature flags to return. Defaults to -1, which returns all flags
555
+ # @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next limit items
556
+ # @option opts [String] :query A string that matches against the flags&#39; keys and names. It is not case sensitive
557
+ # @option opts [Boolean] :archived A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned
558
+ # @option opts [Boolean] :summary By default in API version &gt;&#x3D; 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary&#x3D;0 to include these fields for each flag returned
559
+ # @option opts [String] :filter A comma-separated list of filters. Each filter is of the form field:value
560
+ # @option opts [String] :sort A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
561
+ # @return [Array<(FeatureFlags, Integer, Hash)>] FeatureFlags data, response status code and response headers
562
+ def get_feature_flags_with_http_info(proj_key, opts = {})
752
563
  if @api_client.config.debugging
753
564
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_feature_flags ...'
754
565
  end
755
- # verify the required parameter 'project_key' is set
756
- if @api_client.config.client_side_validation && project_key.nil?
757
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_feature_flags"
566
+ # verify the required parameter 'proj_key' is set
567
+ if @api_client.config.client_side_validation && proj_key.nil?
568
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.get_feature_flags"
758
569
  end
759
570
  # resource path
760
- local_var_path = '/flags/{projectKey}'.sub('{' + 'projectKey' + '}', project_key.to_s)
571
+ local_var_path = '/api/v2/flags/{projKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s))
761
572
 
762
573
  # query parameters
763
- query_params = {}
764
- query_params[:'env'] = @api_client.build_collection_param(opts[:'env'], :multi) if !opts[:'env'].nil?
765
- query_params[:'summary'] = opts[:'summary'] if !opts[:'summary'].nil?
766
- query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
574
+ query_params = opts[:query_params] || {}
575
+ query_params[:'env'] = opts[:'env'] if !opts[:'env'].nil?
576
+ query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
767
577
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
768
578
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
579
+ query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
580
+ query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
581
+ query_params[:'summary'] = opts[:'summary'] if !opts[:'summary'].nil?
769
582
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
770
583
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
771
- query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
772
584
 
773
585
  # header parameters
774
- header_params = {}
586
+ header_params = opts[:header_params] || {}
775
587
  # HTTP header 'Accept' (if needed)
776
588
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
777
- # HTTP header 'Content-Type'
778
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
779
589
 
780
590
  # form parameters
781
- form_params = {}
591
+ form_params = opts[:form_params] || {}
782
592
 
783
593
  # http body (model)
784
- post_body = nil
785
- auth_names = ['Token']
786
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
787
- :header_params => header_params,
788
- :query_params => query_params,
789
- :form_params => form_params,
790
- :body => post_body,
791
- :auth_names => auth_names,
792
- :return_type => 'FeatureFlags')
793
- if @api_client.config.debugging
794
- @api_client.config.logger.debug "API called: FeatureFlagsApi#get_feature_flags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
795
- end
796
- return data, status_code, headers
797
- end
798
- # Get a scheduled change on a feature flag by id.
799
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
800
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
801
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
802
- # @param scheduled_change_id The id of the scheduled change
803
- # @param [Hash] opts the optional parameters
804
- # @return [FeatureFlagScheduledChange]
805
- def get_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, scheduled_change_id, opts = {})
806
- data, _status_code, _headers = get_flag_config_scheduled_change_with_http_info(project_key, feature_flag_key, environment_key, scheduled_change_id, opts)
807
- data
808
- end
594
+ post_body = opts[:debug_body]
809
595
 
810
- # Get a scheduled change on a feature flag by id.
811
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
812
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
813
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
814
- # @param scheduled_change_id The id of the scheduled change
815
- # @param [Hash] opts the optional parameters
816
- # @return [Array<(FeatureFlagScheduledChange, Fixnum, Hash)>] FeatureFlagScheduledChange data, response status code and response headers
817
- def get_flag_config_scheduled_change_with_http_info(project_key, feature_flag_key, environment_key, scheduled_change_id, opts = {})
818
- if @api_client.config.debugging
819
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_flag_config_scheduled_change ...'
820
- end
821
- # verify the required parameter 'project_key' is set
822
- if @api_client.config.client_side_validation && project_key.nil?
823
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_flag_config_scheduled_change"
824
- end
825
- # verify the required parameter 'feature_flag_key' is set
826
- if @api_client.config.client_side_validation && feature_flag_key.nil?
827
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_flag_config_scheduled_change"
828
- end
829
- # verify the required parameter 'environment_key' is set
830
- if @api_client.config.client_side_validation && environment_key.nil?
831
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_flag_config_scheduled_change"
832
- end
833
- # verify the required parameter 'scheduled_change_id' is set
834
- if @api_client.config.client_side_validation && scheduled_change_id.nil?
835
- fail ArgumentError, "Missing the required parameter 'scheduled_change_id' when calling FeatureFlagsApi.get_flag_config_scheduled_change"
836
- end
837
- # resource path
838
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'scheduledChangeId' + '}', scheduled_change_id.to_s)
839
-
840
- # query parameters
841
- query_params = {}
842
-
843
- # header parameters
844
- header_params = {}
845
- # HTTP header 'Accept' (if needed)
846
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
847
- # HTTP header 'Content-Type'
848
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
596
+ # return_type
597
+ return_type = opts[:debug_return_type] || 'FeatureFlags'
849
598
 
850
- # form parameters
851
- form_params = {}
599
+ # auth_names
600
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
852
601
 
853
- # http body (model)
854
- post_body = nil
855
- auth_names = ['Token']
856
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
602
+ new_options = opts.merge(
603
+ :operation => :"FeatureFlagsApi.get_feature_flags",
857
604
  :header_params => header_params,
858
605
  :query_params => query_params,
859
606
  :form_params => form_params,
860
607
  :body => post_body,
861
608
  :auth_names => auth_names,
862
- :return_type => 'FeatureFlagScheduledChange')
863
- if @api_client.config.debugging
864
- @api_client.config.logger.debug "API called: FeatureFlagsApi#get_flag_config_scheduled_change\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
865
- end
866
- return data, status_code, headers
867
- end
868
- # Get all scheduled workflows for a feature flag by key.
869
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
870
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
871
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
872
- # @param [Hash] opts the optional parameters
873
- # @return [FeatureFlagScheduledChanges]
874
- def get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, opts = {})
875
- data, _status_code, _headers = get_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key, opts)
876
- data
877
- end
609
+ :return_type => return_type
610
+ )
878
611
 
879
- # Get all scheduled workflows for a feature flag by key.
880
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
881
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
882
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
883
- # @param [Hash] opts the optional parameters
884
- # @return [Array<(FeatureFlagScheduledChanges, Fixnum, Hash)>] FeatureFlagScheduledChanges data, response status code and response headers
885
- def get_flag_config_scheduled_changes_with_http_info(project_key, feature_flag_key, environment_key, opts = {})
612
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
886
613
  if @api_client.config.debugging
887
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_flag_config_scheduled_changes ...'
888
- end
889
- # verify the required parameter 'project_key' is set
890
- if @api_client.config.client_side_validation && project_key.nil?
891
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_flag_config_scheduled_changes"
892
- end
893
- # verify the required parameter 'feature_flag_key' is set
894
- if @api_client.config.client_side_validation && feature_flag_key.nil?
895
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_flag_config_scheduled_changes"
896
- end
897
- # verify the required parameter 'environment_key' is set
898
- if @api_client.config.client_side_validation && environment_key.nil?
899
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_flag_config_scheduled_changes"
900
- end
901
- # resource path
902
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)
903
-
904
- # query parameters
905
- query_params = {}
906
-
907
- # header parameters
908
- header_params = {}
909
- # HTTP header 'Accept' (if needed)
910
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
911
- # HTTP header 'Content-Type'
912
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
913
-
914
- # form parameters
915
- form_params = {}
916
-
917
- # http body (model)
918
- post_body = nil
919
- auth_names = ['Token']
920
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
921
- :header_params => header_params,
922
- :query_params => query_params,
923
- :form_params => form_params,
924
- :body => post_body,
925
- :auth_names => auth_names,
926
- :return_type => 'FeatureFlagScheduledChanges')
927
- if @api_client.config.debugging
928
- @api_client.config.logger.debug "API called: FeatureFlagsApi#get_flag_config_scheduled_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
614
+ @api_client.config.logger.debug "API called: FeatureFlagsApi#get_feature_flags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
929
615
  end
930
616
  return data, status_code, headers
931
617
  end
932
- # Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
933
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
934
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
935
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
936
- # @param flag_config_scheduled_changes_conflicts_body Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag.
618
+
619
+ # Update expiring user targets on feature flag
620
+ # Update the list of user targets on a feature flag that are scheduled for removal.
621
+ # @param proj_key [String] The project key.
622
+ # @param env_key [String] The environment key.
623
+ # @param flag_key [String] The feature flag key.
624
+ # @param patch_with_comment [PatchWithComment]
937
625
  # @param [Hash] opts the optional parameters
938
- # @return [FeatureFlagScheduledChangesConflicts]
939
- def get_flag_config_scheduled_changes_conflicts(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body, opts = {})
940
- data, _status_code, _headers = get_flag_config_scheduled_changes_conflicts_with_http_info(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body, opts)
626
+ # @return [ExpiringUserTargetPatchResponse]
627
+ def patch_expiring_user_targets(proj_key, env_key, flag_key, patch_with_comment, opts = {})
628
+ data, _status_code, _headers = patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment, opts)
941
629
  data
942
630
  end
943
631
 
944
- # Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
945
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
946
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
947
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
948
- # @param flag_config_scheduled_changes_conflicts_body Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag.
632
+ # Update expiring user targets on feature flag
633
+ # Update the list of user targets on a feature flag that are scheduled for removal.
634
+ # @param proj_key [String] The project key.
635
+ # @param env_key [String] The environment key.
636
+ # @param flag_key [String] The feature flag key.
637
+ # @param patch_with_comment [PatchWithComment]
949
638
  # @param [Hash] opts the optional parameters
950
- # @return [Array<(FeatureFlagScheduledChangesConflicts, Fixnum, Hash)>] FeatureFlagScheduledChangesConflicts data, response status code and response headers
951
- def get_flag_config_scheduled_changes_conflicts_with_http_info(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body, opts = {})
639
+ # @return [Array<(ExpiringUserTargetPatchResponse, Integer, Hash)>] ExpiringUserTargetPatchResponse data, response status code and response headers
640
+ def patch_expiring_user_targets_with_http_info(proj_key, env_key, flag_key, patch_with_comment, opts = {})
952
641
  if @api_client.config.debugging
953
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.get_flag_config_scheduled_changes_conflicts ...'
642
+ @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.patch_expiring_user_targets ...'
954
643
  end
955
- # verify the required parameter 'project_key' is set
956
- if @api_client.config.client_side_validation && project_key.nil?
957
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.get_flag_config_scheduled_changes_conflicts"
644
+ # verify the required parameter 'proj_key' is set
645
+ if @api_client.config.client_side_validation && proj_key.nil?
646
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
958
647
  end
959
- # verify the required parameter 'feature_flag_key' is set
960
- if @api_client.config.client_side_validation && feature_flag_key.nil?
961
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.get_flag_config_scheduled_changes_conflicts"
648
+ # verify the required parameter 'env_key' is set
649
+ if @api_client.config.client_side_validation && env_key.nil?
650
+ fail ArgumentError, "Missing the required parameter 'env_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
962
651
  end
963
- # verify the required parameter 'environment_key' is set
964
- if @api_client.config.client_side_validation && environment_key.nil?
965
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.get_flag_config_scheduled_changes_conflicts"
652
+ # verify the required parameter 'flag_key' is set
653
+ if @api_client.config.client_side_validation && flag_key.nil?
654
+ fail ArgumentError, "Missing the required parameter 'flag_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
966
655
  end
967
- # verify the required parameter 'flag_config_scheduled_changes_conflicts_body' is set
968
- if @api_client.config.client_side_validation && flag_config_scheduled_changes_conflicts_body.nil?
969
- fail ArgumentError, "Missing the required parameter 'flag_config_scheduled_changes_conflicts_body' when calling FeatureFlagsApi.get_flag_config_scheduled_changes_conflicts"
656
+ # verify the required parameter 'patch_with_comment' is set
657
+ if @api_client.config.client_side_validation && patch_with_comment.nil?
658
+ fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling FeatureFlagsApi.patch_expiring_user_targets"
970
659
  end
971
660
  # resource path
972
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes-conflicts'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)
661
+ local_var_path = '/api/v2/flags/{projKey}/{flagKey}/expiring-user-targets/{envKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s)).sub('{' + 'flagKey' + '}', CGI.escape(flag_key.to_s))
973
662
 
974
663
  # query parameters
975
- query_params = {}
664
+ query_params = opts[:query_params] || {}
976
665
 
977
666
  # header parameters
978
- header_params = {}
667
+ header_params = opts[:header_params] || {}
979
668
  # HTTP header 'Accept' (if needed)
980
669
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
981
670
  # HTTP header 'Content-Type'
982
671
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
983
672
 
984
673
  # form parameters
985
- form_params = {}
674
+ form_params = opts[:form_params] || {}
986
675
 
987
676
  # http body (model)
988
- post_body = @api_client.object_to_http_body(flag_config_scheduled_changes_conflicts_body)
989
- auth_names = ['Token']
990
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
991
- :header_params => header_params,
992
- :query_params => query_params,
993
- :form_params => form_params,
994
- :body => post_body,
995
- :auth_names => auth_names,
996
- :return_type => 'FeatureFlagScheduledChangesConflicts')
997
- if @api_client.config.debugging
998
- @api_client.config.logger.debug "API called: FeatureFlagsApi#get_flag_config_scheduled_changes_conflicts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
999
- end
1000
- return data, status_code, headers
1001
- end
1002
- # Update, add, or delete expiring user targets on feature flag
1003
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1004
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1005
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1006
- # @param semantic_patch_with_comment Requires a Semantic Patch representation of the desired changes to the resource. &#39;https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches&#39;. The addition of comments is also supported.
1007
- # @param [Hash] opts the optional parameters
1008
- # @return [UserTargetingExpirationForFlags]
1009
- def patch_expiring_user_targets(project_key, environment_key, feature_flag_key, semantic_patch_with_comment, opts = {})
1010
- data, _status_code, _headers = patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, semantic_patch_with_comment, opts)
1011
- data
1012
- end
1013
-
1014
- # Update, add, or delete expiring user targets on feature flag
1015
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1016
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1017
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1018
- # @param semantic_patch_with_comment Requires a Semantic Patch representation of the desired changes to the resource. &#39;https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches&#39;. The addition of comments is also supported.
1019
- # @param [Hash] opts the optional parameters
1020
- # @return [Array<(UserTargetingExpirationForFlags, Fixnum, Hash)>] UserTargetingExpirationForFlags data, response status code and response headers
1021
- def patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, semantic_patch_with_comment, opts = {})
1022
- if @api_client.config.debugging
1023
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.patch_expiring_user_targets ...'
1024
- end
1025
- # verify the required parameter 'project_key' is set
1026
- if @api_client.config.client_side_validation && project_key.nil?
1027
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
1028
- end
1029
- # verify the required parameter 'environment_key' is set
1030
- if @api_client.config.client_side_validation && environment_key.nil?
1031
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
1032
- end
1033
- # verify the required parameter 'feature_flag_key' is set
1034
- if @api_client.config.client_side_validation && feature_flag_key.nil?
1035
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.patch_expiring_user_targets"
1036
- end
1037
- # verify the required parameter 'semantic_patch_with_comment' is set
1038
- if @api_client.config.client_side_validation && semantic_patch_with_comment.nil?
1039
- fail ArgumentError, "Missing the required parameter 'semantic_patch_with_comment' when calling FeatureFlagsApi.patch_expiring_user_targets"
1040
- end
1041
- # resource path
1042
- local_var_path = '/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
677
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_with_comment)
1043
678
 
1044
- # query parameters
1045
- query_params = {}
1046
-
1047
- # header parameters
1048
- header_params = {}
1049
- # HTTP header 'Accept' (if needed)
1050
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1051
- # HTTP header 'Content-Type'
1052
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
679
+ # return_type
680
+ return_type = opts[:debug_return_type] || 'ExpiringUserTargetPatchResponse'
1053
681
 
1054
- # form parameters
1055
- form_params = {}
682
+ # auth_names
683
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
1056
684
 
1057
- # http body (model)
1058
- post_body = @api_client.object_to_http_body(semantic_patch_with_comment)
1059
- auth_names = ['Token']
1060
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
685
+ new_options = opts.merge(
686
+ :operation => :"FeatureFlagsApi.patch_expiring_user_targets",
1061
687
  :header_params => header_params,
1062
688
  :query_params => query_params,
1063
689
  :form_params => form_params,
1064
690
  :body => post_body,
1065
691
  :auth_names => auth_names,
1066
- :return_type => 'UserTargetingExpirationForFlags')
692
+ :return_type => return_type
693
+ )
694
+
695
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1067
696
  if @api_client.config.debugging
1068
697
  @api_client.config.logger.debug "API called: FeatureFlagsApi#patch_expiring_user_targets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1069
698
  end
1070
699
  return data, status_code, headers
1071
700
  end
1072
- # Perform a partial update to a feature.
1073
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1074
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1075
- # @param patch_comment Requires a JSON Patch representation of the desired changes to the project, and an optional comment. &#39;http://jsonpatch.com/&#39; Feature flag patches also support JSON Merge Patch format. &#39;https://tools.ietf.org/html/rfc7386&#39; The addition of comments is also supported.
701
+
702
+ # Update feature flag
703
+ # Perform a partial update to a feature
704
+ # @param proj_key [String] The project key.
705
+ # @param key [String] The feature flag&#39;s key. The key identifies the flag in your code.
706
+ # @param patch_with_comment [PatchWithComment]
1076
707
  # @param [Hash] opts the optional parameters
1077
708
  # @return [FeatureFlag]
1078
- def patch_feature_flag(project_key, feature_flag_key, patch_comment, opts = {})
1079
- data, _status_code, _headers = patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_comment, opts)
709
+ def patch_feature_flag(proj_key, key, patch_with_comment, opts = {})
710
+ data, _status_code, _headers = patch_feature_flag_with_http_info(proj_key, key, patch_with_comment, opts)
1080
711
  data
1081
712
  end
1082
713
 
1083
- # Perform a partial update to a feature.
1084
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1085
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1086
- # @param patch_comment Requires a JSON Patch representation of the desired changes to the project, and an optional comment. &#39;http://jsonpatch.com/&#39; Feature flag patches also support JSON Merge Patch format. &#39;https://tools.ietf.org/html/rfc7386&#39; The addition of comments is also supported.
714
+ # Update feature flag
715
+ # Perform a partial update to a feature
716
+ # @param proj_key [String] The project key.
717
+ # @param key [String] The feature flag&#39;s key. The key identifies the flag in your code.
718
+ # @param patch_with_comment [PatchWithComment]
1087
719
  # @param [Hash] opts the optional parameters
1088
- # @return [Array<(FeatureFlag, Fixnum, Hash)>] FeatureFlag data, response status code and response headers
1089
- def patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_comment, opts = {})
720
+ # @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
721
+ def patch_feature_flag_with_http_info(proj_key, key, patch_with_comment, opts = {})
1090
722
  if @api_client.config.debugging
1091
723
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.patch_feature_flag ...'
1092
724
  end
1093
- # verify the required parameter 'project_key' is set
1094
- if @api_client.config.client_side_validation && project_key.nil?
1095
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.patch_feature_flag"
725
+ # verify the required parameter 'proj_key' is set
726
+ if @api_client.config.client_side_validation && proj_key.nil?
727
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.patch_feature_flag"
1096
728
  end
1097
- # verify the required parameter 'feature_flag_key' is set
1098
- if @api_client.config.client_side_validation && feature_flag_key.nil?
1099
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.patch_feature_flag"
729
+ # verify the required parameter 'key' is set
730
+ if @api_client.config.client_side_validation && key.nil?
731
+ fail ArgumentError, "Missing the required parameter 'key' when calling FeatureFlagsApi.patch_feature_flag"
1100
732
  end
1101
- # verify the required parameter 'patch_comment' is set
1102
- if @api_client.config.client_side_validation && patch_comment.nil?
1103
- fail ArgumentError, "Missing the required parameter 'patch_comment' when calling FeatureFlagsApi.patch_feature_flag"
733
+ # verify the required parameter 'patch_with_comment' is set
734
+ if @api_client.config.client_side_validation && patch_with_comment.nil?
735
+ fail ArgumentError, "Missing the required parameter 'patch_with_comment' when calling FeatureFlagsApi.patch_feature_flag"
1104
736
  end
1105
737
  # resource path
1106
- local_var_path = '/flags/{projectKey}/{featureFlagKey}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s)
738
+ local_var_path = '/api/v2/flags/{projKey}/{key}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'key' + '}', CGI.escape(key.to_s))
1107
739
 
1108
740
  # query parameters
1109
- query_params = {}
741
+ query_params = opts[:query_params] || {}
1110
742
 
1111
743
  # header parameters
1112
- header_params = {}
744
+ header_params = opts[:header_params] || {}
1113
745
  # HTTP header 'Accept' (if needed)
1114
746
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1115
747
  # HTTP header 'Content-Type'
1116
748
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1117
749
 
1118
750
  # form parameters
1119
- form_params = {}
751
+ form_params = opts[:form_params] || {}
1120
752
 
1121
753
  # http body (model)
1122
- post_body = @api_client.object_to_http_body(patch_comment)
1123
- auth_names = ['Token']
1124
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
1125
- :header_params => header_params,
1126
- :query_params => query_params,
1127
- :form_params => form_params,
1128
- :body => post_body,
1129
- :auth_names => auth_names,
1130
- :return_type => 'FeatureFlag')
1131
- if @api_client.config.debugging
1132
- @api_client.config.logger.debug "API called: FeatureFlagsApi#patch_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1133
- end
1134
- return data, status_code, headers
1135
- end
1136
- # Updates an existing scheduled-change on a feature flag in an environment.
1137
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1138
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1139
- # @param flag_config_scheduled_changes_patch_body Update scheduled changes on a feature flag.
1140
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1141
- # @param scheduled_change_id The id of the scheduled change
1142
- # @param [Hash] opts the optional parameters
1143
- # @return [FeatureFlagScheduledChange]
1144
- def patch_flag_config_scheduled_change(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id, opts = {})
1145
- data, _status_code, _headers = patch_flag_config_scheduled_change_with_http_info(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id, opts)
1146
- data
1147
- end
1148
-
1149
- # Updates an existing scheduled-change on a feature flag in an environment.
1150
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1151
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1152
- # @param flag_config_scheduled_changes_patch_body Update scheduled changes on a feature flag.
1153
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1154
- # @param scheduled_change_id The id of the scheduled change
1155
- # @param [Hash] opts the optional parameters
1156
- # @return [Array<(FeatureFlagScheduledChange, Fixnum, Hash)>] FeatureFlagScheduledChange data, response status code and response headers
1157
- def patch_flag_config_scheduled_change_with_http_info(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id, opts = {})
1158
- if @api_client.config.debugging
1159
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.patch_flag_config_scheduled_change ...'
1160
- end
1161
- # verify the required parameter 'project_key' is set
1162
- if @api_client.config.client_side_validation && project_key.nil?
1163
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.patch_flag_config_scheduled_change"
1164
- end
1165
- # verify the required parameter 'feature_flag_key' is set
1166
- if @api_client.config.client_side_validation && feature_flag_key.nil?
1167
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.patch_flag_config_scheduled_change"
1168
- end
1169
- # verify the required parameter 'flag_config_scheduled_changes_patch_body' is set
1170
- if @api_client.config.client_side_validation && flag_config_scheduled_changes_patch_body.nil?
1171
- fail ArgumentError, "Missing the required parameter 'flag_config_scheduled_changes_patch_body' when calling FeatureFlagsApi.patch_flag_config_scheduled_change"
1172
- end
1173
- # verify the required parameter 'environment_key' is set
1174
- if @api_client.config.client_side_validation && environment_key.nil?
1175
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.patch_flag_config_scheduled_change"
1176
- end
1177
- # verify the required parameter 'scheduled_change_id' is set
1178
- if @api_client.config.client_side_validation && scheduled_change_id.nil?
1179
- fail ArgumentError, "Missing the required parameter 'scheduled_change_id' when calling FeatureFlagsApi.patch_flag_config_scheduled_change"
1180
- end
1181
- # resource path
1182
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'scheduledChangeId' + '}', scheduled_change_id.to_s)
754
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_with_comment)
1183
755
 
1184
- # query parameters
1185
- query_params = {}
756
+ # return_type
757
+ return_type = opts[:debug_return_type] || 'FeatureFlag'
1186
758
 
1187
- # header parameters
1188
- header_params = {}
1189
- # HTTP header 'Accept' (if needed)
1190
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1191
- # HTTP header 'Content-Type'
1192
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
759
+ # auth_names
760
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
1193
761
 
1194
- # form parameters
1195
- form_params = {}
1196
-
1197
- # http body (model)
1198
- post_body = @api_client.object_to_http_body(flag_config_scheduled_changes_patch_body)
1199
- auth_names = ['Token']
1200
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
762
+ new_options = opts.merge(
763
+ :operation => :"FeatureFlagsApi.patch_feature_flag",
1201
764
  :header_params => header_params,
1202
765
  :query_params => query_params,
1203
766
  :form_params => form_params,
1204
767
  :body => post_body,
1205
768
  :auth_names => auth_names,
1206
- :return_type => 'FeatureFlagScheduledChange')
1207
- if @api_client.config.debugging
1208
- @api_client.config.logger.debug "API called: FeatureFlagsApi#patch_flag_config_scheduled_change\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1209
- end
1210
- return data, status_code, headers
1211
- end
1212
- # Apply approval request for a feature flag config
1213
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1214
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1215
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1216
- # @param approval_request_id The approval request ID
1217
- # @param approval_request_apply_config_body Apply an approval request
1218
- # @param [Hash] opts the optional parameters
1219
- # @return [ApprovalRequests]
1220
- def post_apply_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body, opts = {})
1221
- data, _status_code, _headers = post_apply_approval_request_with_http_info(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body, opts)
1222
- data
1223
- end
769
+ :return_type => return_type
770
+ )
1224
771
 
1225
- # Apply approval request for a feature flag config
1226
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1227
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1228
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1229
- # @param approval_request_id The approval request ID
1230
- # @param approval_request_apply_config_body Apply an approval request
1231
- # @param [Hash] opts the optional parameters
1232
- # @return [Array<(ApprovalRequests, Fixnum, Hash)>] ApprovalRequests data, response status code and response headers
1233
- def post_apply_approval_request_with_http_info(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body, opts = {})
772
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1234
773
  if @api_client.config.debugging
1235
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.post_apply_approval_request ...'
1236
- end
1237
- # verify the required parameter 'project_key' is set
1238
- if @api_client.config.client_side_validation && project_key.nil?
1239
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.post_apply_approval_request"
1240
- end
1241
- # verify the required parameter 'feature_flag_key' is set
1242
- if @api_client.config.client_side_validation && feature_flag_key.nil?
1243
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.post_apply_approval_request"
1244
- end
1245
- # verify the required parameter 'environment_key' is set
1246
- if @api_client.config.client_side_validation && environment_key.nil?
1247
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.post_apply_approval_request"
1248
- end
1249
- # verify the required parameter 'approval_request_id' is set
1250
- if @api_client.config.client_side_validation && approval_request_id.nil?
1251
- fail ArgumentError, "Missing the required parameter 'approval_request_id' when calling FeatureFlagsApi.post_apply_approval_request"
1252
- end
1253
- # verify the required parameter 'approval_request_apply_config_body' is set
1254
- if @api_client.config.client_side_validation && approval_request_apply_config_body.nil?
1255
- fail ArgumentError, "Missing the required parameter 'approval_request_apply_config_body' when calling FeatureFlagsApi.post_apply_approval_request"
1256
- end
1257
- # resource path
1258
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/apply'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'approvalRequestId' + '}', approval_request_id.to_s)
1259
-
1260
- # query parameters
1261
- query_params = {}
1262
-
1263
- # header parameters
1264
- header_params = {}
1265
- # HTTP header 'Accept' (if needed)
1266
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1267
- # HTTP header 'Content-Type'
1268
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1269
-
1270
- # form parameters
1271
- form_params = {}
1272
-
1273
- # http body (model)
1274
- post_body = @api_client.object_to_http_body(approval_request_apply_config_body)
1275
- auth_names = ['Token']
1276
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1277
- :header_params => header_params,
1278
- :query_params => query_params,
1279
- :form_params => form_params,
1280
- :body => post_body,
1281
- :auth_names => auth_names,
1282
- :return_type => 'ApprovalRequests')
1283
- if @api_client.config.debugging
1284
- @api_client.config.logger.debug "API called: FeatureFlagsApi#post_apply_approval_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
774
+ @api_client.config.logger.debug "API called: FeatureFlagsApi#patch_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1285
775
  end
1286
776
  return data, status_code, headers
1287
777
  end
1288
- # Create an approval request for a feature flag config
1289
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1290
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1291
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1292
- # @param approval_request_id The approval request ID
1293
- # @param [Hash] opts the optional parameters
1294
- # @option opts [ApprovalRequestConfigBody] :approval_request_config_body Create a new approval request
1295
- # @return [ApprovalRequest]
1296
- def post_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, opts = {})
1297
- data, _status_code, _headers = post_approval_request_with_http_info(project_key, feature_flag_key, environment_key, approval_request_id, opts)
1298
- data
1299
- end
1300
-
1301
- # Create an approval request for a feature flag config
1302
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1303
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1304
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1305
- # @param approval_request_id The approval request ID
1306
- # @param [Hash] opts the optional parameters
1307
- # @option opts [ApprovalRequestConfigBody] :approval_request_config_body Create a new approval request
1308
- # @return [Array<(ApprovalRequest, Fixnum, Hash)>] ApprovalRequest data, response status code and response headers
1309
- def post_approval_request_with_http_info(project_key, feature_flag_key, environment_key, approval_request_id, opts = {})
1310
- if @api_client.config.debugging
1311
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.post_approval_request ...'
1312
- end
1313
- # verify the required parameter 'project_key' is set
1314
- if @api_client.config.client_side_validation && project_key.nil?
1315
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.post_approval_request"
1316
- end
1317
- # verify the required parameter 'feature_flag_key' is set
1318
- if @api_client.config.client_side_validation && feature_flag_key.nil?
1319
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.post_approval_request"
1320
- end
1321
- # verify the required parameter 'environment_key' is set
1322
- if @api_client.config.client_side_validation && environment_key.nil?
1323
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.post_approval_request"
1324
- end
1325
- # verify the required parameter 'approval_request_id' is set
1326
- if @api_client.config.client_side_validation && approval_request_id.nil?
1327
- fail ArgumentError, "Missing the required parameter 'approval_request_id' when calling FeatureFlagsApi.post_approval_request"
1328
- end
1329
- # resource path
1330
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'approvalRequestId' + '}', approval_request_id.to_s)
1331
778
 
1332
- # query parameters
1333
- query_params = {}
1334
-
1335
- # header parameters
1336
- header_params = {}
1337
- # HTTP header 'Accept' (if needed)
1338
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1339
- # HTTP header 'Content-Type'
1340
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1341
-
1342
- # form parameters
1343
- form_params = {}
1344
-
1345
- # http body (model)
1346
- post_body = @api_client.object_to_http_body(opts[:'approval_request_config_body'])
1347
- auth_names = ['Token']
1348
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1349
- :header_params => header_params,
1350
- :query_params => query_params,
1351
- :form_params => form_params,
1352
- :body => post_body,
1353
- :auth_names => auth_names,
1354
- :return_type => 'ApprovalRequest')
1355
- if @api_client.config.debugging
1356
- @api_client.config.logger.debug "API called: FeatureFlagsApi#post_approval_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1357
- end
1358
- return data, status_code, headers
1359
- end
1360
- # Creates a new feature flag.
1361
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1362
- # @param feature_flag_body Create a new feature flag.
779
+ # Create a feature flag
780
+ # Create a feature flag with the given name, key, and variations
781
+ # @param proj_key [String] The project key.
782
+ # @param feature_flag_body [FeatureFlagBody]
1363
783
  # @param [Hash] opts the optional parameters
1364
- # @option opts [String] :clone The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting clone&#x3D;flagKey will copy the full targeting configuration for all environments (including on/off state) from the original flag to the new flag.
784
+ # @option opts [String] :clone The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting &#x60;clone&#x3D;flagKey&#x60; copies the full targeting configuration for all environments, including &#x60;on/off&#x60; state, from the original flag to the new flag.
1365
785
  # @return [FeatureFlag]
1366
- def post_feature_flag(project_key, feature_flag_body, opts = {})
1367
- data, _status_code, _headers = post_feature_flag_with_http_info(project_key, feature_flag_body, opts)
786
+ def post_feature_flag(proj_key, feature_flag_body, opts = {})
787
+ data, _status_code, _headers = post_feature_flag_with_http_info(proj_key, feature_flag_body, opts)
1368
788
  data
1369
789
  end
1370
790
 
1371
- # Creates a new feature flag.
1372
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1373
- # @param feature_flag_body Create a new feature flag.
791
+ # Create a feature flag
792
+ # Create a feature flag with the given name, key, and variations
793
+ # @param proj_key [String] The project key.
794
+ # @param feature_flag_body [FeatureFlagBody]
1374
795
  # @param [Hash] opts the optional parameters
1375
- # @option opts [String] :clone The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting clone&#x3D;flagKey will copy the full targeting configuration for all environments (including on/off state) from the original flag to the new flag.
1376
- # @return [Array<(FeatureFlag, Fixnum, Hash)>] FeatureFlag data, response status code and response headers
1377
- def post_feature_flag_with_http_info(project_key, feature_flag_body, opts = {})
796
+ # @option opts [String] :clone The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting &#x60;clone&#x3D;flagKey&#x60; copies the full targeting configuration for all environments, including &#x60;on/off&#x60; state, from the original flag to the new flag.
797
+ # @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
798
+ def post_feature_flag_with_http_info(proj_key, feature_flag_body, opts = {})
1378
799
  if @api_client.config.debugging
1379
800
  @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.post_feature_flag ...'
1380
801
  end
1381
- # verify the required parameter 'project_key' is set
1382
- if @api_client.config.client_side_validation && project_key.nil?
1383
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.post_feature_flag"
802
+ # verify the required parameter 'proj_key' is set
803
+ if @api_client.config.client_side_validation && proj_key.nil?
804
+ fail ArgumentError, "Missing the required parameter 'proj_key' when calling FeatureFlagsApi.post_feature_flag"
1384
805
  end
1385
806
  # verify the required parameter 'feature_flag_body' is set
1386
807
  if @api_client.config.client_side_validation && feature_flag_body.nil?
1387
808
  fail ArgumentError, "Missing the required parameter 'feature_flag_body' when calling FeatureFlagsApi.post_feature_flag"
1388
809
  end
1389
810
  # resource path
1390
- local_var_path = '/flags/{projectKey}'.sub('{' + 'projectKey' + '}', project_key.to_s)
811
+ local_var_path = '/api/v2/flags/{projKey}'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s))
1391
812
 
1392
813
  # query parameters
1393
- query_params = {}
814
+ query_params = opts[:query_params] || {}
1394
815
  query_params[:'clone'] = opts[:'clone'] if !opts[:'clone'].nil?
1395
816
 
1396
817
  # header parameters
1397
- header_params = {}
818
+ header_params = opts[:header_params] || {}
1398
819
  # HTTP header 'Accept' (if needed)
1399
820
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1400
821
  # HTTP header 'Content-Type'
1401
822
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1402
823
 
1403
824
  # form parameters
1404
- form_params = {}
825
+ form_params = opts[:form_params] || {}
1405
826
 
1406
827
  # http body (model)
1407
- post_body = @api_client.object_to_http_body(feature_flag_body)
1408
- auth_names = ['Token']
1409
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1410
- :header_params => header_params,
1411
- :query_params => query_params,
1412
- :form_params => form_params,
1413
- :body => post_body,
1414
- :auth_names => auth_names,
1415
- :return_type => 'FeatureFlag')
1416
- if @api_client.config.debugging
1417
- @api_client.config.logger.debug "API called: FeatureFlagsApi#post_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1418
- end
1419
- return data, status_code, headers
1420
- end
1421
- # Creates a new scheduled change for a feature flag.
1422
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1423
- # @param flag_config_scheduled_changes_post_body Create scheduled changes on a feature flag.
1424
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1425
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1426
- # @param [Hash] opts the optional parameters
1427
- # @return [FeatureFlagScheduledChange]
1428
- def post_flag_config_scheduled_changes(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, opts = {})
1429
- data, _status_code, _headers = post_flag_config_scheduled_changes_with_http_info(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, opts)
1430
- data
1431
- end
1432
-
1433
- # Creates a new scheduled change for a feature flag.
1434
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1435
- # @param flag_config_scheduled_changes_post_body Create scheduled changes on a feature flag.
1436
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1437
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1438
- # @param [Hash] opts the optional parameters
1439
- # @return [Array<(FeatureFlagScheduledChange, Fixnum, Hash)>] FeatureFlagScheduledChange data, response status code and response headers
1440
- def post_flag_config_scheduled_changes_with_http_info(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, opts = {})
1441
- if @api_client.config.debugging
1442
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.post_flag_config_scheduled_changes ...'
1443
- end
1444
- # verify the required parameter 'project_key' is set
1445
- if @api_client.config.client_side_validation && project_key.nil?
1446
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.post_flag_config_scheduled_changes"
1447
- end
1448
- # verify the required parameter 'flag_config_scheduled_changes_post_body' is set
1449
- if @api_client.config.client_side_validation && flag_config_scheduled_changes_post_body.nil?
1450
- fail ArgumentError, "Missing the required parameter 'flag_config_scheduled_changes_post_body' when calling FeatureFlagsApi.post_flag_config_scheduled_changes"
1451
- end
1452
- # verify the required parameter 'feature_flag_key' is set
1453
- if @api_client.config.client_side_validation && feature_flag_key.nil?
1454
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.post_flag_config_scheduled_changes"
1455
- end
1456
- # verify the required parameter 'environment_key' is set
1457
- if @api_client.config.client_side_validation && environment_key.nil?
1458
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.post_flag_config_scheduled_changes"
1459
- end
1460
- # resource path
1461
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s)
1462
-
1463
- # query parameters
1464
- query_params = {}
828
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(feature_flag_body)
1465
829
 
1466
- # header parameters
1467
- header_params = {}
1468
- # HTTP header 'Accept' (if needed)
1469
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1470
- # HTTP header 'Content-Type'
1471
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
830
+ # return_type
831
+ return_type = opts[:debug_return_type] || 'FeatureFlag'
1472
832
 
1473
- # form parameters
1474
- form_params = {}
833
+ # auth_names
834
+ auth_names = opts[:debug_auth_names] || ['ApiKey']
1475
835
 
1476
- # http body (model)
1477
- post_body = @api_client.object_to_http_body(flag_config_scheduled_changes_post_body)
1478
- auth_names = ['Token']
1479
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
836
+ new_options = opts.merge(
837
+ :operation => :"FeatureFlagsApi.post_feature_flag",
1480
838
  :header_params => header_params,
1481
839
  :query_params => query_params,
1482
840
  :form_params => form_params,
1483
841
  :body => post_body,
1484
842
  :auth_names => auth_names,
1485
- :return_type => 'FeatureFlagScheduledChange')
1486
- if @api_client.config.debugging
1487
- @api_client.config.logger.debug "API called: FeatureFlagsApi#post_flag_config_scheduled_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1488
- end
1489
- return data, status_code, headers
1490
- end
1491
- # Review approval request for a feature flag config
1492
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1493
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1494
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1495
- # @param approval_request_id The approval request ID
1496
- # @param approval_request_review_config_body Review an approval request
1497
- # @param [Hash] opts the optional parameters
1498
- # @return [ApprovalRequests]
1499
- def post_review_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body, opts = {})
1500
- data, _status_code, _headers = post_review_approval_request_with_http_info(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body, opts)
1501
- data
1502
- end
843
+ :return_type => return_type
844
+ )
1503
845
 
1504
- # Review approval request for a feature flag config
1505
- # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
1506
- # @param feature_flag_key The feature flag&#39;s key. The key identifies the flag in your code.
1507
- # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
1508
- # @param approval_request_id The approval request ID
1509
- # @param approval_request_review_config_body Review an approval request
1510
- # @param [Hash] opts the optional parameters
1511
- # @return [Array<(ApprovalRequests, Fixnum, Hash)>] ApprovalRequests data, response status code and response headers
1512
- def post_review_approval_request_with_http_info(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body, opts = {})
846
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1513
847
  if @api_client.config.debugging
1514
- @api_client.config.logger.debug 'Calling API: FeatureFlagsApi.post_review_approval_request ...'
1515
- end
1516
- # verify the required parameter 'project_key' is set
1517
- if @api_client.config.client_side_validation && project_key.nil?
1518
- fail ArgumentError, "Missing the required parameter 'project_key' when calling FeatureFlagsApi.post_review_approval_request"
1519
- end
1520
- # verify the required parameter 'feature_flag_key' is set
1521
- if @api_client.config.client_side_validation && feature_flag_key.nil?
1522
- fail ArgumentError, "Missing the required parameter 'feature_flag_key' when calling FeatureFlagsApi.post_review_approval_request"
1523
- end
1524
- # verify the required parameter 'environment_key' is set
1525
- if @api_client.config.client_side_validation && environment_key.nil?
1526
- fail ArgumentError, "Missing the required parameter 'environment_key' when calling FeatureFlagsApi.post_review_approval_request"
1527
- end
1528
- # verify the required parameter 'approval_request_id' is set
1529
- if @api_client.config.client_side_validation && approval_request_id.nil?
1530
- fail ArgumentError, "Missing the required parameter 'approval_request_id' when calling FeatureFlagsApi.post_review_approval_request"
1531
- end
1532
- # verify the required parameter 'approval_request_review_config_body' is set
1533
- if @api_client.config.client_side_validation && approval_request_review_config_body.nil?
1534
- fail ArgumentError, "Missing the required parameter 'approval_request_review_config_body' when calling FeatureFlagsApi.post_review_approval_request"
1535
- end
1536
- # resource path
1537
- local_var_path = '/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/review'.sub('{' + 'projectKey' + '}', project_key.to_s).sub('{' + 'featureFlagKey' + '}', feature_flag_key.to_s).sub('{' + 'environmentKey' + '}', environment_key.to_s).sub('{' + 'approvalRequestId' + '}', approval_request_id.to_s)
1538
-
1539
- # query parameters
1540
- query_params = {}
1541
-
1542
- # header parameters
1543
- header_params = {}
1544
- # HTTP header 'Accept' (if needed)
1545
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1546
- # HTTP header 'Content-Type'
1547
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1548
-
1549
- # form parameters
1550
- form_params = {}
1551
-
1552
- # http body (model)
1553
- post_body = @api_client.object_to_http_body(approval_request_review_config_body)
1554
- auth_names = ['Token']
1555
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1556
- :header_params => header_params,
1557
- :query_params => query_params,
1558
- :form_params => form_params,
1559
- :body => post_body,
1560
- :auth_names => auth_names,
1561
- :return_type => 'ApprovalRequests')
1562
- if @api_client.config.debugging
1563
- @api_client.config.logger.debug "API called: FeatureFlagsApi#post_review_approval_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
848
+ @api_client.config.logger.debug "API called: FeatureFlagsApi#post_feature_flag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1564
849
  end
1565
850
  return data, status_code, headers
1566
851
  end