togai_client 1.0.1 → 1.0.2

data/docs/AccountsBillingInformation.md

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

data/docs/ActivatePricePlanRequest.md

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

data/docs/AddAccountAliasesRequest.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **aliases** | **Array<String>** | List of aliases to add | [optional] |
+| **account_aliases** | [**Array<CreateAccountAliasRequest>**](CreateAccountAliasRequest.md) | List of account aliases to add | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'togai_client'
 
 instance = TogaiClient::AddAccountAliasesRequest.new(
-  aliases: null
+  aliases: null,
+  account_aliases: null
 )
 ```
 

data/docs/AddOn.md

@@ -0,0 +1,30 @@
+# TogaiClient::AddOn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of addon |  |
+| **type** | [**AddOnType**](AddOnType.md) |  |  |
+| **billable_name** | **String** | Billable name of addon. Billable name takes precedence over name to display in invoice. | [optional] |
+| **id** | **String** | Id of addon |  |
+| **created_at** | **Time** | Created Time of addon |  |
+| **status** | **String** | status of addon |  |
+| **display_name** | **String** | Display name of addon. This is an auto-generated field which contains billableName of addon. If billableName is not provided, name will be used as display name.  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::AddOn.new(
+  name: null,
+  type: null,
+  billable_name: null,
+  id: addon.1zYnCiM9Bpg.1zYn,
+  created_at: null,
+  status: ACTIVE,
+  display_name: null
+)
+```
+

data/docs/AddOnPaginatedResponse.md

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

data/docs/AddOnType.md

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

data/docs/AddOnsApi.md

