Class: TogaiClient::UsageMetersApi
- Inherits:
-
Object
- Object
- TogaiClient::UsageMetersApi
- Defined in:
- lib/togai_client/api/usage_meters_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#activate_usage_meter(usage_meter_id, opts = {}) ⇒ UsageMeter
Activate usage meter Activate usage meter.
-
#activate_usage_meter_with_http_info(usage_meter_id, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Activate usage meter Activate usage meter.
-
#create_usage_meter(create_usage_meter_request, opts = {}) ⇒ UsageMeter
Create an usage meter Create an usage meter and associate with an event schema.
-
#create_usage_meter_with_http_info(create_usage_meter_request, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Create an usage meter Create an usage meter and associate with an event schema.
-
#deactivate_usage_meter(usage_meter_id, opts = {}) ⇒ UsageMeter
Deactivate usage meter Make an existing active usage meter to be inactive Active Usage Meters with active Pricing Plan attached can also be deactivated.
-
#deactivate_usage_meter_with_http_info(usage_meter_id, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Deactivate usage meter Make an existing active usage meter to be inactive Active Usage Meters with active Pricing Plan attached can also be deactivated.
-
#delete_usage_meter(usage_meter_id, opts = {}) ⇒ BaseSuccessResponse
Delete an Usage Meter Delete an Usage Meter.
-
#delete_usage_meter_with_http_info(usage_meter_id, opts = {}) ⇒ Array<(BaseSuccessResponse, Integer, Hash)>
Delete an Usage Meter Delete an Usage Meter.
-
#get_usage_meter(usage_meter_id, opts = {}) ⇒ UsageMeter
Get usage meter Get an usage meter using event schema name and usage meter id.
-
#get_usage_meter_with_http_info(usage_meter_id, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Get usage meter Get an usage meter using event schema name and usage meter id.
-
#get_usage_meters_for_event_schema(opts = {}) ⇒ UsageMeterPaginatedResponse
List usage meters for event schema Get a list of usage meters associated with an event schema.
-
#get_usage_meters_for_event_schema_with_http_info(opts = {}) ⇒ Array<(UsageMeterPaginatedResponse, Integer, Hash)>
List usage meters for event schema Get a list of usage meters associated with an event schema.
-
#initialize(api_client = ApiClient.default) ⇒ UsageMetersApi
constructor
A new instance of UsageMetersApi.
-
#update_usage_meter(usage_meter_id, update_usage_meter_request, opts = {}) ⇒ UsageMeter
Update an usage meter This API lets you update an existing usage meter.
-
#update_usage_meter_with_http_info(usage_meter_id, update_usage_meter_request, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Update an usage meter This API lets you update an existing usage meter.
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(usage_meter_id, opts = {}) ⇒ UsageMeter
Activate usage meter Activate usage meter
27 28 29 30 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 27 def activate_usage_meter(usage_meter_id, opts = {}) data, _status_code, _headers = activate_usage_meter_with_http_info(usage_meter_id, opts) data end |
#activate_usage_meter_with_http_info(usage_meter_id, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Activate usage meter Activate usage meter
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/usage_meters_api.rb', line 37 def activate_usage_meter_with_http_info(usage_meter_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsageMetersApi.activate_usage_meter ...' end # verify the required parameter 'usage_meter_id' is set if @api_client.config.client_side_validation && usage_meter_id.nil? fail ArgumentError, "Missing the required parameter 'usage_meter_id' when calling UsageMetersApi.activate_usage_meter" end if @api_client.config.client_side_validation && usage_meter_id.to_s.length > 50 fail ArgumentError, 'invalid value for "usage_meter_id" when calling UsageMetersApi.activate_usage_meter, the character length must be smaller than or equal to 50.' end # resource path local_var_path = '/usage_meters/{usage_meter_id}/activate'.sub('{' + 'usage_meter_id' + '}', CGI.escape(usage_meter_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] || 'UsageMeter' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = 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, ) 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(create_usage_meter_request, opts = {}) ⇒ UsageMeter
Create an usage meter Create an usage meter and associate with an event schema
94 95 96 97 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 94 def create_usage_meter(create_usage_meter_request, opts = {}) data, _status_code, _headers = create_usage_meter_with_http_info(create_usage_meter_request, opts) data end |
#create_usage_meter_with_http_info(create_usage_meter_request, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Create an usage meter Create an usage meter and associate with an event schema
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/usage_meters_api.rb', line 104 def create_usage_meter_with_http_info(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 '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 = '/usage_meters' # 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_usage_meter_request) # return_type return_type = opts[:debug_return_type] || 'UsageMeter' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = 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, ) 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(usage_meter_id, opts = {}) ⇒ UsageMeter
Deactivate usage meter Make an existing active usage meter to be inactive Active Usage Meters with active Pricing Plan attached can also be deactivated.
162 163 164 165 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 162 def deactivate_usage_meter(usage_meter_id, opts = {}) data, _status_code, _headers = deactivate_usage_meter_with_http_info(usage_meter_id, opts) data end |
#deactivate_usage_meter_with_http_info(usage_meter_id, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Deactivate usage meter Make an existing active usage meter to be inactive Active Usage Meters with active Pricing Plan attached can also be deactivated.
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/usage_meters_api.rb', line 172 def deactivate_usage_meter_with_http_info(usage_meter_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsageMetersApi.deactivate_usage_meter ...' end # verify the required parameter 'usage_meter_id' is set if @api_client.config.client_side_validation && usage_meter_id.nil? fail ArgumentError, "Missing the required parameter 'usage_meter_id' when calling UsageMetersApi.deactivate_usage_meter" end if @api_client.config.client_side_validation && usage_meter_id.to_s.length > 50 fail ArgumentError, 'invalid value for "usage_meter_id" when calling UsageMetersApi.deactivate_usage_meter, the character length must be smaller than or equal to 50.' end # resource path local_var_path = '/usage_meters/{usage_meter_id}/deactivate'.sub('{' + 'usage_meter_id' + '}', CGI.escape(usage_meter_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] || 'UsageMeter' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = 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, ) 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_id, opts = {}) ⇒ BaseSuccessResponse
Delete an Usage Meter Delete an Usage Meter
229 230 231 232 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 229 def delete_usage_meter(usage_meter_id, opts = {}) data, _status_code, _headers = delete_usage_meter_with_http_info(usage_meter_id, opts) data end |
#delete_usage_meter_with_http_info(usage_meter_id, opts = {}) ⇒ Array<(BaseSuccessResponse, Integer, Hash)>
Delete an Usage Meter Delete an Usage Meter
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 239 def delete_usage_meter_with_http_info(usage_meter_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsageMetersApi.delete_usage_meter ...' end # verify the required parameter 'usage_meter_id' is set if @api_client.config.client_side_validation && usage_meter_id.nil? fail ArgumentError, "Missing the required parameter 'usage_meter_id' when calling UsageMetersApi.delete_usage_meter" end if @api_client.config.client_side_validation && usage_meter_id.to_s.length > 50 fail ArgumentError, 'invalid value for "usage_meter_id" when calling UsageMetersApi.delete_usage_meter, the character length must be smaller than or equal to 50.' end # resource path local_var_path = '/usage_meters/{usage_meter_id}'.sub('{' + 'usage_meter_id' + '}', CGI.escape(usage_meter_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] || 'BaseSuccessResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = 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, ) 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(usage_meter_id, opts = {}) ⇒ UsageMeter
Get usage meter Get an usage meter using event schema name and usage meter id.
297 298 299 300 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 297 def get_usage_meter(usage_meter_id, opts = {}) data, _status_code, _headers = get_usage_meter_with_http_info(usage_meter_id, opts) data end |
#get_usage_meter_with_http_info(usage_meter_id, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Get usage meter Get an usage meter using event schema name and usage meter id.
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 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 308 def get_usage_meter_with_http_info(usage_meter_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsageMetersApi.get_usage_meter ...' end # verify the required parameter 'usage_meter_id' is set if @api_client.config.client_side_validation && usage_meter_id.nil? fail ArgumentError, "Missing the required parameter 'usage_meter_id' when calling UsageMetersApi.get_usage_meter" end if @api_client.config.client_side_validation && usage_meter_id.to_s.length > 50 fail ArgumentError, 'invalid value for "usage_meter_id" when calling UsageMetersApi.get_usage_meter, the character length must be smaller than or equal to 50.' end # resource path local_var_path = '/usage_meters/{usage_meter_id}'.sub('{' + 'usage_meter_id' + '}', CGI.escape(usage_meter_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'includeSchema'] = opts[:'include_schema'] if !opts[:'include_schema'].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] || 'UsageMeter' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = 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, ) 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(opts = {}) ⇒ UsageMeterPaginatedResponse
List usage meters for event schema Get a list of usage meters associated with an event schema
369 370 371 372 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 369 def get_usage_meters_for_event_schema(opts = {}) data, _status_code, _headers = get_usage_meters_for_event_schema_with_http_info(opts) data end |
#get_usage_meters_for_event_schema_with_http_info(opts = {}) ⇒ Array<(UsageMeterPaginatedResponse, Integer, Hash)>
List usage meters for event schema Get a list of usage meters associated with an event schema
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 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 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 382 def get_usage_meters_for_event_schema_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsageMetersApi.get_usage_meters_for_event_schema ...' end allowable_values = ["ACTIVE", "INACTIVE"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end allowable_values = ["COUNT", "SUM"] if @api_client.config.client_side_validation && opts[:'aggregations'] && !allowable_values.include?(opts[:'aggregations']) fail ArgumentError, "invalid value for \"aggregations\", must be one of #{allowable_values}" end # resource path local_var_path = '/usage_meters' # query parameters query_params = opts[:query_params] || {} query_params[:'status'] = opts[:'status'] if !opts[:'status'].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? # 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] || 'UsageMeterPaginatedResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = 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, ) 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(usage_meter_id, update_usage_meter_request, opts = {}) ⇒ UsageMeter
Update an usage meter This API lets you update an existing usage meter.
444 445 446 447 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 444 def update_usage_meter(usage_meter_id, update_usage_meter_request, opts = {}) data, _status_code, _headers = update_usage_meter_with_http_info(usage_meter_id, update_usage_meter_request, opts) data end |
#update_usage_meter_with_http_info(usage_meter_id, update_usage_meter_request, opts = {}) ⇒ Array<(UsageMeter, Integer, Hash)>
Update an usage meter This API lets you update an existing usage meter.
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 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 |
# File 'lib/togai_client/api/usage_meters_api.rb', line 455 def update_usage_meter_with_http_info(usage_meter_id, 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 'usage_meter_id' is set if @api_client.config.client_side_validation && usage_meter_id.nil? fail ArgumentError, "Missing the required parameter 'usage_meter_id' when calling UsageMetersApi.update_usage_meter" end if @api_client.config.client_side_validation && usage_meter_id.to_s.length > 50 fail ArgumentError, 'invalid value for "usage_meter_id" 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 = '/usage_meters/{usage_meter_id}'.sub('{' + 'usage_meter_id' + '}', CGI.escape(usage_meter_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_usage_meter_request) # return_type return_type = opts[:debug_return_type] || 'UsageMeter' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = 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, ) 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 |