togai_client 1.0.0

data/docs/PricePlansApi.md

@@ -0,0 +1,363 @@
+# TogaiClient::PricePlansApi
+
+All URIs are relative to *https://sandbox-api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**activate_price_plan**](PricePlansApi.md#activate_price_plan) | **POST** /price_plans/{price_plan_name}/activate | Activate a price plan |
+| [**create_price_plan**](PricePlansApi.md#create_price_plan) | **POST** /price_plans | Create a price plan |
+| [**get_price_plan**](PricePlansApi.md#get_price_plan) | **GET** /price_plans/{price_plan_name} | Get a price plan |
+| [**get_price_plans**](PricePlansApi.md#get_price_plans) | **GET** /price_plans | List price plans |
+| [**update_price_plan**](PricePlansApi.md#update_price_plan) | **PATCH** /price_plans/{price_plan_name} | Update a price plan |
+
+
+## activate_price_plan
+
+> <PricePlan> activate_price_plan(price_plan_name)
+
+Activate a price plan
+
+Activate a price plan
+
+### 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::PricePlansApi.new
+price_plan_name = 'price_plan_name_example' # String | 
+
+begin
+  # Activate a price plan
+  result = api_instance.activate_price_plan(price_plan_name)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->activate_price_plan: #{e}"
+end
+```
+
+#### Using the activate_price_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PricePlan>, Integer, Hash)> activate_price_plan_with_http_info(price_plan_name)
+
+```ruby
+begin
+  # Activate a price plan
+  data, status_code, headers = api_instance.activate_price_plan_with_http_info(price_plan_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PricePlan>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->activate_price_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price_plan_name** | **String** |  |  |
+
+### Return type
+
+[**PricePlan**](PricePlan.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_price_plan
+
+> <PricePlan> create_price_plan(create_price_plan_request)
+
+Create a price plan
+
+Create a price plan
+
+### 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::PricePlansApi.new
+create_price_plan_request = TogaiClient::CreatePricePlanRequest.new({name: 'name_example', pricing_cycle: TogaiClient::PricingCycle.new({interval: 'MONTHLY', start_type: 'STATIC', start_offset: TogaiClient::PricingCycleStartOffset.new({day_offset: 'day_offset_example', month_offset: 'month_offset_example'}), grace_period: 3}), rate_card: TogaiClient::RateCard.new({type: 'USAGE'})}) # CreatePricePlanRequest | Payload to create price plan
+
+begin
+  # Create a price plan
+  result = api_instance.create_price_plan(create_price_plan_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->create_price_plan: #{e}"
+end
+```
+
+#### Using the create_price_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PricePlan>, Integer, Hash)> create_price_plan_with_http_info(create_price_plan_request)
+
+```ruby
+begin
+  # Create a price plan
+  data, status_code, headers = api_instance.create_price_plan_with_http_info(create_price_plan_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PricePlan>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->create_price_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_price_plan_request** | [**CreatePricePlanRequest**](CreatePricePlanRequest.md) | Payload to create price plan |  |
+
+### Return type
+
+[**PricePlan**](PricePlan.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_price_plan
+
+> <PricePlan> get_price_plan(price_plan_name)
+
+Get a price plan
+
+Get a price plan
+
+### 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::PricePlansApi.new
+price_plan_name = 'price_plan_name_example' # String | 
+
+begin
+  # Get a price plan
+  result = api_instance.get_price_plan(price_plan_name)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->get_price_plan: #{e}"
+end
+```
+
+#### Using the get_price_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PricePlan>, Integer, Hash)> get_price_plan_with_http_info(price_plan_name)
+
+```ruby
+begin
+  # Get a price plan
+  data, status_code, headers = api_instance.get_price_plan_with_http_info(price_plan_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PricePlan>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->get_price_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price_plan_name** | **String** |  |  |
+
+### Return type
+
+[**PricePlan**](PricePlan.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_price_plans
+
+> <PricePlanPaginatedResponse> get_price_plans(opts)
+
+List price plans
+
+List price plans 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::PricePlansApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: '10' # String | 
+}
+
+begin
+  # List price plans
+  result = api_instance.get_price_plans(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->get_price_plans: #{e}"
+end
+```
+
+#### Using the get_price_plans_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PricePlanPaginatedResponse>, Integer, Hash)> get_price_plans_with_http_info(opts)
+
+```ruby
+begin
+  # List price plans
+  data, status_code, headers = api_instance.get_price_plans_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PricePlanPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->get_price_plans_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_token** | **String** |  | [optional] |
+| **page_size** | **String** |  | [optional] |
+
+### Return type
+
+[**PricePlanPaginatedResponse**](PricePlanPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_price_plan
+
+> <PricePlan> update_price_plan(price_plan_name, update_price_plan_request)
+
+Update a price plan
+
+Update a price plan
+
+### 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::PricePlansApi.new
+price_plan_name = 'price_plan_name_example' # String | 
+update_price_plan_request = TogaiClient::UpdatePricePlanRequest.new # UpdatePricePlanRequest | Payload to update price plan
+
+begin
+  # Update a price plan
+  result = api_instance.update_price_plan(price_plan_name, update_price_plan_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->update_price_plan: #{e}"
+end
+```
+
+#### Using the update_price_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PricePlan>, Integer, Hash)> update_price_plan_with_http_info(price_plan_name, update_price_plan_request)
+
+```ruby
+begin
+  # Update a price plan
+  data, status_code, headers = api_instance.update_price_plan_with_http_info(price_plan_name, update_price_plan_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PricePlan>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling PricePlansApi->update_price_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price_plan_name** | **String** |  |  |
+| **update_price_plan_request** | [**UpdatePricePlanRequest**](UpdatePricePlanRequest.md) | Payload to update price plan |  |
+
+### Return type
+
+[**PricePlan**](PricePlan.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PricingCycle.md

@@ -0,0 +1,24 @@
+# TogaiClient::PricingCycle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval** | **String** |  |  |
+| **start_type** | **String** |  |  |
+| **start_offset** | [**PricingCycleStartOffset**](PricingCycleStartOffset.md) |  |  |
+| **grace_period** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricingCycle.new(
+  interval: null,
+  start_type: null,
+  start_offset: null,
+  grace_period: 3
+)
+```
+

data/docs/PricingCycleStartOffset.md

@@ -0,0 +1,20 @@
+# TogaiClient::PricingCycleStartOffset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **day_offset** | **String** | min: \"1\" and max: \"31\" as strings. Spl. string allowed: LAST  |  |
+| **month_offset** | **String** | min: \"1\" and max: \"12\". Spl. string allowed: FIRST / LAST. For QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn't be passed for MONTHLY.  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricingCycleStartOffset.new(
+  day_offset: null,
+  month_offset: null
+)
+```
+

data/docs/PricingSchedule.md

@@ -0,0 +1,22 @@
+# TogaiClient::PricingSchedule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rate_payload** | [**RateCard**](RateCard.md) |  | [optional] |
+| **start_date** | **Time** |  |  |
+| **end_date** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricingSchedule.new(
+  rate_payload: null,
+  start_date: null,
+  end_date: null
+)
+```
+

data/docs/RateCard.md

@@ -0,0 +1,22 @@
+# TogaiClient::RateCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **usage_config** | [**Hash<String, RateCardUsageValue>**](RateCardUsageValue.md) |  | [optional] |
+| **bundle_config** | [**RateCardBundle**](RateCardBundle.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::RateCard.new(
+  type: null,
+  usage_config: null,
+  bundle_config: null
+)
+```
+

data/docs/RateCardBundle.md

@@ -0,0 +1,22 @@
+# TogaiClient::RateCardBundle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rate_strategy** | **String** |  |  |
+| **slab_strategy** | **String** |  |  |
+| **bundles** | [**Array<BundleStrategy>**](BundleStrategy.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::RateCardBundle.new(
+  rate_strategy: null,
+  slab_strategy: null,
+  bundles: null
+)
+```
+

data/docs/RateCardUsageValue.md

@@ -0,0 +1,24 @@
+# TogaiClient::RateCardUsageValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **rate_strategy** | **String** |  |  |
+| **slab_strategy** | **String** |  |  |
+| **slabs** | [**Array<UsageStrategy>**](UsageStrategy.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::RateCardUsageValue.new(
+  name: null,
+  rate_strategy: null,
+  slab_strategy: null,
+  slabs: null
+)
+```
+

data/docs/RemoveAccountAliasesRequest.md

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

data/docs/SignupRequest.md

@@ -0,0 +1,22 @@
+# TogaiClient::SignupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **user_details** | [**UserDetails**](UserDetails.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SignupRequest.new(
+  name: null,
+  description: null,
+  user_details: null
+)
+```
+

data/docs/SignupResponse.md

@@ -0,0 +1,20 @@
+# TogaiClient::SignupResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** | Organization Identifier |  |
+| **jwt_token** | **String** | Token which can be used for authentication |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SignupResponse.new(
+  organization_id: null,
+  jwt_token: null
+)
+```
+

data/docs/StatusResponse.md

@@ -0,0 +1,24 @@
+# TogaiClient::StatusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **greeting** | **String** |  | [optional] |
+| **date** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **headers** | [**StatusResponseHeaders**](StatusResponseHeaders.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::StatusResponse.new(
+  greeting: null,
+  date: null,
+  url: null,
+  headers: null
+)
+```
+

data/docs/StatusResponseHeaders.md

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

data/docs/UpdateAccountRequest.md

@@ -0,0 +1,18 @@
+# TogaiClient::UpdateAccountRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the customer | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UpdateAccountRequest.new(
+  name: null
+)
+```
+

data/docs/UpdateCustomerRequest.md

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

data/docs/UpdateEventSchemaRequest.md

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

data/docs/UpdatePricePlanRequest.md

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