launchdarkly_api 25.2.0 → 25.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +64 -39
  3. data/docs/AIConfig.md +7 -5
  4. data/docs/AIConfigPatch.md +8 -4
  5. data/docs/AIConfigPost.md +8 -6
  6. data/docs/AIConfigTargeting.md +3 -3
  7. data/docs/AIConfigTargetingEnvironmentRule.md +8 -0
  8. data/docs/AIConfigTargetingEnvironmentRuleClause.md +2 -0
  9. data/docs/AIConfigVariation.md +1 -1
  10. data/docs/AIConfigVariationPatch.md +1 -1
  11. data/docs/AgentControlApi.md +110 -110
  12. data/docs/AgentOptimization.md +1 -1
  13. data/docs/AgentOptimizationJudge.md +1 -1
  14. data/docs/AgentOptimizationPost.md +1 -1
  15. data/docs/AgentSkill.md +3 -1
  16. data/docs/AgentSkillPatch.md +3 -1
  17. data/docs/AgentSkillPost.md +3 -1
  18. data/docs/AiConfigsMetricListingRep.md +2 -0
  19. data/docs/ApprovalsApi.md +1 -1
  20. data/docs/CreateFlagReleasePlanRequest.md +32 -0
  21. data/docs/EnvironmentReleasePlan.md +38 -0
  22. data/docs/EnvironmentReleasePlanClause.md +28 -0
  23. data/docs/EnvironmentReleasePlanMetric.md +20 -0
  24. data/docs/EnvironmentReleasePlanPhase.md +24 -0
  25. data/docs/EnvironmentReleasePlanProgressiveRelease.md +26 -0
  26. data/docs/EnvironmentReleasePlanProgressiveReleaseRep.md +26 -0
  27. data/docs/EnvironmentReleasePlanStep.md +22 -0
  28. data/docs/EnvironmentReleasePlans.md +22 -0
  29. data/docs/EnvironmentReleasePlansBetaApi.md +633 -0
  30. data/docs/EnvironmentReleasePlansLink.md +20 -0
  31. data/docs/EnvironmentReleasePlansPaginatedLinks.md +26 -0
  32. data/docs/EnvironmentReleasesMetricListingRep.md +2 -0
  33. data/docs/{ReleaseMethod.md → ExecutionMode.md} +2 -2
  34. data/docs/FeatureFlagsApi.md +1 -1
  35. data/docs/FlagReleasePlan.md +36 -0
  36. data/docs/FlagReleasePlanEnvironment.md +24 -0
  37. data/docs/FlagReleasePlanRequest.md +30 -0
  38. data/docs/FlagReleasePlansBetaApi.md +392 -0
  39. data/docs/FlagReleasePlansError.md +20 -0
  40. data/docs/FlagReleasePlansLink.md +20 -0
  41. data/docs/FlagReleasePlansPaginatedLinks.md +26 -0
  42. data/docs/ListFlagReleasePlansResponse.md +22 -0
  43. data/docs/MaintainerIdentifier.md +79 -0
  44. data/docs/MaintainerIdentifierMember.md +20 -0
  45. data/docs/MaintainerIdentifierTeam.md +20 -0
  46. data/docs/MaintainerResponse.md +79 -0
  47. data/docs/MaintainerResponseMember.md +26 -0
  48. data/docs/MaintainerResponseTeam.md +22 -0
  49. data/docs/PinnedSkillToolRef.md +20 -0
  50. data/docs/PostEnvironmentReleasePlanRequest.md +26 -0
  51. data/docs/PutDefaultEnvironmentReleasePlanRequest.md +18 -0
  52. data/docs/PutEnvironmentReleasePlanRequest.md +26 -0
  53. data/docs/PutFlagReleasePlanRequest.md +32 -0
  54. data/docs/QuickStats.md +2 -2
  55. data/docs/SkillToolRef.md +20 -0
  56. data/docs/ToolReferences.md +5 -1
  57. data/docs/ToolSkillReference.md +22 -0
  58. data/docs/TriggerType.md +15 -0
  59. data/lib/launchdarkly_api/api/agent_control_api.rb +98 -98
  60. data/lib/launchdarkly_api/api/approvals_api.rb +2 -2
  61. data/lib/launchdarkly_api/api/environment_release_plans_beta_api.rb +730 -0
  62. data/lib/launchdarkly_api/api/feature_flags_api.rb +2 -2
  63. data/lib/launchdarkly_api/api/{release_policies_beta_api.rb → flag_release_plans_beta_api.rb} +173 -212
  64. data/lib/launchdarkly_api/models/agent_optimization.rb +1 -1
  65. data/lib/launchdarkly_api/models/agent_optimization_judge.rb +1 -1
  66. data/lib/launchdarkly_api/models/agent_optimization_post.rb +1 -1
  67. data/lib/launchdarkly_api/models/agent_skill.rb +14 -2
  68. data/lib/launchdarkly_api/models/agent_skill_patch.rb +16 -4
  69. data/lib/launchdarkly_api/models/agent_skill_post.rb +16 -4
  70. data/lib/launchdarkly_api/models/ai_config.rb +16 -6
  71. data/lib/launchdarkly_api/models/ai_config_patch.rb +27 -7
  72. data/lib/launchdarkly_api/models/ai_config_post.rb +19 -9
  73. data/lib/launchdarkly_api/models/ai_config_targeting.rb +3 -3
  74. data/lib/launchdarkly_api/models/ai_config_targeting_environment_rule.rb +40 -1
  75. data/lib/launchdarkly_api/models/ai_config_targeting_environment_rule_clause.rb +11 -1
  76. data/lib/launchdarkly_api/models/ai_config_variation.rb +1 -1
  77. data/lib/launchdarkly_api/models/ai_config_variation_patch.rb +1 -1
  78. data/lib/launchdarkly_api/models/ai_configs_metric_listing_rep.rb +11 -1
  79. data/lib/launchdarkly_api/models/create_flag_release_plan_request.rb +335 -0
  80. data/lib/launchdarkly_api/models/environment_release_plan.rb +426 -0
  81. data/lib/launchdarkly_api/models/{release_policies_access_allowed_reason.rb → environment_release_plan_clause.rb} +98 -65
  82. data/lib/launchdarkly_api/models/{release_policies_access_allowed_rep.rb → environment_release_plan_metric.rb} +28 -41
  83. data/lib/launchdarkly_api/models/environment_release_plan_phase.rb +208 -0
  84. data/lib/launchdarkly_api/models/environment_release_plan_progressive_release.rb +285 -0
  85. data/lib/launchdarkly_api/models/{release_policies_access_denied_reason.rb → environment_release_plan_progressive_release_rep.rb} +85 -67
  86. data/lib/launchdarkly_api/models/{release_policy_stage.rb → environment_release_plan_step.rb} +43 -4
  87. data/lib/launchdarkly_api/models/{release_policies_response.rb → environment_release_plans.rb} +16 -7
  88. data/lib/launchdarkly_api/models/{release_policies_access_denied.rb → environment_release_plans_link.rb} +16 -50
  89. data/lib/launchdarkly_api/models/environment_release_plans_paginated_links.rb +200 -0
  90. data/lib/launchdarkly_api/models/environment_releases_metric_listing_rep.rb +11 -1
  91. data/lib/launchdarkly_api/models/{release_method.rb → execution_mode.rb} +6 -7
  92. data/lib/launchdarkly_api/models/expanded_ai_config.rb +1 -1
  93. data/lib/launchdarkly_api/models/flag_release_plan.rb +359 -0
  94. data/lib/launchdarkly_api/models/{put_release_policy_request.rb → flag_release_plan_environment.rb} +47 -65
  95. data/lib/launchdarkly_api/models/{post_release_policy_request.rb → flag_release_plan_request.rb} +64 -67
  96. data/lib/launchdarkly_api/models/flag_release_plans_error.rb +208 -0
  97. data/lib/launchdarkly_api/models/flag_release_plans_link.rb +156 -0
  98. data/lib/launchdarkly_api/models/flag_release_plans_paginated_links.rb +200 -0
  99. data/lib/launchdarkly_api/models/list_flag_release_plans_response.rb +202 -0
  100. data/lib/launchdarkly_api/models/maintainer_identifier.rb +56 -0
  101. data/lib/launchdarkly_api/models/maintainer_identifier_member.rb +214 -0
  102. data/lib/launchdarkly_api/models/{progressive_release_config.rb → maintainer_identifier_team.rb} +66 -32
  103. data/lib/launchdarkly_api/models/maintainer_response.rb +56 -0
  104. data/lib/launchdarkly_api/models/maintainer_response_member.rb +225 -0
  105. data/lib/launchdarkly_api/models/maintainer_response_team.rb +206 -0
  106. data/lib/launchdarkly_api/models/{release_policies_access_rep.rb → pinned_skill_tool_ref.rb} +46 -45
  107. data/lib/launchdarkly_api/models/{release_policy.rb → post_environment_release_plan_request.rb} +93 -120
  108. data/lib/launchdarkly_api/models/{release_policies_access.rb → put_default_environment_release_plan_request.rb} +33 -44
  109. data/lib/launchdarkly_api/models/put_environment_release_plan_request.rb +285 -0
  110. data/lib/launchdarkly_api/models/put_flag_release_plan_request.rb +309 -0
  111. data/lib/launchdarkly_api/models/quick_stats.rb +2 -2
  112. data/lib/launchdarkly_api/models/skill_tool_ref.rb +195 -0
  113. data/lib/launchdarkly_api/models/tool_references.rb +26 -4
  114. data/lib/launchdarkly_api/models/tool_skill_reference.rb +220 -0
  115. data/lib/launchdarkly_api/models/trigger_type.rb +42 -0
  116. data/lib/launchdarkly_api/version.rb +1 -1
  117. data/lib/launchdarkly_api.rb +35 -16
  118. data/spec/api/agent_control_api_spec.rb +49 -49
  119. data/spec/api/approvals_api_spec.rb +1 -1
  120. data/spec/api/environment_release_plans_beta_api_spec.rb +156 -0
  121. data/spec/api/feature_flags_api_spec.rb +1 -1
  122. data/spec/api/{release_policies_beta_api_spec.rb → flag_release_plans_beta_api_spec.rb} +43 -56
  123. data/spec/models/agent_skill_patch_spec.rb +6 -0
  124. data/spec/models/agent_skill_post_spec.rb +6 -0
  125. data/spec/models/agent_skill_spec.rb +6 -0
  126. data/spec/models/ai_config_patch_spec.rb +12 -0
  127. data/spec/models/ai_config_post_spec.rb +6 -0
  128. data/spec/models/ai_config_spec.rb +6 -0
  129. data/spec/models/ai_config_targeting_environment_rule_clause_spec.rb +6 -0
  130. data/spec/models/ai_config_targeting_environment_rule_spec.rb +24 -0
  131. data/spec/models/ai_configs_metric_listing_rep_spec.rb +6 -0
  132. data/spec/models/{release_policy_spec.rb → create_flag_release_plan_request_spec.rb} +13 -19
  133. data/spec/models/{release_policies_access_allowed_reason_spec.rb → environment_release_plan_clause_spec.rb} +16 -16
  134. data/spec/models/{release_policies_access_rep_spec.rb → environment_release_plan_metric_spec.rb} +8 -8
  135. data/spec/models/environment_release_plan_phase_spec.rb +54 -0
  136. data/spec/models/environment_release_plan_progressive_release_rep_spec.rb +68 -0
  137. data/spec/models/environment_release_plan_progressive_release_spec.rb +68 -0
  138. data/spec/models/environment_release_plan_spec.rb +100 -0
  139. data/spec/models/{release_policies_access_allowed_rep_spec.rb → environment_release_plan_step_spec.rb} +14 -8
  140. data/spec/models/{release_policies_access_denied_spec.rb → environment_release_plans_link_spec.rb} +8 -8
  141. data/spec/models/{guarded_release_config_spec.rb → environment_release_plans_paginated_links_spec.rb} +11 -17
  142. data/spec/models/environment_release_plans_spec.rb +48 -0
  143. data/spec/models/environment_releases_metric_listing_rep_spec.rb +6 -0
  144. data/spec/models/{release_method_spec.rb → execution_mode_spec.rb} +6 -6
  145. data/spec/models/flag_release_plan_environment_spec.rb +54 -0
  146. data/spec/models/{release_policies_access_denied_reason_spec.rb → flag_release_plan_request_spec.rb} +18 -16
  147. data/spec/models/flag_release_plan_spec.rb +90 -0
  148. data/spec/models/{release_policy_scope_spec.rb → flag_release_plans_error_spec.rb} +8 -8
  149. data/spec/models/{release_policy_stage_spec.rb → flag_release_plans_link_spec.rb} +8 -8
  150. data/spec/models/{put_release_policy_request_spec.rb → flag_release_plans_paginated_links_spec.rb} +11 -11
  151. data/spec/models/list_flag_release_plans_response_spec.rb +48 -0
  152. data/spec/models/maintainer_identifier_member_spec.rb +46 -0
  153. data/spec/models/maintainer_identifier_spec.rb +44 -0
  154. data/spec/models/{progressive_release_config_spec.rb → maintainer_identifier_team_spec.rb} +12 -8
  155. data/spec/models/maintainer_response_member_spec.rb +64 -0
  156. data/spec/models/maintainer_response_spec.rb +44 -0
  157. data/spec/models/maintainer_response_team_spec.rb +52 -0
  158. data/spec/models/{release_policies_access_spec.rb → pinned_skill_tool_ref_spec.rb} +8 -8
  159. data/spec/models/{post_release_policy_request_spec.rb → post_environment_release_plan_request_spec.rb} +15 -17
  160. data/spec/models/put_default_environment_release_plan_request_spec.rb +36 -0
  161. data/spec/models/put_environment_release_plan_request_spec.rb +64 -0
  162. data/spec/models/put_flag_release_plan_request_spec.rb +78 -0
  163. data/spec/models/{release_policies_response_spec.rb → skill_tool_ref_spec.rb} +8 -8
  164. data/spec/models/tool_references_spec.rb +12 -0
  165. data/spec/models/tool_skill_reference_spec.rb +48 -0
  166. data/spec/models/trigger_type_spec.rb +30 -0
  167. metadata +141 -65
  168. data/docs/GuardedReleaseConfig.md +0 -28
  169. data/docs/PostReleasePolicyRequest.md +0 -28
  170. data/docs/ProgressiveReleaseConfig.md +0 -20
  171. data/docs/PutReleasePolicyRequest.md +0 -26
  172. data/docs/ReleasePoliciesAccess.md +0 -20
  173. data/docs/ReleasePoliciesAccessAllowedReason.md +0 -28
  174. data/docs/ReleasePoliciesAccessAllowedRep.md +0 -20
  175. data/docs/ReleasePoliciesAccessDenied.md +0 -20
  176. data/docs/ReleasePoliciesAccessDeniedReason.md +0 -28
  177. data/docs/ReleasePoliciesAccessRep.md +0 -20
  178. data/docs/ReleasePoliciesBetaApi.md +0 -466
  179. data/docs/ReleasePoliciesResponse.md +0 -20
  180. data/docs/ReleasePolicy.md +0 -34
  181. data/docs/ReleasePolicyScope.md +0 -20
  182. data/docs/ReleasePolicyStage.md +0 -20
  183. data/lib/launchdarkly_api/models/guarded_release_config.rb +0 -224
  184. data/lib/launchdarkly_api/models/release_policy_scope.rb +0 -181
