Class: DocRaptor::DocApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docraptor/api/doc_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DocApi

Returns a new instance of DocApi.



19
20
21
 
# File 'lib/docraptor/api/doc_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/docraptor/api/doc_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_async_doc(doc, opts = {}) ⇒ AsyncDoc

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.

Parameters:

  • doc (Doc) —

    The document to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/docraptor/api/doc_api.rb', line 26

def create_async_doc(doc, opts = {})
  data, _status_code, _headers = create_async_doc_with_http_info(doc, opts)
  data
end

#create_async_doc_with_http_info(doc, opts = {}) ⇒ Array<(AsyncDoc, Integer, Hash)>

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.

Parameters:

  • doc (Doc) —

    The document to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AsyncDoc, Integer, Hash)>) —

    AsyncDoc data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/docraptor/api/doc_api.rb', line 35

def create_async_doc_with_http_info(doc, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocApi.create_async_doc ...'
  end
  # verify the required parameter 'doc' is set
  if @api_client.config.client_side_validation && doc.nil?
    fail ArgumentError, "Missing the required parameter 'doc' when calling DocApi.create_async_doc"
  end
  # resource path
  local_var_path = '/async_docs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)

  # return_type
  return_type = opts[:debug_return_type] || 'AsyncDoc'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DocApi.create_async_doc",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocApi#create_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_doc(doc, opts = {}) ⇒ String

Creates a document synchronously.

Parameters:

  • doc (Doc) —

    The document to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


87
88
89
90
 
# File 'lib/docraptor/api/doc_api.rb', line 87

def create_doc(doc, opts = {})
  data, _status_code, _headers = create_doc_with_http_info(doc, opts)
  data
end

#create_doc_with_http_info(doc, opts = {}) ⇒ Array<(String, Integer, Hash)>

Creates a document synchronously.

Parameters:

  • doc (Doc) —

    The document to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/docraptor/api/doc_api.rb', line 96

def create_doc_with_http_info(doc, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocApi.create_doc ...'
  end
  # verify the required parameter 'doc' is set
  if @api_client.config.client_side_validation && doc.nil?
    fail ArgumentError, "Missing the required parameter 'doc' when calling DocApi.create_doc"
  end
  # resource path
  local_var_path = '/docs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DocApi.create_doc",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocApi#create_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_hosted_async_doc(doc, opts = {}) ⇒ AsyncDoc

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.

Parameters:

  • doc (Doc) —

    The document to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



148
149
150
151
 
# File 'lib/docraptor/api/doc_api.rb', line 148

def create_hosted_async_doc(doc, opts = {})
  data, _status_code, _headers = create_hosted_async_doc_with_http_info(doc, opts)
  data
end

#create_hosted_async_doc_with_http_info(doc, opts = {}) ⇒ Array<(AsyncDoc, Integer, Hash)>

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.

Parameters:

  • doc (Doc) —

    The document to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AsyncDoc, Integer, Hash)>) —

    AsyncDoc data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/docraptor/api/doc_api.rb', line 157

def create_hosted_async_doc_with_http_info(doc, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocApi.create_hosted_async_doc ...'
  end
  # verify the required parameter 'doc' is set
  if @api_client.config.client_side_validation && doc.nil?
    fail ArgumentError, "Missing the required parameter 'doc' when calling DocApi.create_hosted_async_doc"
  end
  # resource path
  local_var_path = '/hosted_async_docs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)

  # return_type
  return_type = opts[:debug_return_type] || 'AsyncDoc'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DocApi.create_hosted_async_doc",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocApi#create_hosted_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_hosted_doc(doc, opts = {}) ⇒ DocStatus

Creates a hosted document synchronously.

Parameters:

  • doc (Doc) —

    The document to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



209
210
211
212
 
# File 'lib/docraptor/api/doc_api.rb', line 209

def create_hosted_doc(doc, opts = {})
  data, _status_code, _headers = create_hosted_doc_with_http_info(doc, opts)
  data
end

#create_hosted_doc_with_http_info(doc, opts = {}) ⇒ Array<(DocStatus, Integer, Hash)>

Creates a hosted document synchronously.

Parameters:

  • doc (Doc) —

    The document to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DocStatus, Integer, Hash)>) —

    DocStatus data, response status code and response headers



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/docraptor/api/doc_api.rb', line 218

def create_hosted_doc_with_http_info(doc, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocApi.create_hosted_doc ...'
  end
  # verify the required parameter 'doc' is set
  if @api_client.config.client_side_validation && doc.nil?
    fail ArgumentError, "Missing the required parameter 'doc' when calling DocApi.create_hosted_doc"
  end
  # resource path
  local_var_path = '/hosted_docs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(doc)

  # return_type
  return_type = opts[:debug_return_type] || 'DocStatus'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DocApi.create_hosted_doc",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocApi#create_hosted_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expire(id, opts = {}) ⇒ nil

Expires a previously created hosted doc.

Parameters:

  • id (String) —

    The download_id returned from status request or hosted document response.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


270
271
272
273
 
# File 'lib/docraptor/api/doc_api.rb', line 270

def expire(id, opts = {})
  expire_with_http_info(id, opts)
  nil
end

#expire_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Expires a previously created hosted doc.

Parameters:

  • id (String) —

    The download_id returned from status request or hosted document response.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/docraptor/api/doc_api.rb', line 279

def expire_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocApi.expire ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.expire"
  end
  # resource path
  local_var_path = '/expire/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DocApi.expire",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocApi#expire\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_async_doc(id, opts = {}) ⇒ String

Downloads a finished document.

Parameters:

  • id (String) —

    The download_id returned from an async status request or callback.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


329
330
331
332
 
# File 'lib/docraptor/api/doc_api.rb', line 329

def get_async_doc(id, opts = {})
  data, _status_code, _headers = get_async_doc_with_http_info(id, opts)
  data
end

#get_async_doc_status(id, opts = {}) ⇒ DocStatus

Check on the status of an asynchronously created document.

Parameters:

  • id (String) —

    The status_id returned when creating an asynchronous document.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



390
391
392
393
 
# File 'lib/docraptor/api/doc_api.rb', line 390

def get_async_doc_status(id, opts = {})
  data, _status_code, _headers = get_async_doc_status_with_http_info(id, opts)
  data
end

#get_async_doc_status_with_http_info(id, opts = {}) ⇒ Array<(DocStatus, Integer, Hash)>

Check on the status of an asynchronously created document.

Parameters:

  • id (String) —

    The status_id returned when creating an asynchronous document.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DocStatus, Integer, Hash)>) —

    DocStatus data, response status code and response headers



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/docraptor/api/doc_api.rb', line 399

def get_async_doc_status_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocApi.get_async_doc_status ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.get_async_doc_status"
  end
  # resource path
  local_var_path = '/status/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DocStatus'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DocApi.get_async_doc_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocApi#get_async_doc_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_async_doc_with_http_info(id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Downloads a finished document.

Parameters:

  • id (String) —

    The download_id returned from an async status request or callback.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/docraptor/api/doc_api.rb', line 338

def get_async_doc_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DocApi.get_async_doc ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling DocApi.get_async_doc"
  end
  # resource path
  local_var_path = '/download/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DocApi.get_async_doc",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocApi#get_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end