Class: ClickSendClient::FAXApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/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.



19
20
21
 
# File 'lib/clicksend_client/api/fax_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/clicksend_client/api/fax_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#fax_history_get(opts = {}) ⇒ String

Get a list of Fax History. Get a list of Fax History.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Customize result by setting from date (timestsamp) Example: 1457572619.

  • :date_to (Integer) —

    Customize result by setting to date (timestamp) Example: 1457573000.

  • :q (String) —

    Custom query Example: status:Sent,status_code:201.

  • :order (String) —

    Order result by Example: date_added:desc,list_id:desc.

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


32
33
34
35
 
# File 'lib/clicksend_client/api/fax_api.rb', line 32

def fax_history_get(opts = {})
  data, _status_code, _headers = fax_history_get_with_http_info(opts)
  data
end

#fax_history_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get a list of Fax History. Get a list of Fax History.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date_from (Integer) —

    Customize result by setting from date (timestsamp) Example: 1457572619.

  • :date_to (Integer) —

    Customize result by setting to date (timestamp) Example: 1457573000.

  • :q (String) —

    Custom query Example: status:Sent,status_code:201.

  • :order (String) —

    Order result by Example: date_added:desc,list_id:desc.

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



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
91
92
93
94
95
 
# File 'lib/clicksend_client/api/fax_api.rb', line 47

def fax_history_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXApi.fax_history_get ...'
  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_history_get, must be greater than or equal to 1.'
  end

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

  # resource path
  local_var_path = '/fax/history'

  # query parameters
  query_params = {}
  query_params[:'date_from'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'date_to'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FAXApi#fax_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_price_post(fax_message, opts = {}) ⇒ String

Calculate Total Price for Fax Messages sent Calculate Total Price for Fax Messages sent

Parameters:

  • fax_message —

    FaxMessageCollection model

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

    the optional parameters

Returns:

  • (String) 


101
102
103
104
 
# File 'lib/clicksend_client/api/fax_api.rb', line 101

def fax_price_post(fax_message, opts = {})
  data, _status_code, _headers = fax_price_post_with_http_info(fax_message, opts)
  data
end

#fax_price_post_with_http_info(fax_message, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Calculate Total Price for Fax Messages sent Calculate Total Price for Fax Messages sent

Parameters:

  • fax_message —

    FaxMessageCollection model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/clicksend_client/api/fax_api.rb', line 111

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(fax_message)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FAXApi#fax_price_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_receipts_by_message_id_get(message_id, opts = {}) ⇒ String

Get a single fax receipt based on message id. Get a single fax receipt based on message id.

Parameters:

  • message_id —

    ID of the message receipt to retrieve

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

    the optional parameters

Returns:

  • (String) 


155
156
157
158
 
# File 'lib/clicksend_client/api/fax_api.rb', line 155

def fax_receipts_by_message_id_get(message_id, opts = {})
  data, _status_code, _headers = fax_receipts_by_message_id_get_with_http_info(message_id, opts)
  data
end

#fax_receipts_by_message_id_get_with_http_info(message_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get a single fax receipt based on message id. Get a single fax receipt based on message id.

Parameters:

  • message_id —

    ID of the message receipt to retrieve

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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/clicksend_client/api/fax_api.rb', line 165

def fax_receipts_by_message_id_get_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXApi.fax_receipts_by_message_id_get ...'
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling FAXApi.fax_receipts_by_message_id_get"
  end
  # resource path
  local_var_path = '/fax/receipts/{message_id}'.sub('{' + 'message_id' + '}', message_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FAXApi#fax_receipts_by_message_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_receipts_get(opts = {}) ⇒ String

Get all delivery receipts Get all delivery receipts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


210
211
212
213
 
# File 'lib/clicksend_client/api/fax_api.rb', line 210

def fax_receipts_get(opts = {})
  data, _status_code, _headers = fax_receipts_get_with_http_info(opts)
  data
end

#fax_receipts_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all delivery receipts Get all delivery receipts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/clicksend_client/api/fax_api.rb', line 221

def fax_receipts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXApi.fax_receipts_get ...'
  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_receipts_get, must be greater than or equal to 1.'
  end

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

  # resource path
  local_var_path = '/fax/receipts'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FAXApi#fax_receipts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_receipts_post(url, opts = {}) ⇒ String

Add a delivery receipt Add a delivery receipt

Parameters:

  • url —

    Url model

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

    the optional parameters

Returns:

  • (String) 


271
272
273
274
 
# File 'lib/clicksend_client/api/fax_api.rb', line 271

def fax_receipts_post(url, opts = {})
  data, _status_code, _headers = fax_receipts_post_with_http_info(url, opts)
  data
end

#fax_receipts_post_with_http_info(url, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Add a delivery receipt Add a delivery receipt

Parameters:

  • url —

    Url model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/clicksend_client/api/fax_api.rb', line 281

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(url)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FAXApi#fax_receipts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_receipts_read_put(opts = {}) ⇒ String

Mark delivery receipts as read Mark delivery receipts as read

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


325
326
327
328
 
# File 'lib/clicksend_client/api/fax_api.rb', line 325

def fax_receipts_read_put(opts = {})
  data, _status_code, _headers = fax_receipts_read_put_with_http_info(opts)
  data
end

#fax_receipts_read_put_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Mark delivery receipts as read Mark delivery receipts as read

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/clicksend_client/api/fax_api.rb', line 335

def fax_receipts_read_put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXApi.fax_receipts_read_put ...'
  end
  # resource path
  local_var_path = '/fax/receipts-read'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'date_before'])
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FAXApi#fax_receipts_read_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_send_post(fax_message, opts = {}) ⇒ String

Send a fax using supplied supported file-types. Send a fax using supplied supported file-types.

Parameters:

  • fax_message —

    FaxMessageCollection model

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

    the optional parameters

Returns:

  • (String) 


375
376
377
378
 
# File 'lib/clicksend_client/api/fax_api.rb', line 375

def fax_send_post(fax_message, opts = {})
  data, _status_code, _headers = fax_send_post_with_http_info(fax_message, opts)
  data
end

#fax_send_post_with_http_info(fax_message, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Send a fax using supplied supported file-types. Send a fax using supplied supported file-types.

Parameters:

  • fax_message —

    FaxMessageCollection model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



385
386
387
388
389
390
391
392
393
394
395
396
397
398
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
 
# File 'lib/clicksend_client/api/fax_api.rb', line 385

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(fax_message)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FAXApi#fax_send_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end