@@ -13,38 +13,38 @@ Generator version: 7.18.0
13
13
  require 'cgi'
14
14
 
15
15
  module LaunchDarklyApi
16
- class ReleasePoliciesBetaApi
16
+ class FlagReleasePlansBetaApi
17
17
  attr_accessor :api_client
18
18
 
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Delete a release policy
23
- # Delete an existing release policy for the specified project.
22
+ # Create a flag release plan for a project
23
+ # Creates a flag release plan. The key must not be in use by another active plan in the project, or the request is rejected with 409. The request is rejected with 400 when an environment isn't in the project, the maintainer isn't in the account, an environment release plan doesn't exist, is incomplete, or is in another environment, `default` is set while the project already has a default plan, or the project already has the maximum number of plans. To make a new plan the project's default, create it, then update it with `default` set, which demotes the current default.
24
24
  # @param ld_api_version [String] Version of the endpoint.
25
- # @param project_key [String] The project key
26
- # @param policy_key [String] The human-readable key of the release policy
25
+ # @param project_key [String]
26
+ # @param create_flag_release_plan_request [CreateFlagReleasePlanRequest]
27
27
  # @param [Hash] opts the optional parameters
28
- # @return [nil]
29
- def delete_release_policy(ld_api_version, project_key, policy_key, opts = {})
30
- delete_release_policy_with_http_info(ld_api_version, project_key, policy_key, opts)
31
- nil
28
+ # @return [FlagReleasePlan]
29
+ def create_flag_release_plan(ld_api_version, project_key, create_flag_release_plan_request, opts = {})
30
+ data, _status_code, _headers = create_flag_release_plan_with_http_info(ld_api_version, project_key, create_flag_release_plan_request, opts)
31
+ data
32
32
  end
