Class: Dropbox::Sign::FaxApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/api/fax_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FaxApi

Returns a new instance of FaxApi.



22
23
24
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 22

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#fax_delete(fax_id, opts = {}) ⇒ nil

Delete Fax Deletes the specified Fax from the system.

Parameters:

  • fax_id (String) —

    Fax ID

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

    the optional parameters

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 30

def fax_delete(fax_id, opts = {})
  fax_delete_with_http_info(fax_id, opts)
  nil
end

#fax_delete_with_http_info(fax_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Fax Deletes the specified Fax from the system.

Parameters:

  • fax_id (String) —

    Fax ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
82
83
84
85
86
87
88
89
90
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 40

def fax_delete_with_http_info(fax_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FaxApi.fax_delete ...'
  end
  # verify the required parameter 'fax_id' is set
  if @api_client.config.client_side_validation && fax_id.nil?
    fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_delete"
  end
  # resource path
  local_var_path = '/fax/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_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']) unless header_params['Accept']

  post_body = {}
  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] || ['api_key']

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

  begin
    data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  rescue Dropbox::Sign::ApiError => e
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#fax_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_files(fax_id, opts = {}) ⇒ File

List Fax Files Returns list of fax files

Parameters:

  • fax_id (String) —

    Fax ID

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

    the optional parameters

Returns:

  • (File) 


97
98
99
100
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 97

def fax_files(fax_id, opts = {})
  data, _status_code, _headers = fax_files_with_http_info(fax_id, opts)
  data
end

#fax_files_with_http_info(fax_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

List Fax Files Returns list of fax files

Parameters:

  • fax_id (String) —

    Fax ID

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 107

def fax_files_with_http_info(fax_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FaxApi.fax_files ...'
  end
  # verify the required parameter 'fax_id' is set
  if @api_client.config.client_side_validation && fax_id.nil?
    fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_files"
  end
  # resource path
  local_var_path = '/fax/files/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_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/pdf', 'application/json']) unless header_params['Accept']

  post_body = {}
  form_params = opts[:form_params] || {}

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

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

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

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

  begin
    data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  rescue Dropbox::Sign::ApiError => e
    if e.code === 200
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::File"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

    range_code = "4XX".split('').first
    range_code_left = "#{range_code}00".to_i
    range_code_right = "#{range_code}99".to_i
    if e.code >= range_code_left && e.code <= range_code_right
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::ErrorResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

  end

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#fax_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_get(fax_id, opts = {}) ⇒ FaxGetResponse

Get Fax Returns information about fax

Parameters:

  • fax_id (String) —

    Fax ID

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

    the optional parameters

Returns:



191
192
193
194
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 191

def fax_get(fax_id, opts = {})
  data, _status_code, _headers = fax_get_with_http_info(fax_id, opts)
  data
end

#fax_get_with_http_info(fax_id, opts = {}) ⇒ Array<(FaxGetResponse, Integer, Hash)>

Get Fax Returns information about fax

Parameters:

  • fax_id (String) —

    Fax ID

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

    the optional parameters

Returns:

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

    FaxGetResponse data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 201

def fax_get_with_http_info(fax_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FaxApi.fax_get ...'
  end
  # verify the required parameter 'fax_id' is set
  if @api_client.config.client_side_validation && fax_id.nil?
    fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_get"
  end
  # resource path
  local_var_path = '/fax/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_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']) unless header_params['Accept']

  post_body = {}
  form_params = opts[:form_params] || {}

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

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

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

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

  begin
    data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  rescue Dropbox::Sign::ApiError => e
    if e.code === 200
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::FaxGetResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

    range_code = "4XX".split('').first
    range_code_left = "#{range_code}00".to_i
    range_code_right = "#{range_code}99".to_i
    if e.code >= range_code_left && e.code <= range_code_right
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::ErrorResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

  end

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#fax_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_list(opts = {}) ⇒ FaxListResponse

Lists Faxes Returns properties of multiple faxes

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page (default to 1)

  • :page_size (Integer) —

    Page size (default to 20)

Returns:



286
287
288
289
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 286

def fax_list(opts = {})
  data, _status_code, _headers = fax_list_with_http_info(opts)
  data
end

#fax_list_with_http_info(opts = {}) ⇒ Array<(FaxListResponse, Integer, Hash)>

Lists Faxes Returns properties of multiple faxes

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page (default to 1)

  • :page_size (Integer) —

    Page size (default to 20)

Returns:

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

    FaxListResponse data, response status code and response headers



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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
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/dropbox-sign/api/fax_api.rb', line 297

def fax_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FaxApi.fax_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling FaxApi.fax_list, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FaxApi.fax_list, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling FaxApi.fax_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/fax/list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  post_body = {}
  form_params = opts[:form_params] || {}

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

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

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

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

  begin
    data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  rescue Dropbox::Sign::ApiError => e
    if e.code === 200
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::FaxListResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

    range_code = "4XX".split('').first
    range_code_left = "#{range_code}00".to_i
    range_code_right = "#{range_code}99".to_i
    if e.code >= range_code_left && e.code <= range_code_right
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::ErrorResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

  end

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#fax_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_send(fax_send_request, opts = {}) ⇒ FaxGetResponse

Send Fax Action to prepare and send a fax

Parameters:

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

    the optional parameters

Returns:



391
392
393
394
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 391

def fax_send(fax_send_request, opts = {})
  data, _status_code, _headers = fax_send_with_http_info(fax_send_request, opts)
  data
end

#fax_send_with_http_info(fax_send_request, opts = {}) ⇒ Array<(FaxGetResponse, Integer, Hash)>

Send Fax Action to prepare and send a fax

Parameters:

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

    the optional parameters

Returns:

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

    FaxGetResponse data, response status code and response headers



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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/dropbox-sign/api/fax_api.rb', line 401

def fax_send_with_http_info(fax_send_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FaxApi.fax_send ...'
  end
  # verify the required parameter 'fax_send_request' is set
  if @api_client.config.client_side_validation && fax_send_request.nil?
    fail ArgumentError, "Missing the required parameter 'fax_send_request' when calling FaxApi.fax_send"
  end
  # resource path
  local_var_path = '/fax/send'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  post_body = {}
  form_params = opts[:form_params] || {}
  result = @api_client.generate_form_data(
    fax_send_request,
    Dropbox::Sign::FaxSendRequest.openapi_types
  )

  # form parameters
  if result[:has_file]
    form_params = opts[:form_params] || result[:params]
    header_params['Content-Type'] = 'multipart/form-data'
  else
    # http body (model)
    post_body = opts[:debug_body] || result[:params]
  end

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

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

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

  begin
    data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  rescue Dropbox::Sign::ApiError => e
    if e.code === 200
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::FaxGetResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

    range_code = "4XX".split('').first
    range_code_left = "#{range_code}00".to_i
    range_code_right = "#{range_code}99".to_i
    if e.code >= range_code_left && e.code <= range_code_right
      body = @api_client.convert_to_type(
        JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
        "Dropbox::Sign::ErrorResponse"
      )

      fail ApiError.new(:code => e.code,
                        :response_headers => e.response_headers,
                        :response_body => body),
           e.message
    end

  end

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#fax_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end