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
@@ -0,0 +1,633 @@
1
+ # LaunchDarklyApi::EnvironmentReleasePlansBetaApi
2
+
3
+ All URIs are relative to *https://app.launchdarkly.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**delete_default_environment_release_plan**](EnvironmentReleasePlansBetaApi.md#delete_default_environment_release_plan) | **DELETE** /api/v2/projects/{projectKey}/environments/{environmentKey}/default-release-plan | Clear the default release plan |
8
+ | [**delete_environment_release_plan**](EnvironmentReleasePlansBetaApi.md#delete_environment_release_plan) | **DELETE** /api/v2/projects/{projectKey}/environments/{environmentKey}/release-plans/{releasePlanKey} | Delete a release plan |
9
+ | [**get_default_environment_release_plan**](EnvironmentReleasePlansBetaApi.md#get_default_environment_release_plan) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/default-release-plan | Get the default release plan |
10
+ | [**get_environment_release_plan**](EnvironmentReleasePlansBetaApi.md#get_environment_release_plan) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/release-plans/{releasePlanKey} | Get a release plan |
11
+ | [**get_environment_release_plans**](EnvironmentReleasePlansBetaApi.md#get_environment_release_plans) | **GET** /api/v2/projects/{projectKey}/environments/{environmentKey}/release-plans | List release plans |
12
+ | [**post_environment_release_plan**](EnvironmentReleasePlansBetaApi.md#post_environment_release_plan) | **POST** /api/v2/projects/{projectKey}/environments/{environmentKey}/release-plans | Create a release plan |
13
+ | [**put_default_environment_release_plan**](EnvironmentReleasePlansBetaApi.md#put_default_environment_release_plan) | **PUT** /api/v2/projects/{projectKey}/environments/{environmentKey}/default-release-plan | Set the default release plan |
14
+ | [**put_environment_release_plan**](EnvironmentReleasePlansBetaApi.md#put_environment_release_plan) | **PUT** /api/v2/projects/{projectKey}/environments/{environmentKey}/release-plans/{releasePlanKey} | Update a release plan |
15
+
16
+
17
+ ## delete_default_environment_release_plan
18
+
19
+ > delete_default_environment_release_plan(ld_api_version, project_key, environment_key)
20
+
21
+ Clear the default release plan
22
+
23
+ Clear the environment's default release plan, incrementing the formerly-default plan's version by 1; the environment then has none. Idempotent: returns `204` whether or not a default was set.
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'launchdarkly_api'
30
+ # setup authorization
31
+ LaunchDarklyApi.configure do |config|
32
+ # Configure API key authorization: ApiKey
33
+ config.api_key['Authorization'] = 'YOUR API KEY'
34
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
35
+ # config.api_key_prefix['Authorization'] = 'Bearer'
36
+ end
37
+
38
+ api_instance = LaunchDarklyApi::EnvironmentReleasePlansBetaApi.new
39
+ ld_api_version = 'beta' # String | Version of the endpoint.
40
+ project_key = 'default' # String | The project key
41
+ environment_key = 'production' # String | The environment key
42
+
43
+ begin
44
+ # Clear the default release plan
45
+ api_instance.delete_default_environment_release_plan(ld_api_version, project_key, environment_key)
46
+ rescue LaunchDarklyApi::ApiError => e
47
+ puts "Error when calling EnvironmentReleasePlansBetaApi->delete_default_environment_release_plan: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the delete_default_environment_release_plan_with_http_info variant
52
+
53
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
54
+
55
+ > <Array(nil, Integer, Hash)> delete_default_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key)
56
+
57
+ ```ruby
58
+ begin
59
+ # Clear the default release plan
60
+ data, status_code, headers = api_instance.delete_default_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => nil
64
+ rescue LaunchDarklyApi::ApiError => e
65
+ puts "Error when calling EnvironmentReleasePlansBetaApi->delete_default_environment_release_plan_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **ld_api_version** | **String** | Version of the endpoint. | |
74
+ | **project_key** | **String** | The project key | |
75
+ | **environment_key** | **String** | The environment key | |
76
+
77
+ ### Return type
78
+
79
+ nil (empty response body)
80
+
81
+ ### Authorization
82
+
83
+ [ApiKey](../README.md#ApiKey)
84
+
85
+ ### HTTP request headers
86
+
87
+ - **Content-Type**: Not defined
88
+ - **Accept**: application/json
89
+
90
+
91
+ ## delete_environment_release_plan
92
+
93
+ > delete_environment_release_plan(ld_api_version, project_key, environment_key, release_plan_key)
94
+
95
+ Delete a release plan
96
+
97
+ Delete a release plan by its key. The plan no longer appears in reads, and its key becomes available for reuse by a new plan. Returns 409 while a flag release plan still uses the release plan; remove it from those flag release plans first.
98
+
99
+ ### Examples
100
+
101
+ ```ruby
102
+ require 'time'
103
+ require 'launchdarkly_api'
104
+ # setup authorization
105
+ LaunchDarklyApi.configure do |config|
106
+ # Configure API key authorization: ApiKey
107
+ config.api_key['Authorization'] = 'YOUR API KEY'
108
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
109
+ # config.api_key_prefix['Authorization'] = 'Bearer'
110
+ end
111
+
112
+ api_instance = LaunchDarklyApi::EnvironmentReleasePlansBetaApi.new
113
+ ld_api_version = 'beta' # String | Version of the endpoint.
114
+ project_key = 'default' # String | The project key
115
+ environment_key = 'production' # String | The environment key
116
+ release_plan_key = 'checkout-flow-rollout' # String | The release plan key
117
+
118
+ begin
119
+ # Delete a release plan
120
+ api_instance.delete_environment_release_plan(ld_api_version, project_key, environment_key, release_plan_key)
121
+ rescue LaunchDarklyApi::ApiError => e
122
+ puts "Error when calling EnvironmentReleasePlansBetaApi->delete_environment_release_plan: #{e}"
123
+ end
124
+ ```
125
+
126
+ #### Using the delete_environment_release_plan_with_http_info variant
127
+
128
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
129
+
130
+ > <Array(nil, Integer, Hash)> delete_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, release_plan_key)
131
+
132
+ ```ruby
133
+ begin
134
+ # Delete a release plan
135
+ data, status_code, headers = api_instance.delete_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, release_plan_key)
136
+ p status_code # => 2xx
137
+ p headers # => { ... }
138
+ p data # => nil
139
+ rescue LaunchDarklyApi::ApiError => e
140
+ puts "Error when calling EnvironmentReleasePlansBetaApi->delete_environment_release_plan_with_http_info: #{e}"
141
+ end
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ | Name | Type | Description | Notes |
147
+ | ---- | ---- | ----------- | ----- |
148
+ | **ld_api_version** | **String** | Version of the endpoint. | |
149
+ | **project_key** | **String** | The project key | |
150
+ | **environment_key** | **String** | The environment key | |
151
+ | **release_plan_key** | **String** | The release plan key | |
152
+
153
+ ### Return type
154
+
155
+ nil (empty response body)
156
+
157
+ ### Authorization
158
+
159
+ [ApiKey](../README.md#ApiKey)
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: Not defined
164
+ - **Accept**: application/json
165
+
166
+
167
+ ## get_default_environment_release_plan
168
+
169
+ > <EnvironmentReleasePlan> get_default_environment_release_plan(ld_api_version, project_key, environment_key)
170
+
171
+ Get the default release plan
172
+
173
+ Get the environment's default release plan — the plan consumers preselect when starting a release. Returns `204 No Content` when the environment has no default.
174
+
175
+ ### Examples
176
+
177
+ ```ruby
178
+ require 'time'
179
+ require 'launchdarkly_api'
180
+ # setup authorization
181
+ LaunchDarklyApi.configure do |config|
182
+ # Configure API key authorization: ApiKey
183
+ config.api_key['Authorization'] = 'YOUR API KEY'
184
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
185
+ # config.api_key_prefix['Authorization'] = 'Bearer'
186
+ end
187
+
188
+ api_instance = LaunchDarklyApi::EnvironmentReleasePlansBetaApi.new
189
+ ld_api_version = 'beta' # String | Version of the endpoint.
190
+ project_key = 'default' # String | The project key
191
+ environment_key = 'production' # String | The environment key
192
+
193
+ begin
194
+ # Get the default release plan
195
+ result = api_instance.get_default_environment_release_plan(ld_api_version, project_key, environment_key)
196
+ p result
197
+ rescue LaunchDarklyApi::ApiError => e
198
+ puts "Error when calling EnvironmentReleasePlansBetaApi->get_default_environment_release_plan: #{e}"
199
+ end
200
+ ```
201
+
202
+ #### Using the get_default_environment_release_plan_with_http_info variant
203
+
204
+ This returns an Array which contains the response data, status code and headers.
205
+
206
+ > <Array(<EnvironmentReleasePlan>, Integer, Hash)> get_default_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key)
207
+
208
+ ```ruby
209
+ begin
210
+ # Get the default release plan
211
+ data, status_code, headers = api_instance.get_default_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key)
212
+ p status_code # => 2xx
213
+ p headers # => { ... }
214
+ p data # => <EnvironmentReleasePlan>
215
+ rescue LaunchDarklyApi::ApiError => e
216
+ puts "Error when calling EnvironmentReleasePlansBetaApi->get_default_environment_release_plan_with_http_info: #{e}"
217
+ end
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ | Name | Type | Description | Notes |
223
+ | ---- | ---- | ----------- | ----- |
224
+ | **ld_api_version** | **String** | Version of the endpoint. | |
225
+ | **project_key** | **String** | The project key | |
226
+ | **environment_key** | **String** | The environment key | |
227
+
228
+ ### Return type
229
+
230
+ [**EnvironmentReleasePlan**](EnvironmentReleasePlan.md)
231
+
232
+ ### Authorization
233
+
234
+ [ApiKey](../README.md#ApiKey)
235
+
236
+ ### HTTP request headers
237
+
238
+ - **Content-Type**: Not defined
239
+ - **Accept**: application/json
240
+
241
+
242
+ ## get_environment_release_plan
243
+
244
+ > <EnvironmentReleasePlan> get_environment_release_plan(ld_api_version, project_key, environment_key, release_plan_key)
245
+
246
+ Get a release plan
247
+
248
+ Get a single release plan by its key.
249
+
250
+ ### Examples
251
+
252
+ ```ruby
253
+ require 'time'
254
+ require 'launchdarkly_api'
255
+ # setup authorization
256
+ LaunchDarklyApi.configure do |config|
257
+ # Configure API key authorization: ApiKey
258
+ config.api_key['Authorization'] = 'YOUR API KEY'
259
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
260
+ # config.api_key_prefix['Authorization'] = 'Bearer'
261
+ end
262
+
263
+ api_instance = LaunchDarklyApi::EnvironmentReleasePlansBetaApi.new
264
+ ld_api_version = 'beta' # String | Version of the endpoint.
265
+ project_key = 'default' # String | The project key
266
+ environment_key = 'production' # String | The environment key
267
+ release_plan_key = 'checkout-flow-rollout' # String | The release plan key
268
+
269
+ begin
270
+ # Get a release plan
271
+ result = api_instance.get_environment_release_plan(ld_api_version, project_key, environment_key, release_plan_key)
272
+ p result
273
+ rescue LaunchDarklyApi::ApiError => e
274
+ puts "Error when calling EnvironmentReleasePlansBetaApi->get_environment_release_plan: #{e}"
275
+ end
276
+ ```
277
+
278
+ #### Using the get_environment_release_plan_with_http_info variant
279
+
280
+ This returns an Array which contains the response data, status code and headers.
281
+
282
+ > <Array(<EnvironmentReleasePlan>, Integer, Hash)> get_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, release_plan_key)
283
+
284
+ ```ruby
285
+ begin
286
+ # Get a release plan
287
+ data, status_code, headers = api_instance.get_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, release_plan_key)
288
+ p status_code # => 2xx
289
+ p headers # => { ... }
290
+ p data # => <EnvironmentReleasePlan>
291
+ rescue LaunchDarklyApi::ApiError => e
292
+ puts "Error when calling EnvironmentReleasePlansBetaApi->get_environment_release_plan_with_http_info: #{e}"
293
+ end
294
+ ```
295
+
296
+ ### Parameters
297
+
298
+ | Name | Type | Description | Notes |
299
+ | ---- | ---- | ----------- | ----- |
300
+ | **ld_api_version** | **String** | Version of the endpoint. | |
301
+ | **project_key** | **String** | The project key | |
302
+ | **environment_key** | **String** | The environment key | |
303
+ | **release_plan_key** | **String** | The release plan key | |
304
+
305
+ ### Return type
306
+
307
+ [**EnvironmentReleasePlan**](EnvironmentReleasePlan.md)
308
+
309
+ ### Authorization
310
+
311
+ [ApiKey](../README.md#ApiKey)
312
+
313
+ ### HTTP request headers
314
+
315
+ - **Content-Type**: Not defined
316
+ - **Accept**: application/json
317
+
318
+
319
+ ## get_environment_release_plans
320
+
321
+ > <EnvironmentReleasePlans> get_environment_release_plans(ld_api_version, project_key, environment_key, opts)
322
+
323
+ List release plans
324
+
325
+ Get the environment's release plans, ordered by creation time.
326
+
327
+ ### Examples
328
+
329
+ ```ruby
330
+ require 'time'
331
+ require 'launchdarkly_api'
332
+ # setup authorization
333
+ LaunchDarklyApi.configure do |config|
334
+ # Configure API key authorization: ApiKey
335
+ config.api_key['Authorization'] = 'YOUR API KEY'
336
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
337
+ # config.api_key_prefix['Authorization'] = 'Bearer'
338
+ end
339
+
340
+ api_instance = LaunchDarklyApi::EnvironmentReleasePlansBetaApi.new
341
+ ld_api_version = 'beta' # String | Version of the endpoint.
342
+ project_key = 'default' # String | The project key
343
+ environment_key = 'production' # String | The environment key
344
+ opts = {
345
+ filter: 'query contains "checkout"', # String | A queryfilter expression that narrows the list by text match. Supported field and operators: `query` (`equals`, `contains`). When present, only release plans whose name or key contains the text, case-insensitively, are returned, and totalCount counts the matches. Surrounding whitespace is ignored, and the text is at most 256 bytes. Omitting the filter lists every release plan in the environment.
346
+ limit: 56, # Integer | The number of release plans to return. Defaults to 20. Maximum is 100.
347
+ offset: 56 # Integer | The number of release plans to skip. Used for pagination.
348
+ }
349
+
350
+ begin
351
+ # List release plans
352
+ result = api_instance.get_environment_release_plans(ld_api_version, project_key, environment_key, opts)
353
+ p result
354
+ rescue LaunchDarklyApi::ApiError => e
355
+ puts "Error when calling EnvironmentReleasePlansBetaApi->get_environment_release_plans: #{e}"
356
+ end
357
+ ```
358
+
359
+ #### Using the get_environment_release_plans_with_http_info variant
360
+
361
+ This returns an Array which contains the response data, status code and headers.
362
+
363
+ > <Array(<EnvironmentReleasePlans>, Integer, Hash)> get_environment_release_plans_with_http_info(ld_api_version, project_key, environment_key, opts)
364
+
365
+ ```ruby
366
+ begin
367
+ # List release plans
368
+ data, status_code, headers = api_instance.get_environment_release_plans_with_http_info(ld_api_version, project_key, environment_key, opts)
369
+ p status_code # => 2xx
370
+ p headers # => { ... }
371
+ p data # => <EnvironmentReleasePlans>
372
+ rescue LaunchDarklyApi::ApiError => e
373
+ puts "Error when calling EnvironmentReleasePlansBetaApi->get_environment_release_plans_with_http_info: #{e}"
374
+ end
375
+ ```
376
+
377
+ ### Parameters
378
+
379
+ | Name | Type | Description | Notes |
380
+ | ---- | ---- | ----------- | ----- |
381
+ | **ld_api_version** | **String** | Version of the endpoint. | |
382
+ | **project_key** | **String** | The project key | |
383
+ | **environment_key** | **String** | The environment key | |
384
+ | **filter** | **String** | A queryfilter expression that narrows the list by text match. Supported field and operators: &#x60;query&#x60; (&#x60;equals&#x60;, &#x60;contains&#x60;). When present, only release plans whose name or key contains the text, case-insensitively, are returned, and totalCount counts the matches. Surrounding whitespace is ignored, and the text is at most 256 bytes. Omitting the filter lists every release plan in the environment. | [optional] |
385
+ | **limit** | **Integer** | The number of release plans to return. Defaults to 20. Maximum is 100. | [optional] |
386
+ | **offset** | **Integer** | The number of release plans to skip. Used for pagination. | [optional] |
387
+
388
+ ### Return type
389
+
390
+ [**EnvironmentReleasePlans**](EnvironmentReleasePlans.md)
391
+
392
+ ### Authorization
393
+
394
+ [ApiKey](../README.md#ApiKey)
395
+
396
+ ### HTTP request headers
397
+
398
+ - **Content-Type**: Not defined
399
+ - **Accept**: application/json
400
+
401
+
402
+ ## post_environment_release_plan
403
+
404
+ > <EnvironmentReleasePlan> post_environment_release_plan(ld_api_version, project_key, environment_key, post_environment_release_plan_request)
405
+
406
+ Create a release plan
407
+
408
+ Create a new release plan for the specified environment.
409
+
410
+ ### Examples
411
+
412
+ ```ruby
413
+ require 'time'
414
+ require 'launchdarkly_api'
415
+ # setup authorization
416
+ LaunchDarklyApi.configure do |config|
417
+ # Configure API key authorization: ApiKey
418
+ config.api_key['Authorization'] = 'YOUR API KEY'
419
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
420
+ # config.api_key_prefix['Authorization'] = 'Bearer'
421
+ end
422
+
423
+ api_instance = LaunchDarklyApi::EnvironmentReleasePlansBetaApi.new
424
+ ld_api_version = 'beta' # String | Version of the endpoint.
425
+ project_key = 'default' # String | The project key
426
+ environment_key = 'production' # String | The environment key
427
+ post_environment_release_plan_request = LaunchDarklyApi::PostEnvironmentReleasePlanRequest.new({name: 'Checkout flow rollout', key: 'checkout-flow-rollout', progressive_release: LaunchDarklyApi::EnvironmentReleasePlanProgressiveRelease.new({randomization_unit: 'user', phases: [LaunchDarklyApi::EnvironmentReleasePlanPhase.new({steps: [LaunchDarklyApi::EnvironmentReleasePlanStep.new({allocation: 50000, duration_millis: 3600000})]})]})}) # PostEnvironmentReleasePlanRequest | Release plan to create
428
+
429
+ begin
430
+ # Create a release plan
431
+ result = api_instance.post_environment_release_plan(ld_api_version, project_key, environment_key, post_environment_release_plan_request)
432
+ p result
433
+ rescue LaunchDarklyApi::ApiError => e
434
+ puts "Error when calling EnvironmentReleasePlansBetaApi->post_environment_release_plan: #{e}"
435
+ end
436
+ ```
437
+
438
+ #### Using the post_environment_release_plan_with_http_info variant
439
+
440
+ This returns an Array which contains the response data, status code and headers.
441
+
442
+ > <Array(<EnvironmentReleasePlan>, Integer, Hash)> post_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, post_environment_release_plan_request)
443
+
444
+ ```ruby
445
+ begin
446
+ # Create a release plan
447
+ data, status_code, headers = api_instance.post_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, post_environment_release_plan_request)
448
+ p status_code # => 2xx
449
+ p headers # => { ... }
450
+ p data # => <EnvironmentReleasePlan>
451
+ rescue LaunchDarklyApi::ApiError => e
452
+ puts "Error when calling EnvironmentReleasePlansBetaApi->post_environment_release_plan_with_http_info: #{e}"
453
+ end
454
+ ```
455
+
456
+ ### Parameters
457
+
458
+ | Name | Type | Description | Notes |
459
+ | ---- | ---- | ----------- | ----- |
460
+ | **ld_api_version** | **String** | Version of the endpoint. | |
461
+ | **project_key** | **String** | The project key | |
462
+ | **environment_key** | **String** | The environment key | |
463
+ | **post_environment_release_plan_request** | [**PostEnvironmentReleasePlanRequest**](PostEnvironmentReleasePlanRequest.md) | Release plan to create | |
464
+
465
+ ### Return type
466
+
467
+ [**EnvironmentReleasePlan**](EnvironmentReleasePlan.md)
468
+
469
+ ### Authorization
470
+
471
+ [ApiKey](../README.md#ApiKey)
472
+
473
+ ### HTTP request headers
474
+
475
+ - **Content-Type**: application/json
476
+ - **Accept**: application/json
477
+
478
+
479
+ ## put_default_environment_release_plan
480
+
481
+ > <EnvironmentReleasePlan> put_default_environment_release_plan(ld_api_version, project_key, environment_key, put_default_environment_release_plan_request)
482
+
483
+ Set the default release plan
484
+
485
+ Set the plan with the given key as the environment's default, atomically replacing whatever was default before. Each plan whose default flag changes has its version incremented by 1. Idempotent: setting the current default again changes nothing. Rejects a key that is not an active plan in the environment, or a plan that has no randomization unit.
486
+
487
+ ### Examples
488
+
489
+ ```ruby
490
+ require 'time'
491
+ require 'launchdarkly_api'
492
+ # setup authorization
493
+ LaunchDarklyApi.configure do |config|
494
+ # Configure API key authorization: ApiKey
495
+ config.api_key['Authorization'] = 'YOUR API KEY'
496
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
497
+ # config.api_key_prefix['Authorization'] = 'Bearer'
498
+ end
499
+
500
+ api_instance = LaunchDarklyApi::EnvironmentReleasePlansBetaApi.new
501
+ ld_api_version = 'beta' # String | Version of the endpoint.
502
+ project_key = 'default' # String | The project key
503
+ environment_key = 'production' # String | The environment key
504
+ put_default_environment_release_plan_request = LaunchDarklyApi::PutDefaultEnvironmentReleasePlanRequest.new({key: 'checkout-flow-rollout'}) # PutDefaultEnvironmentReleasePlanRequest | The plan to set as the environment's default
505
+
506
+ begin
507
+ # Set the default release plan
508
+ result = api_instance.put_default_environment_release_plan(ld_api_version, project_key, environment_key, put_default_environment_release_plan_request)
509
+ p result
510
+ rescue LaunchDarklyApi::ApiError => e
511
+ puts "Error when calling EnvironmentReleasePlansBetaApi->put_default_environment_release_plan: #{e}"
512
+ end
513
+ ```
514
+
515
+ #### Using the put_default_environment_release_plan_with_http_info variant
516
+
517
+ This returns an Array which contains the response data, status code and headers.
518
+
519
+ > <Array(<EnvironmentReleasePlan>, Integer, Hash)> put_default_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, put_default_environment_release_plan_request)
520
+
521
+ ```ruby
522
+ begin
523
+ # Set the default release plan
524
+ data, status_code, headers = api_instance.put_default_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, put_default_environment_release_plan_request)
525
+ p status_code # => 2xx
526
+ p headers # => { ... }
527
+ p data # => <EnvironmentReleasePlan>
528
+ rescue LaunchDarklyApi::ApiError => e
529
+ puts "Error when calling EnvironmentReleasePlansBetaApi->put_default_environment_release_plan_with_http_info: #{e}"
530
+ end
531
+ ```
532
+
533
+ ### Parameters
534
+
535
+ | Name | Type | Description | Notes |
536
+ | ---- | ---- | ----------- | ----- |
537
+ | **ld_api_version** | **String** | Version of the endpoint. | |
538
+ | **project_key** | **String** | The project key | |
539
+ | **environment_key** | **String** | The environment key | |
540
+ | **put_default_environment_release_plan_request** | [**PutDefaultEnvironmentReleasePlanRequest**](PutDefaultEnvironmentReleasePlanRequest.md) | The plan to set as the environment&#39;s default | |
541
+
542
+ ### Return type
543
+
544
+ [**EnvironmentReleasePlan**](EnvironmentReleasePlan.md)
545
+
546
+ ### Authorization
547
+
548
+ [ApiKey](../README.md#ApiKey)
549
+
550
+ ### HTTP request headers
551
+
552
+ - **Content-Type**: application/json
553
+ - **Accept**: application/json
554
+
555
+
556
+ ## put_environment_release_plan
557
+
558
+ > <EnvironmentReleasePlan> put_environment_release_plan(ld_api_version, project_key, environment_key, release_plan_key, put_environment_release_plan_request)
559
+
560
+ Update a release plan
561
+
562
+ Replace a release plan's configuration. This is a full replace, not a merge: the plan's phases, steps, clauses, and metrics become exactly what the request specifies, and anything omitted is removed. The plan's key and environment are 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 release already started from the plan is not affected.
563
+
564
+ ### Examples
565
+
566
+ ```ruby
567
+ require 'time'
568
+ require 'launchdarkly_api'
569
+ # setup authorization
570
+ LaunchDarklyApi.configure do |config|
571
+ # Configure API key authorization: ApiKey
572
+ config.api_key['Authorization'] = 'YOUR API KEY'
573
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
574
+ # config.api_key_prefix['Authorization'] = 'Bearer'
575
+ end
576
+
577
+ api_instance = LaunchDarklyApi::EnvironmentReleasePlansBetaApi.new
578
+ ld_api_version = 'beta' # String | Version of the endpoint.
579
+ project_key = 'default' # String | The project key
580
+ environment_key = 'production' # String | The environment key
581
+ release_plan_key = 'checkout-flow-rollout' # String | The release plan key
582
+ put_environment_release_plan_request = LaunchDarklyApi::PutEnvironmentReleasePlanRequest.new({name: 'Checkout flow rollout', progressive_release: LaunchDarklyApi::EnvironmentReleasePlanProgressiveRelease.new({randomization_unit: 'user', phases: [LaunchDarklyApi::EnvironmentReleasePlanPhase.new({steps: [LaunchDarklyApi::EnvironmentReleasePlanStep.new({allocation: 50000, duration_millis: 3600000})]})]})}) # PutEnvironmentReleasePlanRequest | The release plan's replacement configuration
583
+
584
+ begin
585
+ # Update a release plan
586
+ result = api_instance.put_environment_release_plan(ld_api_version, project_key, environment_key, release_plan_key, put_environment_release_plan_request)
587
+ p result
588
+ rescue LaunchDarklyApi::ApiError => e
589
+ puts "Error when calling EnvironmentReleasePlansBetaApi->put_environment_release_plan: #{e}"
590
+ end
591
+ ```
592
+
593
+ #### Using the put_environment_release_plan_with_http_info variant
594
+
595
+ This returns an Array which contains the response data, status code and headers.
596
+
597
+ > <Array(<EnvironmentReleasePlan>, Integer, Hash)> put_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, release_plan_key, put_environment_release_plan_request)
598
+
599
+ ```ruby
600
+ begin
601
+ # Update a release plan
602
+ data, status_code, headers = api_instance.put_environment_release_plan_with_http_info(ld_api_version, project_key, environment_key, release_plan_key, put_environment_release_plan_request)
603
+ p status_code # => 2xx
604
+ p headers # => { ... }
605
+ p data # => <EnvironmentReleasePlan>
606
+ rescue LaunchDarklyApi::ApiError => e
607
+ puts "Error when calling EnvironmentReleasePlansBetaApi->put_environment_release_plan_with_http_info: #{e}"
608
+ end
609
+ ```
610
+
611
+ ### Parameters
612
+
613
+ | Name | Type | Description | Notes |
614
+ | ---- | ---- | ----------- | ----- |
615
+ | **ld_api_version** | **String** | Version of the endpoint. | |
616
+ | **project_key** | **String** | The project key | |
617
+ | **environment_key** | **String** | The environment key | |
618
+ | **release_plan_key** | **String** | The release plan key | |
619
+ | **put_environment_release_plan_request** | [**PutEnvironmentReleasePlanRequest**](PutEnvironmentReleasePlanRequest.md) | The release plan&#39;s replacement configuration | |
620
+
621
+ ### Return type
622
+
623
+ [**EnvironmentReleasePlan**](EnvironmentReleasePlan.md)
624
+
625
+ ### Authorization
626
+
627
+ [ApiKey](../README.md#ApiKey)
628
+
629
+ ### HTTP request headers
630
+
631
+ - **Content-Type**: application/json
632
+ - **Accept**: application/json
633
+
@@ -0,0 +1,20 @@
1
+ # LaunchDarklyApi::EnvironmentReleasePlansLink
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **href** | **String** | | [optional] |
8
+ | **type** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'launchdarkly_api'
14
+
15
+ instance = LaunchDarklyApi::EnvironmentReleasePlansLink.new(
16
+ href: null,
17
+ type: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # LaunchDarklyApi::EnvironmentReleasePlansPaginatedLinks
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first** | [**EnvironmentReleasePlansLink**](EnvironmentReleasePlansLink.md) | | [optional] |
8
+ | **last** | [**EnvironmentReleasePlansLink**](EnvironmentReleasePlansLink.md) | | [optional] |
9
+ | **_next** | [**EnvironmentReleasePlansLink**](EnvironmentReleasePlansLink.md) | | [optional] |
10
+ | **prev** | [**EnvironmentReleasePlansLink**](EnvironmentReleasePlansLink.md) | | [optional] |
11
+ | **_self** | [**EnvironmentReleasePlansLink**](EnvironmentReleasePlansLink.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'launchdarkly_api'
17
+
18
+ instance = LaunchDarklyApi::EnvironmentReleasePlansPaginatedLinks.new(
19
+ first: null,
20
+ last: null,
21
+ _next: null,
22
+ prev: null,
23
+ _self: null
24
+ )
25
+ ```
26
+