33
33
 
34
- # Delete a release policy
35
- # Delete an existing release policy for the specified project.
34
+ # Create a flag release plan for a project
35
+ # Creates a flag release plan. The key must not be in use by another active plan in the project, or the request is rejected with 409. The request is rejected with 400 when an environment isn't in the project, the maintainer isn't in the account, an environment release plan doesn't exist, is incomplete, or is in another environment, `default` is set while the project already has a default plan, or the project already has the maximum number of plans. To make a new plan the project's default, create it, then update it with `default` set, which demotes the current default.
36
36
  # @param ld_api_version [String] Version of the endpoint.
37
- # @param project_key [String] The project key
38
- # @param policy_key [String] The human-readable key of the release policy
37
+ # @param project_key [String]
38
+ # @param create_flag_release_plan_request [CreateFlagReleasePlanRequest]
39
39
  # @param [Hash] opts the optional parameters
40
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
41
- def delete_release_policy_with_http_info(ld_api_version, project_key, policy_key, opts = {})
40
+ # @return [Array<(FlagReleasePlan, Integer, Hash)>] FlagReleasePlan data, response status code and response headers
41
+ def create_flag_release_plan_with_http_info(ld_api_version, project_key, create_flag_release_plan_request, opts = {})
42
42
  if @api_client.config.debugging
43
- @api_client.config.logger.debug 'Calling API: ReleasePoliciesBetaApi.delete_release_policy ...'
43
+ @api_client.config.logger.debug 'Calling API: FlagReleasePlansBetaApi.create_flag_release_plan ...'
44
44
  end
45
45
  # verify the required parameter 'ld_api_version' is set
46
46
  if @api_client.config.client_side_validation && ld_api_version.nil?
47
- fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling ReleasePoliciesBetaApi.delete_release_policy"
47
+ fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling FlagReleasePlansBetaApi.create_flag_release_plan"
48
48
  end
49
49
  # verify enum value
50
50
  allowable_values = ["beta"]
@@ -53,14 +53,18 @@ module LaunchDarklyApi
53
53
  end
54
54
  # verify the required parameter 'project_key' is set
55
55
  if @api_client.config.client_side_validation && project_key.nil?
56
- fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePoliciesBetaApi.delete_release_policy"
56
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FlagReleasePlansBetaApi.create_flag_release_plan"
57
57
  end
