Class: TogaiClient::UsageMetersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsageMetersApi

Returns a new instance of UsageMetersApi.



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

def api_client
  @api_client
end

Instance Method Details

#activate_usage_meter(event_schema_name, usage_meter_name, opts = {}) ⇒ UsageMeter

Activate usage meter Activate usage meter

Parameters:

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

    the optional parameters

Returns:



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

def activate_usage_meter(event_schema_name, usage_meter_name, opts = {})
  data, _status_code, _headers = activate_usage_meter_with_http_info(event_schema_name, usage_meter_name, opts)
  data
end

#activate_usage_meter_with_http_info(event_schema_name, usage_meter_name, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>

Activate usage meter Activate usage meter

Parameters:

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

    the optional parameters

Returns:

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

    UsageMeter 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
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 39

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

  # verify the required parameter 'usage_meter_name' is set
  if @api_client.config.client_side_validation && usage_meter_name.nil?
    fail ArgumentError, "Missing the required parameter 'usage_meter_name' when calling UsageMetersApi.activate_usage_meter"
  end
  if @api_client.config.client_side_validation && usage_meter_name.to_s.length > 50
    fail ArgumentError, 'invalid value for "usage_meter_name" when calling UsageMetersApi.activate_usage_meter, the character length must be smaller than or equal to 50.'
  end

  # resource path
  local_var_path = '/event_schema/{event_schema_name}/usage_meters/{usage_meter_name}/activate'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_name.to_s)).sub('{' + 'usage_meter_name' + '}', CGI.escape(usage_meter_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] || 'UsageMeter'

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

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

#create_usage_meter(event_schema_name, create_usage_meter_request, opts = {}) ⇒ UsageMeter

Create an usage meter Create an usage meter

Parameters:

  • event_schema_name (String)
  • create_usage_meter_request (CreateUsageMeterRequest) —

    Payload to create usage meter

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

    the optional parameters

Returns:



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

def create_usage_meter(event_schema_name, create_usage_meter_request, opts = {})
  data, _status_code, _headers = create_usage_meter_with_http_info(event_schema_name, create_usage_meter_request, opts)
  data
end

#create_usage_meter_with_http_info(event_schema_name, create_usage_meter_request, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>

Create an usage meter Create an usage meter

Parameters:

  • event_schema_name (String)
  • create_usage_meter_request (CreateUsageMeterRequest) —

    Payload to create usage meter

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

    the optional parameters

Returns:

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

    UsageMeter data, response status code and response headers



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
167
168
169
170
171
172
173
174
175
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 116

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

  # verify the required parameter 'create_usage_meter_request' is set
  if @api_client.config.client_side_validation && create_usage_meter_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_usage_meter_request' when calling UsageMetersApi.create_usage_meter"
  end
  # resource path
  local_var_path = '/event_schema/{event_schema_name}/usage_meters'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_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(create_usage_meter_request)

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

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

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

#deactivate_usage_meter(event_schema_name, usage_meter_name, opts = {}) ⇒ UsageMeter

Deactivate usage meter Deactivate usage meter

Parameters:

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

    the optional parameters

Returns:



183
184
185
186
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 183

def deactivate_usage_meter(event_schema_name, usage_meter_name, opts = {})
  data, _status_code, _headers = deactivate_usage_meter_with_http_info(event_schema_name, usage_meter_name, opts)
  data
end

#deactivate_usage_meter_with_http_info(event_schema_name, usage_meter_name, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>

Deactivate usage meter Deactivate usage meter

Parameters:

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

    the optional parameters

Returns:

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

    UsageMeter data, response status code and response headers



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

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

  # verify the required parameter 'usage_meter_name' is set
  if @api_client.config.client_side_validation && usage_meter_name.nil?
    fail ArgumentError, "Missing the required parameter 'usage_meter_name' when calling UsageMetersApi.deactivate_usage_meter"
  end
  if @api_client.config.client_side_validation && usage_meter_name.to_s.length > 50
    fail ArgumentError, 'invalid value for "usage_meter_name" when calling UsageMetersApi.deactivate_usage_meter, the character length must be smaller than or equal to 50.'
  end

  # resource path
  local_var_path = '/event_schema/{event_schema_name}/usage_meters/{usage_meter_name}/deactivate'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_name.to_s)).sub('{' + 'usage_meter_name' + '}', CGI.escape(usage_meter_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] || 'UsageMeter'

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

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

#delete_usage_meter(usage_meter_name, opts = {}) ⇒ BaseSuccessResponse

Delete an Usage Meter Delete an Usage Meter

Parameters:

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

    the optional parameters

Returns:



259
260
261
262
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 259

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

#delete_usage_meter_with_http_info(usage_meter_name, opts = {}) ⇒ Array<(BaseSuccessResponse, Integer, Hash)>

Delete an Usage Meter Delete an Usage Meter

Parameters:

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

    the optional parameters

Returns:

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

    BaseSuccessResponse data, response status code and response headers



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
312
313
314
315
316
317
318
319
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 269

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

  # resource path
  local_var_path = '/usage_meter/{usage_meter_name}'.sub('{' + 'usage_meter_name' + '}', CGI.escape(usage_meter_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] || 'BaseSuccessResponse'

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

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

#get_usage_meter(event_schema_name, usage_meter_name, opts = {}) ⇒ UsageMeter

Get usage meter Get usage meter

Parameters:

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

    the optional parameters

Returns:



327
328
329
330
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 327

def get_usage_meter(event_schema_name, usage_meter_name, opts = {})
  data, _status_code, _headers = get_usage_meter_with_http_info(event_schema_name, usage_meter_name, opts)
  data
end

#get_usage_meter_with_http_info(event_schema_name, usage_meter_name, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>

Get usage meter Get usage meter

Parameters:

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

    the optional parameters

Returns:

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

    UsageMeter data, response status code and response headers



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
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 338

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

  # verify the required parameter 'usage_meter_name' is set
  if @api_client.config.client_side_validation && usage_meter_name.nil?
    fail ArgumentError, "Missing the required parameter 'usage_meter_name' when calling UsageMetersApi.get_usage_meter"
  end
  if @api_client.config.client_side_validation && usage_meter_name.to_s.length > 50
    fail ArgumentError, 'invalid value for "usage_meter_name" when calling UsageMetersApi.get_usage_meter, the character length must be smaller than or equal to 50.'
  end

  # resource path
  local_var_path = '/event_schema/{event_schema_name}/usage_meters/{usage_meter_name}'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_name.to_s)).sub('{' + 'usage_meter_name' + '}', CGI.escape(usage_meter_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] || 'UsageMeter'

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

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

#get_usage_meters_for_event_schema(event_schema_name, opts = {}) ⇒ UsageMeterPaginatedResponse

List usage meters for event schema List usage meters for event schema with pagination and sort

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :statuses (String) —

    Filter by provided statuses

  • :aggregations (String) —

    Filter by provided aggregations

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

Returns:



408
409
410
411
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 408

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

#get_usage_meters_for_event_schema_with_http_info(event_schema_name, opts = {}) ⇒ Array<(UsageMeterPaginatedResponse, Integer, Hash)>

List usage meters for event schema List usage meters for event schema with pagination and sort

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :statuses (String) —

    Filter by provided statuses

  • :aggregations (String) —

    Filter by provided aggregations

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

Returns:

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

    UsageMeterPaginatedResponse data, response status code and response headers



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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 423

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

  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
    fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/event_schema/{event_schema_name}/usage_meters'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'statuses'] = opts[:'statuses'] if !opts[:'statuses'].nil?
  query_params[:'aggregations'] = opts[:'aggregations'] if !opts[:'aggregations'].nil?
  query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].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] || 'UsageMeterPaginatedResponse'

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

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

