Class: TogaiClient::AccountsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountsApi

Returns a new instance of AccountsApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_aliases(account_id, add_account_aliases_request, opts = {}) ⇒ Account

Add Aliases to account Add aliases to an account using customer_id and account_id.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • add_account_aliases_request (AddAccountAliasesRequest) —

    Payload to add aliases to account

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/togai_client/api/accounts_api.rb', line 28

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

#add_aliases_with_http_info(account_id, add_account_aliases_request, opts = {}) ⇒ Array<(Account, Integer, Hash)>

Add Aliases to account Add aliases to an account using customer_id and account_id.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • add_account_aliases_request (AddAccountAliasesRequest) —

    Payload to add aliases to account

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

    the optional parameters

Returns:

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

    Account 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/togai_client/api/accounts_api.rb', line 39

def add_aliases_with_http_info(, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.add_aliases ...'
  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 AccountsApi.add_aliases"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.add_aliases, the character length must be smaller than or equal to 50.'
  end

  # verify the required parameter 'add_account_aliases_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'add_account_aliases_request' when calling AccountsApi.add_aliases"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/add_aliases'.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']
  # 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()

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.add_aliases",
    :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: AccountsApi#add_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_account(create_account_request, opts = {}) ⇒ Account

Create an account This API let’s you to create an account for a customer using customer_id.

Parameters:

  • create_account_request (CreateAccountRequest) —

    Payload to create account

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

    the optional parameters

Returns:



105
106
107
108
 
# File 'lib/togai_client/api/accounts_api.rb', line 105

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

#create_account_with_http_info(create_account_request, opts = {}) ⇒ Array<(Account, Integer, Hash)>

Create an account This API let’s you to create an account for a customer using customer_id.

Parameters:

  • create_account_request (CreateAccountRequest) —

    Payload to create account

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

    the optional parameters

Returns:

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

    Account data, response status code and response headers



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/togai_client/api/accounts_api.rb', line 115

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

  # 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()

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.create_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#create_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_proposal(account_id, create_proposal_request, opts = {}) ⇒ Proposal

(DEPRECATED) Propose a purchase of a plan This API let’s you to create a proposal of a billing/entitlement plan for an account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • create_proposal_request (CreateProposalRequest) —

    Payload to initiate a proposal

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

    the optional parameters

Returns:



174
175
176
177
 
# File 'lib/togai_client/api/accounts_api.rb', line 174

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

#create_proposal_with_http_info(account_id, create_proposal_request, opts = {}) ⇒ Array<(Proposal, Integer, Hash)>

(DEPRECATED) Propose a purchase of a plan This API let’s you to create a proposal of a billing/entitlement plan for an account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • create_proposal_request (CreateProposalRequest) —

    Payload to initiate a proposal

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

    the optional parameters

Returns:

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

    Proposal data, response status code and response headers



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
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
 
# File 'lib/togai_client/api/accounts_api.rb', line 185

def create_proposal_with_http_info(, create_proposal_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.create_proposal ...'
  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 AccountsApi.create_proposal"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.create_proposal, the character length must be smaller than or equal to 50.'
  end

  # verify the required parameter 'create_proposal_request' is set
  if @api_client.config.client_side_validation && create_proposal_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_proposal_request' when calling AccountsApi.create_proposal"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/purchase_proposals'.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']
  # 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(create_proposal_request)

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.create_proposal",
    :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: AccountsApi#create_proposal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account(account_id, opts = {}) ⇒ BaseSuccessResponse

Delete an account This API let’s you to delete a customer using customer_id and account_id.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:



251
252
253
254
 
# File 'lib/togai_client/api/accounts_api.rb', line 251

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

#delete_account_with_http_info(account_id, opts = {}) ⇒ Array<(BaseSuccessResponse, Integer, Hash)>

Delete an account This API let’s you to delete a customer using customer_id and account_id.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:

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

    BaseSuccessResponse 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
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/togai_client/api/accounts_api.rb', line 261

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.delete_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 AccountsApi.delete_account"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.delete_account, the character length must be smaller than or equal to 50.'
  end

  # resource path
  local_var_path = '/accounts/{account_id}'.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] || 'BaseSuccessResponse'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.delete_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#delete_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account(account_id, opts = {}) ⇒ Account

Get an account Get account information using customer_id and account_id.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Options Hash (opts):

  • :effective_on (Time)
  • :include_group_details (Boolean)

Returns:



320
321
322
323
 
# File 'lib/togai_client/api/accounts_api.rb', line 320

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

#get_account_with_http_info(account_id, opts = {}) ⇒ Array<(Account, Integer, Hash)>

Get an account Get account information using customer_id and account_id.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Options Hash (opts):

  • :effective_on (Time)
  • :include_group_details (Boolean)

Returns:

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

    Account data, response status code and response headers



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
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
 
# File 'lib/togai_client/api/accounts_api.rb', line 332

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_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 AccountsApi.get_account"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.get_account, the character length must be smaller than or equal to 50.'
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'effectiveOn'] = opts[:'effective_on'] if !opts[:'effective_on'].nil?
  query_params[:'includeGroupDetails'] = opts[:'include_group_details'] if !opts[:'include_group_details'].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] || 'Account'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.get_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: AccountsApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_accounts(opts = {}) ⇒ AccountPaginatedResponse