58
- # verify the required parameter 'policy_key' is set
59
- if @api_client.config.client_side_validation && policy_key.nil?
60
- fail ArgumentError, "Missing the required parameter 'policy_key' when calling ReleasePoliciesBetaApi.delete_release_policy"
58
+ if @api_client.config.client_side_validation && project_key.to_s.length < 1
59
+ fail ArgumentError, 'invalid value for "project_key" when calling FlagReleasePlansBetaApi.create_flag_release_plan, the character length must be greater than or equal to 1.'
60
+ end
61
+
62
+ # verify the required parameter 'create_flag_release_plan_request' is set
63
+ if @api_client.config.client_side_validation && create_flag_release_plan_request.nil?
64
+ fail ArgumentError, "Missing the required parameter 'create_flag_release_plan_request' when calling FlagReleasePlansBetaApi.create_flag_release_plan"
61
65
  end
62
66
  # resource path
63
- local_var_path = '/api/v2/projects/{projectKey}/release-policies/{policyKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'policyKey' + '}', CGI.escape(policy_key.to_s))
67
+ local_var_path = '/api/v2/projects/{projectKey}/flag-release-plans'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
64
68
 
65
69
  # query parameters
66
70
  query_params = opts[:query_params] || {}
@@ -69,22 +73,27 @@ module LaunchDarklyApi
69
73
  header_params = opts[:header_params] || {}
70
74
  # HTTP header 'Accept' (if needed)
71
75
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
76
+ # HTTP header 'Content-Type'
77
+ content_type = @api_client.select_header_content_type(['application/json'])
78
+ if !content_type.nil?
79
+ header_params['Content-Type'] = content_type
80
+ end
72
81
  header_params[:'LD-API-Version'] = ld_api_version
73
82
 
74
83
  # form parameters
75
84
  form_params = opts[:form_params] || {}
76
85
 
77
86
  # http body (model)
78
- post_body = opts[:debug_body]
87
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_flag_release_plan_request)
79
88
 
80
89
  # return_type
81
- return_type = opts[:debug_return_type]
90
+ return_type = opts[:debug_return_type] || 'FlagReleasePlan'
82
91
 
83
92
  # auth_names
84
93
  auth_names = opts[:debug_auth_names] || ['ApiKey']
85
94
 
86
95
  new_options = opts.merge(
87
- :operation => :"ReleasePoliciesBetaApi.delete_release_policy",
96
+ :operation => :"FlagReleasePlansBetaApi.create_flag_release_plan",
88
97
  :header_params => header_params,
89
98
  :query_params => query_params,
90
99
  :form_params => form_params,
@@ -93,39 +102,39 @@ module LaunchDarklyApi
93
102
  :return_type => return_type
94
103
  )
95
104
 
96
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
105
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
97
106
  if @api_client.config.debugging
98
- @api_client.config.logger.debug "API called: ReleasePoliciesBetaApi#delete_release_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
107
+ @api_client.config.logger.debug "API called: FlagReleasePlansBetaApi#create_flag_release_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
99
108
  end
100
109
  return data, status_code, headers
101
110
  end
102
111
 
103
- # List release policies
104
- # Get a list of release policies for the specified project with optional filtering.
112
+ # Delete a flag release plan in a project
113
+ # Delete a flag release plan in a project.
105
114
  # @param ld_api_version [String] Version of the endpoint.
106
- # @param project_key [String] The project key
115
+ # @param project_key [String]
116
+ # @param plan_key [String]
107
117
  # @param [Hash] opts the optional parameters
108
- # @option opts [Boolean] :exclude_default When true, exclude the default release policy from the response. When false or omitted, include the default policy if an environment filter is present. (default to false)
109
- # @return [ReleasePoliciesResponse]
110
- def get_release_policies(ld_api_version, project_key, opts = {})
111
- data, _status_code, _headers = get_release_policies_with_http_info(ld_api_version, project_key, opts)
112
- data
118
+ # @return [nil]
119
+ def delete_flag_release_plan(ld_api_version, project_key, plan_key, opts = {})
120
+ delete_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key, opts)
121
+ nil
113
122
  end
114
123
 
115
- # List release policies
116
- # Get a list of release policies for the specified project with optional filtering.
124
+ # Delete a flag release plan in a project
125
+ # Delete a flag release plan in a project.
117
126
  # @param ld_api_version [String] Version of the endpoint.
118
- # @param project_key [String] The project key
127
+ # @param project_key [String]
128
+ # @param plan_key [String]
119
129
  # @param [Hash] opts the optional parameters
120
- # @option opts [Boolean] :exclude_default When true, exclude the default release policy from the response. When false or omitted, include the default policy if an environment filter is present. (default to false)
121
- # @return [Array<(ReleasePoliciesResponse, Integer, Hash)>] ReleasePoliciesResponse data, response status code and response headers
122
- def get_release_policies_with_http_info(ld_api_version, project_key, opts = {})
130
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
131
+ def delete_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key, opts = {})
123
132
  if @api_client.config.debugging
124
- @api_client.config.logger.debug 'Calling API: ReleasePoliciesBetaApi.get_release_policies ...'
133
+ @api_client.config.logger.debug 'Calling API: FlagReleasePlansBetaApi.delete_flag_release_plan ...'
125
134
  end
126
135
  # verify the required parameter 'ld_api_version' is set
127
136
  if @api_client.config.client_side_validation && ld_api_version.nil?
128
- fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling ReleasePoliciesBetaApi.get_release_policies"
137
+ fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling FlagReleasePlansBetaApi.delete_flag_release_plan"
129
138
  end
130
139
  # verify enum value
131
140
  allowable_values = ["beta"]
@@ -134,14 +143,25 @@ module LaunchDarklyApi
134
143
  end
135
144
  # verify the required parameter 'project_key' is set
136
145
  if @api_client.config.client_side_validation && project_key.nil?
137
- fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePoliciesBetaApi.get_release_policies"
146
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FlagReleasePlansBetaApi.delete_flag_release_plan"
138
147
  end
148
+ if @api_client.config.client_side_validation && project_key.to_s.length < 1
149
+ fail ArgumentError, 'invalid value for "project_key" when calling FlagReleasePlansBetaApi.delete_flag_release_plan, the character length must be greater than or equal to 1.'
150
+ end
151
+
152
+ # verify the required parameter 'plan_key' is set
153
+ if @api_client.config.client_side_validation && plan_key.nil?
154
+ fail ArgumentError, "Missing the required parameter 'plan_key' when calling FlagReleasePlansBetaApi.delete_flag_release_plan"
155
+ end
156
+ if @api_client.config.client_side_validation && plan_key.to_s.length < 1
157
+ fail ArgumentError, 'invalid value for "plan_key" when calling FlagReleasePlansBetaApi.delete_flag_release_plan, the character length must be greater than or equal to 1.'
158
+ end
159
+
139
160
  # resource path
