togai_client 1.0.1 → 1.0.2

data/docs/CreditsApi.md

@@ -0,0 +1,369 @@
+# TogaiClient::CreditsApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_credit**](CreditsApi.md#create_credit) | **POST** /credits | Grant credit |
+| [**credit_balance_for_account**](CreditsApi.md#credit_balance_for_account) | **GET** /accounts/{account_id}/credit_balance | Credit balance for Account |
+| [**get_credit_details**](CreditsApi.md#get_credit_details) | **GET** /credits/{credit_id} | Get credit details |
+| [**list_credits**](CreditsApi.md#list_credits) | **GET** /credits | List credits |
+| [**void_credit**](CreditsApi.md#void_credit) | **POST** /credits/{credit_id}/void | Void credit |
+
+
+## create_credit
+
+> <CreateCreditResponse> create_credit(opts)
+
+Grant credit
+
+Grant credit
+
+### 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::CreditsApi.new
+opts = {
+  create_credit_request: TogaiClient::CreateCreditRequest.new({credit_requests: [TogaiClient::CreditRequest.new({account_id: 'ACC001', purpose: 'PREPAID_CREDIT', effective_from: Date.parse('Sat Jul 04 00:00:00 UTC 2020'), priority: 1})]}) # CreateCreditRequest | Payload to grant credits
+}
+
+begin
+  # Grant credit
+  result = api_instance.create_credit(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->create_credit: #{e}"
+end
+```
+
+#### Using the create_credit_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCreditResponse>, Integer, Hash)> create_credit_with_http_info(opts)
+
+```ruby
+begin
+  # Grant credit
+  data, status_code, headers = api_instance.create_credit_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCreditResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->create_credit_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_credit_request** | [**CreateCreditRequest**](CreateCreditRequest.md) | Payload to grant credits | [optional] |
+
+### Return type
+
+[**CreateCreditResponse**](CreateCreditResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## credit_balance_for_account
+
+> <CreditBalanceResponse> credit_balance_for_account(account_id)
+
+Credit balance for Account
+
+Credit balance for Account
+
+### 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::CreditsApi.new
+account_id = 'ACC00001' # String | account_id corresponding to an account
+
+begin
+  # Credit balance for Account
+  result = api_instance.credit_balance_for_account(account_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->credit_balance_for_account: #{e}"
+end
+```
+
+#### Using the credit_balance_for_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditBalanceResponse>, Integer, Hash)> credit_balance_for_account_with_http_info(account_id)
+
+```ruby
+begin
+  # Credit balance for Account
+  data, status_code, headers = api_instance.credit_balance_for_account_with_http_info(account_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditBalanceResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->credit_balance_for_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | account_id corresponding to an account |  |
+
+### Return type
+
+[**CreditBalanceResponse**](CreditBalanceResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_credit_details
+
+> <CreditDetailsResponse> get_credit_details(credit_id)
+
+Get credit details
+
+Get credit details
+
+### 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::CreditsApi.new
+credit_id = 'creds.1znQx9jiIXw.r44fc' # String | 
+
+begin
+  # Get credit details
+  result = api_instance.get_credit_details(credit_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->get_credit_details: #{e}"
+end
+```
+
+#### Using the get_credit_details_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditDetailsResponse>, Integer, Hash)> get_credit_details_with_http_info(credit_id)
+
+```ruby
+begin
+  # Get credit details
+  data, status_code, headers = api_instance.get_credit_details_with_http_info(credit_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditDetailsResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->get_credit_details_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_id** | **String** |  |  |
+
+### Return type
+
+[**CreditDetailsResponse**](CreditDetailsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_credits
+
+> <ListCreditsResponse> list_credits(opts)
+
+List credits
+
+Get all credits
+
+### 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::CreditsApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | Pagination token used as a marker to get records from next page.
+  status: 'PROCESSED', # String | Filter option to filter by status.
+  account_id: '1234', # String | Filter option to filter based on account id.
+  id: 'cred.1znpoFlsI3U.zmg85', # String | Filter option to filter based on credit id.
+  page_size: 10 # Integer | Maximum page size expected by client to return the record list.    NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.
+}
+
+begin
+  # List credits
+  result = api_instance.list_credits(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->list_credits: #{e}"
+end
+```
+
+#### Using the list_credits_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCreditsResponse>, Integer, Hash)> list_credits_with_http_info(opts)
+
+```ruby
+begin
+  # List credits
+  data, status_code, headers = api_instance.list_credits_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCreditsResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->list_credits_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_token** | **String** | Pagination token used as a marker to get records from next page. | [optional] |
+| **status** | **String** | Filter option to filter by status. | [optional] |
+| **account_id** | **String** | Filter option to filter based on account id. | [optional] |
+| **id** | **String** | Filter option to filter based on credit id. | [optional] |
+| **page_size** | **Integer** | Maximum page size expected by client to return the record list.    NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided. | [optional] |
+
+### Return type
+
+[**ListCreditsResponse**](ListCreditsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## void_credit
+
+> <Credit> void_credit(credit_id)
+
+Void credit
+
+Void credit
+
+### 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::CreditsApi.new
+credit_id = 'creds.1znQx9jiIXw.r44fc' # String | 
+
+begin
+  # Void credit
+  result = api_instance.void_credit(credit_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->void_credit: #{e}"
+end
+```
+
+#### Using the void_credit_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Credit>, Integer, Hash)> void_credit_with_http_info(credit_id)
+
+```ruby
+begin
+  # Void credit
+  data, status_code, headers = api_instance.void_credit_with_http_info(credit_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Credit>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CreditsApi->void_credit_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credit_id** | **String** |  |  |
+
+### Return type
+
+[**Credit**](Credit.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CurrencyConfig.md

@@ -0,0 +1,22 @@
+# TogaiClient::CurrencyConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | Mode to get the currency - CUSTOM: Use the currency provided in the request - ACCOUNT_INVOICE: Use the invoice currency of the given account  |  |
+| **currency** | **String** | Currency to be used, this will be considered if mode is CUSTOM | [optional] |
+| **account_id** | **String** | Id of the account of which invoice currency will be used, this will be considered if mode is ACCOUNT_INVOICE | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CurrencyConfig.new(
+  mode: null,
+  currency: null,
+  account_id: null
+)
+```
+

data/docs/CurrencyRateValue.md

@@ -0,0 +1,20 @@
+# TogaiClient::CurrencyRateValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** |  |  |
+| **rate** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CurrencyRateValue.new(
+  currency: null,
+  rate: null
+)
+```
+

data/docs/CurrencySlabRateDetail.md

@@ -0,0 +1,24 @@
+# TogaiClient::CurrencySlabRateDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** |  |  |
+| **credit_amount** | **Float** | The amount of credit that needs to be credited |  |
+| **slab_details** | [**Array<SlabDetail>**](SlabDetail.md) |  |  |
+| **rate_config** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CurrencySlabRateDetail.new(
+  currency: null,
+  credit_amount: null,
+  slab_details: null,
+  rate_config: null
+)
+```
+

data/docs/CustomInvoiceLineItem.md

@@ -0,0 +1,28 @@
+# TogaiClient::CustomInvoiceLineItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **value_per_quantity** | **Float** |  | [optional] |
+| **quantity** | **Float** |  | [optional] |
+| **value** | **Float** |  | [optional] |
+| **billable_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::CustomInvoiceLineItem.new(
+  id: null,
+  description: null,
+  value_per_quantity: null,
+  quantity: null,
+  value: null,
+  billable_id: null
+)
+```
+

data/docs/Customer.md

@@ -5,9 +5,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Identifier of customer |  |
-| **name** | **String** | Name of the customer |  |
+| **togai_customer_id** | **String** | Unique 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 |  |
+| **address** | [**Address**](Address.md) |  |  |
 | **status** | **String** | Status of the customer |  |
 | **created_at** | **Time** |  |  |
 | **updated_at** | **Time** |  |  |
@@ -19,9 +21,11 @@ require 'togai_client'
 
 instance = TogaiClient::Customer.new(
   id: null,
+  togai_customer_id: null,
   name: null,
   primary_email: null,
-  billing_address: null,
+  billing_address: 201 Boulevard, WA 53123,
+  address: null,
   status: ACTIVE,
   created_at: null,
   updated_at: null

data/docs/CustomerPortalApi.md

@@ -0,0 +1,77 @@
+# TogaiClient::CustomerPortalApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_customer_portal_delegate_token**](CustomerPortalApi.md#get_customer_portal_delegate_token) | **POST** /portal/token | Get delegate token for customer portal |
+
+
+## get_customer_portal_delegate_token
+
+> <TokenResponse> get_customer_portal_delegate_token(get_customer_portal_delegate_token_request)
+
+Get delegate token for customer portal
+
+Get delegate token for customer portal
+
+### 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::CustomerPortalApi.new
+get_customer_portal_delegate_token_request = TogaiClient::GetCustomerPortalDelegateTokenRequest.new({customer_id: 'customer_id_example'}) # GetCustomerPortalDelegateTokenRequest | Payload to get delegate token for customer portal
+
+begin
+  # Get delegate token for customer portal
+  result = api_instance.get_customer_portal_delegate_token(get_customer_portal_delegate_token_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomerPortalApi->get_customer_portal_delegate_token: #{e}"
+end
+```
+
+#### Using the get_customer_portal_delegate_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TokenResponse>, Integer, Hash)> get_customer_portal_delegate_token_with_http_info(get_customer_portal_delegate_token_request)
+
+```ruby
+begin
+  # Get delegate token for customer portal
+  data, status_code, headers = api_instance.get_customer_portal_delegate_token_with_http_info(get_customer_portal_delegate_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TokenResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomerPortalApi->get_customer_portal_delegate_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **get_customer_portal_delegate_token_request** | [**GetCustomerPortalDelegateTokenRequest**](GetCustomerPortalDelegateTokenRequest.md) | Payload to get delegate token for customer portal |  |
+
+### Return type
+
+[**TokenResponse**](TokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+