Class: ClickSendClient::AccountRechargeApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountRechargeApi

Returns a new instance of AccountRechargeApi.



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

def api_client
  @api_client
end

Instance Method Details

#recharge_credit_card_get(opts = {}) ⇒ String

Get Credit Card info Get Credit Card info

Parameters:

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

    the optional parameters

Returns:

  • (String) 


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

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

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

Get Credit Card info Get Credit Card info

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_recharge_api.rb', line 35

def recharge_credit_card_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountRechargeApi.recharge_credit_card_get ...'
  end
  # resource path
  local_var_path = '/recharge/credit-card'

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

#recharge_credit_card_put(credit_card, opts = {}) ⇒ String

Update credit card info Update credit card info

Parameters:

  • credit_card —

    CreditCard model

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

    the optional parameters

Returns:

  • (String) 


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

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

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

Update credit card info Update credit card info

Parameters:

  • credit_card —

    CreditCard 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_recharge_api.rb', line 85

def recharge_credit_card_put_with_http_info(credit_card, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountRechargeApi.recharge_credit_card_put ...'
  end
  # verify the required parameter 'credit_card' is set
  if @api_client.config.client_side_validation && credit_card.nil?
    fail ArgumentError, "Missing the required parameter 'credit_card' when calling AccountRechargeApi.recharge_credit_card_put"
  end
  # resource path
  local_var_path = '/recharge/credit-card'

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

#recharge_packages_get(opts = {}) ⇒ String

Get list of all packages Get list of all packages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country (String) —

    Country code

Returns:

  • (String) 


129
130
131
132
 
# File 'lib/clicksend_client/api/account_recharge_api.rb', line 129

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

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

Get list of all packages Get list of all packages

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country (String) —

    Country code

Returns:

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

    String data, response status code and response headers



139
140
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
 
# File 'lib/clicksend_client/api/account_recharge_api.rb', line 139

def recharge_packages_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountRechargeApi.recharge_packages_get ...'
  end
  # resource path
  local_var_path = '/recharge/packages'

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

#recharge_purchase_by_package_id_put(package_id, opts = {}) ⇒ String

Purchase a package Purchase a package

Parameters:

  • package_id —

    ID of package to purchase

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

    the optional parameters

Returns:

  • (String) 


180
181
182
183
 
# File 'lib/clicksend_client/api/account_recharge_api.rb', line 180

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

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

Purchase a package Purchase a package

Parameters:

  • package_id —

    ID of package to purchase

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



190
191
192
193
194
195
196
197
198
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
 
# File 'lib/clicksend_client/api/account_recharge_api.rb', line 190

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

#recharge_transactions_by_transaction_id_get(transaction_id, opts = {}) ⇒ String

Get specific Transaction Get specific Transaction

Parameters:

  • transaction_id —

    ID of transaction to retrieve

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

    the optional parameters

Returns:

  • (String) 


234
235
236
237
 
# File 'lib/clicksend_client/api/account_recharge_api.rb', line 234

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

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

Get specific Transaction Get specific Transaction

Parameters:

  • transaction_id —

    ID of transaction to retrieve

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



244
245
246
247
248
249
250
251
252
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
 
# File 'lib/clicksend_client/api/account_recharge_api.rb', line 244

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

#recharge_transactions_get(opts = {}) ⇒ String

Purchase a package Get all transactions

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) 


289
290
291
292
 
# File 'lib/clicksend_client/api/account_recharge_api.rb', line 289

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

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

Purchase a package Get all transactions

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



300
301
302
303
304
305
306
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
342
343
344
 
# File 'lib/clicksend_client/api/account_recharge_api.rb', line 300

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

  # resource path
  local_var_path = '/recharge/transactions'

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