140
- local_var_path = '/api/v2/projects/{projectKey}/release-policies'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
161
+ local_var_path = '/api/v2/projects/{projectKey}/flag-release-plans/{planKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'planKey' + '}', CGI.escape(plan_key.to_s))
141
162
 
142
163
  # query parameters
143
164
  query_params = opts[:query_params] || {}
144
- query_params[:'excludeDefault'] = opts[:'exclude_default'] if !opts[:'exclude_default'].nil?
145
165
 
146
166
  # header parameters
147
167
  header_params = opts[:header_params] || {}
@@ -156,13 +176,13 @@ module LaunchDarklyApi
156
176
  post_body = opts[:debug_body]
157
177
 
158
178
  # return_type
159
- return_type = opts[:debug_return_type] || 'ReleasePoliciesResponse'
179
+ return_type = opts[:debug_return_type]
160
180
 
161
181
  # auth_names
162
182
  auth_names = opts[:debug_auth_names] || ['ApiKey']
163
183
 
164
184
  new_options = opts.merge(
165
- :operation => :"ReleasePoliciesBetaApi.get_release_policies",
185
+ :operation => :"FlagReleasePlansBetaApi.delete_flag_release_plan",
166
186
  :header_params => header_params,
167
187
  :query_params => query_params,
168
188
  :form_params => form_params,
@@ -171,39 +191,39 @@ module LaunchDarklyApi
171
191
  :return_type => return_type
172
192
  )
173
193
 
174
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
194
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
175
195
  if @api_client.config.debugging
176
- @api_client.config.logger.debug "API called: ReleasePoliciesBetaApi#get_release_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
196
+ @api_client.config.logger.debug "API called: FlagReleasePlansBetaApi#delete_flag_release_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
177
197
  end
178
198
  return data, status_code, headers
179
199
  end
180
200
 
181
- # Get a release policy by key
182
- # Retrieve a single release policy by its key for the specified project.
201
+ # Get a flag release plan in a project by plan key
202
+ # Get a flag release plan in a project by plan key.
183
203
  # @param ld_api_version [String] Version of the endpoint.
184
- # @param project_key [String] The project key
185
- # @param policy_key [String] The release policy key
204
+ # @param project_key [String]
205
+ # @param plan_key [String]
186
206
  # @param [Hash] opts the optional parameters
187
- # @return [ReleasePolicy]
188
- def get_release_policy(ld_api_version, project_key, policy_key, opts = {})
189
- data, _status_code, _headers = get_release_policy_with_http_info(ld_api_version, project_key, policy_key, opts)
207
+ # @return [FlagReleasePlan]
208
+ def get_flag_release_plan(ld_api_version, project_key, plan_key, opts = {})
209
+ data, _status_code, _headers = get_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key, opts)
190
210
  data
191
211
  end
192
212
 
193
- # Get a release policy by key
194
- # Retrieve a single release policy by its key for the specified project.
213
+ # Get a flag release plan in a project by plan key
214
+ # Get a flag release plan in a project by plan key.
195
215
  # @param ld_api_version [String] Version of the endpoint.
196
- # @param project_key [String] The project key
197
- # @param policy_key [String] The release policy key
216
+ # @param project_key [String]
217
+ # @param plan_key [String]
198
218
  # @param [Hash] opts the optional parameters
199
- # @return [Array<(ReleasePolicy, Integer, Hash)>] ReleasePolicy data, response status code and response headers
200
- def get_release_policy_with_http_info(ld_api_version, project_key, policy_key, opts = {})
219
+ # @return [Array<(FlagReleasePlan, Integer, Hash)>] FlagReleasePlan data, response status code and response headers
220
+ def get_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key, opts = {})
201
221
  if @api_client.config.debugging
202
- @api_client.config.logger.debug 'Calling API: ReleasePoliciesBetaApi.get_release_policy ...'
222
+ @api_client.config.logger.debug 'Calling API: FlagReleasePlansBetaApi.get_flag_release_plan ...'
203
223
  end
204
224
  # verify the required parameter 'ld_api_version' is set
205
225
  if @api_client.config.client_side_validation && ld_api_version.nil?
206
- fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling ReleasePoliciesBetaApi.get_release_policy"
226
+ fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling FlagReleasePlansBetaApi.get_flag_release_plan"
207
227
  end
208
228
  # verify enum value
209
229
  allowable_values = ["beta"]
@@ -212,14 +232,22 @@ module LaunchDarklyApi
212
232
  end
213
233
  # verify the required parameter 'project_key' is set
214
234
  if @api_client.config.client_side_validation && project_key.nil?
215
- fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePoliciesBetaApi.get_release_policy"
235
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FlagReleasePlansBetaApi.get_flag_release_plan"
216
236
  end
217
- # verify the required parameter 'policy_key' is set
218
- if @api_client.config.client_side_validation && policy_key.nil?
219
- fail ArgumentError, "Missing the required parameter 'policy_key' when calling ReleasePoliciesBetaApi.get_release_policy"
237
+ if @api_client.config.client_side_validation && project_key.to_s.length < 1
238
+ fail ArgumentError, 'invalid value for "project_key" when calling FlagReleasePlansBetaApi.get_flag_release_plan, the character length must be greater than or equal to 1.'
239
+ end
240
+
241
+ # verify the required parameter 'plan_key' is set
242
+ if @api_client.config.client_side_validation && plan_key.nil?
243
+ fail ArgumentError, "Missing the required parameter 'plan_key' when calling FlagReleasePlansBetaApi.get_flag_release_plan"
220
244
  end
245
+ if @api_client.config.client_side_validation && plan_key.to_s.length < 1
246
+ fail ArgumentError, 'invalid value for "plan_key" when calling FlagReleasePlansBetaApi.get_flag_release_plan, the character length must be greater than or equal to 1.'
247
+ end
248
+
221
249
  # resource path
222
- local_var_path = '/api/v2/projects/{projectKey}/release-policies/{policyKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'policyKey' + '}', CGI.escape(policy_key.to_s))
250
+ local_var_path = '/api/v2/projects/{projectKey}/flag-release-plans/{planKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'planKey' + '}', CGI.escape(plan_key.to_s))
223
251
 
224
252
  # query parameters
225
253
  query_params = opts[:query_params] || {}
@@ -237,13 +265,13 @@ module LaunchDarklyApi
237
265
  post_body = opts[:debug_body]