List accounts of customer Returns a list of accounts of a customer with pagination and sort.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_token (String)
  • :page_size (Float)

Returns:



392
393
394
395
 
# File 'lib/togai_client/api/accounts_api.rb', line 392

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

#get_accounts_with_http_info(opts = {}) ⇒ Array<(AccountPaginatedResponse, Integer, Hash)>

List accounts of customer Returns a list of accounts of a customer with pagination and sort.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :next_token (String)
  • :page_size (Float)

Returns:

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

    AccountPaginatedResponse data, response status code and response headers



403
404
405
406
407
408
409
410
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
446
447
 
# File 'lib/togai_client/api/accounts_api.rb', line 403

def get_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...'
  end
  # resource path
  local_var_path = '/accounts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].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] || 'AccountPaginatedResponse'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.get_accounts",
    :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: AccountsApi#get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_pricing_schedules(account_id, opts = {}) ⇒ PricingSchedulePaginatedResponse

(DEPRECATED) List pricing schedules of an account Returns a list of pricing schedules of an account with pagination and sort.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Options Hash (opts):

  • :next_token (String)
  • :page_size (Float)
  • :start_date (String)
  • :end_date (String)
  • :include_price_plan_info (Boolean)
  • :compact (Boolean)

Returns:



460
461
462
463
 
# File 'lib/togai_client/api/accounts_api.rb', line 460

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

#get_pricing_schedules_with_http_info(account_id, opts = {}) ⇒ Array<(PricingSchedulePaginatedResponse, Integer, Hash)>

(DEPRECATED) List pricing schedules of an account Returns a list of pricing schedules of an account with pagination and sort.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Options Hash (opts):

  • :next_token (String)
  • :page_size (Float)
  • :start_date (String)
  • :end_date (String)
  • :include_price_plan_info (Boolean)
  • :compact (Boolean)

Returns:



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/togai_client/api/accounts_api.rb', line 476

def get_pricing_schedules_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_pricing_schedules ...'
  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 AccountsApi.get_pricing_schedules"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.get_pricing_schedules, the character length must be smaller than or equal to 50.'
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'include_price_plan_info'] = opts[:'include_price_plan_info'] if !opts[:'include_price_plan_info'].nil?
  query_params[:'compact'] = opts[:'compact'] if !opts[:'compact'].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] || 'PricingSchedulePaginatedResponse'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.get_pricing_schedules",
    :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: AccountsApi#get_pricing_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_proposal(purchase_proposal_id, opts = {}) ⇒ GetProposalResponse

(DEPRECATED) Get proposal information Get proposal information

Parameters:

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

    the optional parameters

Returns:



539
540
541
542
 
# File 'lib/togai_client/api/accounts_api.rb', line 539

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

#get_proposal_with_http_info(purchase_proposal_id, opts = {}) ⇒ Array<(GetProposalResponse, Integer, Hash)>

(DEPRECATED) Get proposal information Get proposal information

Parameters:

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

    the optional parameters