@@ -0,0 +1,365 @@
+# TogaiClient::AddOnsApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_add_on**](AddOnsApi.md#create_add_on) | **POST** /addons | Create an AddOn |
+| [**delete_add_on**](AddOnsApi.md#delete_add_on) | **DELETE** /addons/{addon_id} | Delete an addon |
+| [**get_add_on**](AddOnsApi.md#get_add_on) | **GET** /addons/{addon_id} | Get an addon |
+| [**get_add_ons**](AddOnsApi.md#get_add_ons) | **GET** /addons | List addOns |
+| [**update_add_on**](AddOnsApi.md#update_add_on) | **PATCH** /addons/{addon_id} | Update an addon |
+
+
+## create_add_on
+
+> <AddOn> create_add_on(create_add_on_request)
+
+Create an AddOn
+
+Create an AddOn
+
+### 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::AddOnsApi.new
+create_add_on_request = TogaiClient::CreateAddOnRequest.new({name: 'name_example', type: TogaiClient::AddOnType::LICENSE}) # CreateAddOnRequest | Payload to create addon
+
+begin
+  # Create an AddOn
+  result = api_instance.create_add_on(create_add_on_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->create_add_on: #{e}"
+end
+```
+
+#### Using the create_add_on_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddOn>, Integer, Hash)> create_add_on_with_http_info(create_add_on_request)
+
+```ruby
+begin
+  # Create an AddOn
+  data, status_code, headers = api_instance.create_add_on_with_http_info(create_add_on_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddOn>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->create_add_on_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_add_on_request** | [**CreateAddOnRequest**](CreateAddOnRequest.md) | Payload to create addon |  |
+
+### Return type
+
+[**AddOn**](AddOn.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_add_on
+
+> <BaseSuccessResponse> delete_add_on(addon_id)
+
+Delete an addon
+
+Archive an addOn
+
+### 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::AddOnsApi.new
+addon_id = 'addon.1zYnCiM9Bpg.lv25y' # String | 
+
+begin
+  # Delete an addon
+  result = api_instance.delete_add_on(addon_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->delete_add_on: #{e}"
+end
+```
+
+#### Using the delete_add_on_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BaseSuccessResponse>, Integer, Hash)> delete_add_on_with_http_info(addon_id)
+
+```ruby
+begin
+  # Delete an addon
+  data, status_code, headers = api_instance.delete_add_on_with_http_info(addon_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BaseSuccessResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->delete_add_on_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addon_id** | **String** |  |  |
+
+### Return type
+
+[**BaseSuccessResponse**](BaseSuccessResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_add_on
+
+> <AddOn> get_add_on(addon_id)
+
+Get an addon
+
+Get details of an addon
+
+### 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::AddOnsApi.new
+addon_id = 'addon.1zYnCiM9Bpg.lv25y' # String | 
+
+begin
+  # Get an addon
+  result = api_instance.get_add_on(addon_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->get_add_on: #{e}"
+end
+```
+
+#### Using the get_add_on_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddOn>, Integer, Hash)> get_add_on_with_http_info(addon_id)
+
+```ruby
+begin
+  # Get an addon
+  data, status_code, headers = api_instance.get_add_on_with_http_info(addon_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddOn>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->get_add_on_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addon_id** | **String** |  |  |
+
+### Return type
+
+[**AddOn**](AddOn.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_add_ons
+
+> <AddOnPaginatedResponse> get_add_ons(opts)
+
+List addOns
+
+Get a list of add-ons
+
+### 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::AddOnsApi.new
+opts = {
+  status: 'ACTIVE', # String | Filter by status 
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: 10 # Float | 
+}
+
+begin
+  # List addOns
+  result = api_instance.get_add_ons(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->get_add_ons: #{e}"
+end
+```
+
+#### Using the get_add_ons_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddOnPaginatedResponse>, Integer, Hash)> get_add_ons_with_http_info(opts)
+
+```ruby
+begin
+  # List addOns
+  data, status_code, headers = api_instance.get_add_ons_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddOnPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->get_add_ons_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Filter by status  | [optional] |
+| **next_token** | **String** |  | [optional] |
+| **page_size** | **Float** |  | [optional] |
+
+### Return type
+
+[**AddOnPaginatedResponse**](AddOnPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_add_on
+
+> <AddOn> update_add_on(addon_id, update_add_on_request)
+
+Update an addon
+
+Update an existing addon 
+
+### 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::AddOnsApi.new
+addon_id = 'addon.1zYnCiM9Bpg.lv25y' # String | 
+update_add_on_request = TogaiClient::UpdateAddOnRequest.new # UpdateAddOnRequest | Payload to update addon
+
+begin
+  # Update an addon
+  result = api_instance.update_add_on(addon_id, update_add_on_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->update_add_on: #{e}"
+end
+```
+
+#### Using the update_add_on_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddOn>, Integer, Hash)> update_add_on_with_http_info(addon_id, update_add_on_request)
+
+```ruby
+begin
+  # Update an addon
+  data, status_code, headers = api_instance.update_add_on_with_http_info(addon_id, update_add_on_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddOn>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling AddOnsApi->update_add_on_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addon_id** | **String** |  |  |
+| **update_add_on_request** | [**UpdateAddOnRequest**](UpdateAddOnRequest.md) | Payload to update addon |  |
+
+### Return type
+
+[**AddOn**](AddOn.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Address.md

@@ -0,0 +1,30 @@
+# TogaiClient::Address
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Contact number | [optional] |
+| **line1** | **String** | Address line 1 (eg. Street, PO Box, Company Name) | [optional] |
+| **line2** | **String** | Address line 2 (eg. apartment, suite, unit or building) | [optional] |
+| **postal_code** | **String** | ZIP or postal code | [optional] |
+| **city** | **String** | City, district, suburb, town or village | [optional] |
+| **state** | **String** | State, county, province or region | [optional] |
+| **country** | **String** | Two letter country code [ISO-3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Address.new(
+  phone_number: null,
+  line1: null,
+  line2: null,
+  postal_code: null,
+  city: null,
+  state: null,
+  country: null
+)
+```
+

data/docs/Alert.md

@@ -0,0 +1,40 @@
+# TogaiClient::Alert
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Alert ID |  |
+| **version** | **Integer** | Alert Version |  |
+| **description** | **String** | Alert Description | [optional] |
+| **status** | [**AlertStatus**](AlertStatus.md) |  |  |
+| **validity** | **Integer** | Validity of the alert in minutes, if null then alert will be valid forever | [optional] |
+| **alert_template_id** | **String** | Alert Template Id |  |
+| **interval** | **Integer** | Interval |  |
+| **entity_details** | **Hash<String, Object>** |  | [optional] |
+| **owner_details** | **Hash<String, Object>** |  | [optional] |
+| **parameters** | **Hash<String, Object>** |  | [optional] |
+| **created_at** | **Time** | Created At |  |
+| **updated_at** | **Time** | Updated At | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Alert.new(
+  id: null,
+  version: null,
+  description: null,
+  status: null,
+  validity: null,
+  alert_template_id: null,
+  interval: null,
+  entity_details: null,
+  owner_details: null,
+  parameters: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/AlertStatus.md

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

data/docs/AlertTemplate.md

@@ -0,0 +1,38 @@
+# TogaiClient::AlertTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Alert Template ID |  |
+| **name** | **String** | Alert Template Name |  |
+| **description** | **String** | Alert Template Description | [optional] |
+| **interval** | **Integer** | Cron Interval |  |
+| **entity_schema** | **String** | Entity Schema | [optional] |
+| **entity_type** | **String** | Entity Type | [optional] |
+| **owner_schema** | **String** | Owner Schema | [optional] |
+| **owner_type** | **String** | Owner Type | [optional] |
+| **parameters_schema** | **String** | Parameters Schema | [optional] |
+| **created_at** | **Time** | Created At |  |
+| **updated_at** | **Time** | Updated At | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::AlertTemplate.new(
+  id: null,
+  name: null,
+  description: null,
+  interval: null,
+  entity_schema: null,
+  entity_type: null,
+  owner_schema: null,
+  owner_type: null,
+  parameters_schema: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/AlertTemplatesPaginatedResponse.md

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