238
266
 
239
267
  # return_type
240
- return_type = opts[:debug_return_type] || 'ReleasePolicy'
268
+ return_type = opts[:debug_return_type] || 'FlagReleasePlan'
241
269
 
242
270
  # auth_names
243
271
  auth_names = opts[:debug_auth_names] || ['ApiKey']
244
272
 
245
273
  new_options = opts.merge(
246
- :operation => :"ReleasePoliciesBetaApi.get_release_policy",
274
+ :operation => :"FlagReleasePlansBetaApi.get_flag_release_plan",
247
275
  :header_params => header_params,
248
276
  :query_params => query_params,
249
277
  :form_params => form_params,
@@ -254,37 +282,39 @@ module LaunchDarklyApi
254
282
 
255
283
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
256
284
  if @api_client.config.debugging
257
- @api_client.config.logger.debug "API called: ReleasePoliciesBetaApi#get_release_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
285
+ @api_client.config.logger.debug "API called: FlagReleasePlansBetaApi#get_flag_release_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
258
286
  end
259
287
  return data, status_code, headers
260
288
  end
261
289
 
262
- # Update the order of existing release policies
263
- # Update the order of existing release policies for the specified project.
290
+ # List a project's flag release plans
291
+ # List a project's flag release plans, in creation order.
264
292
  # @param ld_api_version [String] Version of the endpoint.
265
- # @param project_key [String] The project key
266
- # @param request_body [Array<String>] Array of release policy keys in the desired rank order (scoped policies only). These keys must include _all_ of the scoped release policies for the project.
293
+ # @param project_key [String]
267
294
  # @param [Hash] opts the optional parameters
268
- # @return [Array<ReleasePolicy>]
269
- def post_release_policies_order(ld_api_version, project_key, request_body, opts = {})
270
- data, _status_code, _headers = post_release_policies_order_with_http_info(ld_api_version, project_key, request_body, opts)
295
+ # @option opts [Integer] :limit The number of flag release plans to return. (default to 25)
296
+ # @option opts [Integer] :offset The number of flag release plans to skip. Used for pagination. (default to 0)
297
+ # @return [ListFlagReleasePlansResponse]
298
+ def list_flag_release_plans(ld_api_version, project_key, opts = {})
299
+ data, _status_code, _headers = list_flag_release_plans_with_http_info(ld_api_version, project_key, opts)
271
300
  data
272
301
  end
273
302
 
274
- # Update the order of existing release policies
275
- # Update the order of existing release policies for the specified project.
303
+ # List a project&#39;s flag release plans
304
+ # List a project&#39;s flag release plans, in creation order.
276
305
  # @param ld_api_version [String] Version of the endpoint.
277
- # @param project_key [String] The project key
278
- # @param request_body [Array<String>] Array of release policy keys in the desired rank order (scoped policies only). These keys must include _all_ of the scoped release policies for the project.
306
+ # @param project_key [String]
279
307
  # @param [Hash] opts the optional parameters
280
- # @return [Array<(Array<ReleasePolicy>, Integer, Hash)>] Array<ReleasePolicy> data, response status code and response headers
281
- def post_release_policies_order_with_http_info(ld_api_version, project_key, request_body, opts = {})
308
+ # @option opts [Integer] :limit The number of flag release plans to return. (default to 25)
309
+ # @option opts [Integer] :offset The number of flag release plans to skip. Used for pagination. (default to 0)
310
+ # @return [Array<(ListFlagReleasePlansResponse, Integer, Hash)>] ListFlagReleasePlansResponse data, response status code and response headers
311
+ def list_flag_release_plans_with_http_info(ld_api_version, project_key, opts = {})
282
312
  if @api_client.config.debugging
283
- @api_client.config.logger.debug 'Calling API: ReleasePoliciesBetaApi.post_release_policies_order ...'
313
+ @api_client.config.logger.debug 'Calling API: FlagReleasePlansBetaApi.list_flag_release_plans ...'
284
314
  end
285
315
  # verify the required parameter 'ld_api_version' is set
286
316
  if @api_client.config.client_side_validation && ld_api_version.nil?
287
- fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling ReleasePoliciesBetaApi.post_release_policies_order"
317
+ fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling FlagReleasePlansBetaApi.list_flag_release_plans"
288
318
  end
289
319
  # verify enum value
290
320
  allowable_values = ["beta"]
@@ -293,129 +323,52 @@ module LaunchDarklyApi
293
323
  end
294
324
  # verify the required parameter 'project_key' is set
295
325
  if @api_client.config.client_side_validation && project_key.nil?
296
- fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePoliciesBetaApi.post_release_policies_order"
326
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FlagReleasePlansBetaApi.list_flag_release_plans"
297
327
  end
298
- # verify the required parameter 'request_body' is set
299
- if @api_client.config.client_side_validation && request_body.nil?
300
- fail ArgumentError, "Missing the required parameter 'request_body' when calling ReleasePoliciesBetaApi.post_release_policies_order"
328
+ if @api_client.config.client_side_validation && project_key.to_s.length < 1
329
+ fail ArgumentError, 'invalid value for "project_key" when calling FlagReleasePlansBetaApi.list_flag_release_plans, the character length must be greater than or equal to 1.'
301
330
  end
302
- # resource path
303
- local_var_path = '/api/v2/projects/{projectKey}/release-policies/order'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
304
331
 
305
- # query parameters
306
- query_params = opts[:query_params] || {}
307
-
308
- # header parameters
309
- header_params = opts[:header_params] || {}
310
- # HTTP header 'Accept' (if needed)
311
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
312
- # HTTP header 'Content-Type'
313
- content_type = @api_client.select_header_content_type(['application/json'])
314
- if !content_type.nil?
315
- header_params['Content-Type'] = content_type
332
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
333
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FlagReleasePlansBetaApi.list_flag_release_plans, must be smaller than or equal to 50.'
316
334
  end
317
- header_params[:'LD-API-Version'] = ld_api_version
318
-
319
- # form parameters
320
- form_params = opts[:form_params] || {}
321
-
322
- # http body (model)
323
- post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
324
-
325
- # return_type
326
- return_type = opts[:debug_return_type] || 'Array<ReleasePolicy>'
327
-
328
- # auth_names
329
- auth_names = opts[:debug_auth_names] || ['ApiKey']
330
-
331
- new_options = opts.merge(
332
- :operation => :"ReleasePoliciesBetaApi.post_release_policies_order",
333
- :header_params => header_params,
334
- :query_params => query_params,
335
- :form_params => form_params,
336
- :body => post_body,
337
- :auth_names => auth_names,
338
- :return_type => return_type
339
- )
340
335
 
341
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
342
- if @api_client.config.debugging
343
- @api_client.config.logger.debug "API called: ReleasePoliciesBetaApi#post_release_policies_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
336
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
337
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling FlagReleasePlansBetaApi.list_flag_release_plans, must be greater than or equal to 1.'
344
338
  end
345
- return data, status_code, headers
346
- end
347
-
348
- # Create a release policy
349
- # Create a new release policy for the specified project.
350
- # @param ld_api_version [String] Version of the endpoint.
351
- # @param project_key [String] The project key
352
- # @param post_release_policy_request [PostReleasePolicyRequest] Release policy to create
353
- # @param [Hash] opts the optional parameters
354
- # @return [ReleasePolicy]
355
- def post_release_policy(ld_api_version, project_key, post_release_policy_request, opts = {})
356
- data, _status_code, _headers = post_release_policy_with_http_info(ld_api_version, project_key, post_release_policy_request, opts)
357
- data
358
- end
359
339
 
360
- # Create a release policy
361
- # Create a new release policy for the specified project.
362
- # @param ld_api_version [String] Version of the endpoint.
363
- # @param project_key [String] The project key
364
- # @param post_release_policy_request [PostReleasePolicyRequest] Release policy to create
365
- # @param [Hash] opts the optional parameters
366
- # @return [Array<(ReleasePolicy, Integer, Hash)>] ReleasePolicy data, response status code and response headers
367
- def post_release_policy_with_http_info(ld_api_version, project_key, post_release_policy_request, opts = {})
368
- if @api_client.config.debugging
369
- @api_client.config.logger.debug 'Calling API: ReleasePoliciesBetaApi.post_release_policy ...'
370
- end
371
- # verify the required parameter 'ld_api_version' is set
372
- if @api_client.config.client_side_validation && ld_api_version.nil?
373
- fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling ReleasePoliciesBetaApi.post_release_policy"
374
- end
375
- # verify enum value
376
- allowable_values = ["beta"]
377
- if @api_client.config.client_side_validation && !allowable_values.include?(ld_api_version)
378
- fail ArgumentError, "invalid value for \"ld_api_version\", must be one of #{allowable_values}"
379
- end
380
- # verify the required parameter 'project_key' is set
381
- if @api_client.config.client_side_validation && project_key.nil?
382
- fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePoliciesBetaApi.post_release_policy"
383
- end
384
- # verify the required parameter 'post_release_policy_request' is set
385
- if @api_client.config.client_side_validation && post_release_policy_request.nil?
386
- fail ArgumentError, "Missing the required parameter 'post_release_policy_request' when calling ReleasePoliciesBetaApi.post_release_policy"
340
+ if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
341
+ fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling FlagReleasePlansBetaApi.list_flag_release_plans, must be greater than or equal to 0.'
387
342
  end
343
+
388
344
  # resource path
389
- local_var_path = '/api/v2/projects/{projectKey}/release-policies'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
345
+ local_var_path = '/api/v2/projects/{projectKey}/flag-release-plans'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
390
346
 
391
347
  # query parameters
392
348
  query_params = opts[:query_params] || {}
349
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
350
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
393
351
 
394
352
  # header parameters
395
353
  header_params = opts[:header_params] || {}
396
354
  # HTTP header 'Accept' (if needed)
397
355
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
398
- # HTTP header 'Content-Type'
399
- content_type = @api_client.select_header_content_type(['application/json'])
400
- if !content_type.nil?
401
- header_params['Content-Type'] = content_type
402
- end
403
356
  header_params[:'LD-API-Version'] = ld_api_version
404
357
 
405
358
  # form parameters
406
359
  form_params = opts[:form_params] || {}
407
360
 
408
361
  # http body (model)
409
- post_body = opts[:debug_body] || @api_client.object_to_http_body(post_release_policy_request)
362
+ post_body = opts[:debug_body]
410
363
 
411
364
  # return_type
412
- return_type = opts[:debug_return_type] || 'ReleasePolicy'
365
+ return_type = opts[:debug_return_type] || 'ListFlagReleasePlansResponse'
413
366
 
414
367
  # auth_names
415
368
  auth_names = opts[:debug_auth_names] || ['ApiKey']
416
369
 
417
370
  new_options = opts.merge(
418
- :operation => :"ReleasePoliciesBetaApi.post_release_policy",
371
+ :operation => :"FlagReleasePlansBetaApi.list_flag_release_plans",
419
372
  :header_params => header_params,
420
373
  :query_params => query_params,
421
374
  :form_params => form_params,
@@ -424,41 +377,41 @@ module LaunchDarklyApi
424
377
  :return_type => return_type
425
378
  )
426
379
 
427
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
380
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
428
381
  if @api_client.config.debugging
429
- @api_client.config.logger.debug "API called: ReleasePoliciesBetaApi#post_release_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
382
+ @api_client.config.logger.debug "API called: FlagReleasePlansBetaApi#list_flag_release_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
430
383
  end
431
384
  return data, status_code, headers
432
385
  end
433
386
 
434
- # Update a release policy
435
- # Update an existing release policy for the specified project.
387
+ # Replace a flag release plan configuration in a project
388
+ # Replace a flag release plan configuration in a project. This is a full replace, not a merge, and anything omitted is overwritten. Omitting `default` clears it, so a request without it demotes the project's default plan. The flag release plan's key is immutable, and its version increments by 1 on every successful update. The request's version is an optional optimistic lock: when present it must match the plan's current version, and on mismatch the request is rejected with 409 and no changes are applied, meaning the plan was edited since it was read; get the plan again and retry with its current version. When omitted the update applies unconditionally to the plan currently holding the key. A flag release already started from the plan is not affected.
436
389
  # @param ld_api_version [String] Version of the endpoint.
437
- # @param project_key [String] The project key
438
- # @param policy_key [String] The human-readable key of the release policy
439
- # @param put_release_policy_request [PutReleasePolicyRequest] Release policy data to update
390
+ # @param project_key [String]
391
+ # @param plan_key [String]
392
+ # @param put_flag_release_plan_request [PutFlagReleasePlanRequest]
440
393
  # @param [Hash] opts the optional parameters
441
- # @return [ReleasePolicy]
442
- def put_release_policy(ld_api_version, project_key, policy_key, put_release_policy_request, opts = {})
443
- data, _status_code, _headers = put_release_policy_with_http_info(ld_api_version, project_key, policy_key, put_release_policy_request, opts)
394
+ # @return [FlagReleasePlan]
395
+ def update_flag_release_plan(ld_api_version, project_key, plan_key, put_flag_release_plan_request, opts = {})
396
+ data, _status_code, _headers = update_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key, put_flag_release_plan_request, opts)
444
397
  data