Returns:

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

    GetProposalResponse data, response status code and response headers



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/togai_client/api/accounts_api.rb', line 549

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

  # resource path
  local_var_path = '/purchase_proposals/{purchase_proposal_id}'.sub('{' + 'purchase_proposal_id' + '}', CGI.escape(purchase_proposal_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] || 'GetProposalResponse'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.get_proposal",
    :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: AccountsApi#get_proposal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_purchase(purchase_id, opts = {}) ⇒ GetPurchaseResponse

(DEPRECATED) Get a specific purchase of an account Get purchase information of an account for a specific plan using account_id and price_plan_id

Parameters:

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

    the optional parameters

Returns:



606
607
608
609
 
# File 'lib/togai_client/api/accounts_api.rb', line 606

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

#get_purchase_with_http_info(purchase_id, opts = {}) ⇒ Array<(GetPurchaseResponse, Integer, Hash)>

(DEPRECATED) Get a specific purchase of an account Get purchase information of an account for a specific plan using account_id and price_plan_id

Parameters:

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

    the optional parameters

Returns:

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

    GetPurchaseResponse data, response status code and response headers



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/togai_client/api/accounts_api.rb', line 616

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

  # resource path
  local_var_path = '/purchases/{purchase_id}'.sub('{' + 'purchase_id' + '}', CGI.escape(purchase_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] || 'GetPurchaseResponse'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.get_purchase",
    :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: AccountsApi#get_purchase\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#initiate_one_time_entitlement_plan(account_id, create_purchase_request, opts = {}) ⇒ Purchase

(DEPRECATED) Initiate a purchase This API let’s you to initiate a purchase for an account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • create_purchase_request (CreatePurchaseRequest) —

    Payload to initiate a purchase

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

    the optional parameters

Returns:



674
675
676
677
 
# File 'lib/togai_client/api/accounts_api.rb', line 674

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

#initiate_one_time_entitlement_plan_with_http_info(account_id, create_purchase_request, opts = {}) ⇒ Array<(Purchase, Integer, Hash)>

(DEPRECATED) Initiate a purchase This API let’s you to initiate a purchase for an account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • create_purchase_request (CreatePurchaseRequest) —

    Payload to initiate a purchase

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

    the optional parameters

Returns:

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

    Purchase data, response status code and response headers



685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/togai_client/api/accounts_api.rb', line 685

def initiate_one_time_entitlement_plan_with_http_info(, create_purchase_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.initiate_one_time_entitlement_plan ...'
  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 AccountsApi.initiate_one_time_entitlement_plan"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.initiate_one_time_entitlement_plan, the character length must be smaller than or equal to 50.'
  end

  # verify the required parameter 'create_purchase_request' is set
  if @api_client.config.client_side_validation && create_purchase_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_purchase_request' when calling AccountsApi.initiate_one_time_entitlement_plan"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/purchases'.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']
  # 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(create_purchase_request)

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.initiate_one_time_entitlement_plan",
    :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: AccountsApi#initiate_one_time_entitlement_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_aliases(account_id, opts = {}) ⇒ AccountAliasesPaginatedResponse

Get all aliases of an account Get all aliases of an account using account_id

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:



751
752
753
754
 
# File 'lib/togai_client/api/accounts_api.rb', line 751

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

#list_account_aliases_with_http_info(account_id, opts = {}) ⇒ Array<(AccountAliasesPaginatedResponse, Integer, Hash)>

Get all aliases of an account Get all aliases of an account using account_id

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/togai_client/api/accounts_api.rb', line 761

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.list_account_aliases ...'
  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 AccountsApi.list_account_aliases"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.list_account_aliases, the character length must be smaller than or equal to 50.'
  end

  # resource path
  local_var_path = '/accounts/{account_id}/account_aliases'.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] || 'AccountAliasesPaginatedResponse'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.list_account_aliases",
    :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: AccountsApi#list_account_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_proposals(account_id, opts = {}) ⇒ ProposalsPaginatedResponse

(DEPRECATED) List all proposals of an account List all proposals of an account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:



818
819
820
821
 
# File 'lib/togai_client/api/accounts_api.rb', line 818

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

#list_account_proposals_with_http_info(account_id, opts = {}) ⇒ Array<(ProposalsPaginatedResponse, Integer, Hash)>

(DEPRECATED) List all proposals of an account List all proposals of an account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:

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

    ProposalsPaginatedResponse data, response status code and response headers



828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/togai_client/api/accounts_api.rb', line 828

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.list_account_proposals ...'
  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 AccountsApi.list_account_proposals"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.list_account_proposals, the character length must be smaller than or equal to 50.'
  end

  # resource path
  local_var_path = '/accounts/{account_id}/purchase_proposals'.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] || 'ProposalsPaginatedResponse'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.list_account_proposals",
    :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: AccountsApi#list_account_proposals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_purchases(account_id, opts = {}) ⇒ PurchasePaginatedListData

(DEPRECATED) Get all purchases for an account Get Purchase information for an account using account_id and price_plan_id

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:



885
886
887
888
 
# File 'lib/togai_client/api/accounts_api.rb', line 885

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

#list_account_purchases_with_http_info(account_id, opts = {}) ⇒ Array<(PurchasePaginatedListData, Integer, Hash)>

(DEPRECATED) Get all purchases for an account Get Purchase information for an account using account_id and price_plan_id

Parameters:

  • account_id (String) —

    account_id corresponding to an account

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

    the optional parameters

Returns:

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

    PurchasePaginatedListData data, response status code and response headers



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/togai_client/api/accounts_api.rb', line 895

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.list_account_purchases ...'
  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 AccountsApi.list_account_purchases"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.list_account_purchases, the character length must be smaller than or equal to 50.'
  end

  # resource path
  local_var_path = '/accounts/{account_id}/purchases'.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] || 'PurchasePaginatedListData'

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

  new_options = opts.merge(
    :operation => :"AccountsApi.list_account_purchases",
    :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: AccountsApi#list_account_purchases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_aliases(account_id, remove_account_aliases_request, opts = {}) ⇒ Account

Remove Aliases to account Remove existing aliases tagged to an account using this API

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • remove_account_aliases_request (RemoveAccountAliasesRequest) —

    Payload to remove aliases from account

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

    the optional parameters

Returns:



953
954
955
956
 
# File 'lib/togai_client/api/accounts_api.rb', line 953

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

#remove_aliases_with_http_info(account_id, remove_account_aliases_request, opts = {}) ⇒ Array<(Account, Integer, Hash)>

Remove Aliases to account Remove existing aliases tagged to an account using this API

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • remove_account_aliases_request (RemoveAccountAliasesRequest) —

    Payload to remove aliases from account

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

    the optional parameters

Returns:

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

    Account data, response status code and response headers



964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/togai_client/api/accounts_api.rb', line 964

def remove_aliases_with_http_info(, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.remove_aliases ...'
  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 AccountsApi.remove_aliases"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.remove_aliases, the character length must be smaller than or equal to 50.'
  end

  # verify the required parameter 'remove_account_aliases_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'remove_account_aliases_request' when calling AccountsApi.remove_aliases"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/remove_aliases'.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']
  # 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()

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.remove_aliases",
    :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: AccountsApi#remove_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account(account_id, update_account_request, opts = {}) ⇒ Account

Update an account This API let’s you to update an account’s information using customer_id and account_id.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • update_account_request (UpdateAccountRequest) —

    Payload to update account

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

    the optional parameters

Returns:



1031
1032
1033
1034
 
# File 'lib/togai_client/api/accounts_api.rb', line 1031

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

#update_account_with_http_info(account_id, update_account_request, opts = {}) ⇒ Array<(Account, Integer, Hash)>

Update an account This API let’s you to update an account’s information using customer_id and account_id.

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • update_account_request (UpdateAccountRequest) —

    Payload to update account

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

    the optional parameters

Returns:

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

    Account data, response status code and response headers



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/togai_client/api/accounts_api.rb', line 1042

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.update_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 AccountsApi.update_account"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.update_account, the character length must be smaller than or equal to 50.'
  end

  # verify the required parameter 'update_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'update_account_request' when calling AccountsApi.update_account"
  end
  # resource path
  local_var_path = '/accounts/{account_id}'.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']
  # 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()

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.update_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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#update_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_pricing_schedule(account_id, update_pricing_schedule_request_with_actions, opts = {}) ⇒ UpdatePricingScheduleResponse

(DEPRECATED) Dissociate or associate a price plan with an account This API let’s you to detach or attach a price plan with an existing account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • update_pricing_schedule_request_with_actions (UpdatePricingScheduleRequestWithActions) —

    Payload to associate or dissociate a price plan to an account with actions

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

    the optional parameters

Returns:



1109
1110
1111
1112
 
# File 'lib/togai_client/api/accounts_api.rb', line 1109

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

#update_pricing_schedule_batch(account_id, edit_pricing_schedule_request, opts = {}) ⇒ UpdatePricingScheduleResponse

(DEPRECATED) Edit schedules of an account. This API let’s you to detach/attach one or more price plans from/to an existing account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • edit_pricing_schedule_request (EditPricingScheduleRequest) —

    Payload to dis/associate one or more price plans to an account

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean)

Returns:



1188
1189
1190
1191
 
# File 'lib/togai_client/api/accounts_api.rb', line 1188

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

#update_pricing_schedule_batch_with_http_info(account_id, edit_pricing_schedule_request, opts = {}) ⇒ Array<(UpdatePricingScheduleResponse, Integer, Hash)>

(DEPRECATED) Edit schedules of an account. This API let’s you to detach/attach one or more price plans from/to an existing account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • edit_pricing_schedule_request (EditPricingScheduleRequest) —

    Payload to dis/associate one or more price plans to an account

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

    the optional parameters

Options Hash (opts):

  • :dry_run (Boolean)

Returns:



1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/togai_client/api/accounts_api.rb', line 1200

def update_pricing_schedule_batch_with_http_info(, edit_pricing_schedule_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.update_pricing_schedule_batch ...'
  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 AccountsApi.update_pricing_schedule_batch"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.update_pricing_schedule_batch, the character length must be smaller than or equal to 50.'
  end

  # verify the required parameter 'edit_pricing_schedule_request' is set
  if @api_client.config.client_side_validation && edit_pricing_schedule_request.nil?
    fail ArgumentError, "Missing the required parameter 'edit_pricing_schedule_request' when calling AccountsApi.update_pricing_schedule_batch"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/edit_schedules'.sub('{' + 'account_id' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dry_run'] = opts[:'dry_run'] if !opts[:'dry_run'].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']
  # 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(edit_pricing_schedule_request)

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.update_pricing_schedule_batch",
    :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: AccountsApi#update_pricing_schedule_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_pricing_schedule_with_http_info(account_id, update_pricing_schedule_request_with_actions, opts = {}) ⇒ Array<(UpdatePricingScheduleResponse, Integer, Hash)>

(DEPRECATED) Dissociate or associate a price plan with an account This API let’s you to detach or attach a price plan with an existing account

Parameters:

  • account_id (String) —

    account_id corresponding to an account

  • update_pricing_schedule_request_with_actions (UpdatePricingScheduleRequestWithActions) —

    Payload to associate or dissociate a price plan to an account with actions

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

    the optional parameters

Returns:



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/togai_client/api/accounts_api.rb', line 1120

def update_pricing_schedule_with_http_info(, update_pricing_schedule_request_with_actions, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.update_pricing_schedule ...'
  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 AccountsApi.update_pricing_schedule"
  end
  if @api_client.config.client_side_validation && .to_s.length > 50
    fail ArgumentError, 'invalid value for "account_id" when calling AccountsApi.update_pricing_schedule, the character length must be smaller than or equal to 50.'
  end

  # verify the required parameter 'update_pricing_schedule_request_with_actions' is set
  if @api_client.config.client_side_validation && update_pricing_schedule_request_with_actions.nil?
    fail ArgumentError, "Missing the required parameter 'update_pricing_schedule_request_with_actions' when calling AccountsApi.update_pricing_schedule"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/price_plans'.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']
  # 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(update_pricing_schedule_request_with_actions)

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.update_pricing_schedule",
    :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: AccountsApi#update_pricing_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_proposal_status(purchase_proposal_id, update_proposal_status, opts = {}) ⇒ Proposal

(DEPRECATED) Approve or decline a purchase of a billing plan This API let’s you to approve or decline a proposal of a billing plan for an account

Parameters:

  • purchase_proposal_id (String)
  • update_proposal_status (UpdateProposalStatus) —

    Payload to approve or decline a proposal

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

    the optional parameters

Returns:



1268
1269
1270
1271
 
# File 'lib/togai_client/api/accounts_api.rb', line 1268

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

#update_proposal_status_with_http_info(purchase_proposal_id, update_proposal_status, opts = {}) ⇒ Array<(Proposal, Integer, Hash)>

(DEPRECATED) Approve or decline a purchase of a billing plan This API let’s you to approve or decline a proposal of a billing plan for an account

Parameters:

  • purchase_proposal_id (String)
  • update_proposal_status (UpdateProposalStatus) —

    Payload to approve or decline a proposal

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

    the optional parameters

Returns:

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

    Proposal data, response status code and response headers



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/togai_client/api/accounts_api.rb', line 1279

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

  # verify the required parameter 'update_proposal_status' is set
  if @api_client.config.client_side_validation && update_proposal_status.nil?
    fail ArgumentError, "Missing the required parameter 'update_proposal_status' when calling AccountsApi.update_proposal_status"
  end
  # resource path
  local_var_path = '/purchase_proposals/{purchase_proposal_id}/update_status'.sub('{' + 'purchase_proposal_id' + '}', CGI.escape(purchase_proposal_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']
  # 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(update_proposal_status)

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

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

  new_options = opts.merge(
    :operation => :"AccountsApi.update_proposal_status",
    :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: AccountsApi#update_proposal_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end