docraptor 2.0.0 → 3.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 +4 -4
- data/.docker_env.list +3 -0
- data/.generator-language-identifier +1 -0
- data/.generator-revision +1 -0
- data/.github/pull_request_template.txt +17 -0
- data/.gitignore +20 -14
- data/.gitlab-ci.yml +26 -0
- data/.openapi-generator/FILES +27 -0
- data/.openapi-generator/VERSION +1 -0
- data/{.swagger-codegen-ignore → .openapi-generator-ignore} +23 -7
- data/.review/README.md +16 -0
- data/.review/generated_files/.gitignore +39 -0
- data/.review/generated_files/README.md +107 -0
- data/.rubocop.yml +148 -0
- data/.runtime-environments +10 -0
- data/.travis.yml +12 -7
- data/CHANGELOG.md +5 -0
- data/Gemfile +3 -1
- data/README.md +8 -8
- data/Rakefile +1 -2
- data/docraptor.gemspec +5 -19
- data/docraptor.yaml +5 -4
- data/examples/async.rb +24 -30
- data/examples/hosted_async.rb +21 -33
- data/examples/hosted_sync.rb +19 -32
- data/examples/sync.rb +20 -26
- data/gemfiles/Gemfile.2.5.lock +70 -0
- data/gemfiles/Gemfile.2.6.lock +70 -0
- data/gemfiles/Gemfile.2.7.lock +70 -0
- data/gemfiles/Gemfile.3.0.lock +70 -0
- data/{swagger-config.json → generator-config.json} +3 -2
- data/lib/docraptor/api/doc_api.rb +154 -79
- data/lib/docraptor/api_client.rb +91 -90
- data/lib/docraptor/api_error.rb +22 -3
- data/lib/docraptor/configuration.rb +85 -15
- data/lib/docraptor/models/async_doc.rb +53 -18
- data/lib/docraptor/models/doc.rb +80 -45
- data/lib/docraptor/models/doc_status.rb +58 -23
- data/lib/docraptor/models/prince_options.rb +101 -66
- data/lib/docraptor/version.rb +4 -4
- data/lib/docraptor.rb +3 -3
- data/script/clean +2 -2
- data/script/console +5 -0
- data/script/docker +39 -0
- data/script/fix_gemspec.rb +3 -18
- data/script/generate_language +21 -4
- data/script/inside_container/README.md +6 -0
- data/script/inside_container/test +38 -0
- data/script/post_generate_language +10 -2
- data/script/setup +25 -14
- data/script/swagger +6 -33
- data/script/test +30 -27
- data/test/async.rb +2 -2
- data/test/expire_hosted.rb +2 -2
- data/test/hosted_async.rb +7 -1
- data/test/hosted_sync.rb +2 -2
- data/test/sync.rb +2 -2
- data/test/xlsx.rb +6 -3
- metadata +29 -217
- data/.swagger-codegen/VERSION +0 -1
- data/.swagger-revision +0 -1
- data/spec/api_client_spec.rb +0 -243
- data/spec/configuration_spec.rb +0 -42
- data/spec/spec_helper.rb +0 -111
@@ -3,14 +3,14 @@
|
|
3
3
|
|
4
4
|
#A native client library for the DocRaptor HTML to PDF/XLS service.
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.1.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
|
-
require '
|
13
|
+
require 'cgi'
|
14
14
|
|
15
15
|
module DocRaptor
|
16
16
|
class DocApi
|
@@ -20,7 +20,7 @@ module DocRaptor
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Creates a document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document.
|
23
|
-
# @param doc The document to be created.
|
23
|
+
# @param doc [Doc] The document to be created.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
25
|
# @return [AsyncDoc]
|
26
26
|
def create_async_doc(doc, opts = {})
|
@@ -29,9 +29,9 @@ module DocRaptor
|
|
29
29
|
end
|
30
30
|
|
31
31
|
# Creates a document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document.
|
32
|
-
# @param doc The document to be created.
|
32
|
+
# @param doc [Doc] The document to be created.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
|
-
# @return [Array<(AsyncDoc,
|
34
|
+
# @return [Array<(AsyncDoc, Integer, Hash)>] AsyncDoc data, response status code and response headers
|
35
35
|
def create_async_doc_with_http_info(doc, opts = {})
|
36
36
|
if @api_client.config.debugging
|
37
37
|
@api_client.config.logger.debug 'Calling API: DocApi.create_async_doc ...'
|
@@ -44,33 +44,44 @@ module DocRaptor
|
|
44
44
|
local_var_path = '/async_docs'
|
45
45
|
|
46
46
|
# query parameters
|
47
|
-
query_params = {}
|
47
|
+
query_params = opts[:query_params] || {}
|
48
48
|
|
49
49
|
# header parameters
|
50
|
-
header_params = {}
|
50
|
+
header_params = opts[:header_params] || {}
|
51
51
|
# HTTP header 'Accept' (if needed)
|
52
52
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
|
53
53
|
|
54
54
|
# form parameters
|
55
|
-
form_params = {}
|
55
|
+
form_params = opts[:form_params] || {}
|
56
56
|
|
57
57
|
# http body (model)
|
58
|
-
post_body = @api_client.object_to_http_body(doc)
|
59
|
-
|
60
|
-
|
58
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)
|
59
|
+
|
60
|
+
# return_type
|
61
|
+
return_type = opts[:debug_return_type] || 'AsyncDoc'
|
62
|
+
|
63
|
+
# auth_names
|
64
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
65
|
+
|
66
|
+
new_options = opts.merge(
|
67
|
+
:operation => :"DocApi.create_async_doc",
|
61
68
|
:header_params => header_params,
|
62
69
|
:query_params => query_params,
|
63
70
|
:form_params => form_params,
|
64
71
|
:body => post_body,
|
65
72
|
:auth_names => auth_names,
|
66
|
-
:return_type =>
|
73
|
+
:return_type => return_type
|
74
|
+
)
|
75
|
+
|
76
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
67
77
|
if @api_client.config.debugging
|
68
78
|
@api_client.config.logger.debug "API called: DocApi#create_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
69
79
|
end
|
70
80
|
return data, status_code, headers
|
71
81
|
end
|
82
|
+
|
72
83
|
# Creates a document synchronously.
|
73
|
-
# @param doc The document to be created.
|
84
|
+
# @param doc [Doc] The document to be created.
|
74
85
|
# @param [Hash] opts the optional parameters
|
75
86
|
# @return [String]
|
76
87
|
def create_doc(doc, opts = {})
|
@@ -79,9 +90,9 @@ module DocRaptor
|
|
79
90
|
end
|
80
91
|
|
81
92
|
# Creates a document synchronously.
|
82
|
-
# @param doc The document to be created.
|
93
|
+
# @param doc [Doc] The document to be created.
|
83
94
|
# @param [Hash] opts the optional parameters
|
84
|
-
# @return [Array<(String,
|
95
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
85
96
|
def create_doc_with_http_info(doc, opts = {})
|
86
97
|
if @api_client.config.debugging
|
87
98
|
@api_client.config.logger.debug 'Calling API: DocApi.create_doc ...'
|
@@ -94,33 +105,44 @@ module DocRaptor
|
|
94
105
|
local_var_path = '/docs'
|
95
106
|
|
96
107
|
# query parameters
|
97
|
-
query_params = {}
|
108
|
+
query_params = opts[:query_params] || {}
|
98
109
|
|
99
110
|
# header parameters
|
100
|
-
header_params = {}
|
111
|
+
header_params = opts[:header_params] || {}
|
101
112
|
# HTTP header 'Accept' (if needed)
|
102
113
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
|
103
114
|
|
104
115
|
# form parameters
|
105
|
-
form_params = {}
|
116
|
+
form_params = opts[:form_params] || {}
|
106
117
|
|
107
118
|
# http body (model)
|
108
|
-
post_body = @api_client.object_to_http_body(doc)
|
109
|
-
|
110
|
-
|
119
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)
|
120
|
+
|
121
|
+
# return_type
|
122
|
+
return_type = opts[:debug_return_type] || 'String'
|
123
|
+
|
124
|
+
# auth_names
|
125
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
126
|
+
|
127
|
+
new_options = opts.merge(
|
128
|
+
:operation => :"DocApi.create_doc",
|
111
129
|
:header_params => header_params,
|
112
130
|
:query_params => query_params,
|
113
131
|
:form_params => form_params,
|
114
132
|
:body => post_body,
|
115
133
|
:auth_names => auth_names,
|
116
|
-
:return_type =>
|
134
|
+
:return_type => return_type
|
135
|
+
)
|
136
|
+
|
137
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
117
138
|
if @api_client.config.debugging
|
118
139
|
@api_client.config.logger.debug "API called: DocApi#create_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
119
140
|
end
|
120
141
|
return data, status_code, headers
|
121
142
|
end
|
143
|
+
|
122
144
|
# Creates a hosted document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document.
|
123
|
-
# @param doc The document to be created.
|
145
|
+
# @param doc [Doc] The document to be created.
|
124
146
|
# @param [Hash] opts the optional parameters
|
125
147
|
# @return [AsyncDoc]
|
126
148
|
def create_hosted_async_doc(doc, opts = {})
|
@@ -129,9 +151,9 @@ module DocRaptor
|
|
129
151
|
end
|
130
152
|
|
131
153
|
# Creates a hosted document asynchronously. You must use a callback url or the returned status id and the status API to find out when it completes. Then use the download API to get the document.
|
132
|
-
# @param doc The document to be created.
|
154
|
+
# @param doc [Doc] The document to be created.
|
133
155
|
# @param [Hash] opts the optional parameters
|
134
|
-
# @return [Array<(AsyncDoc,
|
156
|
+
# @return [Array<(AsyncDoc, Integer, Hash)>] AsyncDoc data, response status code and response headers
|
135
157
|
def create_hosted_async_doc_with_http_info(doc, opts = {})
|
136
158
|
if @api_client.config.debugging
|
137
159
|
@api_client.config.logger.debug 'Calling API: DocApi.create_hosted_async_doc ...'
|
@@ -144,33 +166,44 @@ module DocRaptor
|
|
144
166
|
local_var_path = '/hosted_async_docs'
|
145
167
|
|
146
168
|
# query parameters
|
147
|
-
query_params = {}
|
169
|
+
query_params = opts[:query_params] || {}
|
148
170
|
|
149
171
|
# header parameters
|
150
|
-
header_params = {}
|
172
|
+
header_params = opts[:header_params] || {}
|
151
173
|
# HTTP header 'Accept' (if needed)
|
152
174
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
|
153
175
|
|
154
176
|
# form parameters
|
155
|
-
form_params = {}
|
177
|
+
form_params = opts[:form_params] || {}
|
156
178
|
|
157
179
|
# http body (model)
|
158
|
-
post_body = @api_client.object_to_http_body(doc)
|
159
|
-
|
160
|
-
|
180
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)
|
181
|
+
|
182
|
+
# return_type
|
183
|
+
return_type = opts[:debug_return_type] || 'AsyncDoc'
|
184
|
+
|
185
|
+
# auth_names
|
186
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
187
|
+
|
188
|
+
new_options = opts.merge(
|
189
|
+
:operation => :"DocApi.create_hosted_async_doc",
|
161
190
|
:header_params => header_params,
|
162
191
|
:query_params => query_params,
|
163
192
|
:form_params => form_params,
|
164
193
|
:body => post_body,
|
165
194
|
:auth_names => auth_names,
|
166
|
-
:return_type =>
|
195
|
+
:return_type => return_type
|
196
|
+
)
|
197
|
+
|
198
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
167
199
|
if @api_client.config.debugging
|
168
200
|
@api_client.config.logger.debug "API called: DocApi#create_hosted_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
169
201
|
end
|
170
202
|
return data, status_code, headers
|
171
203
|
end
|
204
|
+
|
172
205
|
# Creates a hosted document synchronously.
|
173
|
-
# @param doc The document to be created.
|
206
|
+
# @param doc [Doc] The document to be created.
|
174
207
|
# @param [Hash] opts the optional parameters
|
175
208
|
# @return [DocStatus]
|
176
209
|
def create_hosted_doc(doc, opts = {})
|
@@ -179,9 +212,9 @@ module DocRaptor
|
|
179
212
|
end
|
180
213
|
|
181
214
|
# Creates a hosted document synchronously.
|
182
|
-
# @param doc The document to be created.
|
215
|
+
# @param doc [Doc] The document to be created.
|
183
216
|
# @param [Hash] opts the optional parameters
|
184
|
-
# @return [Array<(DocStatus,
|
217
|
+
# @return [Array<(DocStatus, Integer, Hash)>] DocStatus data, response status code and response headers
|
185
218
|
def create_hosted_doc_with_http_info(doc, opts = {})
|
186
219
|
if @api_client.config.debugging
|
187
220
|
@api_client.config.logger.debug 'Calling API: DocApi.create_hosted_doc ...'
|
@@ -194,33 +227,44 @@ module DocRaptor
|
|
194
227
|
local_var_path = '/hosted_docs'
|
195
228
|
|
196
229
|
# query parameters
|
197
|
-
query_params = {}
|
230
|
+
query_params = opts[:query_params] || {}
|
198
231
|
|
199
232
|
# header parameters
|
200
|
-
header_params = {}
|
233
|
+
header_params = opts[:header_params] || {}
|
201
234
|
# HTTP header 'Accept' (if needed)
|
202
235
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
|
203
236
|
|
204
237
|
# form parameters
|
205
|
-
form_params = {}
|
238
|
+
form_params = opts[:form_params] || {}
|
206
239
|
|
207
240
|
# http body (model)
|
208
|
-
post_body = @api_client.object_to_http_body(doc)
|
209
|
-
|
210
|
-
|
241
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)
|
242
|
+
|
243
|
+
# return_type
|
244
|
+
return_type = opts[:debug_return_type] || 'DocStatus'
|
245
|
+
|
246
|
+
# auth_names
|
247
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
248
|
+
|
249
|
+
new_options = opts.merge(
|
250
|
+
:operation => :"DocApi.create_hosted_doc",
|
211
251
|
:header_params => header_params,
|
212
252
|
:query_params => query_params,
|
213
253
|
:form_params => form_params,
|
214
254
|
:body => post_body,
|
215
255
|
:auth_names => auth_names,
|
216
|
-
:return_type =>
|
256
|
+
:return_type => return_type
|
257
|
+
)
|
258
|
+
|
259
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
217
260
|
if @api_client.config.debugging
|
218
261
|
@api_client.config.logger.debug "API called: DocApi#create_hosted_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
219
262
|
end
|
220
263
|
return data, status_code, headers
|
221
264
|
end
|
265
|
+
|
222
266
|
# Expires a previously created hosted doc.
|
223
|
-
# @param id The download_id returned from status request or hosted document response.
|
267
|
+
# @param id [String] The download_id returned from status request or hosted document response.
|
224
268
|
# @param [Hash] opts the optional parameters
|
225
269
|
# @return [nil]
|
226
270
|
def expire(id, opts = {})
|
@@ -229,9 +273,9 @@ module DocRaptor
|
|
229
273
|
end
|
230
274
|
|
231
275
|
# Expires a previously created hosted doc.
|
232
|
-
# @param id The download_id returned from status request or hosted document response.
|
276
|
+
# @param id [String] The download_id returned from status request or hosted document response.
|
233
277
|
# @param [Hash] opts the optional parameters
|
234
|
-
# @return [Array<(nil,
|
278
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
235
279
|
def expire_with_http_info(id, opts = {})
|
236
280
|
if @api_client.config.debugging
|
237
281
|
@api_client.config.logger.debug 'Calling API: DocApi.expire ...'
|
@@ -241,35 +285,45 @@ module DocRaptor
|
|
241
285
|
fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.expire"
|
242
286
|
end
|
243
287
|
# resource path
|
244
|
-
local_var_path = '/expire/{id}'.sub('{' + 'id' + '}', id.to_s)
|
288
|
+
local_var_path = '/expire/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
245
289
|
|
246
290
|
# query parameters
|
247
|
-
query_params = {}
|
291
|
+
query_params = opts[:query_params] || {}
|
248
292
|
|
249
293
|
# header parameters
|
250
|
-
header_params = {}
|
251
|
-
# HTTP header 'Accept' (if needed)
|
252
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
|
294
|
+
header_params = opts[:header_params] || {}
|
253
295
|
|
254
296
|
# form parameters
|
255
|
-
form_params = {}
|
297
|
+
form_params = opts[:form_params] || {}
|
256
298
|
|
257
299
|
# http body (model)
|
258
|
-
post_body =
|
259
|
-
|
260
|
-
|
300
|
+
post_body = opts[:debug_body]
|
301
|
+
|
302
|
+
# return_type
|
303
|
+
return_type = opts[:debug_return_type]
|
304
|
+
|
305
|
+
# auth_names
|
306
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
307
|
+
|
308
|
+
new_options = opts.merge(
|
309
|
+
:operation => :"DocApi.expire",
|
261
310
|
:header_params => header_params,
|
262
311
|
:query_params => query_params,
|
263
312
|
:form_params => form_params,
|
264
313
|
:body => post_body,
|
265
|
-
:auth_names => auth_names
|
314
|
+
:auth_names => auth_names,
|
315
|
+
:return_type => return_type
|
316
|
+
)
|
317
|
+
|
318
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
266
319
|
if @api_client.config.debugging
|
267
320
|
@api_client.config.logger.debug "API called: DocApi#expire\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
268
321
|
end
|
269
322
|
return data, status_code, headers
|
270
323
|
end
|
324
|
+
|
271
325
|
# Downloads a finished document.
|
272
|
-
# @param id The download_id returned from an async status request or callback.
|
326
|
+
# @param id [String] The download_id returned from an async status request or callback.
|
273
327
|
# @param [Hash] opts the optional parameters
|
274
328
|
# @return [String]
|
275
329
|
def get_async_doc(id, opts = {})
|
@@ -278,9 +332,9 @@ module DocRaptor
|
|
278
332
|
end
|
279
333
|
|
280
334
|
# Downloads a finished document.
|
281
|
-
# @param id The download_id returned from an async status request or callback.
|
335
|
+
# @param id [String] The download_id returned from an async status request or callback.
|
282
336
|
# @param [Hash] opts the optional parameters
|
283
|
-
# @return [Array<(String,
|
337
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
284
338
|
def get_async_doc_with_http_info(id, opts = {})
|
285
339
|
if @api_client.config.debugging
|
286
340
|
@api_client.config.logger.debug 'Calling API: DocApi.get_async_doc ...'
|
@@ -290,36 +344,47 @@ module DocRaptor
|
|
290
344
|
fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.get_async_doc"
|
291
345
|
end
|
292
346
|
# resource path
|
293
|
-
local_var_path = '/download/{id}'.sub('{' + 'id' + '}', id.to_s)
|
347
|
+
local_var_path = '/download/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
294
348
|
|
295
349
|
# query parameters
|
296
|
-
query_params = {}
|
350
|
+
query_params = opts[:query_params] || {}
|
297
351
|
|
298
352
|
# header parameters
|
299
|
-
header_params = {}
|
353
|
+
header_params = opts[:header_params] || {}
|
300
354
|
# HTTP header 'Accept' (if needed)
|
301
355
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
|
302
356
|
|
303
357
|
# form parameters
|
304
|
-
form_params = {}
|
358
|
+
form_params = opts[:form_params] || {}
|
305
359
|
|
306
360
|
# http body (model)
|
307
|
-
post_body =
|
308
|
-
|
309
|
-
|
361
|
+
post_body = opts[:debug_body]
|
362
|
+
|
363
|
+
# return_type
|
364
|
+
return_type = opts[:debug_return_type] || 'String'
|
365
|
+
|
366
|
+
# auth_names
|
367
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
368
|
+
|
369
|
+
new_options = opts.merge(
|
370
|
+
:operation => :"DocApi.get_async_doc",
|
310
371
|
:header_params => header_params,
|
311
372
|
:query_params => query_params,
|
312
373
|
:form_params => form_params,
|
313
374
|
:body => post_body,
|
314
375
|
:auth_names => auth_names,
|
315
|
-
:return_type =>
|
376
|
+
:return_type => return_type
|
377
|
+
)
|
378
|
+
|
379
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
316
380
|
if @api_client.config.debugging
|
317
381
|
@api_client.config.logger.debug "API called: DocApi#get_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
318
382
|
end
|
319
383
|
return data, status_code, headers
|
320
384
|
end
|
385
|
+
|
321
386
|
# Check on the status of an asynchronously created document.
|
322
|
-
# @param id The status_id returned when creating an asynchronous document.
|
387
|
+
# @param id [String] The status_id returned when creating an asynchronous document.
|
323
388
|
# @param [Hash] opts the optional parameters
|
324
389
|
# @return [DocStatus]
|
325
390
|
def get_async_doc_status(id, opts = {})
|
@@ -328,9 +393,9 @@ module DocRaptor
|
|
328
393
|
end
|
329
394
|
|
330
395
|
# Check on the status of an asynchronously created document.
|
331
|
-
# @param id The status_id returned when creating an asynchronous document.
|
396
|
+
# @param id [String] The status_id returned when creating an asynchronous document.
|
332
397
|
# @param [Hash] opts the optional parameters
|
333
|
-
# @return [Array<(DocStatus,
|
398
|
+
# @return [Array<(DocStatus, Integer, Hash)>] DocStatus data, response status code and response headers
|
334
399
|
def get_async_doc_status_with_http_info(id, opts = {})
|
335
400
|
if @api_client.config.debugging
|
336
401
|
@api_client.config.logger.debug 'Calling API: DocApi.get_async_doc_status ...'
|
@@ -340,29 +405,39 @@ module DocRaptor
|
|
340
405
|
fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.get_async_doc_status"
|
341
406
|
end
|
342
407
|
# resource path
|
343
|
-
local_var_path = '/status/{id}'.sub('{' + 'id' + '}', id.to_s)
|
408
|
+
local_var_path = '/status/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
344
409
|
|
345
410
|
# query parameters
|
346
|
-
query_params = {}
|
411
|
+
query_params = opts[:query_params] || {}
|
347
412
|
|
348
413
|
# header parameters
|
349
|
-
header_params = {}
|
414
|
+
header_params = opts[:header_params] || {}
|
350
415
|
# HTTP header 'Accept' (if needed)
|
351
416
|
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
|
352
417
|
|
353
418
|
# form parameters
|
354
|
-
form_params = {}
|
419
|
+
form_params = opts[:form_params] || {}
|
355
420
|
|
356
421
|
# http body (model)
|
357
|
-
post_body =
|
358
|
-
|
359
|
-
|
422
|
+
post_body = opts[:debug_body]
|
423
|
+
|
424
|
+
# return_type
|
425
|
+
return_type = opts[:debug_return_type] || 'DocStatus'
|
426
|
+
|
427
|
+
# auth_names
|
428
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
429
|
+
|
430
|
+
new_options = opts.merge(
|
431
|
+
:operation => :"DocApi.get_async_doc_status",
|
360
432
|
:header_params => header_params,
|
361
433
|
:query_params => query_params,
|
362
434
|
:form_params => form_params,
|
363
435
|
:body => post_body,
|
364
436
|
:auth_names => auth_names,
|
365
|
-
:return_type =>
|
437
|
+
:return_type => return_type
|
438
|
+
)
|
439
|
+
|
440
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
366
441
|
if @api_client.config.debugging
|
367
442
|
@api_client.config.logger.debug "API called: DocApi#get_async_doc_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
368
443
|
end
|