togai_client 1.0.0

data/docs/UpdateUsageMeterRequest.md

@@ -0,0 +1,24 @@
+# TogaiClient::UpdateUsageMeterRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the event | [optional] |
+| **type** | **String** | Type of usage meter * COUNTER - Count usage  * GAUGE - Not supported at the moment * TIMER - Not supported at the moment  |  |
+| **aggregation** | **String** | Aggregation to be applied on usage meter result * COUNT - Counts number of events matching the usage meter * SUM - Sums up results of computation of all events matching usage meter  |  |
+| **computations** | [**Array<Computation>**](Computation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UpdateUsageMeterRequest.new(
+  description: null,
+  type: COUNTER,
+  aggregation: COUNT,
+  computations: null
+)
+```
+

data/docs/UsageMeter.md

@@ -0,0 +1,34 @@
+# TogaiClient::UsageMeter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the usage meter |  |
+| **description** | **String** |  | [optional] |
+| **type** | **String** | Type of usage meter |  |
+| **status** | **String** | Status of usage meter | [optional] |
+| **aggregation** | **String** | Aggregation to be applied on usage meter result |  |
+| **computations** | [**Array<Computation>**](Computation.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **last_activated_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UsageMeter.new(
+  name: rides-usage,
+  description: Meter to track cab rides,
+  type: COUNTER,
+  status: DRAFT,
+  aggregation: COUNT,
+  computations: null,
+  created_at: null,
+  last_activated_at: null,
+  updated_at: null
+)
+```
+

data/docs/UsageMeterPaginatedResponse.md

@@ -0,0 +1,22 @@
+# TogaiClient::UsageMeterPaginatedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<UsageMeter>**](UsageMeter.md) |  | [optional] |
+| **next_token** | **String** |  | [optional] |
+| **context** | [**PaginationOptions**](PaginationOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UsageMeterPaginatedResponse.new(
+  data: null,
+  next_token: null,
+  context: null
+)
+```
+

data/docs/UsageMetersApi.md

@@ -0,0 +1,521 @@
+# TogaiClient::UsageMetersApi
+
+All URIs are relative to *https://sandbox-api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**activate_usage_meter**](UsageMetersApi.md#activate_usage_meter) | **POST** /event_schema/{event_schema_name}/usage_meters/{usage_meter_name}/activate | Activate usage meter |
+| [**create_usage_meter**](UsageMetersApi.md#create_usage_meter) | **POST** /event_schema/{event_schema_name}/usage_meters | Create an usage meter |
+| [**deactivate_usage_meter**](UsageMetersApi.md#deactivate_usage_meter) | **POST** /event_schema/{event_schema_name}/usage_meters/{usage_meter_name}/deactivate | Deactivate usage meter |
+| [**delete_usage_meter**](UsageMetersApi.md#delete_usage_meter) | **DELETE** /usage_meter/{usage_meter_name} | Delete an Usage Meter |
+| [**get_usage_meter**](UsageMetersApi.md#get_usage_meter) | **GET** /event_schema/{event_schema_name}/usage_meters/{usage_meter_name} | Get usage meter |
+| [**get_usage_meters_for_event_schema**](UsageMetersApi.md#get_usage_meters_for_event_schema) | **GET** /event_schema/{event_schema_name}/usage_meters | List usage meters for event schema |
+| [**update_usage_meter**](UsageMetersApi.md#update_usage_meter) | **PATCH** /event_schema/{event_schema_name}/usage_meters/{usage_meter_name} | Update an usage meter |
+
+
+## activate_usage_meter
+
+> <UsageMeter> activate_usage_meter(event_schema_name, usage_meter_name)
+
+Activate usage meter
+
+Activate usage meter
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::UsageMetersApi.new
+event_schema_name = 'event_schema_name_example' # String | 
+usage_meter_name = 'usage_meter_name_example' # String | 
+
+begin
+  # Activate usage meter
+  result = api_instance.activate_usage_meter(event_schema_name, usage_meter_name)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->activate_usage_meter: #{e}"
+end
+```
+
+#### Using the activate_usage_meter_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsageMeter>, Integer, Hash)> activate_usage_meter_with_http_info(event_schema_name, usage_meter_name)
+
+```ruby
+begin
+  # Activate usage meter
+  data, status_code, headers = api_instance.activate_usage_meter_with_http_info(event_schema_name, usage_meter_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsageMeter>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->activate_usage_meter_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_schema_name** | **String** |  |  |
+| **usage_meter_name** | **String** |  |  |
+
+### Return type
+
+[**UsageMeter**](UsageMeter.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_usage_meter
+
+> <UsageMeter> create_usage_meter(event_schema_name, create_usage_meter_request)
+
+Create an usage meter
+
+Create an usage meter
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::UsageMetersApi.new
+event_schema_name = 'event_schema_name_example' # String | 
+create_usage_meter_request = TogaiClient::CreateUsageMeterRequest.new({name: 'name_example', type: 'COUNTER', aggregation: 'COUNT'}) # CreateUsageMeterRequest | Payload to create usage meter
+
+begin
+  # Create an usage meter
+  result = api_instance.create_usage_meter(event_schema_name, create_usage_meter_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->create_usage_meter: #{e}"
+end
+```
+
+#### Using the create_usage_meter_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsageMeter>, Integer, Hash)> create_usage_meter_with_http_info(event_schema_name, create_usage_meter_request)
+
+```ruby
+begin
+  # Create an usage meter
+  data, status_code, headers = api_instance.create_usage_meter_with_http_info(event_schema_name, create_usage_meter_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsageMeter>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->create_usage_meter_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_schema_name** | **String** |  |  |
+| **create_usage_meter_request** | [**CreateUsageMeterRequest**](CreateUsageMeterRequest.md) | Payload to create usage meter |  |
+
+### Return type
+
+[**UsageMeter**](UsageMeter.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deactivate_usage_meter
+
+> <UsageMeter> deactivate_usage_meter(event_schema_name, usage_meter_name)
+
+Deactivate usage meter
+
+Deactivate usage meter
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::UsageMetersApi.new
+event_schema_name = 'event_schema_name_example' # String | 
+usage_meter_name = 'usage_meter_name_example' # String | 
+
+begin
+  # Deactivate usage meter
+  result = api_instance.deactivate_usage_meter(event_schema_name, usage_meter_name)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->deactivate_usage_meter: #{e}"
+end
+```
+
+#### Using the deactivate_usage_meter_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsageMeter>, Integer, Hash)> deactivate_usage_meter_with_http_info(event_schema_name, usage_meter_name)
+
+```ruby
+begin
+  # Deactivate usage meter
+  data, status_code, headers = api_instance.deactivate_usage_meter_with_http_info(event_schema_name, usage_meter_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsageMeter>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->deactivate_usage_meter_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_schema_name** | **String** |  |  |
+| **usage_meter_name** | **String** |  |  |
+
+### Return type
+
+[**UsageMeter**](UsageMeter.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_usage_meter
+
+> <BaseSuccessResponse> delete_usage_meter(usage_meter_name)
+
+Delete an Usage Meter
+
+Delete an Usage Meter
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::UsageMetersApi.new
+usage_meter_name = 'usage_meter_name_example' # String | 
+
+begin
+  # Delete an Usage Meter
+  result = api_instance.delete_usage_meter(usage_meter_name)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->delete_usage_meter: #{e}"
+end
+```
+
+#### Using the delete_usage_meter_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BaseSuccessResponse>, Integer, Hash)> delete_usage_meter_with_http_info(usage_meter_name)
+
+```ruby
+begin
+  # Delete an Usage Meter
+  data, status_code, headers = api_instance.delete_usage_meter_with_http_info(usage_meter_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BaseSuccessResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->delete_usage_meter_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usage_meter_name** | **String** |  |  |
+
+### Return type
+
+[**BaseSuccessResponse**](BaseSuccessResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_usage_meter
+
+> <UsageMeter> get_usage_meter(event_schema_name, usage_meter_name)
+
+Get usage meter
+
+Get usage meter
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::UsageMetersApi.new
+event_schema_name = 'event_schema_name_example' # String | 
+usage_meter_name = 'usage_meter_name_example' # String | 
+
+begin
+  # Get usage meter
+  result = api_instance.get_usage_meter(event_schema_name, usage_meter_name)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->get_usage_meter: #{e}"
+end
+```
+
+#### Using the get_usage_meter_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsageMeter>, Integer, Hash)> get_usage_meter_with_http_info(event_schema_name, usage_meter_name)
+
+```ruby
+begin
+  # Get usage meter
+  data, status_code, headers = api_instance.get_usage_meter_with_http_info(event_schema_name, usage_meter_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsageMeter>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->get_usage_meter_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_schema_name** | **String** |  |  |
+| **usage_meter_name** | **String** |  |  |
+
+### Return type
+
+[**UsageMeter**](UsageMeter.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_usage_meters_for_event_schema
+
+> <UsageMeterPaginatedResponse> get_usage_meters_for_event_schema(event_schema_name, opts)
+
+List usage meters for event schema
+
+List usage meters for event schema with pagination and sort
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::UsageMetersApi.new
+event_schema_name = 'event_schema_name_example' # String | 
+opts = {
+  statuses: 'statuses_example', # String | Filter by provided statuses
+  aggregations: 'aggregations_example', # String | Filter by provided aggregations
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: '10', # String | 
+  sort_order: 'ASC' # String | 
+}
+
+begin
+  # List usage meters for event schema
+  result = api_instance.get_usage_meters_for_event_schema(event_schema_name, opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->get_usage_meters_for_event_schema: #{e}"
+end
+```
+
+#### Using the get_usage_meters_for_event_schema_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsageMeterPaginatedResponse>, Integer, Hash)> get_usage_meters_for_event_schema_with_http_info(event_schema_name, opts)
+
+```ruby
+begin
+  # List usage meters for event schema
+  data, status_code, headers = api_instance.get_usage_meters_for_event_schema_with_http_info(event_schema_name, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsageMeterPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->get_usage_meters_for_event_schema_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_schema_name** | **String** |  |  |
+| **statuses** | **String** | Filter by provided statuses | [optional] |
+| **aggregations** | **String** | Filter by provided aggregations | [optional] |
+| **next_token** | **String** |  | [optional] |
+| **page_size** | **String** |  | [optional] |
+| **sort_order** | **String** |  | [optional] |
+
+### Return type
+
+[**UsageMeterPaginatedResponse**](UsageMeterPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_usage_meter
+
+> <UsageMeter> update_usage_meter(event_schema_name, usage_meter_name, update_usage_meter_request)
+
+Update an usage meter
+
+Update an usage meter
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::UsageMetersApi.new
+event_schema_name = 'event_schema_name_example' # String | 
+usage_meter_name = 'usage_meter_name_example' # String | 
+update_usage_meter_request = TogaiClient::UpdateUsageMeterRequest.new({type: 'COUNTER', aggregation: 'COUNT'}) # UpdateUsageMeterRequest | Payload to create usage meter
+
+begin
+  # Update an usage meter
+  result = api_instance.update_usage_meter(event_schema_name, usage_meter_name, update_usage_meter_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->update_usage_meter: #{e}"
+end
+```
+
+#### Using the update_usage_meter_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UsageMeter>, Integer, Hash)> update_usage_meter_with_http_info(event_schema_name, usage_meter_name, update_usage_meter_request)
+
+```ruby
+begin
+  # Update an usage meter
+  data, status_code, headers = api_instance.update_usage_meter_with_http_info(event_schema_name, usage_meter_name, update_usage_meter_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UsageMeter>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling UsageMetersApi->update_usage_meter_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_schema_name** | **String** |  |  |
+| **usage_meter_name** | **String** |  |  |
+| **update_usage_meter_request** | [**UpdateUsageMeterRequest**](UpdateUsageMeterRequest.md) | Payload to create usage meter |  |
+
+### Return type
+
+[**UsageMeter**](UsageMeter.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UsageStrategy.md

@@ -0,0 +1,22 @@
+# TogaiClient::UsageStrategy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rate** | **Float** |  |  |
+| **start_after** | **Float** |  |  |
+| **order** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UsageStrategy.new(
+  rate: null,
+  start_after: null,
+  order: null
+)
+```
+

data/docs/UserDetails.md

@@ -0,0 +1,26 @@
+# TogaiClient::UserDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preferred_username** | **String** |  | [optional] |
+| **name** | **String** |  |  |
+| **password** | **String** |  |  |
+| **email** | **String** |  |  |
+| **phone** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UserDetails.new(
+  preferred_username: null,
+  name: null,
+  password: null,
+  email: null,
+  phone: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'