togai_client 1.0.1 → 1.0.2

data/docs/AliasesApi.md

@@ -0,0 +1,291 @@
+# TogaiClient::AliasesApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_alias**](AliasesApi.md#create_alias) | **POST** /aliases | Create an alias |
+| [**delete_alias**](AliasesApi.md#delete_alias) | **DELETE** /aliases/{alias} | Delete an alias |
+| [**get_alias**](AliasesApi.md#get_alias) | **GET** /aliases/{alias} | Get an alias |
+| [**list_aliases**](AliasesApi.md#list_aliases) | **GET** /aliases | List all aliases |
+
+
+## create_alias
+
+> <AliasPaginatedResponse> create_alias(create_bulk_alias_request)
+
+Create an alias
+
+This API let’s you to create an alias
+
+### 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::AliasesApi.new
+create_bulk_alias_request = TogaiClient::CreateBulkAliasRequest.new({aliases: [TogaiClient::CreateAliasRequest.new({value: 'value_example'})]}) # CreateBulkAliasRequest | Payload to create bulk aliases
+
+begin
+  # Create an alias
+  result = api_instance.create_alias(create_bulk_alias_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AliasesApi->create_alias: #{e}"
+end
+```
+
+#### Using the create_alias_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AliasPaginatedResponse>, Integer, Hash)> create_alias_with_http_info(create_bulk_alias_request)
+
+```ruby
+begin
+  # Create an alias
+  data, status_code, headers = api_instance.create_alias_with_http_info(create_bulk_alias_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AliasPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AliasesApi->create_alias_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_bulk_alias_request** | [**CreateBulkAliasRequest**](CreateBulkAliasRequest.md) | Payload to create bulk aliases |  |
+
+### Return type
+
+[**AliasPaginatedResponse**](AliasPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_alias
+
+> <BaseSuccessResponse> delete_alias(_alias)
+
+Delete an alias
+
+This API let’s you to delete an alias using alias.
+
+### 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::AliasesApi.new
+_alias = 'custom_value' # String | 
+
+begin
+  # Delete an alias
+  result = api_instance.delete_alias(_alias)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AliasesApi->delete_alias: #{e}"
+end
+```
+
+#### Using the delete_alias_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BaseSuccessResponse>, Integer, Hash)> delete_alias_with_http_info(_alias)
+
+```ruby
+begin
+  # Delete an alias
+  data, status_code, headers = api_instance.delete_alias_with_http_info(_alias)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BaseSuccessResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AliasesApi->delete_alias_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** |  |  |
+
+### Return type
+
+[**BaseSuccessResponse**](BaseSuccessResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_alias
+
+> <ModelAlias> get_alias(_alias)
+
+Get an alias
+
+Get alias information using alias.
+
+### 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::AliasesApi.new
+_alias = 'custom_value' # String | 
+
+begin
+  # Get an alias
+  result = api_instance.get_alias(_alias)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AliasesApi->get_alias: #{e}"
+end
+```
+
+#### Using the get_alias_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ModelAlias>, Integer, Hash)> get_alias_with_http_info(_alias)
+
+```ruby
+begin
+  # Get an alias
+  data, status_code, headers = api_instance.get_alias_with_http_info(_alias)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ModelAlias>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AliasesApi->get_alias_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** |  |  |
+
+### Return type
+
+[**ModelAlias**](ModelAlias.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_aliases
+
+> <AliasPaginatedResponse> list_aliases(opts)
+
+List all aliases
+
+Returns a list of aliases 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::AliasesApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: 10 # Float | 
+}
+
+begin
+  # List all aliases
+  result = api_instance.list_aliases(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AliasesApi->list_aliases: #{e}"
+end
+```
+
+#### Using the list_aliases_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AliasPaginatedResponse>, Integer, Hash)> list_aliases_with_http_info(opts)
+
+```ruby
+begin
+  # List all aliases
+  data, status_code, headers = api_instance.list_aliases_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AliasPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AliasesApi->list_aliases_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_token** | **String** |  | [optional] |
+| **page_size** | **Float** |  | [optional] |
+
+### Return type
+
+[**AliasPaginatedResponse**](AliasPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AssociationConfig.md

@@ -0,0 +1,24 @@
+# TogaiClient::AssociationConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price_plan_id** | **String** | Id of the price plan if association request | [optional] |
+| **schedule_id** | **String** | If provided, rate cards and pricing rules will copied from this schedule | [optional] |
+| **pricing_cycle_config_override** | [**PricingCycleConfig**](PricingCycleConfig.md) |  | [optional] |
+| **retain_start_offsets** | **Boolean** | If this flag is true, current pricing cycle of the account on the date of association will continue rather  than the configurations of the newly associated price plan. Pricing cycle overrides specified  using  `pricePlanDetailsOverride` will take precedence over the pricing cycle configurations of  the new price plan that the account needs to migrate to. PricingCycleInterval of the existing plan and  the new plan must be same for this to work. We'll return a `400 BadRequest` otherwise. Examples:   - Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL}     New association (15th Oct to 15th Nov) of different price plan with retainStartOffsets option true      will use the same pricing cycle configuration {dayOffset: 1, monthOffset: NIL} rather than using the     pricing cycle configuration of the new price plan that the account needs to migrate to.   - Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL}     New association (1st Nov to 30th Nov) of different price plan with retainStartOffsets option true will     throw a `400 BadRequest` as no existing price plan configuration found on date of association  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::AssociationConfig.new(
+  price_plan_id: null,
+  schedule_id: null,
+  pricing_cycle_config_override: null,
+  retain_start_offsets: null
+)
+```
+

data/docs/Attribute.md

@@ -0,0 +1,22 @@
+# TogaiClient::Attribute
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the event attribute |  |
+| **value** | **String** | Value of the event attribute |  |
+| **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::Attribute.new(
+  name: message,
+  value: 100,
+  unit: characters
+)
+```
+

data/docs/AuthenticationApi.md

@@ -0,0 +1,74 @@
+# TogaiClient::AuthenticationApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**authenticate**](AuthenticationApi.md#authenticate) | **POST** /authenticate | Generate short lived bearer token |
+
+
+## authenticate
+
+> <TokenResponse> authenticate
+
+Generate short lived bearer token
+
+Generates and returns a bearer token. Behavior of this API differs on the basis of the auth mechanism used to make the request.   - For API key auth, this API generates a JWT token whcih is valid for 24 hours and returns it.   - For JWT bearer auth, returns the same JWT token in response For information on how to generate API token, refer [Generating New API Keys](https://docs.togai.com/api-reference/authentication#generating-new-api-keys) section of docs. 
+
+### 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::AuthenticationApi.new
+
+begin
+  # Generate short lived bearer token
+  result = api_instance.authenticate
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AuthenticationApi->authenticate: #{e}"
+end
+```
+
+#### Using the authenticate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TokenResponse>, Integer, Hash)> authenticate_with_http_info
+
+```ruby
+begin
+  # Generate short lived bearer token
+  data, status_code, headers = api_instance.authenticate_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TokenResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AuthenticationApi->authenticate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TokenResponse**](TokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BillingConfig.md

@@ -0,0 +1,20 @@
+# TogaiClient::BillingConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval** | **Integer** | Represents the number of pricing cycles after which the rate card will be billed | [optional] |
+| **start_offset** | **Integer** | Represents the offset for pricing cycles after which the rate card will be billed | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::BillingConfig.new(
+  interval: 3,
+  start_offset: 5
+)
+```
+

data/docs/BillingEntitlementRateCard.md

@@ -0,0 +1,34 @@
+# TogaiClient::BillingEntitlementRateCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_id** | **String** |  |  |
+| **feature_configs** | [**Array<FeatureConfig>**](FeatureConfig.md) |  |  |
+| **tag** | **String** | A tag string to group rate cards | [optional] |
+| **invoice_timing** | [**InvoiceTiming**](InvoiceTiming.md) |  |  |
+| **display_name** | **String** | Name your rate card, this will be used in invoice | [optional] |
+| **name** | **String** | Unique identifier for the rate card in a price plan. If left null it is auto-generated. | [optional] |
+| **rate_plan** | [**RatePlan**](RatePlan.md) |  |  |
+| **rate_values** | [**Array<RateValue>**](RateValue.md) |  |  |
+| **recurrence_config** | [**RecurrenceConfig**](RecurrenceConfig.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::BillingEntitlementRateCard.new(
+  feature_id: null,
+  feature_configs: null,
+  tag: null,
+  invoice_timing: null,
+  display_name: null,
+  name: null,
+  rate_plan: null,
+  rate_values: null,
+  recurrence_config: null
+)
+```
+

data/docs/BillingEntitlementRevenueSummary.md

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

data/docs/BulkRateCardOperationsRequest.md

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

data/docs/BulkRateCardOperationsResponse.md

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

data/docs/CalculateRevenueRequest.md

@@ -0,0 +1,30 @@
+# TogaiClient::CalculateRevenueRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency_config** | [**CurrencyConfig**](CurrencyConfig.md) |  |  |
+| **price_plan_details_config** | [**PricePlanDetailsConfig**](PricePlanDetailsConfig.md) |  |  |
+| **usage_config** | [**UsageConfig**](UsageConfig.md) |  |  |
+| **license_entries_config** | [**LicenseEntriesConfig**](LicenseEntriesConfig.md) |  |  |
+| **named_license_entries_config** | [**NamedLicenseEntriesConfig**](NamedLicenseEntriesConfig.md) |  | [optional] |
+| **proration_config** | [**ProrationConfig**](ProrationConfig.md) |  | [optional] |
+| **entitlement_overage_config** | [**EntitlementOverageConfig**](EntitlementOverageConfig.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CalculateRevenueRequest.new(
+  currency_config: null,
+  price_plan_details_config: null,
+  usage_config: null,
+  license_entries_config: null,
+  named_license_entries_config: null,
+  proration_config: null,
+  entitlement_overage_config: null
+)
+```
+

data/docs/CalculateRevenueResponse.md

@@ -0,0 +1,24 @@
+# TogaiClient::CalculateRevenueResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** |  |  |
+| **usage_lookup_range** | [**UsageLookupRange**](UsageLookupRange.md) |  | [optional] |
+| **price_plan_details** | [**PricePlanDetails**](PricePlanDetails.md) |  |  |
+| **revenue_info** | [**Array<RevenueInfo>**](RevenueInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CalculateRevenueResponse.new(
+  currency: null,
+  usage_lookup_range: null,
+  price_plan_details: null,
+  revenue_info: null
+)
+```
+

data/docs/CalculateRevenueResponseV2.md

@@ -0,0 +1,22 @@
+# TogaiClient::CalculateRevenueResponseV2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** |  |  |
+| **usage_lookup_range** | [**UsageLookupRange**](UsageLookupRange.md) |  | [optional] |
+| **revenue_info** | [**Array<RevenueInfoV2>**](RevenueInfoV2.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CalculateRevenueResponseV2.new(
+  currency: null,
+  usage_lookup_range: null,
+  revenue_info: null
+)
+```
+

data/docs/Computation.md

@@ -5,8 +5,9 @@
 | 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'  |  |
+| **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'  |  |
+| **order** | **Integer** | The order in which multiple matched computations will get evaluated |  |
 
 ## Example
 
@@ -25,7 +26,8 @@ instance = TogaiClient::Computation.new(
   ]
 }
 ,
-  computation: {"*":[{"var":"attributes.distance"},0.4]}
+  computation: {"*":[{"var":"attributes.distance"},0.4]},
+  order: null
 )
 ```
 

data/docs/CreateAccountAliasRequest.md

@@ -0,0 +1,22 @@
+# TogaiClient::CreateAccountAliasRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** |  |  |
+| **effective_from** | **Time** | Effective from date, if not provided, it will be set to -infinity | [optional] |
+| **effective_until** | **Time** | Effective until date, if not provided, it will be set to +infinity | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CreateAccountAliasRequest.new(
+  value: null,
+  effective_from: null,
+  effective_until: null
+)
+```
+