Class: TogaiClient::CreditsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/api/credits_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CreditsApi

Returns a new instance of CreditsApi.



19
20
21
 
# File 'lib/togai_client/api/credits_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/togai_client/api/credits_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_credit(opts = {}) ⇒ CreateCreditResponse

Grant credit Grant credit

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



27
28
29
30
 
# File 'lib/togai_client/api/credits_api.rb', line 27

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

#create_credit_with_http_info(opts = {}) ⇒ Array<(CreateCreditResponse, Integer, Hash)>

Grant credit Grant credit

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(CreateCreditResponse, Integer, Hash)>) —

    CreateCreditResponse 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
76
77
78
79
80
81
82
83
84
 
# File 'lib/togai_client/api/credits_api.rb', line 37

def create_credit_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CreditsApi.create_credit ...'
  end
  # resource path
  local_var_path = '/credits'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_credit_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CreateCreditResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"CreditsApi.create_credit",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditsApi#create_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#credit_balance_for_account(account_id, opts = {}) ⇒ CreditBalanceResponse

Credit balance for Account Credit balance for Account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/togai_client/api/credits_api.rb', line 91

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

#credit_balance_for_account_with_http_info(account_id, opts = {}) ⇒ Array<(CreditBalanceResponse, Integer, Hash)>

Credit balance for Account Credit balance for Account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:

  • (Array<(CreditBalanceResponse, Integer, Hash)>) —

    CreditBalanceResponse data, response status code and response headers



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/togai_client/api/credits_api.rb', line 101

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CreditsApi.credit_balance_for_account ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling CreditsApi.credit_balance_for_account"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling CreditsApi.credit_balance_for_account, the character length must be smaller than or equal to 50.'
  end

  # resource path
  local_var_path = '/accounts/{account_id}/credit_balance'.sub('{' + 'account_id' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CreditBalanceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"CreditsApi.credit_balance_for_account",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditsApi#credit_balance_for_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credit_details(credit_id, opts = {}) ⇒ CreditDetailsResponse

Get credit details Get credit details

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/togai_client/api/credits_api.rb', line 158

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

#get_credit_details_with_http_info(credit_id, opts = {}) ⇒ Array<(CreditDetailsResponse, Integer, Hash)>

Get credit details Get credit details

Parameters:

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

    the optional parameters

Returns:

  • (Array<(CreditDetailsResponse, Integer, Hash)>) —

    CreditDetailsResponse data, response status code and response headers



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
206
207
208
209
210
211
212
213
214
 
# File 'lib/togai_client/api/credits_api.rb', line 168

def get_credit_details_with_http_info(credit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CreditsApi.get_credit_details ...'
  end
  # verify the required parameter 'credit_id' is set
  if @api_client.config.client_side_validation && credit_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_id' when calling CreditsApi.get_credit_details"
  end
  # resource path
  local_var_path = '/credits/{credit_id}'.sub('{' + 'credit_id' + '}', CGI.escape(credit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CreditDetailsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"CreditsApi.get_credit_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditsApi#get_credit_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_credits(opts = {}) ⇒ ListCreditsResponse

List credits Get all credits

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_token (String) —

    Pagination token used as a marker to get records from next page.

  • :status (String) —

    Filter option to filter by status.

  • :account_id (String) —

    Filter option to filter based on account id.

  • :id (String) —

    Filter option to filter based on credit id.

  • :page_size (Integer) —

    Maximum page size expected by client to return the record list. NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

Returns:



225
226
227
228
 
# File 'lib/togai_client/api/credits_api.rb', line 225

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

#list_credits_with_http_info(opts = {}) ⇒ Array<(ListCreditsResponse, Integer, Hash)>

List credits Get all credits

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_token (String) —

    Pagination token used as a marker to get records from next page.

  • :status (String) —

    Filter option to filter by status.

  • :account_id (String) —

    Filter option to filter based on account id.

  • :id (String) —

    Filter option to filter based on credit id.

  • :page_size (Integer) —

    Maximum page size expected by client to return the record list. NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

Returns:

  • (Array<(ListCreditsResponse, Integer, Hash)>) —

    ListCreditsResponse data, response status code and response headers



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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/togai_client/api/credits_api.rb', line 239

def list_credits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CreditsApi.list_credits ...'
  end
  # resource path
  local_var_path = '/credits'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListCreditsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"CreditsApi.list_credits",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditsApi#list_credits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#void_credit(credit_id, opts = {}) ⇒ Credit

Void credit Void credit

Parameters:

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

    the optional parameters

Returns:



293
294
295
296
 
# File 'lib/togai_client/api/credits_api.rb', line 293

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

#void_credit_with_http_info(credit_id, opts = {}) ⇒ Array<(Credit, Integer, Hash)>

Void credit Void credit

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Credit, Integer, Hash)>) —

    Credit data, response status code and response headers



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
345
346
347
348
349
 
# File 'lib/togai_client/api/credits_api.rb', line 303

def void_credit_with_http_info(credit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CreditsApi.void_credit ...'
  end
  # verify the required parameter 'credit_id' is set
  if @api_client.config.client_side_validation && credit_id.nil?
    fail ArgumentError, "Missing the required parameter 'credit_id' when calling CreditsApi.void_credit"
  end
  # resource path
  local_var_path = '/credits/{credit_id}/void'.sub('{' + 'credit_id' + '}', CGI.escape(credit_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Credit'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"CreditsApi.void_credit",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CreditsApi#void_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end