togai_client 1.0.0

data/docs/EventAttribute.md

@@ -0,0 +1,22 @@
+# TogaiClient::EventAttribute
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attribute_name** | **String** | Name of the event attribute |  |
+| **attribute_value** | **String** | Value of the event attribute |  |
+| **attribute_value_unit** | **String** | Unit with which the attribute value was measured. Natively supported units - \"Meters, Miles, Kilometers, Grams, Kilograms, ounces, Pounds, Minutes, Hours, Seconds, Milliseconds, Microseconds, None\". Clients are free to add any other custom units. | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventAttribute.new(
+  attribute_name: apiUsage,
+  attribute_value: null,
+  attribute_value_unit: null
+)
+```
+

data/docs/EventAttributeSchema.md

@@ -0,0 +1,20 @@
+# TogaiClient::EventAttributeSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the event attribute. |  |
+| **default_unit** | **String** | Unit for the attribute | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventAttributeSchema.new(
+  name: distance,
+  default_unit: kms
+)
+```
+

data/docs/EventIngestionApi.md

@@ -0,0 +1,146 @@
+# TogaiClient::EventIngestionApi
+
+All URIs are relative to *https://sandbox-api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**ingest**](EventIngestionApi.md#ingest) | **POST** /ingest | Ingest events to Togai |
+| [**ingest_batch**](EventIngestionApi.md#ingest_batch) | **POST** /ingestBatch | Ingest events to Togai in batch |
+
+
+## ingest
+
+> ingest(ingest_event_request)
+
+Ingest events to Togai
+
+API to ingest your application event to Togai for billing and usage analytics. To know the limits on the ingestion api, check our docs - https://togai.com/docs/limits.
+
+### 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::EventIngestionApi.new
+ingest_event_request = TogaiClient::IngestEventRequest.new # IngestEventRequest | Request body to ingest events to Togai usage and billing management service.
+
+begin
+  # Ingest events to Togai
+  api_instance.ingest(ingest_event_request)
+rescue TogaiClient::ApiError => e
+  puts "Error when calling EventIngestionApi->ingest: #{e}"
+end
+```
+
+#### Using the ingest_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> ingest_with_http_info(ingest_event_request)
+
+```ruby
+begin
+  # Ingest events to Togai
+  data, status_code, headers = api_instance.ingest_with_http_info(ingest_event_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TogaiClient::ApiError => e
+  puts "Error when calling EventIngestionApi->ingest_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ingest_event_request** | [**IngestEventRequest**](IngestEventRequest.md) | Request body to ingest events to Togai usage and billing management service. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## ingest_batch
+
+> <IngestBatchEventResponse> ingest_batch(ingest_batch_event_request)
+
+Ingest events to Togai in batch
+
+API to ingest your application event in batch to Togai for billing and usage analytics. To know the limits on the ingestion api, check our docs - https://togai.com/docs/limits.
+
+### 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::EventIngestionApi.new
+ingest_batch_event_request = TogaiClient::IngestBatchEventRequest.new({events: [TogaiClient::Event.new({event_name: 'event_name_example', id: 'id_example', event_timestamp: Time.now, account_id: 'account_id_example', event_attributes: [TogaiClient::EventAttribute.new({attribute_name: 'apiUsage', attribute_value: 'attribute_value_example'})], dimensions: { key: 'inner_example'}})]}) # IngestBatchEventRequest | Request body to ingest events in batch to Togai usage and billing management service.
+
+begin
+  # Ingest events to Togai in batch
+  result = api_instance.ingest_batch(ingest_batch_event_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling EventIngestionApi->ingest_batch: #{e}"
+end
+```
+
+#### Using the ingest_batch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IngestBatchEventResponse>, Integer, Hash)> ingest_batch_with_http_info(ingest_batch_event_request)
+
+```ruby
+begin
+  # Ingest events to Togai in batch
+  data, status_code, headers = api_instance.ingest_batch_with_http_info(ingest_batch_event_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IngestBatchEventResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling EventIngestionApi->ingest_batch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ingest_batch_event_request** | [**IngestBatchEventRequest**](IngestBatchEventRequest.md) | Request body to ingest events in batch to Togai usage and billing management service. |  |
+
+### Return type
+
+[**IngestBatchEventResponse**](IngestBatchEventResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EventManagementApi.md

@@ -0,0 +1,159 @@
+# TogaiClient::EventManagementApi
+
+All URIs are relative to *https://sandbox-api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_events**](EventManagementApi.md#get_events) | **GET** /events | Get usage events from Togai |
+| [**get_single_event**](EventManagementApi.md#get_single_event) | **GET** /events/{event_id} | Get the usage event given event id. |
+
+
+## get_events
+
+> <GetEventsResponse> get_events(opts)
+
+Get usage events from Togai
+
+API to get usage events ingested to Togai.
+
+### 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::EventManagementApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | Pagination token used as a marker to get records from next page.
+  status: 'PROCESSED', # String | Filter option to filter the events by processed/unprocessed status.
+  account_id: '1234', # String | Filter option to filter the events based on account id.
+  page_size: 10, # Integer | Maximum page size expected by client to return the record list.    NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.
+  start_time: 1650110402000, # Integer | Start time filter in epoch milli seconds
+  end_time: 1650110402000 # Integer | End time filter in epoch milli seconds
+}
+
+begin
+  # Get usage events from Togai
+  result = api_instance.get_events(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling EventManagementApi->get_events: #{e}"
+end
+```
+
+#### Using the get_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetEventsResponse>, Integer, Hash)> get_events_with_http_info(opts)
+
+```ruby
+begin
+  # Get usage events from Togai
+  data, status_code, headers = api_instance.get_events_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetEventsResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling EventManagementApi->get_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_token** | **String** | Pagination token used as a marker to get records from next page. | [optional] |
+| **status** | **String** | Filter option to filter the events by processed/unprocessed status. | [optional] |
+| **account_id** | **String** | Filter option to filter the events based on account id. | [optional] |
+| **page_size** | **Integer** | Maximum page size expected by client to return the record list.    NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided. | [optional] |
+| **start_time** | **Integer** | Start time filter in epoch milli seconds | [optional] |
+| **end_time** | **Integer** | End time filter in epoch milli seconds | [optional] |
+
+### Return type
+
+[**GetEventsResponse**](GetEventsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_single_event
+
+> <GetEventResponse> get_single_event(event_id)
+
+Get the usage event given event id.
+
+API to get the event given the event id.
+
+### 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::EventManagementApi.new
+event_id = 'event_id_example' # String | 
+
+begin
+  # Get the usage event given event id.
+  result = api_instance.get_single_event(event_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling EventManagementApi->get_single_event: #{e}"
+end
+```
+
+#### Using the get_single_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetEventResponse>, Integer, Hash)> get_single_event_with_http_info(event_id)
+
+```ruby
+begin
+  # Get the usage event given event id.
+  data, status_code, headers = api_instance.get_single_event_with_http_info(event_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetEventResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling EventManagementApi->get_single_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** |  |  |
+
+### Return type
+
+[**GetEventResponse**](GetEventResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/EventPipelineInfo.md

@@ -0,0 +1,26 @@
+# TogaiClient::EventPipelineInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_schema** | [**EventPipelineInfoEventSchema**](EventPipelineInfoEventSchema.md) |  | [optional] |
+| **usage_meters** | [**Array<EventPipelineInfoUsageMetersInner>**](EventPipelineInfoUsageMetersInner.md) |  | [optional] |
+| **price_plans** | [**Array<EventPipelineInfoPricePlansInner>**](EventPipelineInfoPricePlansInner.md) |  | [optional] |
+| **account** | [**EventPipelineInfoAccount**](EventPipelineInfoAccount.md) |  | [optional] |
+| **customer** | [**EventPipelineInfoCustomer**](EventPipelineInfoCustomer.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventPipelineInfo.new(
+  event_schema: null,
+  usage_meters: null,
+  price_plans: null,
+  account: null,
+  customer: null
+)
+```
+

data/docs/EventPipelineInfoAccount.md

@@ -0,0 +1,20 @@
+# TogaiClient::EventPipelineInfoAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventPipelineInfoAccount.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/EventPipelineInfoCustomer.md

@@ -0,0 +1,20 @@
+# TogaiClient::EventPipelineInfoCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventPipelineInfoCustomer.new(
+  id: null,
+  name: null
+)
+```
+

data/docs/EventPipelineInfoEventSchema.md

@@ -0,0 +1,20 @@
+# TogaiClient::EventPipelineInfoEventSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **version** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventPipelineInfoEventSchema.new(
+  name: null,
+  version: null
+)
+```
+

data/docs/EventPipelineInfoPricePlansInner.md

@@ -0,0 +1,26 @@
+# TogaiClient::EventPipelineInfoPricePlansInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **id** | **String** |  |  |
+| **cycle_start** | **Date** |  |  |
+| **cycle_end** | **Date** |  |  |
+| **usage_meters** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventPipelineInfoPricePlansInner.new(
+  name: null,
+  id: null,
+  cycle_start: null,
+  cycle_end: null,
+  usage_meters: null
+)
+```
+

data/docs/EventPipelineInfoUsageMetersInner.md

@@ -0,0 +1,24 @@
+# TogaiClient::EventPipelineInfoUsageMetersInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **version** | **Integer** |  |  |
+| **status** | **String** |  |  |
+| **units** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventPipelineInfoUsageMetersInner.new(
+  name: null,
+  version: null,
+  status: null,
+  units: null
+)
+```
+

data/docs/EventSchema.md

@@ -0,0 +1,32 @@
+# TogaiClient::EventSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the event. Must be unique for an organization. |  |
+| **description** | **String** | Description of the event | [optional] |
+| **version** | **Integer** | Version of event schema |  |
+| **status** | **String** | Status of event schema * DRAFT - Schema is in draft state  * ACTIVE - Schema is currently active  * INACTIVE - Schema is currently inactive * ARCHIVED - Older version of event schema  | [optional] |
+| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) |  |  |
+| **dimensions** | [**Array<DimensionsSchema>**](DimensionsSchema.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventSchema.new(
+  name: null,
+  description: null,
+  version: 1,
+  status: DRAFT,
+  attributes: null,
+  dimensions: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/EventSchemaListData.md

@@ -0,0 +1,34 @@
+# TogaiClient::EventSchemaListData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the event. Must be unique for an organization. |  |
+| **description** | **String** | Description of the event | [optional] |
+| **version** | **Integer** | Version of event schema |  |
+| **status** | **String** | Status of event schema * DRAFT - Schema is in draft state  * ACTIVE - Schema is currently active  * INACTIVE - Schema is currently inactive * ARCHIVED - Older version of event schema  | [optional] |
+| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) |  |  |
+| **dimensions** | [**Array<DimensionsSchema>**](DimensionsSchema.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+| **associated_usage_meters** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventSchemaListData.new(
+  name: null,
+  description: null,
+  version: 1,
+  status: DRAFT,
+  attributes: null,
+  dimensions: null,
+  created_at: null,
+  updated_at: null,
+  associated_usage_meters: null
+)
+```
+

data/docs/EventSchemaListDataAllOf.md

@@ -0,0 +1,18 @@
+# TogaiClient::EventSchemaListDataAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **associated_usage_meters** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventSchemaListDataAllOf.new(
+  associated_usage_meters: null
+)
+```
+

data/docs/EventSchemaListPaginatedResponse.md

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

data/docs/EventSchemaVersionsResponse.md

@@ -0,0 +1,18 @@
+# TogaiClient::EventSchemaVersionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<EventSchema>**](EventSchema.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EventSchemaVersionsResponse.new(
+  data: null
+)
+```
+