togai_client 1.0.1 → 1.0.2

data/docs/InvoiceGroupAccountsPaginatedResponse.md

@@ -0,0 +1,40 @@
+# TogaiClient::InvoiceGroupAccountsPaginatedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **email** | **String** |  |  |
+| **daily_invoice_consolidation** | **Boolean** |  |  |
+| **net_term_days** | **Integer** |  | [optional] |
+| **invoice_currency** | **String** |  |  |
+| **billing_address** | [**Address**](Address.md) |  |  |
+| **accounts_count** | **Integer** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **accounts** | **Array<String>** |  |  |
+| **next_token** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::InvoiceGroupAccountsPaginatedResponse.new(
+  id: null,
+  name: null,
+  email: null,
+  daily_invoice_consolidation: null,
+  net_term_days: null,
+  invoice_currency: null,
+  billing_address: null,
+  accounts_count: null,
+  created_at: null,
+  updated_at: null,
+  accounts: null,
+  next_token: null
+)
+```
+

data/docs/InvoiceGroupDetails.md

@@ -0,0 +1,30 @@
+# TogaiClient::InvoiceGroupDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **email** | **String** |  |  |
+| **daily_invoice_consolidation** | **Boolean** |  |  |
+| **net_term_days** | **Integer** |  | [optional] |
+| **invoice_currency** | **String** |  |  |
+| **billing_address** | [**Address**](Address.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::InvoiceGroupDetails.new(
+  id: null,
+  name: null,
+  email: null,
+  daily_invoice_consolidation: null,
+  net_term_days: null,
+  invoice_currency: null,
+  billing_address: null
+)
+```
+

data/docs/InvoiceGroupPaginatedResponse.md

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

data/docs/InvoiceGroups.md