#update_usage_meter(event_schema_name, usage_meter_name, update_usage_meter_request, opts = {}) ⇒ UsageMeter

Update an usage meter Update an usage meter

Parameters:

  • event_schema_name (String)
  • usage_meter_name (String)
  • update_usage_meter_request (UpdateUsageMeterRequest) —

    Payload to create usage meter

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

    the optional parameters

Returns:



491
492
493
494
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 491

def update_usage_meter(event_schema_name, usage_meter_name, update_usage_meter_request, opts = {})
  data, _status_code, _headers = update_usage_meter_with_http_info(event_schema_name, usage_meter_name, update_usage_meter_request, opts)
  data
end

#update_usage_meter_with_http_info(event_schema_name, usage_meter_name, update_usage_meter_request, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>

Update an usage meter Update an usage meter

Parameters:

  • event_schema_name (String)
  • usage_meter_name (String)
  • update_usage_meter_request (UpdateUsageMeterRequest) —

    Payload to create usage meter

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

    the optional parameters

Returns:

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

    UsageMeter data, response status code and response headers



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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/togai_client/api/usage_meters_api.rb', line 503

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

  # verify the required parameter 'usage_meter_name' is set
  if @api_client.config.client_side_validation && usage_meter_name.nil?
    fail ArgumentError, "Missing the required parameter 'usage_meter_name' when calling UsageMetersApi.update_usage_meter"
  end
  if @api_client.config.client_side_validation && usage_meter_name.to_s.length > 50
    fail ArgumentError, 'invalid value for "usage_meter_name" when calling UsageMetersApi.update_usage_meter, the character length must be smaller than or equal to 50.'
  end

  # verify the required parameter 'update_usage_meter_request' is set
  if @api_client.config.client_side_validation && update_usage_meter_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_usage_meter_request' when calling UsageMetersApi.update_usage_meter"
  end
  # resource path
  local_var_path = '/event_schema/{event_schema_name}/usage_meters/{usage_meter_name}'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_name.to_s)).sub('{' + 'usage_meter_name' + '}', CGI.escape(usage_meter_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_usage_meter_request)

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

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

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