Class: ClickSendClient::FAXDeliveryReceiptRulesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FAXDeliveryReceiptRulesApi

Returns a new instance of FAXDeliveryReceiptRulesApi.



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

def api_client
  @api_client
end

Instance Method Details

#fax_delivery_receipt_automation_delete(receipt_rule_id, opts = {}) ⇒ String

Delete fax delivery receipt automation Delete fax delivery receipt automation

Parameters:

  • receipt_rule_id —

    Receipt rule id

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

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb', line 27

def fax_delivery_receipt_automation_delete(receipt_rule_id, opts = {})
  data, _status_code, _headers = fax_delivery_receipt_automation_delete_with_http_info(receipt_rule_id, opts)
  data
end

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

Delete fax delivery receipt automation Delete fax delivery receipt automation

Parameters:

  • receipt_rule_id —

    Receipt rule id

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def fax_delivery_receipt_automation_delete_with_http_info(receipt_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_delete ...'
  end
  # verify the required parameter 'receipt_rule_id' is set
  if @api_client.config.client_side_validation && receipt_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_delete"
  end
  # resource path
  local_var_path = '/automations/fax/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_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(:DELETE, 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: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_delivery_receipt_automation_get(receipt_rule_id, opts = {}) ⇒ String

Get specific fax delivery receipt automation Get specific fax delivery receipt automation

Parameters:

  • receipt_rule_id —

    Receipt rule id

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

    the optional parameters

Returns:

  • (String) 


81
82
83
84
 
# File 'lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb', line 81

def fax_delivery_receipt_automation_get(receipt_rule_id, opts = {})
  data, _status_code, _headers = fax_delivery_receipt_automation_get_with_http_info(receipt_rule_id, opts)
  data
end

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

Get specific fax delivery receipt automation Get specific fax delivery receipt automation

Parameters:

  • receipt_rule_id —

    Receipt rule id

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def fax_delivery_receipt_automation_get_with_http_info(receipt_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_get ...'
  end
  # verify the required parameter 'receipt_rule_id' is set
  if @api_client.config.client_side_validation && receipt_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_get"
  end
  # resource path
  local_var_path = '/automations/fax/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_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: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_delivery_receipt_automation_post(delivery_receipt_rule, opts = {}) ⇒ String

Create fax delivery receipt automations Create fax delivery receipt automations

Parameters:

  • delivery_receipt_rule —

    fax delivery receipt rule model

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

    the optional parameters

Returns:

  • (String) 


135
136
137
138
 
# File 'lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb', line 135

def fax_delivery_receipt_automation_post(delivery_receipt_rule, opts = {})
  data, _status_code, _headers = fax_delivery_receipt_automation_post_with_http_info(delivery_receipt_rule, opts)
  data
end

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

Create fax delivery receipt automations Create fax delivery receipt automations

Parameters:

  • delivery_receipt_rule —

    fax delivery receipt rule model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def fax_delivery_receipt_automation_post_with_http_info(delivery_receipt_rule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_post ...'
  end
  # verify the required parameter 'delivery_receipt_rule' is set
  if @api_client.config.client_side_validation && delivery_receipt_rule.nil?
    fail ArgumentError, "Missing the required parameter 'delivery_receipt_rule' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_post"
  end
  # resource path
  local_var_path = '/automations/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(delivery_receipt_rule)
  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: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automation_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule, opts = {}) ⇒ String

Update fax delivery receipt automation Update fax delivery receipt automation

Parameters:

  • receipt_rule_id —

    Receipt rule id

  • delivery_receipt_rule —

    Delivery receipt rule model

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

    the optional parameters

Returns:

  • (String) 


190
191
192
193
 
# File 'lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb', line 190

def fax_delivery_receipt_automation_put(receipt_rule_id, delivery_receipt_rule, opts = {})
  data, _status_code, _headers = fax_delivery_receipt_automation_put_with_http_info(receipt_rule_id, delivery_receipt_rule, opts)
  data
end

#fax_delivery_receipt_automation_put_with_http_info(receipt_rule_id, delivery_receipt_rule, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Update fax delivery receipt automation Update fax delivery receipt automation

Parameters:

  • receipt_rule_id —

    Receipt rule id

  • delivery_receipt_rule —

    Delivery receipt rule model

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

    the optional parameters

Returns:

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

    String 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
 
# File 'lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb', line 201

def fax_delivery_receipt_automation_put_with_http_info(receipt_rule_id, delivery_receipt_rule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_put ...'
  end
  # verify the required parameter 'receipt_rule_id' is set
  if @api_client.config.client_side_validation && receipt_rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'receipt_rule_id' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_put"
  end
  # verify the required parameter 'delivery_receipt_rule' is set
  if @api_client.config.client_side_validation && delivery_receipt_rule.nil?
    fail ArgumentError, "Missing the required parameter 'delivery_receipt_rule' when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automation_put"
  end
  # resource path
  local_var_path = '/automations/fax/receipts/{receipt_rule_id}'.sub('{' + 'receipt_rule_id' + '}', receipt_rule_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 = @api_client.object_to_http_body(delivery_receipt_rule)
  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: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automation_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fax_delivery_receipt_automations_get(opts = {}) ⇒ String

Get all fax delivery receipt automations Get all fax delivery receipt automations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Your keyword or query.

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


251
252
253
254
 
# File 'lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb', line 251

def fax_delivery_receipt_automations_get(opts = {})
  data, _status_code, _headers = fax_delivery_receipt_automations_get_with_http_info(opts)
  data
end

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

Get all fax delivery receipt automations Get all fax delivery receipt automations

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :q (String) —

    Your keyword or query.

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
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
 
# File 'lib/clicksend_client/api/fax_delivery_receipt_rules_api.rb', line 263

def fax_delivery_receipt_automations_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automations_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automations_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 FAXDeliveryReceiptRulesApi.fax_delivery_receipt_automations_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/automations/fax/receipts'

  # query parameters
  query_params = {}
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].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: FAXDeliveryReceiptRulesApi#fax_delivery_receipt_automations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end