@@ -0,0 +1,36 @@
+# TogaiClient::InvoiceGroups
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **email** | **String** |  |  |
+| **daily_invoice_consolidation** | **Boolean** |  |  |
+| **net_term_days** | **Integer** |  | [optional] |
+| **invoice_currency** | **String** |  |  |
+| **billing_address** | [**Address**](Address.md) |  |  |
+| **accounts_count** | **Integer** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::InvoiceGroups.new(
+  id: null,
+  name: null,
+  email: null,
+  daily_invoice_consolidation: null,
+  net_term_days: null,
+  invoice_currency: null,
+  billing_address: null,
+  accounts_count: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/InvoiceGroupsApi.md

@@ -0,0 +1,358 @@
+# TogaiClient::InvoiceGroupsApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_invoice_group_accounts**](InvoiceGroupsApi.md#add_invoice_group_accounts) | **POST** /invoice_groups/{invoice_group_id}/add_accounts | Add accounts to an invoice group |
+| [**create_invoice_group**](InvoiceGroupsApi.md#create_invoice_group) | **POST** /invoice_groups | Create an invoice group |
+| [**get_invoice_group**](InvoiceGroupsApi.md#get_invoice_group) | **GET** /invoice_groups/{invoice_group_id} | Get information of an invoice group |
+| [**list_invoice_groups**](InvoiceGroupsApi.md#list_invoice_groups) | **GET** /invoice_groups | List Invoice Groups |
+| [**remove_invoice_group_accounts**](InvoiceGroupsApi.md#remove_invoice_group_accounts) | **POST** /invoice_groups/{invoice_group_id}/remove_accounts | Remove accounts from an invoice group. Removing all accounts will also delete the invoice group |
+
+
+## add_invoice_group_accounts
+
+> <InvoiceGroups> add_invoice_group_accounts(invoice_group_id, update_invoice_group_accounts)
+
+Add accounts to an invoice group
+
+This API let’s you to add accounts to an invoice group
+
+### 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::InvoiceGroupsApi.new
+invoice_group_id = 'inv_grp.20rqjgFJf2O.ejl25' # String | 
+update_invoice_group_accounts = TogaiClient::UpdateInvoiceGroupAccounts.new({account_ids: ['account_ids_example']}) # UpdateInvoiceGroupAccounts | Payload to add or remove accounts to/from an invoice group
+
+begin
+  # Add accounts to an invoice group
+  result = api_instance.add_invoice_group_accounts(invoice_group_id, update_invoice_group_accounts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->add_invoice_group_accounts: #{e}"
+end
+```
+
+#### Using the add_invoice_group_accounts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvoiceGroups>, Integer, Hash)> add_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts)
+
+```ruby
+begin
+  # Add accounts to an invoice group
+  data, status_code, headers = api_instance.add_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvoiceGroups>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->add_invoice_group_accounts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_group_id** | **String** |  |  |
+| **update_invoice_group_accounts** | [**UpdateInvoiceGroupAccounts**](UpdateInvoiceGroupAccounts.md) | Payload to add or remove accounts to/from an invoice group |  |
+
+### Return type
+
+[**InvoiceGroups**](InvoiceGroups.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_invoice_group
+
+> <InvoiceGroups> create_invoice_group(create_invoice_group_request)
+
+Create an invoice group
+
+This API let’s you to create an invoice group
+
+### 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::InvoiceGroupsApi.new
+create_invoice_group_request = TogaiClient::CreateInvoiceGroupRequest.new({name: 'name_example', email: 'email_example', daily_invoice_consolidation: false, account_ids: ['account_ids_example'], address: TogaiClient::Address.new}) # CreateInvoiceGroupRequest | Payload to approve or decline a proposal
+
+begin
+  # Create an invoice group
+  result = api_instance.create_invoice_group(create_invoice_group_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->create_invoice_group: #{e}"
+end
+```
+
+#### Using the create_invoice_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvoiceGroups>, Integer, Hash)> create_invoice_group_with_http_info(create_invoice_group_request)
+
+```ruby
+begin
+  # Create an invoice group
+  data, status_code, headers = api_instance.create_invoice_group_with_http_info(create_invoice_group_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvoiceGroups>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->create_invoice_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_invoice_group_request** | [**CreateInvoiceGroupRequest**](CreateInvoiceGroupRequest.md) | Payload to approve or decline a proposal |  |
+
+### Return type
+
+[**InvoiceGroups**](InvoiceGroups.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_invoice_group
+
+> <InvoiceGroupAccountsPaginatedResponse> get_invoice_group(invoice_group_id)
+
+Get information of an invoice group
+
+This API let’s you to get information of an invoice group
+
+### 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::InvoiceGroupsApi.new
+invoice_group_id = 'inv_grp.20rqjgFJf2O.ejl25' # String | 
+
+begin
+  # Get information of an invoice group
+  result = api_instance.get_invoice_group(invoice_group_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->get_invoice_group: #{e}"
+end
+```
+
+#### Using the get_invoice_group_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvoiceGroupAccountsPaginatedResponse>, Integer, Hash)> get_invoice_group_with_http_info(invoice_group_id)
+
+```ruby
+begin
+  # Get information of an invoice group
+  data, status_code, headers = api_instance.get_invoice_group_with_http_info(invoice_group_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvoiceGroupAccountsPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->get_invoice_group_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_group_id** | **String** |  |  |
+
+### Return type
+
+[**InvoiceGroupAccountsPaginatedResponse**](InvoiceGroupAccountsPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_invoice_groups
+
+> <InvoiceGroupPaginatedResponse> list_invoice_groups
+
+List Invoice Groups
+
+This API let’s you to list invoice groups
+
+### 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::InvoiceGroupsApi.new
+
+begin
+  # List Invoice Groups
+  result = api_instance.list_invoice_groups
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->list_invoice_groups: #{e}"
+end
+```
+
+#### Using the list_invoice_groups_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvoiceGroupPaginatedResponse>, Integer, Hash)> list_invoice_groups_with_http_info
+
+```ruby
+begin
+  # List Invoice Groups
+  data, status_code, headers = api_instance.list_invoice_groups_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvoiceGroupPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->list_invoice_groups_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InvoiceGroupPaginatedResponse**](InvoiceGroupPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_invoice_group_accounts
+
+> <BaseSuccessResponse> remove_invoice_group_accounts(invoice_group_id, update_invoice_group_accounts)
+
+Remove accounts from an invoice group. Removing all accounts will also delete the invoice group
+
+This API let’s you to remove accounts from an invoice group. Removing all accounts will also delete the invoice group
+
+### 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::InvoiceGroupsApi.new
+invoice_group_id = 'inv_grp.20rqjgFJf2O.ejl25' # String | 
+update_invoice_group_accounts = TogaiClient::UpdateInvoiceGroupAccounts.new({account_ids: ['account_ids_example']}) # UpdateInvoiceGroupAccounts | Payload to add or remove accounts to/from an invoice group
+
+begin
+  # Remove accounts from an invoice group. Removing all accounts will also delete the invoice group
+  result = api_instance.remove_invoice_group_accounts(invoice_group_id, update_invoice_group_accounts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->remove_invoice_group_accounts: #{e}"
+end
+```
+
+#### Using the remove_invoice_group_accounts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BaseSuccessResponse>, Integer, Hash)> remove_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts)
+
+```ruby
+begin
+  # Remove accounts from an invoice group. Removing all accounts will also delete the invoice group
+  data, status_code, headers = api_instance.remove_invoice_group_accounts_with_http_info(invoice_group_id, update_invoice_group_accounts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BaseSuccessResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling InvoiceGroupsApi->remove_invoice_group_accounts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_group_id** | **String** |  |  |
+| **update_invoice_group_accounts** | [**UpdateInvoiceGroupAccounts**](UpdateInvoiceGroupAccounts.md) | Payload to add or remove accounts to/from an invoice group |  |
+
+### Return type
+
+[**BaseSuccessResponse**](BaseSuccessResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/InvoiceInfoInner.md

@@ -0,0 +1,20 @@
+# TogaiClient::InvoiceInfoInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of the information |  |
+| **value** | **String** | Value of the information |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::InvoiceInfoInner.new(
+  type: null,
+  value: null
+)
+```
+

data/docs/InvoiceLineItem.md

@@ -0,0 +1,34 @@
+# TogaiClient::InvoiceLineItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **description** | **String** |  |  |
+| **type** | **String** | Type of the line item - GRAND_TOTAL_AMOUNT: Sum of all total amount of individual invoices in a grouped(composite) invoice - TOTAL_AMOUNT: Total revenue of the invoice - NET_AMOUNT: Net revenue of the invoice ( Gross revenue - Discounts ) - GROSS_AMOUNT: Gross revenue of the invoice  - PRICE_PLAN_AMOUNT: SUB_TOTAL_AMOUNT + true up amount - SUB_TOTAL_AMOUNT: Sum of all rate card revenues - TRUE_UP_AMOUNT: Minimum commitment - SUB_TOTAL_AMOUNT (Always positive) - TOTAL_USAGE: List of all the usage meter usages - USAGE_METER_USAGE: Usage of an usage meter - USAGE_RATE_CARD_AMOUNT: Revenue generated from usage rate card - USAGE_RATE_CARD_SLAB_AMOUNT: Revenue generated from usage rate card slab - FIXED_FEE_RATE_CARD_AMOUNT: Revenue generated from fixed fee rate card - CREDIT_GRANT_RATE_CARD_AMOUNT: : Revenue generated from credit grant rate card - BILLING_ENTITLEMENT_RATE_CARD_AMOUNT: Revenue generated from billing entitlement rate card - ENTITLEMENT_OVERAGE_RATE_CARD_AMOUNT: : Revenue generated from entitlement overage rate card - ENTITLEMENT_OVERAGE_RATE_CARD_SLAB_AMOUNT: Revenue generated from entitlement overage rate card slab - LICENSE_RATE_CARD_AMOUNT: Revenue generated from license rate card - TOTAL_CREDITS: Sum of all credit amounts - SUB_CREDITS: Granted credit value - TOTAL_ADVANCED_FEES: Sum of all advanced fee revenue - ADVANCED_FIXED_FEE: Revenue generated from advanced fixed fee rate card - ADVANCED_LICENSE_RATE_CARD_AMOUNT: Revenue generated from advanced license rate card - ADVANCED_BILLING_ENTITLEMENT_RATE_CARD_AMOUNT: Revenue generated from advanced billing entitlement rate card - ADVANCED_CREDIT_GRANT_RATE_CARD_AMOUNT: Revenue generated from advanced credit grant rate card - TOTAL_MISCELLANEOUS_CHARGES: Net revenue of all MISCELLANEOUS_CHARGE - MISCELLANEOUS_CHARGE: Custom amount added to a DRAFT invoice - TOTAL_PURCHASE_AMOUNT: Net revenue all rate cards in a purchase plan - CUSTOM_AMOUNT: Custom amount added a DRAFT invoice - CUSTOM_TAG: User defined tags given to each rate card - TOTAL_PRICING_RULE_ADDITION_AMOUNT: Sum of all line items added by applying pricing rules - PRICING_RULE_ADDITION_AMOUNT: Amount added to invoice as a result of applying a pricing rule - PRICING_RULE_REVENUE_UPDATE_AMOUNT: Difference in revenue(value) obtained as a result of applying a pricing rule - PRICING_RULE_USAGE_UPDATE_AMOUNT: Difference in usage(quantity) obtained as a result of applying a pricing rule - RATE_CONFIG_ADJUSTMENT_AMOUNT: Difference in revenue obtained as a result of applying rate config['minimumRate', 'maximumRate'] at rate card level  |  |
+| **value_per_quantity** | **Float** |  | [optional] |
+| **quantity** | **Float** |  | [optional] |
+| **units** | **String** |  | [optional] |
+| **value** | **Float** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **line_items** | [**Array<InvoiceLineItem>**](InvoiceLineItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::InvoiceLineItem.new(
+  id: null,
+  description: null,
+  type: null,
+  value_per_quantity: null,
+  quantity: null,
+  units: null,
+  value: null,
+  metadata: null,
+  line_items: null
+)
+```
+

data/docs/InvoiceSummary.md

@@ -0,0 +1,58 @@
+# TogaiClient::InvoiceSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of invoice |  |
+| **customer_id** | **String** |  | [optional] |
+| **owner_id** | **String** |  | [optional] |
+| **price_plan_id** | **String** |  | [optional] |
+| **status** | [**InvoicesStatus**](InvoicesStatus.md) |  |  |
+| **finalizing_status** | **String** |  | [optional] |
+| **invoice_class** | [**InvoicesClass**](InvoicesClass.md) |  |  |
+| **invoice_type** | [**InvoicesType**](InvoicesType.md) |  |  |
+| **start_date** | **Time** | Start date of the invoice | [optional] |
+| **end_date** | **Time** | End date of the invoice | [optional] |
+| **end_date_inclusive** | **Time** | Inclusive end date of the invoice | [optional] |
+| **invoice_date** | **Time** | Invoice date of the invoice |  |
+| **due_date** | **Time** | Due date of the invoice | [optional] |
+| **generated_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  |  |
+| **sequence_id** | **String** | Sequence id of the invoice | [optional] |
+| **pdf_url** | **String** | Download URL of the pdf file corresponding to the invoice | [optional] |
+| **total_amount** | **Float** |  |  |
+| **paid_amount** | **Float** |  |  |
+| **invoice_details** | [**InvoiceDetails**](InvoiceDetails.md) |  | [optional] |
+| **net_term_days** | **Integer** | Number of days from the invoice date after which an invoice is considered overdue. |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::InvoiceSummary.new(
+  id: null,
+  customer_id: null,
+  owner_id: null,
+  price_plan_id: null,
+  status: null,
+  finalizing_status: null,
+  invoice_class: null,
+  invoice_type: null,
+  start_date: 2020-07-04T12:00Z,
+  end_date: 2020-07-04T12:00Z,
+  end_date_inclusive: 2020-07-03T11:59:59.999Z,
+  invoice_date: 2020-07-04T12:00Z,
+  due_date: 2020-07-04T12:00Z,
+  generated_at: null,
+  updated_at: null,
+  sequence_id: null,
+  pdf_url: null,
+  total_amount: null,
+  paid_amount: null,
+  invoice_details: null,
+  net_term_days: null
+)
+```
+

data/docs/InvoiceTiming.md

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