Class: TogaiClient::PricePlansApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PricePlansApi

Returns a new instance of PricePlansApi.



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

def api_client
  @api_client
end

Instance Method Details

#activate_price_plan(price_plan_name, opts = {}) ⇒ PricePlan

Activate a price plan Activate a price plan

Parameters:

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

    the optional parameters

Returns:



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

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

#activate_price_plan_with_http_info(price_plan_name, opts = {}) ⇒ Array<(PricePlan, Integer, Hash)>

Activate a price plan Activate a price plan

Parameters:

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

    the optional parameters

Returns:

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

    PricePlan 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
85
86
87
 
# File 'lib/togai_client/api/price_plans_api.rb', line 37

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

  # resource path
  local_var_path = '/price_plans/{price_plan_name}/activate'.sub('{' + 'price_plan_name' + '}', CGI.escape(price_plan_name.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'])

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

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

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

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

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

#create_price_plan(create_price_plan_request, opts = {}) ⇒ PricePlan

Create a price plan Create a price plan

Parameters:

  • create_price_plan_request (CreatePricePlanRequest) —

    Payload to create price plan

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/togai_client/api/price_plans_api.rb', line 94

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

#create_price_plan_with_http_info(create_price_plan_request, opts = {}) ⇒ Array<(PricePlan, Integer, Hash)>

Create a price plan Create a price plan

Parameters:

  • create_price_plan_request (CreatePricePlanRequest) —

    Payload to create price plan

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

    the optional parameters

Returns:

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

    PricePlan data, response status code and response headers



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
152
153
154
155
 
# File 'lib/togai_client/api/price_plans_api.rb', line 104

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

  # 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'])
  # 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_price_plan_request)

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

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

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

#get_price_plan(price_plan_name, opts = {}) ⇒ PricePlan

Get a price plan Get a price plan

Parameters:

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

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/togai_client/api/price_plans_api.rb', line 162

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

#get_price_plan_with_http_info(price_plan_name, opts = {}) ⇒ Array<(PricePlan, Integer, Hash)>

Get a price plan Get a price plan

Parameters:

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

    the optional parameters

Returns:

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

    PricePlan data, response status code and response headers



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
215
216
217
218
219
220
221
222
 
# File 'lib/togai_client/api/price_plans_api.rb', line 172

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

  # resource path
  local_var_path = '/price_plans/{price_plan_name}'.sub('{' + 'price_plan_name' + '}', CGI.escape(price_plan_name.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'])

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

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

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

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

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

#get_price_plans(opts = {}) ⇒ PricePlanPaginatedResponse

List price plans List price plans with pagination and sort

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



230
231
232
233
 
# File 'lib/togai_client/api/price_plans_api.rb', line 230

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

#get_price_plans_with_http_info(opts = {}) ⇒ Array<(PricePlanPaginatedResponse, Integer, Hash)>

List price plans List price plans with pagination and sort

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    PricePlanPaginatedResponse data, response status code and response headers



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

def get_price_plans_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PricePlansApi.get_price_plans ...'
  end
  # resource path
  local_var_path = '/price_plans'

  # 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'])

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

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

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

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

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

#update_price_plan(price_plan_name, update_price_plan_request, opts = {}) ⇒ PricePlan

Update a price plan Update a price plan

Parameters:

  • price_plan_name (String)
  • update_price_plan_request (UpdatePricePlanRequest) —

    Payload to update price plan

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

    the optional parameters

Returns:



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

def update_price_plan(price_plan_name, update_price_plan_request, opts = {})
  data, _status_code, _headers = update_price_plan_with_http_info(price_plan_name, update_price_plan_request, opts)
  data
end

#update_price_plan_with_http_info(price_plan_name, update_price_plan_request, opts = {}) ⇒ Array<(PricePlan, Integer, Hash)>

Update a price plan Update a price plan

Parameters:

  • price_plan_name (String)
  • update_price_plan_request (UpdatePricePlanRequest) —

    Payload to update price plan

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

    the optional parameters

Returns:

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

    PricePlan data, response status code and response headers



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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/togai_client/api/price_plans_api.rb', line 304

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

  # verify the required parameter 'update_price_plan_request' is set
  if @api_client.config.client_side_validation && update_price_plan_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_price_plan_request' when calling PricePlansApi.update_price_plan"
  end
  # resource path
  local_var_path = '/price_plans/{price_plan_name}'.sub('{' + 'price_plan_name' + '}', CGI.escape(price_plan_name.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'])
  # 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_price_plan_request)

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

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

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