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,392 @@
1
+ # LaunchDarklyApi::FlagReleasePlansBetaApi
2
+
3
+ All URIs are relative to *https://app.launchdarkly.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_flag_release_plan**](FlagReleasePlansBetaApi.md#create_flag_release_plan) | **POST** /api/v2/projects/{projectKey}/flag-release-plans | Create a flag release plan for a project |
8
+ | [**delete_flag_release_plan**](FlagReleasePlansBetaApi.md#delete_flag_release_plan) | **DELETE** /api/v2/projects/{projectKey}/flag-release-plans/{planKey} | Delete a flag release plan in a project |
9
+ | [**get_flag_release_plan**](FlagReleasePlansBetaApi.md#get_flag_release_plan) | **GET** /api/v2/projects/{projectKey}/flag-release-plans/{planKey} | Get a flag release plan in a project by plan key |
10
+ | [**list_flag_release_plans**](FlagReleasePlansBetaApi.md#list_flag_release_plans) | **GET** /api/v2/projects/{projectKey}/flag-release-plans | List a project's flag release plans |
11
+ | [**update_flag_release_plan**](FlagReleasePlansBetaApi.md#update_flag_release_plan) | **PUT** /api/v2/projects/{projectKey}/flag-release-plans/{planKey} | Replace a flag release plan configuration in a project |
12
+
13
+
14
+ ## create_flag_release_plan
15
+
16
+ > <FlagReleasePlan> create_flag_release_plan(ld_api_version, project_key, create_flag_release_plan_request)
17
+
18
+ Create a flag release plan for a project
19
+
20
+ 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.
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'launchdarkly_api'
27
+ # setup authorization
28
+ LaunchDarklyApi.configure do |config|
29
+ # Configure API key authorization: ApiKey
30
+ config.api_key['Authorization'] = 'YOUR API KEY'
31
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
+ # config.api_key_prefix['Authorization'] = 'Bearer'
33
+ end
34
+
35
+ api_instance = LaunchDarklyApi::FlagReleasePlansBetaApi.new
36
+ ld_api_version = 'beta' # String | Version of the endpoint.
37
+ project_key = 'project_key_example' # String |
38
+ create_flag_release_plan_request = LaunchDarklyApi::CreateFlagReleasePlanRequest.new({name: 'name_example', environments: [LaunchDarklyApi::FlagReleasePlanEnvironment.new({environment_key: 'environment_key_example', trigger_type: LaunchDarklyApi::TriggerType::FLAG_EVAL})], key: 'key_example'}) # CreateFlagReleasePlanRequest |
39
+
40
+ begin
41
+ # Create a flag release plan for a project
42
+ result = api_instance.create_flag_release_plan(ld_api_version, project_key, create_flag_release_plan_request)
43
+ p result
44
+ rescue LaunchDarklyApi::ApiError => e
45
+ puts "Error when calling FlagReleasePlansBetaApi->create_flag_release_plan: #{e}"
46
+ end
47
+ ```
48
+
49
+ #### Using the create_flag_release_plan_with_http_info variant
50
+
51
+ This returns an Array which contains the response data, status code and headers.
52
+
53
+ > <Array(<FlagReleasePlan>, Integer, Hash)> create_flag_release_plan_with_http_info(ld_api_version, project_key, create_flag_release_plan_request)
54
+
55
+ ```ruby
56
+ begin
57
+ # Create a flag release plan for a project
58
+ data, status_code, headers = api_instance.create_flag_release_plan_with_http_info(ld_api_version, project_key, create_flag_release_plan_request)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => <FlagReleasePlan>
62
+ rescue LaunchDarklyApi::ApiError => e
63
+ puts "Error when calling FlagReleasePlansBetaApi->create_flag_release_plan_with_http_info: #{e}"
64
+ end
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ | Name | Type | Description | Notes |
70
+ | ---- | ---- | ----------- | ----- |
71
+ | **ld_api_version** | **String** | Version of the endpoint. | |
72
+ | **project_key** | **String** | | |
73
+ | **create_flag_release_plan_request** | [**CreateFlagReleasePlanRequest**](CreateFlagReleasePlanRequest.md) | | |
74
+
75
+ ### Return type
76
+
77
+ [**FlagReleasePlan**](FlagReleasePlan.md)
78
+
79
+ ### Authorization
80
+
81
+ [ApiKey](../README.md#ApiKey)
82
+
83
+ ### HTTP request headers
84
+
85
+ - **Content-Type**: application/json
86
+ - **Accept**: application/json
87
+
88
+
89
+ ## delete_flag_release_plan
90
+
91
+ > delete_flag_release_plan(ld_api_version, project_key, plan_key)
92
+
93
+ Delete a flag release plan in a project
94
+
95
+ Delete a flag release plan in a project.
96
+
97
+ ### Examples
98
+
99
+ ```ruby
100
+ require 'time'
101
+ require 'launchdarkly_api'
102
+ # setup authorization
103
+ LaunchDarklyApi.configure do |config|
104
+ # Configure API key authorization: ApiKey
105
+ config.api_key['Authorization'] = 'YOUR API KEY'
106
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
107
+ # config.api_key_prefix['Authorization'] = 'Bearer'
108
+ end
109
+
110
+ api_instance = LaunchDarklyApi::FlagReleasePlansBetaApi.new
111
+ ld_api_version = 'beta' # String | Version of the endpoint.
112
+ project_key = 'project_key_example' # String |
113
+ plan_key = 'plan_key_example' # String |
114
+
115
+ begin
116
+ # Delete a flag release plan in a project
117
+ api_instance.delete_flag_release_plan(ld_api_version, project_key, plan_key)
118
+ rescue LaunchDarklyApi::ApiError => e
119
+ puts "Error when calling FlagReleasePlansBetaApi->delete_flag_release_plan: #{e}"
120
+ end
121
+ ```
122
+
123
+ #### Using the delete_flag_release_plan_with_http_info variant
124
+
125
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
126
+
127
+ > <Array(nil, Integer, Hash)> delete_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key)
128
+
129
+ ```ruby
130
+ begin
131
+ # Delete a flag release plan in a project
132
+ data, status_code, headers = api_instance.delete_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key)
133
+ p status_code # => 2xx
134
+ p headers # => { ... }
135
+ p data # => nil
136
+ rescue LaunchDarklyApi::ApiError => e
137
+ puts "Error when calling FlagReleasePlansBetaApi->delete_flag_release_plan_with_http_info: #{e}"
138
+ end
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ | Name | Type | Description | Notes |
144
+ | ---- | ---- | ----------- | ----- |
145
+ | **ld_api_version** | **String** | Version of the endpoint. | |
146
+ | **project_key** | **String** | | |
147
+ | **plan_key** | **String** | | |
148
+
149
+ ### Return type
150
+
151
+ nil (empty response body)
152
+
153
+ ### Authorization
154
+
155
+ [ApiKey](../README.md#ApiKey)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: Not defined
160
+ - **Accept**: application/json
161
+
162
+
163
+ ## get_flag_release_plan
164
+
165
+ > <FlagReleasePlan> get_flag_release_plan(ld_api_version, project_key, plan_key)
166
+
167
+ Get a flag release plan in a project by plan key
168
+
169
+ Get a flag release plan in a project by plan key.
170
+
171
+ ### Examples
172
+
173
+ ```ruby
174
+ require 'time'
175
+ require 'launchdarkly_api'
176
+ # setup authorization
177
+ LaunchDarklyApi.configure do |config|
178
+ # Configure API key authorization: ApiKey
179
+ config.api_key['Authorization'] = 'YOUR API KEY'
180
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
181
+ # config.api_key_prefix['Authorization'] = 'Bearer'
182
+ end
183
+
184
+ api_instance = LaunchDarklyApi::FlagReleasePlansBetaApi.new
185
+ ld_api_version = 'beta' # String | Version of the endpoint.
186
+ project_key = 'project_key_example' # String |
187
+ plan_key = 'plan_key_example' # String |
188
+
189
+ begin
190
+ # Get a flag release plan in a project by plan key
191
+ result = api_instance.get_flag_release_plan(ld_api_version, project_key, plan_key)
192
+ p result
193
+ rescue LaunchDarklyApi::ApiError => e
194
+ puts "Error when calling FlagReleasePlansBetaApi->get_flag_release_plan: #{e}"
195
+ end
196
+ ```
197
+
198
+ #### Using the get_flag_release_plan_with_http_info variant
199
+
200
+ This returns an Array which contains the response data, status code and headers.
201
+
202
+ > <Array(<FlagReleasePlan>, Integer, Hash)> get_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key)
203
+
204
+ ```ruby
205
+ begin
206
+ # Get a flag release plan in a project by plan key
207
+ data, status_code, headers = api_instance.get_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key)
208
+ p status_code # => 2xx
209
+ p headers # => { ... }
210
+ p data # => <FlagReleasePlan>
211
+ rescue LaunchDarklyApi::ApiError => e
212
+ puts "Error when calling FlagReleasePlansBetaApi->get_flag_release_plan_with_http_info: #{e}"
213
+ end
214
+ ```
215
+
216
+ ### Parameters
217
+
218
+ | Name | Type | Description | Notes |
219
+ | ---- | ---- | ----------- | ----- |
220
+ | **ld_api_version** | **String** | Version of the endpoint. | |
221
+ | **project_key** | **String** | | |
222
+ | **plan_key** | **String** | | |
223
+
224
+ ### Return type
225
+
226
+ [**FlagReleasePlan**](FlagReleasePlan.md)
227
+
228
+ ### Authorization
229
+
230
+ [ApiKey](../README.md#ApiKey)
231
+
232
+ ### HTTP request headers
233
+
234
+ - **Content-Type**: Not defined
235
+ - **Accept**: application/json
236
+
237
+
238
+ ## list_flag_release_plans
239
+
240
+ > <ListFlagReleasePlansResponse> list_flag_release_plans(ld_api_version, project_key, opts)
241
+
242
+ List a project's flag release plans
243
+
244
+ List a project's flag release plans, in creation order.
245
+
246
+ ### Examples
247
+
248
+ ```ruby
249
+ require 'time'
250
+ require 'launchdarkly_api'
251
+ # setup authorization
252
+ LaunchDarklyApi.configure do |config|
253
+ # Configure API key authorization: ApiKey
254
+ config.api_key['Authorization'] = 'YOUR API KEY'
255
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
256
+ # config.api_key_prefix['Authorization'] = 'Bearer'
257
+ end
258
+
259
+ api_instance = LaunchDarklyApi::FlagReleasePlansBetaApi.new
260
+ ld_api_version = 'beta' # String | Version of the endpoint.
261
+ project_key = 'project_key_example' # String |
262
+ opts = {
263
+ limit: 56, # Integer | The number of flag release plans to return.
264
+ offset: 56 # Integer | The number of flag release plans to skip. Used for pagination.
265
+ }
266
+
267
+ begin
268
+ # List a project's flag release plans
269
+ result = api_instance.list_flag_release_plans(ld_api_version, project_key, opts)
270
+ p result
271
+ rescue LaunchDarklyApi::ApiError => e
272
+ puts "Error when calling FlagReleasePlansBetaApi->list_flag_release_plans: #{e}"
273
+ end
274
+ ```
275
+
276
+ #### Using the list_flag_release_plans_with_http_info variant
277
+
278
+ This returns an Array which contains the response data, status code and headers.
279
+
280
+ > <Array(<ListFlagReleasePlansResponse>, Integer, Hash)> list_flag_release_plans_with_http_info(ld_api_version, project_key, opts)
281
+
282
+ ```ruby
283
+ begin
284
+ # List a project's flag release plans
285
+ data, status_code, headers = api_instance.list_flag_release_plans_with_http_info(ld_api_version, project_key, opts)
286
+ p status_code # => 2xx
287
+ p headers # => { ... }
288
+ p data # => <ListFlagReleasePlansResponse>
289
+ rescue LaunchDarklyApi::ApiError => e
290
+ puts "Error when calling FlagReleasePlansBetaApi->list_flag_release_plans_with_http_info: #{e}"
291
+ end
292
+ ```
293
+
294
+ ### Parameters
295
+
296
+ | Name | Type | Description | Notes |
297
+ | ---- | ---- | ----------- | ----- |
298
+ | **ld_api_version** | **String** | Version of the endpoint. | |
299
+ | **project_key** | **String** | | |
300
+ | **limit** | **Integer** | The number of flag release plans to return. | [optional][default to 25] |
301
+ | **offset** | **Integer** | The number of flag release plans to skip. Used for pagination. | [optional][default to 0] |
302
+
303
+ ### Return type
304
+
305
+ [**ListFlagReleasePlansResponse**](ListFlagReleasePlansResponse.md)
306
+
307
+ ### Authorization
308
+
309
+ [ApiKey](../README.md#ApiKey)
310
+
311
+ ### HTTP request headers
312
+
313
+ - **Content-Type**: Not defined
314
+ - **Accept**: application/json
315
+
316
+
317
+ ## update_flag_release_plan
318
+
319
+ > <FlagReleasePlan> update_flag_release_plan(ld_api_version, project_key, plan_key, put_flag_release_plan_request)
320
+
321
+ Replace a flag release plan configuration in a project
322
+
323
+ 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.
324
+
325
+ ### Examples
326
+
327
+ ```ruby
328
+ require 'time'
329
+ require 'launchdarkly_api'
330
+ # setup authorization
331
+ LaunchDarklyApi.configure do |config|
332
+ # Configure API key authorization: ApiKey
333
+ config.api_key['Authorization'] = 'YOUR API KEY'
334
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
335
+ # config.api_key_prefix['Authorization'] = 'Bearer'
336
+ end
337
+
338
+ api_instance = LaunchDarklyApi::FlagReleasePlansBetaApi.new
339
+ ld_api_version = 'beta' # String | Version of the endpoint.
340
+ project_key = 'project_key_example' # String |
341
+ plan_key = 'plan_key_example' # String |
342
+ put_flag_release_plan_request = LaunchDarklyApi::PutFlagReleasePlanRequest.new({name: 'name_example', environments: [LaunchDarklyApi::FlagReleasePlanEnvironment.new({environment_key: 'environment_key_example', trigger_type: LaunchDarklyApi::TriggerType::FLAG_EVAL})]}) # PutFlagReleasePlanRequest |
343
+
344
+ begin
345
+ # Replace a flag release plan configuration in a project
346
+ result = api_instance.update_flag_release_plan(ld_api_version, project_key, plan_key, put_flag_release_plan_request)
347
+ p result
348
+ rescue LaunchDarklyApi::ApiError => e
349
+ puts "Error when calling FlagReleasePlansBetaApi->update_flag_release_plan: #{e}"
350
+ end
351
+ ```
352
+
353
+ #### Using the update_flag_release_plan_with_http_info variant
354
+
355
+ This returns an Array which contains the response data, status code and headers.
356
+
357
+ > <Array(<FlagReleasePlan>, Integer, Hash)> update_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key, put_flag_release_plan_request)
358
+
359
+ ```ruby
360
+ begin
361
+ # Replace a flag release plan configuration in a project
362
+ data, status_code, headers = api_instance.update_flag_release_plan_with_http_info(ld_api_version, project_key, plan_key, put_flag_release_plan_request)
363
+ p status_code # => 2xx
364
+ p headers # => { ... }
365
+ p data # => <FlagReleasePlan>
366
+ rescue LaunchDarklyApi::ApiError => e
367
+ puts "Error when calling FlagReleasePlansBetaApi->update_flag_release_plan_with_http_info: #{e}"
368
+ end
369
+ ```
370
+
371
+ ### Parameters
372
+
373
+ | Name | Type | Description | Notes |
374
+ | ---- | ---- | ----------- | ----- |
375
+ | **ld_api_version** | **String** | Version of the endpoint. | |
376
+ | **project_key** | **String** | | |
377
+ | **plan_key** | **String** | | |
378
+ | **put_flag_release_plan_request** | [**PutFlagReleasePlanRequest**](PutFlagReleasePlanRequest.md) | | |
379
+
380
+ ### Return type
381
+
382
+ [**FlagReleasePlan**](FlagReleasePlan.md)
383
+
384
+ ### Authorization
385
+
386
+ [ApiKey](../README.md#ApiKey)
387
+
388
+ ### HTTP request headers
389
+
390
+ - **Content-Type**: application/json
391
+ - **Accept**: application/json
392
+
@@ -0,0 +1,20 @@
1
+ # LaunchDarklyApi::FlagReleasePlansError
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | | |
8
+ | **code** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'launchdarkly_api'
14
+
15
+ instance = LaunchDarklyApi::FlagReleasePlansError.new(
16
+ message: null,
17
+ code: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # LaunchDarklyApi::FlagReleasePlansLink
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::FlagReleasePlansLink.new(
16
+ href: null,
17
+ type: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # LaunchDarklyApi::FlagReleasePlansPaginatedLinks
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first** | [**FlagReleasePlansLink**](FlagReleasePlansLink.md) | | [optional] |
8
+ | **last** | [**FlagReleasePlansLink**](FlagReleasePlansLink.md) | | [optional] |
9
+ | **_next** | [**FlagReleasePlansLink**](FlagReleasePlansLink.md) | | [optional] |
10
+ | **prev** | [**FlagReleasePlansLink**](FlagReleasePlansLink.md) | | [optional] |
11
+ | **_self** | [**FlagReleasePlansLink**](FlagReleasePlansLink.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'launchdarkly_api'
17
+
18
+ instance = LaunchDarklyApi::FlagReleasePlansPaginatedLinks.new(
19
+ first: null,
20
+ last: null,
21
+ _next: null,
22
+ prev: null,
23
+ _self: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # LaunchDarklyApi::ListFlagReleasePlansResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **items** | [**Array&lt;FlagReleasePlan&gt;**](FlagReleasePlan.md) | | |
8
+ | **total_count** | **Integer** | The total number of flag release plans in the project, before pagination. | |
9
+ | **_links** | [**FlagReleasePlansPaginatedLinks**](FlagReleasePlansPaginatedLinks.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'launchdarkly_api'
15
+
16
+ instance = LaunchDarklyApi::ListFlagReleasePlansResponse.new(
17
+ items: null,
18
+ total_count: null,
19
+ _links: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,79 @@
1
+ # LaunchDarklyApi::MaintainerIdentifier
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'launchdarkly_api'
13
+
14
+ LaunchDarklyApi::MaintainerIdentifier.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'MaintainerIdentifierMember',
18
+ # :'MaintainerIdentifierTeam'
19
+ # ]
20
+ ```
21
+
22
+ ### `openapi_discriminator_name`
23
+
24
+ Returns the discriminator's property name.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'launchdarkly_api'
30
+
31
+ LaunchDarklyApi::MaintainerIdentifier.openapi_discriminator_name
32
+ # => :'kind'
33
+ ```
34
+
35
+ ### `openapi_discriminator_name`
36
+
37
+ Returns the discriminator's mapping.
38
+
39
+ #### Example
40
+
41
+ ```ruby
42
+ require 'launchdarkly_api'
43
+
44
+ LaunchDarklyApi::MaintainerIdentifier.openapi_discriminator_mapping
45
+ # =>
46
+ # {
47
+ # :'member' => :'MaintainerIdentifierMember',
48
+ # :'team' => :'MaintainerIdentifierTeam'
49
+ # }
50
+ ```
51
+
52
+ ### build
53
+
54
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
55
+
56
+ #### Example
57
+
58
+ ```ruby
59
+ require 'launchdarkly_api'
60
+
61
+ LaunchDarklyApi::MaintainerIdentifier.build(data)
62
+ # => #<MaintainerIdentifierMember:0x00007fdd4aab02a0>
63
+
64
+ LaunchDarklyApi::MaintainerIdentifier.build(data_that_doesnt_match)
65
+ # => nil
66
+ ```
67
+
68
+ #### Parameters
69
+
70
+ | Name | Type | Description |
71
+ | ---- | ---- | ----------- |
72
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
73
+
74
+ #### Return type
75
+
76
+ - `MaintainerIdentifierMember`
77
+ - `MaintainerIdentifierTeam`
78
+ - `nil` (if no type matches)
79
+
@@ -0,0 +1,20 @@
1
+ # LaunchDarklyApi::MaintainerIdentifierMember
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **kind** | **String** | | |
8
+ | **member_id** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'launchdarkly_api'
14
+
15
+ instance = LaunchDarklyApi::MaintainerIdentifierMember.new(
16
+ kind: null,
17
+ member_id: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # LaunchDarklyApi::MaintainerIdentifierTeam
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **kind** | **String** | | |
8
+ | **team_key** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'launchdarkly_api'
14
+
15
+ instance = LaunchDarklyApi::MaintainerIdentifierTeam.new(
16
+ kind: null,
17
+ team_key: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,79 @@
1
+ # LaunchDarklyApi::MaintainerResponse
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'launchdarkly_api'
13
+
14
+ LaunchDarklyApi::MaintainerResponse.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'MaintainerResponseMember',
18
+ # :'MaintainerResponseTeam'
19
+ # ]
20
+ ```
21
+
22
+ ### `openapi_discriminator_name`
23
+
24
+ Returns the discriminator's property name.
25
+
26
+ #### Example
27
+
28
+ ```ruby
29
+ require 'launchdarkly_api'
30
+
31
+ LaunchDarklyApi::MaintainerResponse.openapi_discriminator_name
32
+ # => :'kind'
33
+ ```
34
+
35
+ ### `openapi_discriminator_name`
36
+
37
+ Returns the discriminator's mapping.
38
+
39
+ #### Example
40
+
41
+ ```ruby
42
+ require 'launchdarkly_api'
43
+
44
+ LaunchDarklyApi::MaintainerResponse.openapi_discriminator_mapping
45
+ # =>
46
+ # {
47
+ # :'member' => :'MaintainerResponseMember',
48
+ # :'team' => :'MaintainerResponseTeam'
49
+ # }
50
+ ```
51
+
52
+ ### build
53
+
54
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
55
+
56
+ #### Example
57
+
58
+ ```ruby
59
+ require 'launchdarkly_api'
60
+
61
+ LaunchDarklyApi::MaintainerResponse.build(data)
62
+ # => #<MaintainerResponseMember:0x00007fdd4aab02a0>
63
+
64
+ LaunchDarklyApi::MaintainerResponse.build(data_that_doesnt_match)
65
+ # => nil
66
+ ```
67
+
68
+ #### Parameters
69
+
70
+ | Name | Type | Description |
71
+ | ---- | ---- | ----------- |
72
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
73
+
74
+ #### Return type
75
+
76
+ - `MaintainerResponseMember`
77
+ - `MaintainerResponseTeam`
78
+ - `nil` (if no type matches)
79
+