ilovevideoeditor-sdk 1.0.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.
- checksums.yaml +7 -0
- data/lib/generated/ilovevideoeditor-sdk/api/api_keys_api.rb +204 -0
- data/lib/generated/ilovevideoeditor-sdk/api/assets_api.rb +632 -0
- data/lib/generated/ilovevideoeditor-sdk/api/billing_api.rb +428 -0
- data/lib/generated/ilovevideoeditor-sdk/api/health_api.rb +134 -0
- data/lib/generated/ilovevideoeditor-sdk/api/integrations_api.rb +587 -0
- data/lib/generated/ilovevideoeditor-sdk/api/projects_api.rb +614 -0
- data/lib/generated/ilovevideoeditor-sdk/api/render_api.rb +656 -0
- data/lib/generated/ilovevideoeditor-sdk/api/renditions_api.rb +420 -0
- data/lib/generated/ilovevideoeditor-sdk/api/templates_api.rb +217 -0
- data/lib/generated/ilovevideoeditor-sdk/api/tools_api.rb +220 -0
- data/lib/generated/ilovevideoeditor-sdk/api/webhooks_api.rb +204 -0
- data/lib/generated/ilovevideoeditor-sdk/api/workflows_api.rb +854 -0
- data/lib/generated/ilovevideoeditor-sdk/api_client.rb +397 -0
- data/lib/generated/ilovevideoeditor-sdk/api_error.rb +58 -0
- data/lib/generated/ilovevideoeditor-sdk/api_model_base.rb +88 -0
- data/lib/generated/ilovevideoeditor-sdk/configuration.rb +316 -0
- data/lib/generated/ilovevideoeditor-sdk/models/api_key.rb +246 -0
- data/lib/generated/ilovevideoeditor-sdk/models/api_key_with_secret.rb +191 -0
- data/lib/generated/ilovevideoeditor-sdk/models/asset.rb +404 -0
- data/lib/generated/ilovevideoeditor-sdk/models/asset_create.rb +303 -0
- data/lib/generated/ilovevideoeditor-sdk/models/asset_upload_url_response.rb +295 -0
- data/lib/generated/ilovevideoeditor-sdk/models/batch_delete_projects_request.rb +184 -0
- data/lib/generated/ilovevideoeditor-sdk/models/batch_delete_result.rb +175 -0
- data/lib/generated/ilovevideoeditor-sdk/models/billing_prices.rb +158 -0
- data/lib/generated/ilovevideoeditor-sdk/models/billing_prices_tiers.rb +168 -0
- data/lib/generated/ilovevideoeditor-sdk/models/billing_subscription.rb +254 -0
- data/lib/generated/ilovevideoeditor-sdk/models/cancel_render200_response.rb +225 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_api_key_request.rb +147 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_asset201_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_checkout_session200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_checkout_session_request.rb +220 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_integration201_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_project200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_workflow201_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_workflow_request.rb +208 -0
- data/lib/generated/ilovevideoeditor-sdk/models/credit_balance.rb +219 -0
- data/lib/generated/ilovevideoeditor-sdk/models/credit_balance_summary.rb +174 -0
- data/lib/generated/ilovevideoeditor-sdk/models/credit_balance_usage.rb +156 -0
- data/lib/generated/ilovevideoeditor-sdk/models/delete_project200_response.rb +190 -0
- data/lib/generated/ilovevideoeditor-sdk/models/destination.rb +331 -0
- data/lib/generated/ilovevideoeditor-sdk/models/destination_input.rb +304 -0
- data/lib/generated/ilovevideoeditor-sdk/models/error.rb +182 -0
- data/lib/generated/ilovevideoeditor-sdk/models/estimate_render_cost_request.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_asset_signed_url200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_asset_upload_url_request.rb +214 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_destination200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_project200_response.rb +173 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_project_stats200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_render_download_url200_response.rb +190 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_rendition200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_subscription200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_template200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_usage200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_workflow200_response.rb +175 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_workflow_run200_response.rb +175 -0
- data/lib/generated/ilovevideoeditor-sdk/models/health_check200_response.rb +147 -0
- data/lib/generated/ilovevideoeditor-sdk/models/health_check_detailed200_response.rb +199 -0
- data/lib/generated/ilovevideoeditor-sdk/models/health_check_detailed200_response_services.rb +156 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_api_keys200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_assets200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_integrations200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_invoices200_response.rb +158 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_projects200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_renditions200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_templates200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_webhook_subscriptions200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_workflow_runs200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_workflow_step_types200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_workflows200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/project.rb +329 -0
- data/lib/generated/ilovevideoeditor-sdk/models/project_create.rb +218 -0
- data/lib/generated/ilovevideoeditor-sdk/models/project_update.rb +239 -0
- data/lib/generated/ilovevideoeditor-sdk/models/queue_render200_response.rb +199 -0
- data/lib/generated/ilovevideoeditor-sdk/models/queue_render_request.rb +182 -0
- data/lib/generated/ilovevideoeditor-sdk/models/refresh_render_url200_response.rb +190 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_cost_estimate.rb +254 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_cost_estimate_resolution.rb +165 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_cost_estimate_tier.rb +165 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_job.rb +271 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_job_progress.rb +165 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_list_item.rb +356 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_template_request.rb +167 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_webhook_payload.rb +357 -0
- data/lib/generated/ilovevideoeditor-sdk/models/rendition.rb +335 -0
- data/lib/generated/ilovevideoeditor-sdk/models/rendition_cancel_result.rb +236 -0
- data/lib/generated/ilovevideoeditor-sdk/models/rendition_output.rb +233 -0
- data/lib/generated/ilovevideoeditor-sdk/models/rendition_stats.rb +192 -0
- data/lib/generated/ilovevideoeditor-sdk/models/run_workflow202_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/run_workflow_request.rb +149 -0
- data/lib/generated/ilovevideoeditor-sdk/models/service_health.rb +208 -0
- data/lib/generated/ilovevideoeditor-sdk/models/template.rb +324 -0
- data/lib/generated/ilovevideoeditor-sdk/models/template_summary.rb +322 -0
- data/lib/generated/ilovevideoeditor-sdk/models/test_integration200_response.rb +174 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tier_info.rb +214 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tier_info_credits.rb +165 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tool_job_request.rb +242 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tool_job_request_dimensions.rb +208 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tool_job_status.rb +310 -0
- data/lib/generated/ilovevideoeditor-sdk/models/track_render_bandwidth200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/update_workflow_request.rb +174 -0
- data/lib/generated/ilovevideoeditor-sdk/models/upload_asset200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/usage_log.rb +302 -0
- data/lib/generated/ilovevideoeditor-sdk/models/video_json.rb +243 -0
- data/lib/generated/ilovevideoeditor-sdk/models/video_json_destination.rb +227 -0
- data/lib/generated/ilovevideoeditor-sdk/models/webhook_subscription.rb +283 -0
- data/lib/generated/ilovevideoeditor-sdk/models/webhook_subscription_create.rb +204 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow.rb +356 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_definition.rb +262 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_run.rb +372 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_run_step.rb +409 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_step.rb +262 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_variable.rb +242 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workspace_integration.rb +398 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workspace_integration_input.rb +260 -0
- data/lib/generated/ilovevideoeditor-sdk/version.rb +15 -0
- data/lib/generated/ilovevideoeditor-sdk.rb +150 -0
- data/lib/ilovevideoeditor/client.rb +106 -0
- data/lib/ilovevideoeditor-sdk.rb +2 -0
- metadata +181 -0
|
@@ -0,0 +1,854 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#iLoveVideoEditor API
|
|
3
|
+
|
|
4
|
+
#Cloud video rendering API for iLoveVideoEditor. Submit a `VideoJSON` payload, queue a render job, and download the resulting MP4. **Authentication** - **API Key** (`x-api-key` header) — accepted by render pipeline and tool endpoints. - **Bearer Token** (`Authorization: Bearer <jwt>`) — required for user-scoped project, asset, billing, and webhook endpoints. - Many endpoints accept either form of authentication. **SDKs** Official typed SDKs are available for JavaScript/TypeScript, PHP, Python, Ruby, and Go. See https://ilovevideoeditor.com/docs/sdks **Outbound Webhooks** Render lifecycle events (`render.completed`, `render.failed`) are delivered to your endpoints as signed HTTP POST requests. See the `Webhooks` tag and the root-level `x-webhook-docs` extension for the payload format (`RenderWebhookPayload`), signature headers, HMAC verification, and the retry policy.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.22.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module ILoveVideoEditor
|
|
16
|
+
class WorkflowsApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Cancel a workflow run
|
|
23
|
+
# @param run_id [String]
|
|
24
|
+
# @param [Hash] opts the optional parameters
|
|
25
|
+
# @return [UploadAsset200Response]
|
|
26
|
+
def cancel_workflow_run(run_id, opts = {})
|
|
27
|
+
data, _status_code, _headers = cancel_workflow_run_with_http_info(run_id, opts)
|
|
28
|
+
data
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Cancel a workflow run
|
|
32
|
+
# @param run_id [String]
|
|
33
|
+
# @param [Hash] opts the optional parameters
|
|
34
|
+
# @return [Array<(UploadAsset200Response, Integer, Hash)>] UploadAsset200Response data, response status code and response headers
|
|
35
|
+
def cancel_workflow_run_with_http_info(run_id, opts = {})
|
|
36
|
+
if @api_client.config.debugging
|
|
37
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.cancel_workflow_run ...'
|
|
38
|
+
end
|
|
39
|
+
# verify the required parameter 'run_id' is set
|
|
40
|
+
if @api_client.config.client_side_validation && run_id.nil?
|
|
41
|
+
fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkflowsApi.cancel_workflow_run"
|
|
42
|
+
end
|
|
43
|
+
# resource path
|
|
44
|
+
local_var_path = '/v1/workflows/runs/{runId}/cancel'.sub('{runId}', CGI.escape(run_id.to_s))
|
|
45
|
+
|
|
46
|
+
# query parameters
|
|
47
|
+
query_params = opts[:query_params] || {}
|
|
48
|
+
|
|
49
|
+
# header parameters
|
|
50
|
+
header_params = opts[:header_params] || {}
|
|
51
|
+
# HTTP header 'Accept' (if needed)
|
|
52
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
53
|
+
|
|
54
|
+
# form parameters
|
|
55
|
+
form_params = opts[:form_params] || {}
|
|
56
|
+
|
|
57
|
+
# http body (model)
|
|
58
|
+
post_body = opts[:debug_body]
|
|
59
|
+
|
|
60
|
+
# return_type
|
|
61
|
+
return_type = opts[:debug_return_type] || 'UploadAsset200Response'
|
|
62
|
+
|
|
63
|
+
# auth_names
|
|
64
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
65
|
+
|
|
66
|
+
new_options = opts.merge(
|
|
67
|
+
:operation => :"WorkflowsApi.cancel_workflow_run",
|
|
68
|
+
:header_params => header_params,
|
|
69
|
+
:query_params => query_params,
|
|
70
|
+
:form_params => form_params,
|
|
71
|
+
:body => post_body,
|
|
72
|
+
:auth_names => auth_names,
|
|
73
|
+
:return_type => return_type
|
|
74
|
+
)
|
|
75
|
+
|
|
76
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
77
|
+
if @api_client.config.debugging
|
|
78
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#cancel_workflow_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
79
|
+
end
|
|
80
|
+
return data, status_code, headers
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Create a workflow
|
|
84
|
+
# @param create_workflow_request [CreateWorkflowRequest]
|
|
85
|
+
# @param [Hash] opts the optional parameters
|
|
86
|
+
# @return [CreateWorkflow201Response]
|
|
87
|
+
def create_workflow(create_workflow_request, opts = {})
|
|
88
|
+
data, _status_code, _headers = create_workflow_with_http_info(create_workflow_request, opts)
|
|
89
|
+
data
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Create a workflow
|
|
93
|
+
# @param create_workflow_request [CreateWorkflowRequest]
|
|
94
|
+
# @param [Hash] opts the optional parameters
|
|
95
|
+
# @return [Array<(CreateWorkflow201Response, Integer, Hash)>] CreateWorkflow201Response data, response status code and response headers
|
|
96
|
+
def create_workflow_with_http_info(create_workflow_request, opts = {})
|
|
97
|
+
if @api_client.config.debugging
|
|
98
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.create_workflow ...'
|
|
99
|
+
end
|
|
100
|
+
# verify the required parameter 'create_workflow_request' is set
|
|
101
|
+
if @api_client.config.client_side_validation && create_workflow_request.nil?
|
|
102
|
+
fail ArgumentError, "Missing the required parameter 'create_workflow_request' when calling WorkflowsApi.create_workflow"
|
|
103
|
+
end
|
|
104
|
+
# resource path
|
|
105
|
+
local_var_path = '/v1/workflows'
|
|
106
|
+
|
|
107
|
+
# query parameters
|
|
108
|
+
query_params = opts[:query_params] || {}
|
|
109
|
+
|
|
110
|
+
# header parameters
|
|
111
|
+
header_params = opts[:header_params] || {}
|
|
112
|
+
# HTTP header 'Accept' (if needed)
|
|
113
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
114
|
+
# HTTP header 'Content-Type'
|
|
115
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
116
|
+
if !content_type.nil?
|
|
117
|
+
header_params['Content-Type'] = content_type
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# form parameters
|
|
121
|
+
form_params = opts[:form_params] || {}
|
|
122
|
+
|
|
123
|
+
# http body (model)
|
|
124
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_workflow_request)
|
|
125
|
+
|
|
126
|
+
# return_type
|
|
127
|
+
return_type = opts[:debug_return_type] || 'CreateWorkflow201Response'
|
|
128
|
+
|
|
129
|
+
# auth_names
|
|
130
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
131
|
+
|
|
132
|
+
new_options = opts.merge(
|
|
133
|
+
:operation => :"WorkflowsApi.create_workflow",
|
|
134
|
+
:header_params => header_params,
|
|
135
|
+
:query_params => query_params,
|
|
136
|
+
:form_params => form_params,
|
|
137
|
+
:body => post_body,
|
|
138
|
+
:auth_names => auth_names,
|
|
139
|
+
:return_type => return_type
|
|
140
|
+
)
|
|
141
|
+
|
|
142
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
143
|
+
if @api_client.config.debugging
|
|
144
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#create_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
145
|
+
end
|
|
146
|
+
return data, status_code, headers
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Delete a workflow
|
|
150
|
+
# @param id [String]
|
|
151
|
+
# @param [Hash] opts the optional parameters
|
|
152
|
+
# @return [UploadAsset200Response]
|
|
153
|
+
def delete_workflow(id, opts = {})
|
|
154
|
+
data, _status_code, _headers = delete_workflow_with_http_info(id, opts)
|
|
155
|
+
data
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Delete a workflow
|
|
159
|
+
# @param id [String]
|
|
160
|
+
# @param [Hash] opts the optional parameters
|
|
161
|
+
# @return [Array<(UploadAsset200Response, Integer, Hash)>] UploadAsset200Response data, response status code and response headers
|
|
162
|
+
def delete_workflow_with_http_info(id, opts = {})
|
|
163
|
+
if @api_client.config.debugging
|
|
164
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.delete_workflow ...'
|
|
165
|
+
end
|
|
166
|
+
# verify the required parameter 'id' is set
|
|
167
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
168
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WorkflowsApi.delete_workflow"
|
|
169
|
+
end
|
|
170
|
+
# resource path
|
|
171
|
+
local_var_path = '/v1/workflows/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
172
|
+
|
|
173
|
+
# query parameters
|
|
174
|
+
query_params = opts[:query_params] || {}
|
|
175
|
+
|
|
176
|
+
# header parameters
|
|
177
|
+
header_params = opts[:header_params] || {}
|
|
178
|
+
# HTTP header 'Accept' (if needed)
|
|
179
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
180
|
+
|
|
181
|
+
# form parameters
|
|
182
|
+
form_params = opts[:form_params] || {}
|
|
183
|
+
|
|
184
|
+
# http body (model)
|
|
185
|
+
post_body = opts[:debug_body]
|
|
186
|
+
|
|
187
|
+
# return_type
|
|
188
|
+
return_type = opts[:debug_return_type] || 'UploadAsset200Response'
|
|
189
|
+
|
|
190
|
+
# auth_names
|
|
191
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
192
|
+
|
|
193
|
+
new_options = opts.merge(
|
|
194
|
+
:operation => :"WorkflowsApi.delete_workflow",
|
|
195
|
+
:header_params => header_params,
|
|
196
|
+
:query_params => query_params,
|
|
197
|
+
:form_params => form_params,
|
|
198
|
+
:body => post_body,
|
|
199
|
+
:auth_names => auth_names,
|
|
200
|
+
:return_type => return_type
|
|
201
|
+
)
|
|
202
|
+
|
|
203
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
204
|
+
if @api_client.config.debugging
|
|
205
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#delete_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
206
|
+
end
|
|
207
|
+
return data, status_code, headers
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# Get a workflow
|
|
211
|
+
# @param id [String]
|
|
212
|
+
# @param [Hash] opts the optional parameters
|
|
213
|
+
# @return [GetWorkflow200Response]
|
|
214
|
+
def get_workflow(id, opts = {})
|
|
215
|
+
data, _status_code, _headers = get_workflow_with_http_info(id, opts)
|
|
216
|
+
data
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
# Get a workflow
|
|
220
|
+
# @param id [String]
|
|
221
|
+
# @param [Hash] opts the optional parameters
|
|
222
|
+
# @return [Array<(GetWorkflow200Response, Integer, Hash)>] GetWorkflow200Response data, response status code and response headers
|
|
223
|
+
def get_workflow_with_http_info(id, opts = {})
|
|
224
|
+
if @api_client.config.debugging
|
|
225
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.get_workflow ...'
|
|
226
|
+
end
|
|
227
|
+
# verify the required parameter 'id' is set
|
|
228
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
229
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WorkflowsApi.get_workflow"
|
|
230
|
+
end
|
|
231
|
+
# resource path
|
|
232
|
+
local_var_path = '/v1/workflows/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
233
|
+
|
|
234
|
+
# query parameters
|
|
235
|
+
query_params = opts[:query_params] || {}
|
|
236
|
+
|
|
237
|
+
# header parameters
|
|
238
|
+
header_params = opts[:header_params] || {}
|
|
239
|
+
# HTTP header 'Accept' (if needed)
|
|
240
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
241
|
+
|
|
242
|
+
# form parameters
|
|
243
|
+
form_params = opts[:form_params] || {}
|
|
244
|
+
|
|
245
|
+
# http body (model)
|
|
246
|
+
post_body = opts[:debug_body]
|
|
247
|
+
|
|
248
|
+
# return_type
|
|
249
|
+
return_type = opts[:debug_return_type] || 'GetWorkflow200Response'
|
|
250
|
+
|
|
251
|
+
# auth_names
|
|
252
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
253
|
+
|
|
254
|
+
new_options = opts.merge(
|
|
255
|
+
:operation => :"WorkflowsApi.get_workflow",
|
|
256
|
+
:header_params => header_params,
|
|
257
|
+
:query_params => query_params,
|
|
258
|
+
:form_params => form_params,
|
|
259
|
+
:body => post_body,
|
|
260
|
+
:auth_names => auth_names,
|
|
261
|
+
:return_type => return_type
|
|
262
|
+
)
|
|
263
|
+
|
|
264
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
265
|
+
if @api_client.config.debugging
|
|
266
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#get_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
267
|
+
end
|
|
268
|
+
return data, status_code, headers
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
# Get a workflow run
|
|
272
|
+
# @param run_id [String]
|
|
273
|
+
# @param [Hash] opts the optional parameters
|
|
274
|
+
# @return [GetWorkflowRun200Response]
|
|
275
|
+
def get_workflow_run(run_id, opts = {})
|
|
276
|
+
data, _status_code, _headers = get_workflow_run_with_http_info(run_id, opts)
|
|
277
|
+
data
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
# Get a workflow run
|
|
281
|
+
# @param run_id [String]
|
|
282
|
+
# @param [Hash] opts the optional parameters
|
|
283
|
+
# @return [Array<(GetWorkflowRun200Response, Integer, Hash)>] GetWorkflowRun200Response data, response status code and response headers
|
|
284
|
+
def get_workflow_run_with_http_info(run_id, opts = {})
|
|
285
|
+
if @api_client.config.debugging
|
|
286
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.get_workflow_run ...'
|
|
287
|
+
end
|
|
288
|
+
# verify the required parameter 'run_id' is set
|
|
289
|
+
if @api_client.config.client_side_validation && run_id.nil?
|
|
290
|
+
fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkflowsApi.get_workflow_run"
|
|
291
|
+
end
|
|
292
|
+
# resource path
|
|
293
|
+
local_var_path = '/v1/workflows/runs/{runId}'.sub('{runId}', CGI.escape(run_id.to_s))
|
|
294
|
+
|
|
295
|
+
# query parameters
|
|
296
|
+
query_params = opts[:query_params] || {}
|
|
297
|
+
|
|
298
|
+
# header parameters
|
|
299
|
+
header_params = opts[:header_params] || {}
|
|
300
|
+
# HTTP header 'Accept' (if needed)
|
|
301
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
302
|
+
|
|
303
|
+
# form parameters
|
|
304
|
+
form_params = opts[:form_params] || {}
|
|
305
|
+
|
|
306
|
+
# http body (model)
|
|
307
|
+
post_body = opts[:debug_body]
|
|
308
|
+
|
|
309
|
+
# return_type
|
|
310
|
+
return_type = opts[:debug_return_type] || 'GetWorkflowRun200Response'
|
|
311
|
+
|
|
312
|
+
# auth_names
|
|
313
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
314
|
+
|
|
315
|
+
new_options = opts.merge(
|
|
316
|
+
:operation => :"WorkflowsApi.get_workflow_run",
|
|
317
|
+
:header_params => header_params,
|
|
318
|
+
:query_params => query_params,
|
|
319
|
+
:form_params => form_params,
|
|
320
|
+
:body => post_body,
|
|
321
|
+
:auth_names => auth_names,
|
|
322
|
+
:return_type => return_type
|
|
323
|
+
)
|
|
324
|
+
|
|
325
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
326
|
+
if @api_client.config.debugging
|
|
327
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#get_workflow_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
328
|
+
end
|
|
329
|
+
return data, status_code, headers
|
|
330
|
+
end
|
|
331
|
+
|
|
332
|
+
# List workflow runs
|
|
333
|
+
# @param id [String]
|
|
334
|
+
# @param [Hash] opts the optional parameters
|
|
335
|
+
# @option opts [Integer] :page (default to 1)
|
|
336
|
+
# @option opts [Integer] :limit (default to 25)
|
|
337
|
+
# @return [ListWorkflowRuns200Response]
|
|
338
|
+
def list_workflow_runs(id, opts = {})
|
|
339
|
+
data, _status_code, _headers = list_workflow_runs_with_http_info(id, opts)
|
|
340
|
+
data
|
|
341
|
+
end
|
|
342
|
+
|
|
343
|
+
# List workflow runs
|
|
344
|
+
# @param id [String]
|
|
345
|
+
# @param [Hash] opts the optional parameters
|
|
346
|
+
# @option opts [Integer] :page (default to 1)
|
|
347
|
+
# @option opts [Integer] :limit (default to 25)
|
|
348
|
+
# @return [Array<(ListWorkflowRuns200Response, Integer, Hash)>] ListWorkflowRuns200Response data, response status code and response headers
|
|
349
|
+
def list_workflow_runs_with_http_info(id, opts = {})
|
|
350
|
+
if @api_client.config.debugging
|
|
351
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.list_workflow_runs ...'
|
|
352
|
+
end
|
|
353
|
+
# verify the required parameter 'id' is set
|
|
354
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
355
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WorkflowsApi.list_workflow_runs"
|
|
356
|
+
end
|
|
357
|
+
# resource path
|
|
358
|
+
local_var_path = '/v1/workflows/{id}/runs'.sub('{id}', CGI.escape(id.to_s))
|
|
359
|
+
|
|
360
|
+
# query parameters
|
|
361
|
+
query_params = opts[:query_params] || {}
|
|
362
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
363
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
364
|
+
|
|
365
|
+
# header parameters
|
|
366
|
+
header_params = opts[:header_params] || {}
|
|
367
|
+
# HTTP header 'Accept' (if needed)
|
|
368
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
369
|
+
|
|
370
|
+
# form parameters
|
|
371
|
+
form_params = opts[:form_params] || {}
|
|
372
|
+
|
|
373
|
+
# http body (model)
|
|
374
|
+
post_body = opts[:debug_body]
|
|
375
|
+
|
|
376
|
+
# return_type
|
|
377
|
+
return_type = opts[:debug_return_type] || 'ListWorkflowRuns200Response'
|
|
378
|
+
|
|
379
|
+
# auth_names
|
|
380
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
381
|
+
|
|
382
|
+
new_options = opts.merge(
|
|
383
|
+
:operation => :"WorkflowsApi.list_workflow_runs",
|
|
384
|
+
:header_params => header_params,
|
|
385
|
+
:query_params => query_params,
|
|
386
|
+
:form_params => form_params,
|
|
387
|
+
:body => post_body,
|
|
388
|
+
:auth_names => auth_names,
|
|
389
|
+
:return_type => return_type
|
|
390
|
+
)
|
|
391
|
+
|
|
392
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
393
|
+
if @api_client.config.debugging
|
|
394
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#list_workflow_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
395
|
+
end
|
|
396
|
+
return data, status_code, headers
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
# List available workflow step types
|
|
400
|
+
# @param [Hash] opts the optional parameters
|
|
401
|
+
# @return [ListWorkflowStepTypes200Response]
|
|
402
|
+
def list_workflow_step_types(opts = {})
|
|
403
|
+
data, _status_code, _headers = list_workflow_step_types_with_http_info(opts)
|
|
404
|
+
data
|
|
405
|
+
end
|
|
406
|
+
|
|
407
|
+
# List available workflow step types
|
|
408
|
+
# @param [Hash] opts the optional parameters
|
|
409
|
+
# @return [Array<(ListWorkflowStepTypes200Response, Integer, Hash)>] ListWorkflowStepTypes200Response data, response status code and response headers
|
|
410
|
+
def list_workflow_step_types_with_http_info(opts = {})
|
|
411
|
+
if @api_client.config.debugging
|
|
412
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.list_workflow_step_types ...'
|
|
413
|
+
end
|
|
414
|
+
# resource path
|
|
415
|
+
local_var_path = '/v1/workflows/step-types'
|
|
416
|
+
|
|
417
|
+
# query parameters
|
|
418
|
+
query_params = opts[:query_params] || {}
|
|
419
|
+
|
|
420
|
+
# header parameters
|
|
421
|
+
header_params = opts[:header_params] || {}
|
|
422
|
+
# HTTP header 'Accept' (if needed)
|
|
423
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
424
|
+
|
|
425
|
+
# form parameters
|
|
426
|
+
form_params = opts[:form_params] || {}
|
|
427
|
+
|
|
428
|
+
# http body (model)
|
|
429
|
+
post_body = opts[:debug_body]
|
|
430
|
+
|
|
431
|
+
# return_type
|
|
432
|
+
return_type = opts[:debug_return_type] || 'ListWorkflowStepTypes200Response'
|
|
433
|
+
|
|
434
|
+
# auth_names
|
|
435
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
436
|
+
|
|
437
|
+
new_options = opts.merge(
|
|
438
|
+
:operation => :"WorkflowsApi.list_workflow_step_types",
|
|
439
|
+
:header_params => header_params,
|
|
440
|
+
:query_params => query_params,
|
|
441
|
+
:form_params => form_params,
|
|
442
|
+
:body => post_body,
|
|
443
|
+
:auth_names => auth_names,
|
|
444
|
+
:return_type => return_type
|
|
445
|
+
)
|
|
446
|
+
|
|
447
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
448
|
+
if @api_client.config.debugging
|
|
449
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#list_workflow_step_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
450
|
+
end
|
|
451
|
+
return data, status_code, headers
|
|
452
|
+
end
|
|
453
|
+
|
|
454
|
+
# List workflows
|
|
455
|
+
# @param [Hash] opts the optional parameters
|
|
456
|
+
# @option opts [Integer] :page (default to 1)
|
|
457
|
+
# @option opts [Integer] :limit (default to 25)
|
|
458
|
+
# @return [ListWorkflows200Response]
|
|
459
|
+
def list_workflows(opts = {})
|
|
460
|
+
data, _status_code, _headers = list_workflows_with_http_info(opts)
|
|
461
|
+
data
|
|
462
|
+
end
|
|
463
|
+
|
|
464
|
+
# List workflows
|
|
465
|
+
# @param [Hash] opts the optional parameters
|
|
466
|
+
# @option opts [Integer] :page (default to 1)
|
|
467
|
+
# @option opts [Integer] :limit (default to 25)
|
|
468
|
+
# @return [Array<(ListWorkflows200Response, Integer, Hash)>] ListWorkflows200Response data, response status code and response headers
|
|
469
|
+
def list_workflows_with_http_info(opts = {})
|
|
470
|
+
if @api_client.config.debugging
|
|
471
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.list_workflows ...'
|
|
472
|
+
end
|
|
473
|
+
# resource path
|
|
474
|
+
local_var_path = '/v1/workflows'
|
|
475
|
+
|
|
476
|
+
# query parameters
|
|
477
|
+
query_params = opts[:query_params] || {}
|
|
478
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
479
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
480
|
+
|
|
481
|
+
# header parameters
|
|
482
|
+
header_params = opts[:header_params] || {}
|
|
483
|
+
# HTTP header 'Accept' (if needed)
|
|
484
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
485
|
+
|
|
486
|
+
# form parameters
|
|
487
|
+
form_params = opts[:form_params] || {}
|
|
488
|
+
|
|
489
|
+
# http body (model)
|
|
490
|
+
post_body = opts[:debug_body]
|
|
491
|
+
|
|
492
|
+
# return_type
|
|
493
|
+
return_type = opts[:debug_return_type] || 'ListWorkflows200Response'
|
|
494
|
+
|
|
495
|
+
# auth_names
|
|
496
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
497
|
+
|
|
498
|
+
new_options = opts.merge(
|
|
499
|
+
:operation => :"WorkflowsApi.list_workflows",
|
|
500
|
+
:header_params => header_params,
|
|
501
|
+
:query_params => query_params,
|
|
502
|
+
:form_params => form_params,
|
|
503
|
+
:body => post_body,
|
|
504
|
+
:auth_names => auth_names,
|
|
505
|
+
:return_type => return_type
|
|
506
|
+
)
|
|
507
|
+
|
|
508
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
509
|
+
if @api_client.config.debugging
|
|
510
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#list_workflows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
511
|
+
end
|
|
512
|
+
return data, status_code, headers
|
|
513
|
+
end
|
|
514
|
+
|
|
515
|
+
# Retry a workflow run
|
|
516
|
+
# @param run_id [String]
|
|
517
|
+
# @param [Hash] opts the optional parameters
|
|
518
|
+
# @return [RunWorkflow202Response]
|
|
519
|
+
def retry_workflow_run(run_id, opts = {})
|
|
520
|
+
data, _status_code, _headers = retry_workflow_run_with_http_info(run_id, opts)
|
|
521
|
+
data
|
|
522
|
+
end
|
|
523
|
+
|
|
524
|
+
# Retry a workflow run
|
|
525
|
+
# @param run_id [String]
|
|
526
|
+
# @param [Hash] opts the optional parameters
|
|
527
|
+
# @return [Array<(RunWorkflow202Response, Integer, Hash)>] RunWorkflow202Response data, response status code and response headers
|
|
528
|
+
def retry_workflow_run_with_http_info(run_id, opts = {})
|
|
529
|
+
if @api_client.config.debugging
|
|
530
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.retry_workflow_run ...'
|
|
531
|
+
end
|
|
532
|
+
# verify the required parameter 'run_id' is set
|
|
533
|
+
if @api_client.config.client_side_validation && run_id.nil?
|
|
534
|
+
fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkflowsApi.retry_workflow_run"
|
|
535
|
+
end
|
|
536
|
+
# resource path
|
|
537
|
+
local_var_path = '/v1/workflows/runs/{runId}/retry'.sub('{runId}', CGI.escape(run_id.to_s))
|
|
538
|
+
|
|
539
|
+
# query parameters
|
|
540
|
+
query_params = opts[:query_params] || {}
|
|
541
|
+
|
|
542
|
+
# header parameters
|
|
543
|
+
header_params = opts[:header_params] || {}
|
|
544
|
+
# HTTP header 'Accept' (if needed)
|
|
545
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
546
|
+
|
|
547
|
+
# form parameters
|
|
548
|
+
form_params = opts[:form_params] || {}
|
|
549
|
+
|
|
550
|
+
# http body (model)
|
|
551
|
+
post_body = opts[:debug_body]
|
|
552
|
+
|
|
553
|
+
# return_type
|
|
554
|
+
return_type = opts[:debug_return_type] || 'RunWorkflow202Response'
|
|
555
|
+
|
|
556
|
+
# auth_names
|
|
557
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
558
|
+
|
|
559
|
+
new_options = opts.merge(
|
|
560
|
+
:operation => :"WorkflowsApi.retry_workflow_run",
|
|
561
|
+
:header_params => header_params,
|
|
562
|
+
:query_params => query_params,
|
|
563
|
+
:form_params => form_params,
|
|
564
|
+
:body => post_body,
|
|
565
|
+
:auth_names => auth_names,
|
|
566
|
+
:return_type => return_type
|
|
567
|
+
)
|
|
568
|
+
|
|
569
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
570
|
+
if @api_client.config.debugging
|
|
571
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#retry_workflow_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
572
|
+
end
|
|
573
|
+
return data, status_code, headers
|
|
574
|
+
end
|
|
575
|
+
|
|
576
|
+
# Retry a workflow step
|
|
577
|
+
# @param run_id [String]
|
|
578
|
+
# @param step_id [String]
|
|
579
|
+
# @param [Hash] opts the optional parameters
|
|
580
|
+
# @return [UploadAsset200Response]
|
|
581
|
+
def retry_workflow_step(run_id, step_id, opts = {})
|
|
582
|
+
data, _status_code, _headers = retry_workflow_step_with_http_info(run_id, step_id, opts)
|
|
583
|
+
data
|
|
584
|
+
end
|
|
585
|
+
|
|
586
|
+
# Retry a workflow step
|
|
587
|
+
# @param run_id [String]
|
|
588
|
+
# @param step_id [String]
|
|
589
|
+
# @param [Hash] opts the optional parameters
|
|
590
|
+
# @return [Array<(UploadAsset200Response, Integer, Hash)>] UploadAsset200Response data, response status code and response headers
|
|
591
|
+
def retry_workflow_step_with_http_info(run_id, step_id, opts = {})
|
|
592
|
+
if @api_client.config.debugging
|
|
593
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.retry_workflow_step ...'
|
|
594
|
+
end
|
|
595
|
+
# verify the required parameter 'run_id' is set
|
|
596
|
+
if @api_client.config.client_side_validation && run_id.nil?
|
|
597
|
+
fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkflowsApi.retry_workflow_step"
|
|
598
|
+
end
|
|
599
|
+
# verify the required parameter 'step_id' is set
|
|
600
|
+
if @api_client.config.client_side_validation && step_id.nil?
|
|
601
|
+
fail ArgumentError, "Missing the required parameter 'step_id' when calling WorkflowsApi.retry_workflow_step"
|
|
602
|
+
end
|
|
603
|
+
# resource path
|
|
604
|
+
local_var_path = '/v1/workflows/runs/{runId}/steps/{stepId}/retry'.sub('{runId}', CGI.escape(run_id.to_s)).sub('{stepId}', CGI.escape(step_id.to_s))
|
|
605
|
+
|
|
606
|
+
# query parameters
|
|
607
|
+
query_params = opts[:query_params] || {}
|
|
608
|
+
|
|
609
|
+
# header parameters
|
|
610
|
+
header_params = opts[:header_params] || {}
|
|
611
|
+
# HTTP header 'Accept' (if needed)
|
|
612
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
613
|
+
|
|
614
|
+
# form parameters
|
|
615
|
+
form_params = opts[:form_params] || {}
|
|
616
|
+
|
|
617
|
+
# http body (model)
|
|
618
|
+
post_body = opts[:debug_body]
|
|
619
|
+
|
|
620
|
+
# return_type
|
|
621
|
+
return_type = opts[:debug_return_type] || 'UploadAsset200Response'
|
|
622
|
+
|
|
623
|
+
# auth_names
|
|
624
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
625
|
+
|
|
626
|
+
new_options = opts.merge(
|
|
627
|
+
:operation => :"WorkflowsApi.retry_workflow_step",
|
|
628
|
+
:header_params => header_params,
|
|
629
|
+
:query_params => query_params,
|
|
630
|
+
:form_params => form_params,
|
|
631
|
+
:body => post_body,
|
|
632
|
+
:auth_names => auth_names,
|
|
633
|
+
:return_type => return_type
|
|
634
|
+
)
|
|
635
|
+
|
|
636
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
637
|
+
if @api_client.config.debugging
|
|
638
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#retry_workflow_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
639
|
+
end
|
|
640
|
+
return data, status_code, headers
|
|
641
|
+
end
|
|
642
|
+
|
|
643
|
+
# Run a workflow
|
|
644
|
+
# @param id [String]
|
|
645
|
+
# @param run_workflow_request [RunWorkflowRequest]
|
|
646
|
+
# @param [Hash] opts the optional parameters
|
|
647
|
+
# @return [RunWorkflow202Response]
|
|
648
|
+
def run_workflow(id, run_workflow_request, opts = {})
|
|
649
|
+
data, _status_code, _headers = run_workflow_with_http_info(id, run_workflow_request, opts)
|
|
650
|
+
data
|
|
651
|
+
end
|
|
652
|
+
|
|
653
|
+
# Run a workflow
|
|
654
|
+
# @param id [String]
|
|
655
|
+
# @param run_workflow_request [RunWorkflowRequest]
|
|
656
|
+
# @param [Hash] opts the optional parameters
|
|
657
|
+
# @return [Array<(RunWorkflow202Response, Integer, Hash)>] RunWorkflow202Response data, response status code and response headers
|
|
658
|
+
def run_workflow_with_http_info(id, run_workflow_request, opts = {})
|
|
659
|
+
if @api_client.config.debugging
|
|
660
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.run_workflow ...'
|
|
661
|
+
end
|
|
662
|
+
# verify the required parameter 'id' is set
|
|
663
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
664
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WorkflowsApi.run_workflow"
|
|
665
|
+
end
|
|
666
|
+
# verify the required parameter 'run_workflow_request' is set
|
|
667
|
+
if @api_client.config.client_side_validation && run_workflow_request.nil?
|
|
668
|
+
fail ArgumentError, "Missing the required parameter 'run_workflow_request' when calling WorkflowsApi.run_workflow"
|
|
669
|
+
end
|
|
670
|
+
# resource path
|
|
671
|
+
local_var_path = '/v1/workflows/{id}/run'.sub('{id}', CGI.escape(id.to_s))
|
|
672
|
+
|
|
673
|
+
# query parameters
|
|
674
|
+
query_params = opts[:query_params] || {}
|
|
675
|
+
|
|
676
|
+
# header parameters
|
|
677
|
+
header_params = opts[:header_params] || {}
|
|
678
|
+
# HTTP header 'Accept' (if needed)
|
|
679
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
680
|
+
# HTTP header 'Content-Type'
|
|
681
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
682
|
+
if !content_type.nil?
|
|
683
|
+
header_params['Content-Type'] = content_type
|
|
684
|
+
end
|
|
685
|
+
|
|
686
|
+
# form parameters
|
|
687
|
+
form_params = opts[:form_params] || {}
|
|
688
|
+
|
|
689
|
+
# http body (model)
|
|
690
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(run_workflow_request)
|
|
691
|
+
|
|
692
|
+
# return_type
|
|
693
|
+
return_type = opts[:debug_return_type] || 'RunWorkflow202Response'
|
|
694
|
+
|
|
695
|
+
# auth_names
|
|
696
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
697
|
+
|
|
698
|
+
new_options = opts.merge(
|
|
699
|
+
:operation => :"WorkflowsApi.run_workflow",
|
|
700
|
+
:header_params => header_params,
|
|
701
|
+
:query_params => query_params,
|
|
702
|
+
:form_params => form_params,
|
|
703
|
+
:body => post_body,
|
|
704
|
+
:auth_names => auth_names,
|
|
705
|
+
:return_type => return_type
|
|
706
|
+
)
|
|
707
|
+
|
|
708
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
709
|
+
if @api_client.config.debugging
|
|
710
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#run_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
711
|
+
end
|
|
712
|
+
return data, status_code, headers
|
|
713
|
+
end
|
|
714
|
+
|
|
715
|
+
# Skip a workflow step
|
|
716
|
+
# @param run_id [String]
|
|
717
|
+
# @param step_id [String]
|
|
718
|
+
# @param [Hash] opts the optional parameters
|
|
719
|
+
# @return [UploadAsset200Response]
|
|
720
|
+
def skip_workflow_step(run_id, step_id, opts = {})
|
|
721
|
+
data, _status_code, _headers = skip_workflow_step_with_http_info(run_id, step_id, opts)
|
|
722
|
+
data
|
|
723
|
+
end
|
|
724
|
+
|
|
725
|
+
# Skip a workflow step
|
|
726
|
+
# @param run_id [String]
|
|
727
|
+
# @param step_id [String]
|
|
728
|
+
# @param [Hash] opts the optional parameters
|
|
729
|
+
# @return [Array<(UploadAsset200Response, Integer, Hash)>] UploadAsset200Response data, response status code and response headers
|
|
730
|
+
def skip_workflow_step_with_http_info(run_id, step_id, opts = {})
|
|
731
|
+
if @api_client.config.debugging
|
|
732
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.skip_workflow_step ...'
|
|
733
|
+
end
|
|
734
|
+
# verify the required parameter 'run_id' is set
|
|
735
|
+
if @api_client.config.client_side_validation && run_id.nil?
|
|
736
|
+
fail ArgumentError, "Missing the required parameter 'run_id' when calling WorkflowsApi.skip_workflow_step"
|
|
737
|
+
end
|
|
738
|
+
# verify the required parameter 'step_id' is set
|
|
739
|
+
if @api_client.config.client_side_validation && step_id.nil?
|
|
740
|
+
fail ArgumentError, "Missing the required parameter 'step_id' when calling WorkflowsApi.skip_workflow_step"
|
|
741
|
+
end
|
|
742
|
+
# resource path
|
|
743
|
+
local_var_path = '/v1/workflows/runs/{runId}/steps/{stepId}/skip'.sub('{runId}', CGI.escape(run_id.to_s)).sub('{stepId}', CGI.escape(step_id.to_s))
|
|
744
|
+
|
|
745
|
+
# query parameters
|
|
746
|
+
query_params = opts[:query_params] || {}
|
|
747
|
+
|
|
748
|
+
# header parameters
|
|
749
|
+
header_params = opts[:header_params] || {}
|
|
750
|
+
# HTTP header 'Accept' (if needed)
|
|
751
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
752
|
+
|
|
753
|
+
# form parameters
|
|
754
|
+
form_params = opts[:form_params] || {}
|
|
755
|
+
|
|
756
|
+
# http body (model)
|
|
757
|
+
post_body = opts[:debug_body]
|
|
758
|
+
|
|
759
|
+
# return_type
|
|
760
|
+
return_type = opts[:debug_return_type] || 'UploadAsset200Response'
|
|
761
|
+
|
|
762
|
+
# auth_names
|
|
763
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
764
|
+
|
|
765
|
+
new_options = opts.merge(
|
|
766
|
+
:operation => :"WorkflowsApi.skip_workflow_step",
|
|
767
|
+
:header_params => header_params,
|
|
768
|
+
:query_params => query_params,
|
|
769
|
+
:form_params => form_params,
|
|
770
|
+
:body => post_body,
|
|
771
|
+
:auth_names => auth_names,
|
|
772
|
+
:return_type => return_type
|
|
773
|
+
)
|
|
774
|
+
|
|
775
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
776
|
+
if @api_client.config.debugging
|
|
777
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#skip_workflow_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
778
|
+
end
|
|
779
|
+
return data, status_code, headers
|
|
780
|
+
end
|
|
781
|
+
|
|
782
|
+
# Update a workflow
|
|
783
|
+
# @param id [String]
|
|
784
|
+
# @param update_workflow_request [UpdateWorkflowRequest]
|
|
785
|
+
# @param [Hash] opts the optional parameters
|
|
786
|
+
# @return [CreateWorkflow201Response]
|
|
787
|
+
def update_workflow(id, update_workflow_request, opts = {})
|
|
788
|
+
data, _status_code, _headers = update_workflow_with_http_info(id, update_workflow_request, opts)
|
|
789
|
+
data
|
|
790
|
+
end
|
|
791
|
+
|
|
792
|
+
# Update a workflow
|
|
793
|
+
# @param id [String]
|
|
794
|
+
# @param update_workflow_request [UpdateWorkflowRequest]
|
|
795
|
+
# @param [Hash] opts the optional parameters
|
|
796
|
+
# @return [Array<(CreateWorkflow201Response, Integer, Hash)>] CreateWorkflow201Response data, response status code and response headers
|
|
797
|
+
def update_workflow_with_http_info(id, update_workflow_request, opts = {})
|
|
798
|
+
if @api_client.config.debugging
|
|
799
|
+
@api_client.config.logger.debug 'Calling API: WorkflowsApi.update_workflow ...'
|
|
800
|
+
end
|
|
801
|
+
# verify the required parameter 'id' is set
|
|
802
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
803
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WorkflowsApi.update_workflow"
|
|
804
|
+
end
|
|
805
|
+
# verify the required parameter 'update_workflow_request' is set
|
|
806
|
+
if @api_client.config.client_side_validation && update_workflow_request.nil?
|
|
807
|
+
fail ArgumentError, "Missing the required parameter 'update_workflow_request' when calling WorkflowsApi.update_workflow"
|
|
808
|
+
end
|
|
809
|
+
# resource path
|
|
810
|
+
local_var_path = '/v1/workflows/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
811
|
+
|
|
812
|
+
# query parameters
|
|
813
|
+
query_params = opts[:query_params] || {}
|
|
814
|
+
|
|
815
|
+
# header parameters
|
|
816
|
+
header_params = opts[:header_params] || {}
|
|
817
|
+
# HTTP header 'Accept' (if needed)
|
|
818
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
819
|
+
# HTTP header 'Content-Type'
|
|
820
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
821
|
+
if !content_type.nil?
|
|
822
|
+
header_params['Content-Type'] = content_type
|
|
823
|
+
end
|
|
824
|
+
|
|
825
|
+
# form parameters
|
|
826
|
+
form_params = opts[:form_params] || {}
|
|
827
|
+
|
|
828
|
+
# http body (model)
|
|
829
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_workflow_request)
|
|
830
|
+
|
|
831
|
+
# return_type
|
|
832
|
+
return_type = opts[:debug_return_type] || 'CreateWorkflow201Response'
|
|
833
|
+
|
|
834
|
+
# auth_names
|
|
835
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
836
|
+
|
|
837
|
+
new_options = opts.merge(
|
|
838
|
+
:operation => :"WorkflowsApi.update_workflow",
|
|
839
|
+
:header_params => header_params,
|
|
840
|
+
:query_params => query_params,
|
|
841
|
+
:form_params => form_params,
|
|
842
|
+
:body => post_body,
|
|
843
|
+
:auth_names => auth_names,
|
|
844
|
+
:return_type => return_type
|
|
845
|
+
)
|
|
846
|
+
|
|
847
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
848
|
+
if @api_client.config.debugging
|
|
849
|
+
@api_client.config.logger.debug "API called: WorkflowsApi#update_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
850
|
+
end
|
|
851
|
+
return data, status_code, headers
|
|
852
|
+
end
|
|
853
|
+
end
|
|
854
|
+
end
|