Class: PureCloud::FaxApi

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



23
24
25
 
# File 'lib/purecloud/api/fax_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloud/api/fax_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_documents_document_id(document_id, opts = {}) ⇒ nil

Delete a fax document.

Parameters:

  • document_id —

    Document ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_documents_document_id(document_id, opts = {})
  delete_documents_document_id_with_http_info(document_id, opts)
  return nil
end

#delete_documents_document_id_with_http_info(document_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a fax document.

Parameters:

  • document_id —

    Document ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_documents_document_id_with_http_info(document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FaxApi#delete_documents_document_id ..."
  end
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling delete_documents_document_id" if document_id.nil?
  
  # resource path
  local_var_path = "/api/v2/fax/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

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

#get_documents(opts = {}) ⇒ FaxDocumentEntityListing

Get a list of fax documents.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



92
93
94
95
 
# File 'lib/purecloud/api/fax_api.rb', line 92

def get_documents(opts = {})
  data, status_code, headers = get_documents_with_http_info(opts)
  return data
end

#get_documents_document_id(document_id, opts = {}) ⇒ FaxDocument

Get a document.

Parameters:

  • document_id —

    Document ID

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/purecloud/api/fax_api.rb', line 152

def get_documents_document_id(document_id, opts = {})
  data, status_code, headers = get_documents_document_id_with_http_info(document_id, opts)
  return data
end

#get_documents_document_id_content(document_id, opts = {}) ⇒ DownloadResponse

Download a fax document.

Parameters:

  • document_id —

    Document ID

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

    the optional parameters

Returns:



212
213
214
215
 
# File 'lib/purecloud/api/fax_api.rb', line 212

def get_documents_document_id_content(document_id, opts = {})
  data, status_code, headers = get_documents_document_id_content_with_http_info(document_id, opts)
  return data
end

#get_documents_document_id_content_with_http_info(document_id, opts = {}) ⇒ Array<(DownloadResponse, Fixnum, Hash)>

Download a fax document.

Parameters:

  • document_id —

    Document ID

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

    the optional parameters

Returns:

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

    DownloadResponse data, response status code and response headers



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

def get_documents_document_id_content_with_http_info(document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FaxApi#get_documents_document_id_content ..."
  end
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling get_documents_document_id_content" if document_id.nil?
  
  # resource path
  local_var_path = "/api/v2/fax/documents/{documentId}/content".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'DownloadResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#get_documents_document_id_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_documents_document_id_with_http_info(document_id, opts = {}) ⇒ Array<(FaxDocument, Fixnum, Hash)>

Get a document.

Parameters:

  • document_id —

    Document ID

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

    the optional parameters

Returns:

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

    FaxDocument data, response status code and response headers



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
204
205
 
# File 'lib/purecloud/api/fax_api.rb', line 162

def get_documents_document_id_with_http_info(document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FaxApi#get_documents_document_id ..."
  end
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling get_documents_document_id" if document_id.nil?
  
  # resource path
  local_var_path = "/api/v2/fax/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'FaxDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#get_documents_document_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_documents_with_http_info(opts = {}) ⇒ Array<(FaxDocumentEntityListing, Fixnum, Hash)>

Get a list of fax documents.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    FaxDocumentEntityListing data, response status code and response headers



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
143
144
145
 
# File 'lib/purecloud/api/fax_api.rb', line 103

def get_documents_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FaxApi#get_documents ..."
  end
  
  # resource path
  local_var_path = "/api/v2/fax/documents".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'FaxDocumentEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#get_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_summary(opts = {}) ⇒ FaxSummary

Get fax summary

Parameters:

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

    the optional parameters

Returns:



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

def get_summary(opts = {})
  data, status_code, headers = get_summary_with_http_info(opts)
  return data
end

#get_summary_with_http_info(opts = {}) ⇒ Array<(FaxSummary, Fixnum, Hash)>

Get fax summary

Parameters:

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

    the optional parameters

Returns:

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

    FaxSummary data, response status code and response headers



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

def get_summary_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FaxApi#get_summary ..."
  end
  
  # resource path
  local_var_path = "/api/v2/fax/summary".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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 => 'FaxSummary')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#get_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_documents_document_id(document_id, body, opts = {}) ⇒ FaxDocument

Update a fax document.

Parameters:

  • document_id —

    Document ID

  • body —

    Document

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

    the optional parameters

Returns:



328
329
330
331
 
# File 'lib/purecloud/api/fax_api.rb', line 328

def put_documents_document_id(document_id, body, opts = {})
  data, status_code, headers = put_documents_document_id_with_http_info(document_id, body, opts)
  return data
end

#put_documents_document_id_with_http_info(document_id, body, opts = {}) ⇒ Array<(FaxDocument, Fixnum, Hash)>

Update a fax document.

Parameters:

  • document_id —

    Document ID

  • body —

    Document

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

    the optional parameters

Returns:

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

    FaxDocument data, response status code and response headers



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
385
 
# File 'lib/purecloud/api/fax_api.rb', line 339

def put_documents_document_id_with_http_info(document_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FaxApi#put_documents_document_id ..."
  end
  
  # verify the required parameter 'document_id' is set
  fail "Missing the required parameter 'document_id' when calling put_documents_document_id" if document_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_documents_document_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/fax/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  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 => 'FaxDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FaxApi#put_documents_document_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end