Class: ClickSendClient::AccountApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountApi

Returns a new instance of AccountApi.



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

def api_client
  @api_client
end

Instance Method Details

#account_get(opts = {}) ⇒ String

Get account information Get account details

Parameters:

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

    the optional parameters

Returns:

  • (String) 


26
27
28
29
 
# File 'lib/clicksend_client/api/account_api.rb', line 26

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

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

Get account information Get account details

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



35
36
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
 
# File 'lib/clicksend_client/api/account_api.rb', line 35

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.account_get ...'
  end
  # resource path
  local_var_path = '/account'

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

#account_post(account, opts = {}) ⇒ String

Create a new account Create An Account

Parameters:

  • account —

    Account model

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

    the optional parameters

Returns:

  • (String) 


75
76
77
78
 
# File 'lib/clicksend_client/api/account_api.rb', line 75

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

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

Create a new account Create An Account

Parameters:

  • account —

    Account model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



85
86
87
88
89
90
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
 
# File 'lib/clicksend_client/api/account_api.rb', line 85

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

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

#account_useage_by_subaccount_get(year, month, opts = {}) ⇒ String

Get account useage by subaccount Get account useage by subaccount

Parameters:

  • year —

    Year to filter by (yyyy)

  • month —

    Month to filter by (mm)

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

    the optional parameters

Returns:

  • (String) 


130
131
132
133
 
# File 'lib/clicksend_client/api/account_api.rb', line 130

def (year, month, opts = {})
  data, _status_code, _headers = (year, month, opts)
  data
end

#account_useage_by_subaccount_get_with_http_info(year, month, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get account useage by subaccount Get account useage by subaccount

Parameters:

  • year —

    Year to filter by (yyyy)

  • month —

    Month to filter by (mm)

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

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

#account_verify_send_put(account_verify, opts = {}) ⇒ String

Send account activation token Send account activation token

Parameters:

  • account_verify —

    Account details

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

    the optional parameters

Returns:

  • (String) 


189
190
191
192
 
# File 'lib/clicksend_client/api/account_api.rb', line 189

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

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

Send account activation token Send account activation token

Parameters:

  • account_verify —

    Account details

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



199
200
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
 
# File 'lib/clicksend_client/api/account_api.rb', line 199

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

#account_verify_verify_by_activation_token_put(activation_token, opts = {}) ⇒ String

Verify new account Verify new account

Parameters:

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

    the optional parameters

Returns:

  • (String) 


243
244
245
246
 
# File 'lib/clicksend_client/api/account_api.rb', line 243

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

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

Verify new account Verify new account

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/clicksend_client/api/account_api.rb', line 253

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

#forgot_password_put(opts = {}) ⇒ String

Forgot password Forgot password

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


297
298
299
300
 
# File 'lib/clicksend_client/api/account_api.rb', line 297

def forgot_password_put(opts = {})
  data, _status_code, _headers = forgot_password_put_with_http_info(opts)
  data
end

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

Forgot password Forgot password

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



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

def forgot_password_put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.forgot_password_put ...'
  end
  # resource path
  local_var_path = '/forgot-password'

  # 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[:'forgot_password'])
  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: AccountApi#forgot_password_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#forgot_password_verify_put(verify_password, opts = {}) ⇒ String

Verify forgot password Verify forgot password

Parameters:

  • verify_password —

    verifyPassword data

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

    the optional parameters

Returns:

  • (String) 


347
348
349
350
 
# File 'lib/clicksend_client/api/account_api.rb', line 347

def forgot_password_verify_put(verify_password, opts = {})
  data, _status_code, _headers = forgot_password_verify_put_with_http_info(verify_password, opts)
  data
end

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

Verify forgot password Verify forgot password

Parameters:

  • verify_password —

    verifyPassword data

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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

def forgot_password_verify_put_with_http_info(verify_password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.forgot_password_verify_put ...'
  end
  # verify the required parameter 'verify_password' is set
  if @api_client.config.client_side_validation && verify_password.nil?
    fail ArgumentError, "Missing the required parameter 'verify_password' when calling AccountApi.forgot_password_verify_put"
  end
  # resource path
  local_var_path = '/forgot-password/verify'

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

#forgot_username_put(opts = {}) ⇒ String

Forgot username Forgot username

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


401
402
403
404
 
# File 'lib/clicksend_client/api/account_api.rb', line 401

def forgot_username_put(opts = {})
  data, _status_code, _headers = forgot_username_put_with_http_info(opts)
  data
end

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

Forgot username Forgot username

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



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

def forgot_username_put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.forgot_username_put ...'
  end
  # resource path
  local_var_path = '/forgot-username'

  # 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[:'forgot_username'])
  auth_names = []
  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: AccountApi#forgot_username_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end