togai_client 1.0.1 → 1.0.2

data/docs/Setting.md

@@ -0,0 +1,30 @@
+# TogaiClient::Setting
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **value** | **String** |  |  |
+| **entity_type** | **String** |  |  |
+| **entity_id** | **String** |  |  |
+| **namespace** | **String** |  |  |
+| **name** | **String** |  |  |
+| **data_type** | [**SettingDataType**](SettingDataType.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Setting.new(
+  id: null,
+  value: null,
+  entity_type: null,
+  entity_id: null,
+  namespace: null,
+  name: null,
+  data_type: null
+)
+```
+

data/docs/SettingDataType.md

@@ -0,0 +1,15 @@
+# TogaiClient::SettingDataType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SettingDataType.new()
+```
+

data/docs/SettingPaginatedResponse.md

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

data/docs/SettingsApi.md

@@ -0,0 +1,301 @@
+# TogaiClient::SettingsApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_setting**](SettingsApi.md#get_setting) | **GET** /settings/{setting_id_str} | Get a setting |
+| [**insert_setting**](SettingsApi.md#insert_setting) | **POST** /settings | Create a setting |
+| [**list_setting**](SettingsApi.md#list_setting) | **GET** /settings | Lists settings |
+| [**update_setting**](SettingsApi.md#update_setting) | **PATCH** /settings/{setting_id_str} | Update a setting |
+
+
+## get_setting
+
+> <Setting> get_setting(setting_id_str)
+
+Get a setting
+
+Get a setting
+
+### 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::SettingsApi.new
+setting_id_str = 'setting.USER.success_threshold.ACCOUNT.G234DZZKBKACATFFGVGEMERFI' # String | 
+
+begin
+  # Get a setting
+  result = api_instance.get_setting(setting_id_str)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling SettingsApi->get_setting: #{e}"
+end
+```
+
+#### Using the get_setting_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Setting>, Integer, Hash)> get_setting_with_http_info(setting_id_str)
+
+```ruby
+begin
+  # Get a setting
+  data, status_code, headers = api_instance.get_setting_with_http_info(setting_id_str)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Setting>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling SettingsApi->get_setting_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **setting_id_str** | **String** |  |  |
+
+### Return type
+
+[**Setting**](Setting.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## insert_setting
+
+> <Setting> insert_setting(setting)
+
+Create a setting
+
+Create a setting
+
+### 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::SettingsApi.new
+setting = TogaiClient::Setting.new({id: 'id_example', value: 'value_example', entity_type: 'entity_type_example', entity_id: 'entity_id_example', namespace: 'namespace_example', name: 'name_example', data_type: TogaiClient::SettingDataType::STRING}) # Setting | Payload to insert setting
+
+begin
+  # Create a setting
+  result = api_instance.insert_setting(setting)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling SettingsApi->insert_setting: #{e}"
+end
+```
+
+#### Using the insert_setting_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Setting>, Integer, Hash)> insert_setting_with_http_info(setting)
+
+```ruby
+begin
+  # Create a setting
+  data, status_code, headers = api_instance.insert_setting_with_http_info(setting)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Setting>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling SettingsApi->insert_setting_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **setting** | [**Setting**](Setting.md) | Payload to insert setting |  |
+
+### Return type
+
+[**Setting**](Setting.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_setting
+
+> <SettingPaginatedResponse> list_setting(opts)
+
+Lists settings
+
+List settings
+
+### 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::SettingsApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: 10, # Float | 
+  entity_type: 'ACCOUNT', # String | 
+  entity_id: 'acc_X1Df3sRf3', # String | 
+  setting_id: 'setting_id_example', # String | 
+  namespace: 'USER' # String | 
+}
+
+begin
+  # Lists settings
+  result = api_instance.list_setting(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling SettingsApi->list_setting: #{e}"
+end
+```
+
+#### Using the list_setting_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SettingPaginatedResponse>, Integer, Hash)> list_setting_with_http_info(opts)
+
+```ruby
+begin
+  # Lists settings
+  data, status_code, headers = api_instance.list_setting_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SettingPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling SettingsApi->list_setting_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_token** | **String** |  | [optional] |
+| **page_size** | **Float** |  | [optional] |
+| **entity_type** | **String** |  | [optional] |
+| **entity_id** | **String** |  | [optional] |
+| **setting_id** | **String** |  | [optional] |
+| **namespace** | **String** |  | [optional] |
+
+### Return type
+
+[**SettingPaginatedResponse**](SettingPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_setting
+
+> <Setting> update_setting(setting_id_str, update_setting_request)
+
+Update a setting
+
+Update a setting
+
+### 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::SettingsApi.new
+setting_id_str = 'setting.USER.success_threshold.ACCOUNT.G234DZZKBKACATFFGVGEMERFI' # String | 
+update_setting_request = TogaiClient::UpdateSettingRequest.new # UpdateSettingRequest | Payload to update setting
+
+begin
+  # Update a setting
+  result = api_instance.update_setting(setting_id_str, update_setting_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling SettingsApi->update_setting: #{e}"
+end
+```
+
+#### Using the update_setting_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Setting>, Integer, Hash)> update_setting_with_http_info(setting_id_str, update_setting_request)
+
+```ruby
+begin
+  # Update a setting
+  data, status_code, headers = api_instance.update_setting_with_http_info(setting_id_str, update_setting_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Setting>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling SettingsApi->update_setting_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **setting_id_str** | **String** |  |  |
+| **update_setting_request** | [**UpdateSettingRequest**](UpdateSettingRequest.md) | Payload to update setting |  |
+
+### Return type
+
+[**Setting**](Setting.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Slab.md

@@ -0,0 +1,24 @@
+# TogaiClient::Slab
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order** | **Integer** |  |  |
+| **start_after** | **Float** |  |  |
+| **price_type** | [**PriceType**](PriceType.md) |  |  |
+| **slab_config** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Slab.new(
+  order: null,
+  start_after: null,
+  price_type: null,
+  slab_config: null
+)
+```
+

data/docs/SlabDetail.md

@@ -0,0 +1,26 @@
+# TogaiClient::SlabDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_after** | **Float** |  |  |
+| **price_type** | [**PriceType**](PriceType.md) |  |  |
+| **slab_config** | **Hash<String, String>** |  | [optional] |
+| **rate** | **Float** |  |  |
+| **slab_rate_config** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SlabDetail.new(
+  start_after: null,
+  price_type: null,
+  slab_config: null,
+  rate: null,
+  slab_rate_config: null
+)
+```
+

data/docs/SlabRate.md

@@ -0,0 +1,22 @@
+# TogaiClient::SlabRate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order** | **Integer** |  |  |
+| **rate** | **Float** |  |  |
+| **slab_rate_config** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SlabRate.new(
+  order: null,
+  rate: null,
+  slab_rate_config: null
+)
+```
+

data/docs/SlabRevenue.md

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

data/docs/SlabRevenueMetadata.md

@@ -0,0 +1,22 @@
+# TogaiClient::SlabRevenueMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **minimum_rate_applied** | **Boolean** |  | [optional] |
+| **maximum_rate_applied** | **Boolean** |  | [optional] |
+| **package_quantity** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SlabRevenueMetadata.new(
+  minimum_rate_applied: null,
+  maximum_rate_applied: null,
+  package_quantity: null
+)
+```
+

data/docs/SlabRevenueSummary.md

@@ -0,0 +1,24 @@
+# TogaiClient::SlabRevenueSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order** | **Integer** |  |  |
+| **usage** | **Float** |  |  |
+| **revenue** | **Float** |  |  |
+| **metadata** | [**SlabRevenueMetadata**](SlabRevenueMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SlabRevenueSummary.new(
+  order: null,
+  usage: null,
+  revenue: null,
+  metadata: null
+)
+```
+

data/docs/SlabRevenueWithMetadata.md

@@ -0,0 +1,24 @@
+# TogaiClient::SlabRevenueWithMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order** | **Integer** |  |  |
+| **usage** | **Float** |  |  |
+| **revenue** | **Float** |  |  |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SlabRevenueWithMetadata.new(
+  order: null,
+  usage: null,
+  revenue: null,
+  metadata: null
+)
+```
+

data/docs/TokenResponse.md

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

data/docs/TopupWalletRequest.md

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

data/docs/UpdateAccountRequest.md

@@ -4,7 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name of the customer | [optional] |
+| **name** | **String** | Name of the Account | [optional] |
+| **status** | **String** |  | [optional] |
+| **invoice_currency** | **String** | [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency in which the account must be invoiced Defaults to Base currency.  | [optional] |
+| **net_term_days** | **Integer** |  | [optional] |
+| **primary_email** | **String** | Primary email of the account | [optional] |
+| **billing_information** | [**AccountsBillingInformation**](AccountsBillingInformation.md) |  | [optional] |
+| **address** | [**Address**](Address.md) |  | [optional] |
+| **metadata** | **Hash<String, String>** | Additional information associated with the account. Example: GSTN, VATN NOTE: This replaces the existing metadata if the metadata in the request is not null.  To remove all existing metadata, use empty object  | [optional] |
+| **tags** | **Array<String>** | Tag for accounts are stored in lowercase | [optional] |
 
 ## Example
 
@@ -12,7 +20,15 @@
 require 'togai_client'
 
 instance = TogaiClient::UpdateAccountRequest.new(
-  name: null
+  name: ACME Enterprise,
+  status: null,
+  invoice_currency: USD,
+  net_term_days: null,
+  primary_email: admin@example.com,
+  billing_information: null,
+  address: null,
+  metadata: null,
+  tags: null
 )
 ```
 

data/docs/UpdateAccountScheduleV2Request.md

@@ -0,0 +1,26 @@
+# TogaiClient::UpdateAccountScheduleV2Request
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | Mode of request to create dis/association | [optional] |
+| **effective_from** | **Date** | Date of effectiveness of the association. The date is expected in YYYY-MM-DD format - Editing of a BILLING plan with deferredRevenue can be achieved with    effectiveFrom as start date of current cycle or using `retainStartOffset` option.  |  |
+| **effective_until** | **Date** | Date until which the association must be effective. The date is expected in YYYY-MM-DD format  |  |
+| **association_config** | [**AssociationConfig**](AssociationConfig.md) |  | [optional] |
+| **merge_schedules** | **Boolean** | If this flag is true, the schedules will be merged with the existing schedules of the account if possible. If this flag is false, the existing schedules will be replaced with the new schedules. Default value is false  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UpdateAccountScheduleV2Request.new(
+  mode: null,
+  effective_from: null,
+  effective_until: null,
+  association_config: null,
+  merge_schedules: null
+)
+```
+

data/docs/UpdateAddOnRequest.md

@@ -0,0 +1,20 @@
+# TogaiClient::UpdateAddOnRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of addon | [optional] |
+| **billable_name** | **String** | Billable name of addon. Billable name takes precedence over name to display in invoice. | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UpdateAddOnRequest.new(
+  name: null,
+  billable_name: null
+)
+```
+

data/docs/UpdateAlertRequest.md

@@ -0,0 +1,26 @@
+# TogaiClient::UpdateAlertRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  | [optional] |
+| **status** | [**AlertStatus**](AlertStatus.md) |  | [optional] |
+| **interval** | **Integer** |  | [optional] |
+| **validity** | **Integer** |  | [optional] |
+| **parameters** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::UpdateAlertRequest.new(
+  description: null,
+  status: null,
+  interval: null,
+  validity: null,
+  parameters: null
+)
+```
+