445
398
  end
446
399
 
447
- # Update a release policy
448
- # Update an existing release policy for the specified project.
400
+ # Replace a flag release plan configuration in a project
401
+ # Replace a flag release plan configuration in a project. This is a full replace, not a merge, and anything omitted is overwritten. Omitting &#x60;default&#x60; clears it, so a request without it demotes the project&#39;s default plan. The flag release plan&#39;s key is immutable, and its version increments by 1 on every successful update. The request&#39;s version is an optional optimistic lock: when present it must match the plan&#39;s current version, and on mismatch the request is rejected with 409 and no changes are applied, meaning the plan was edited since it was read; get the plan again and retry with its current version. When omitted the update applies unconditionally to the plan currently holding the key. A flag release already started from the plan is not affected.
449
402
  # @param ld_api_version [String] Version of the endpoint.
450
- # @param project_key [String] The project key
451
- # @param policy_key [String] The human-readable key of the release policy
452
- # @param put_release_policy_request [PutReleasePolicyRequest] Release policy data to update
403
+ # @param project_key [String]
404
+ # @param plan_key [String]
405
+ # @param put_flag_release_plan_request [PutFlagReleasePlanRequest]
453
406
  # @param [Hash] opts the optional parameters
454
- # @return [Array<(ReleasePolicy, Integer, Hash)>] ReleasePolicy data, response status code and response headers
455
- def put_release_policy_with_http_info(ld_api_version, project_key, policy_key, put_release_policy_request, opts = {})
407
+ # @return [Array<(FlagReleasePlan, Integer, Hash)>] FlagReleasePlan data, response status code and response headers
408
+ def update_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key, put_flag_release_plan_request, opts = {})
456
409
  if @api_client.config.debugging
