launchdarkly_api 5.3.0 → 7.0.0

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