togai_client 1.0.0

data/docs/BundleStrategyUsageMetersValue.md

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

data/docs/Computation.md

@@ -0,0 +1,31 @@
+# TogaiClient::Computation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Optional identifier describing the matcher and computation pair | [optional] |
+| **matcher** | **String** | Condition to be applied on event. Upon matching it the corresponding computation will be considered for usage_meter unit calculation. The result of the matcher needs to be truthy (https://jsonlogic.com/truthy.html) in order to be considered as a match.  | [optional] |
+| **computation** | **String** | Computation to be applied on an event if it matches the matcher In case of a COUNT aggregation type, computation should be passed as '1'  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Computation.new(
+  id: null,
+  matcher: {
+  "and": [
+    {"in": [{"var": "dimension.city"}, "chennai", "mumbai"]},
+    "or": [
+      {">": [{"var": "attribute.distance"}, 100]},
+      {"<": [{"var": "attribute.distance"}, 20]}
+    ]
+  ]
+}
+,
+  computation: {"*":[{"var":"attributes.distance"},0.4]}
+)
+```
+

data/docs/CreateAccountRequest.md

@@ -0,0 +1,22 @@
+# TogaiClient::CreateAccountRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the account |  |
+| **name** | **String** | Name of the customer |  |
+| **aliases** | **Array<String>** | list of aliases for the account. Can be used interchangeably with 'id' for event ingestion. | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CreateAccountRequest.new(
+  id: null,
+  name: null,
+  aliases: null
+)
+```
+

data/docs/CreateCustomerRequest.md

@@ -0,0 +1,26 @@
+# TogaiClient::CreateCustomerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Customer identifier |  |
+| **name** | **String** | Name of the customer |  |
+| **primary_email** | **String** | Primary email of the customer |  |
+| **billing_address** | **String** | billing address of the customer |  |
+| **account** | [**CreateAccountRequest**](CreateAccountRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CreateCustomerRequest.new(
+  id: null,
+  name: null,
+  primary_email: null,
+  billing_address: null,
+  account: null
+)
+```
+

data/docs/CreateCustomerResponse.md

@@ -0,0 +1,26 @@
+# TogaiClient::CreateCustomerResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of customer |  |
+| **name** | **String** | Name of the customer |  |
+| **primary_email** | **String** | Primary email of the customer |  |
+| **billing_address** | **String** | billing address of the customer |  |
+| **account** | [**Account**](Account.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CreateCustomerResponse.new(
+  id: null,
+  name: null,
+  primary_email: null,
+  billing_address: null,
+  account: null
+)
+```
+

data/docs/CreateEventSchemaRequest.md

@@ -0,0 +1,24 @@
+# TogaiClient::CreateEventSchemaRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the event. Must be unique for an organization. |  |
+| **description** | **String** | Description of the event | [optional] |
+| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) |  |  |
+| **dimensions** | [**Array<DimensionsSchema>**](DimensionsSchema.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CreateEventSchemaRequest.new(
+  name: null,
+  description: null,
+  attributes: null,
+  dimensions: null
+)
+```
+

data/docs/CreatePricePlanRequest.md

@@ -0,0 +1,24 @@
+# TogaiClient::CreatePricePlanRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the price plan |  |
+| **description** | **String** | Description of price plan | [optional] |
+| **pricing_cycle** | [**PricingCycle**](PricingCycle.md) |  |  |
+| **rate_card** | [**RateCard**](RateCard.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CreatePricePlanRequest.new(
+  name: null,
+  description: null,
+  pricing_cycle: null,
+  rate_card: null
+)
+```
+

data/docs/CreateUsageMeterRequest.md

@@ -0,0 +1,26 @@
+# TogaiClient::CreateUsageMeterRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the event. Must be unique for an organization. |  |
+| **description** | **String** | Description of the event | [optional] |
+| **type** | **String** | Type of usage meter |  |
+| **aggregation** | **String** | Aggregation to be applied on usage meter result |  |
+| **computations** | [**Array<Computation>**](Computation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CreateUsageMeterRequest.new(
+  name: null,
+  description: null,
+  type: COUNTER,
+  aggregation: DRAFT,
+  computations: null
+)
+```
+

data/docs/Customer.md

@@ -0,0 +1,30 @@
+# TogaiClient::Customer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of customer |  |
+| **name** | **String** | Name of the customer |  |
+| **primary_email** | **String** | Primary email of the customer |  |
+| **billing_address** | **String** | billing address of the customer |  |
+| **status** | **String** | Status of the customer |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Customer.new(
+  id: null,
+  name: null,
+  primary_email: null,
+  billing_address: null,
+  status: ACTIVE,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/CustomerPaginatedResponse.md

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

data/docs/CustomersApi.md

@@ -0,0 +1,363 @@
+# TogaiClient::CustomersApi
+
+All URIs are relative to *https://sandbox-api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_customer**](CustomersApi.md#create_customer) | **POST** /customers | Create a customer |
+| [**delete_customer**](CustomersApi.md#delete_customer) | **DELETE** /customers/{customer_id} | Delete a customer |
+| [**get_customer**](CustomersApi.md#get_customer) | **GET** /customers/{customer_id} | Get a customer |
+| [**get_customers**](CustomersApi.md#get_customers) | **GET** /customers | List customers |
+| [**update_customer**](CustomersApi.md#update_customer) | **PATCH** /customers/{customer_id} | Update a customer |
+
+
+## create_customer
+
+> <CreateCustomerResponse> create_customer(create_customer_request)
+
+Create a customer
+
+Create a customer and a default account corresponding to it
+
+### 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::CustomersApi.new
+create_customer_request = TogaiClient::CreateCustomerRequest.new({id: 'id_example', name: 'name_example', primary_email: 'primary_email_example', billing_address: 'billing_address_example'}) # CreateCustomerRequest | Payload to create customer
+
+begin
+  # Create a customer
+  result = api_instance.create_customer(create_customer_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->create_customer: #{e}"
+end
+```
+
+#### Using the create_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCustomerResponse>, Integer, Hash)> create_customer_with_http_info(create_customer_request)
+
+```ruby
+begin
+  # Create a customer
+  data, status_code, headers = api_instance.create_customer_with_http_info(create_customer_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCustomerResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->create_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_customer_request** | [**CreateCustomerRequest**](CreateCustomerRequest.md) | Payload to create customer |  |
+
+### Return type
+
+[**CreateCustomerResponse**](CreateCustomerResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_customer
+
+> <BaseSuccessResponse> delete_customer(customer_id)
+
+Delete a customer
+
+Delete a customer by 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::CustomersApi.new
+customer_id = 'customer_id_example' # String | 
+
+begin
+  # Delete a customer
+  result = api_instance.delete_customer(customer_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->delete_customer: #{e}"
+end
+```
+
+#### Using the delete_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BaseSuccessResponse>, Integer, Hash)> delete_customer_with_http_info(customer_id)
+
+```ruby
+begin
+  # Delete a customer
+  data, status_code, headers = api_instance.delete_customer_with_http_info(customer_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BaseSuccessResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->delete_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+
+### Return type
+
+[**BaseSuccessResponse**](BaseSuccessResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_customer
+
+> <Customer> get_customer(customer_id)
+
+Get a customer
+
+Get a customer by 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::CustomersApi.new
+customer_id = 'customer_id_example' # String | 
+
+begin
+  # Get a customer
+  result = api_instance.get_customer(customer_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->get_customer: #{e}"
+end
+```
+
+#### Using the get_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Customer>, Integer, Hash)> get_customer_with_http_info(customer_id)
+
+```ruby
+begin
+  # Get a customer
+  data, status_code, headers = api_instance.get_customer_with_http_info(customer_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Customer>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->get_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_customers
+
+> <CustomerPaginatedResponse> get_customers(opts)
+
+List customers
+
+List customers 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::CustomersApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: '10' # String | 
+}
+
+begin
+  # List customers
+  result = api_instance.get_customers(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->get_customers: #{e}"
+end
+```
+
+#### Using the get_customers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerPaginatedResponse>, Integer, Hash)> get_customers_with_http_info(opts)
+
+```ruby
+begin
+  # List customers
+  data, status_code, headers = api_instance.get_customers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->get_customers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_token** | **String** |  | [optional] |
+| **page_size** | **String** |  | [optional] |
+
+### Return type
+
+[**CustomerPaginatedResponse**](CustomerPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_customer
+
+> <Customer> update_customer(customer_id, update_customer_request)
+
+Update a customer
+
+Update a customer by 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::CustomersApi.new
+customer_id = 'customer_id_example' # String | 
+update_customer_request = TogaiClient::UpdateCustomerRequest.new # UpdateCustomerRequest | Payload to update customer
+
+begin
+  # Update a customer
+  result = api_instance.update_customer(customer_id, update_customer_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->update_customer: #{e}"
+end
+```
+
+#### Using the update_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Customer>, Integer, Hash)> update_customer_with_http_info(customer_id, update_customer_request)
+
+```ruby
+begin
+  # Update a customer
+  data, status_code, headers = api_instance.update_customer_with_http_info(customer_id, update_customer_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Customer>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->update_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+| **update_customer_request** | [**UpdateCustomerRequest**](UpdateCustomerRequest.md) | Payload to update customer |  |
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DimensionsSchema.md

@@ -0,0 +1,18 @@
+# TogaiClient::DimensionsSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the event dimension |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::DimensionsSchema.new(
+  name: city
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,18 @@
+# TogaiClient::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | error description |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::ErrorResponse.new(
+  message: null
+)
+```
+

data/docs/Event.md

@@ -0,0 +1,28 @@
+# TogaiClient::Event
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_name** | **String** | Name of the event to be recorded. |  |
+| **id** | **String** | A unique value to identify the event instance. This unique value should be generated by the client and it acts as the **idempotency key**. Togai server will use this key to recognize subsequent retries of the same request and avoid metering multiple times for that same request. This id can be created in any format but we recommend using UUIDv4 to reduce collision occurance.    NOTE1: Expiry time for idempotency validation will be until the end of the billing cycle. Any request which comes after the billing cycle with the same id will be treated as new request and ingested for metering.   NOTE2: If the billing cycle is not configured for the idempotency validation will be until **10 days** of the event ingestion. |  |
+| **event_timestamp** | **Time** | Source time stamp of the event. This timestamp must be in ISO 8601 format. |  |
+| **account_id** | **String** |  |  |
+| **event_attributes** | [**Array<EventAttribute>**](EventAttribute.md) |  |  |
+| **dimensions** | **Hash<String, String>** | Dimensions are tags/labels associated with the events. This dimensions can be used to configure billing, for queries, analytics and reports. |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Event.new(
+  event_name: null,
+  id: null,
+  event_timestamp: null,
+  account_id: null,
+  event_attributes: null,
+  dimensions: null
+)
+```
+