457
- @api_client.config.logger.debug 'Calling API: ReleasePoliciesBetaApi.put_release_policy ...'
410
+ @api_client.config.logger.debug 'Calling API: FlagReleasePlansBetaApi.update_flag_release_plan ...'
458
411
  end
459
412
  # verify the required parameter 'ld_api_version' is set
460
413
  if @api_client.config.client_side_validation && ld_api_version.nil?
461
- fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling ReleasePoliciesBetaApi.put_release_policy"
414
+ fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling FlagReleasePlansBetaApi.update_flag_release_plan"
462
415
  end
463
416
  # verify enum value
464
417
  allowable_values = ["beta"]
@@ -467,18 +420,26 @@ module LaunchDarklyApi
467
420
  end
468
421
  # verify the required parameter 'project_key' is set
469
422
  if @api_client.config.client_side_validation && project_key.nil?
470
- fail ArgumentError, "Missing the required parameter 'project_key' when calling ReleasePoliciesBetaApi.put_release_policy"
423
+ fail ArgumentError, "Missing the required parameter 'project_key' when calling FlagReleasePlansBetaApi.update_flag_release_plan"
424
+ end
425
+ if @api_client.config.client_side_validation && project_key.to_s.length < 1
426
+ fail ArgumentError, 'invalid value for "project_key" when calling FlagReleasePlansBetaApi.update_flag_release_plan, the character length must be greater than or equal to 1.'
471
427
  end
472
- # verify the required parameter 'policy_key' is set
473
- if @api_client.config.client_side_validation && policy_key.nil?
474
- fail ArgumentError, "Missing the required parameter 'policy_key' when calling ReleasePoliciesBetaApi.put_release_policy"
428
+
429
+ # verify the required parameter 'plan_key' is set
430
+ if @api_client.config.client_side_validation && plan_key.nil?
431
+ fail ArgumentError, "Missing the required parameter 'plan_key' when calling FlagReleasePlansBetaApi.update_flag_release_plan"
432
+ end
433
+ if @api_client.config.client_side_validation && plan_key.to_s.length < 1
434
+ fail ArgumentError, 'invalid value for "plan_key" when calling FlagReleasePlansBetaApi.update_flag_release_plan, the character length must be greater than or equal to 1.'
475
435
  end
476
- # verify the required parameter 'put_release_policy_request' is set
477
- if @api_client.config.client_side_validation && put_release_policy_request.nil?
478
- fail ArgumentError, "Missing the required parameter 'put_release_policy_request' when calling ReleasePoliciesBetaApi.put_release_policy"
436
+
437
+ # verify the required parameter 'put_flag_release_plan_request' is set
438
+ if @api_client.config.client_side_validation && put_flag_release_plan_request.nil?
439
+ fail ArgumentError, "Missing the required parameter 'put_flag_release_plan_request' when calling FlagReleasePlansBetaApi.update_flag_release_plan"
479
440
  end
480
441
  # resource path
481
- local_var_path = '/api/v2/projects/{projectKey}/release-policies/{policyKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'policyKey' + '}', CGI.escape(policy_key.to_s))
442
+ local_var_path = '/api/v2/projects/{projectKey}/flag-release-plans/{planKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'planKey' + '}', CGI.escape(plan_key.to_s))
482
443
 
483
444
  # query parameters
484
445
  query_params = opts[:query_params] || {}
@@ -498,16 +459,16 @@ module LaunchDarklyApi
498
459
  form_params = opts[:form_params] || {}
499
460
 
500
461
  # http body (model)
501
- post_body = opts[:debug_body] || @api_client.object_to_http_body(put_release_policy_request)
462
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(put_flag_release_plan_request)
502
463
 
503
464
  # return_type
504
- return_type = opts[:debug_return_type] || 'ReleasePolicy'
465
+ return_type = opts[:debug_return_type] || 'FlagReleasePlan'
505
466
 
506
467
  # auth_names
507
468
  auth_names = opts[:debug_auth_names] || ['ApiKey']
508
469
 
509
470
  new_options = opts.merge(
510
- :operation => :"ReleasePoliciesBetaApi.put_release_policy",
471
+ :operation => :"FlagReleasePlansBetaApi.update_flag_release_plan",
511
472
  :header_params => header_params,
512
473
  :query_params => query_params,
513
474
  :form_params => form_params,
@@ -518,7 +479,7 @@ module LaunchDarklyApi
518
479
 
519
480
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
520
481
  if @api_client.config.debugging
521
- @api_client.config.logger.debug "API called: ReleasePoliciesBetaApi#put_release_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
482
+ @api_client.config.logger.debug "API called: FlagReleasePlansBetaApi#update_flag_release_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
522
483
  end
523
484
  return data, status_code, headers
524
485
  end