Class: ClickSendClient::EmailToSmsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailToSmsApi

Returns a new instance of EmailToSmsApi.



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

def api_client
  @api_client
end

Instance Method Details

#sms_email_sms_get(opts = {}) ⇒ String

Get list of email to sms allowed addresses Get list of email to sms allowed addresses

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) 


28
29
30
31
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 28

def sms_email_sms_get(opts = {})
  data, _status_code, _headers = sms_email_sms_get_with_http_info(opts)
  data
end

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

Get list of email to sms allowed addresses Get list of email to sms allowed addresses

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



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
82
83
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 39

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

  # resource path
  local_var_path = '/sms/email-sms'

  # 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: EmailToSmsApi#sms_email_sms_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sms_email_sms_post(email_sms_address, opts = {}) ⇒ String

Create email to sms allowed address Create email to sms allowed address

Parameters:

  • email_sms_address —

    EmailSMSAddress model

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

    the optional parameters

Returns:

  • (String) 


89
90
91
92
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 89

def sms_email_sms_post(email_sms_address, opts = {})
  data, _status_code, _headers = sms_email_sms_post_with_http_info(email_sms_address, opts)
  data
end

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

Create email to sms allowed address Create email to sms allowed address

Parameters:

  • email_sms_address —

    EmailSMSAddress model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def sms_email_sms_post_with_http_info(email_sms_address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailToSmsApi.sms_email_sms_post ...'
  end
  # verify the required parameter 'email_sms_address' is set
  if @api_client.config.client_side_validation && email_sms_address.nil?
    fail ArgumentError, "Missing the required parameter 'email_sms_address' when calling EmailToSmsApi.sms_email_sms_post"
  end
  # resource path
  local_var_path = '/sms/email-sms'

  # 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(email_sms_address)
  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: EmailToSmsApi#sms_email_sms_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sms_email_sms_stripped_string_delete(rule_id, opts = {}) ⇒ String

Delete email to sms stripped string rule Delete email to sms stripped string rule

Parameters:

  • rule_id —

    Your rule id

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

    the optional parameters

Returns:

  • (String) 


143
144
145
146
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 143

def sms_email_sms_stripped_string_delete(rule_id, opts = {})
  data, _status_code, _headers = sms_email_sms_stripped_string_delete_with_http_info(rule_id, opts)
  data
end

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

Delete email to sms stripped string rule Delete email to sms stripped string rule

Parameters:

  • rule_id —

    Your rule id

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
185
186
187
188
189
190
191
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 153

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

#sms_email_sms_stripped_string_get(rule_id, opts = {}) ⇒ String

Get email to sms stripped string rule Get email to sms stripped string rule

Parameters:

  • rule_id —

    Your rule id

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

    the optional parameters

Returns:

  • (String) 


197
198
199
200
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 197

def sms_email_sms_stripped_string_get(rule_id, opts = {})
  data, _status_code, _headers = sms_email_sms_stripped_string_get_with_http_info(rule_id, opts)
  data
end

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

Get email to sms stripped string rule Get email to sms stripped string rule

Parameters:

  • rule_id —

    Your rule id

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

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

#sms_email_sms_stripped_string_post(stripped_string, opts = {}) ⇒ String

Create email to sms stripped string rule Create email to sms stripped string rules

Parameters:

  • stripped_string —

    StrippedString model

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

    the optional parameters

Returns:

  • (String) 


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

def sms_email_sms_stripped_string_post(stripped_string, opts = {})
  data, _status_code, _headers = sms_email_sms_stripped_string_post_with_http_info(stripped_string, opts)
  data
end

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

Create email to sms stripped string rule Create email to sms stripped string rules

Parameters:

  • stripped_string —

    StrippedString model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



261
262
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
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 261

def sms_email_sms_stripped_string_post_with_http_info(stripped_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailToSmsApi.sms_email_sms_stripped_string_post ...'
  end
  # verify the required parameter 'stripped_string' is set
  if @api_client.config.client_side_validation && stripped_string.nil?
    fail ArgumentError, "Missing the required parameter 'stripped_string' when calling EmailToSmsApi.sms_email_sms_stripped_string_post"
  end
  # resource path
  local_var_path = '/sms/email-sms-stripped-strings'

  # 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(stripped_string)
  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: EmailToSmsApi#sms_email_sms_stripped_string_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sms_email_sms_stripped_string_put(stripped_string, rule_id, opts = {}) ⇒ String

Update email to sms stripped string rule Update email to sms stripped string rule

Parameters:

  • stripped_string —

    StrippedString model

  • rule_id —

    Your rule id

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

    the optional parameters

Returns:

  • (String) 


306
307
308
309
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 306

def sms_email_sms_stripped_string_put(stripped_string, rule_id, opts = {})
  data, _status_code, _headers = sms_email_sms_stripped_string_put_with_http_info(stripped_string, rule_id, opts)
  data
end

#sms_email_sms_stripped_string_put_with_http_info(stripped_string, rule_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Update email to sms stripped string rule Update email to sms stripped string rule

Parameters:

  • stripped_string —

    StrippedString model

  • rule_id —

    Your rule id

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def sms_email_sms_stripped_string_put_with_http_info(stripped_string, rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailToSmsApi.sms_email_sms_stripped_string_put ...'
  end
  # verify the required parameter 'stripped_string' is set
  if @api_client.config.client_side_validation && stripped_string.nil?
    fail ArgumentError, "Missing the required parameter 'stripped_string' when calling EmailToSmsApi.sms_email_sms_stripped_string_put"
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling EmailToSmsApi.sms_email_sms_stripped_string_put"
  end
  # resource path
  local_var_path = '/sms/email-sms-stripped-strings/{rule_id}'.sub('{' + 'rule_id' + '}', 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(stripped_string)
  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: EmailToSmsApi#sms_email_sms_stripped_string_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sms_email_sms_stripped_strings_get(opts = {}) ⇒ String

Get list of email to sms stripped string rules Get list of email to sms stripped string rules

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) 


366
367
368
369
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 366

def sms_email_sms_stripped_strings_get(opts = {})
  data, _status_code, _headers = sms_email_sms_stripped_strings_get_with_http_info(opts)
  data
end

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

Get list of email to sms stripped string rules Get list of email to sms stripped string rules

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



377
378
379
380
381
382
383
384
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
 
# File 'lib/clicksend_client/api/email_to_sms_api.rb', line 377

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

  # resource path
  local_var_path = '/sms/email-sms-stripped-strings'

  # 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: EmailToSmsApi#sms_email_sms_stripped_strings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end