togai_client 1.0.1 → 1.0.2

data/docs/LicenseUpdate.md

@@ -0,0 +1,26 @@
+# TogaiClient::LicenseUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **license_id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+| **quantity** | **Float** | Absolute quantity of the license |  |
+| **effective_from** | **Time** |  |  |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseUpdate.new(
+  license_id: lic.fdjsl.313,
+  account_id: acc.fdjsl.313,
+  quantity: 10,
+  effective_from: 2021-03-04T14:25:10Z,
+  metadata: {"key1":"value1","key2":"value2"}
+)
+```
+

data/docs/LicenseUpdateRequest.md

@@ -0,0 +1,30 @@
+# TogaiClient::LicenseUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **license_id** | **String** | The license id for which the update is requested |  |
+| **account_id** | **String** | The account id for which the license is being updated |  |
+| **update_type** | **String** | The type of update to be performed |  |
+| **quantity** | **Float** | The quantity to be updated |  |
+| **effective_from** | **Time** | The effective from date for the update | [optional] |
+| **idempotency_key** | **String** | The idempotency key for uniqueness of the license update request | [optional] |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseUpdateRequest.new(
+  license_id: lic.fdjsl.313,
+  account_id: acc.fdjsl.313,
+  update_type: null,
+  quantity: null,
+  effective_from: 2021-03-04T14:25:10Z,
+  idempotency_key: idempotencyKey#1,
+  metadata: {"key1":"value1","key2":"value2"}
+)
+```
+

data/docs/LicenseUpdateResponse.md

@@ -0,0 +1,28 @@
+# TogaiClient::LicenseUpdateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **license_id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+| **quantity** | **Float** | Absolute quantity of the license |  |
+| **effective_from** | **Time** |  |  |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseUpdateResponse.new(
+  license_id: lic.fdjsl.313,
+  account_id: acc.fdjsl.313,
+  quantity: 10,
+  effective_from: 2021-03-04T14:25:10Z,
+  metadata: {key1=value1, key2=value2},
+  created_at: 2021-03-04T14:25:10Z
+)
+```
+

data/docs/LicensesApi.md

@@ -0,0 +1,300 @@
+# TogaiClient::LicensesApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_license_update_entry**](LicensesApi.md#add_license_update_entry) | **POST** /license_updates | Update a license entry |
+| [**get_license_updates**](LicensesApi.md#get_license_updates) | **GET** /license_updates | Get a list of licenses updates |
+| [**get_named_license_updates**](LicensesApi.md#get_named_license_updates) | **GET** /named_license_updates | Get a list of named licenses updates |
+| [**update_license_entry_details**](LicensesApi.md#update_license_entry_details) | **PATCH** /license_updates/{license_id} | Update a license entry details |
+
+
+## add_license_update_entry
+
+> <LicenseUpdateResponse> add_license_update_entry(opts)
+
+Update a license entry
+
+This API let’s you to add a license entry
+
+### 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::LicensesApi.new
+opts = {
+  license_update_request: TogaiClient::LicenseUpdateRequest.new({license_id: 'lic.fdjsl.313', account_id: 'acc.fdjsl.313', update_type: 'RELATIVE', quantity: 3.56}) # LicenseUpdateRequest | 
+}
+
+begin
+  # Update a license entry
+  result = api_instance.add_license_update_entry(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling LicensesApi->add_license_update_entry: #{e}"
+end
+```
+
+#### Using the add_license_update_entry_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LicenseUpdateResponse>, Integer, Hash)> add_license_update_entry_with_http_info(opts)
+
+```ruby
+begin
+  # Update a license entry
+  data, status_code, headers = api_instance.add_license_update_entry_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LicenseUpdateResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling LicensesApi->add_license_update_entry_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **license_update_request** | [**LicenseUpdateRequest**](LicenseUpdateRequest.md) |  | [optional] |
+
+### Return type
+
+[**LicenseUpdateResponse**](LicenseUpdateResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_license_updates
+
+> <GetLicenseUpdatesResponse> get_license_updates(opts)
+
+Get a list of licenses updates
+
+This API let’s you to fetch a list of licenses updates with multiple query parameters
+
+### 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::LicensesApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | Pagination token used as a marker to get records from next page.
+  account_id: '1234', # String | Filter option to filter based on account 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.
+  license_id: 'addon.1zYnCiM9Bpg.1zYn', # String | License Id to filter
+  effective_from: Time.parse('2021-03-04T14:25:10Z') # Time | effectiveFrom to filter
+}
+
+begin
+  # Get a list of licenses updates
+  result = api_instance.get_license_updates(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling LicensesApi->get_license_updates: #{e}"
+end
+```
+
+#### Using the get_license_updates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetLicenseUpdatesResponse>, Integer, Hash)> get_license_updates_with_http_info(opts)
+
+```ruby
+begin
+  # Get a list of licenses updates
+  data, status_code, headers = api_instance.get_license_updates_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetLicenseUpdatesResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling LicensesApi->get_license_updates_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] |
+| **account_id** | **String** | Filter option to filter based on account 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] |
+| **license_id** | **String** | License Id to filter | [optional] |
+| **effective_from** | **Time** | effectiveFrom to filter | [optional] |
+
+### Return type
+
+[**GetLicenseUpdatesResponse**](GetLicenseUpdatesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_named_license_updates
+
+> <NamedLicenseUpdatesPaginatedResponse> get_named_license_updates
+
+Get a list of named licenses updates
+
+This API let’s you to fetch a list of named licenses updates with multiple query parameters
+
+### 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::LicensesApi.new
+
+begin
+  # Get a list of named licenses updates
+  result = api_instance.get_named_license_updates
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling LicensesApi->get_named_license_updates: #{e}"
+end
+```
+
+#### Using the get_named_license_updates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NamedLicenseUpdatesPaginatedResponse>, Integer, Hash)> get_named_license_updates_with_http_info
+
+```ruby
+begin
+  # Get a list of named licenses updates
+  data, status_code, headers = api_instance.get_named_license_updates_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NamedLicenseUpdatesPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling LicensesApi->get_named_license_updates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**NamedLicenseUpdatesPaginatedResponse**](NamedLicenseUpdatesPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_license_entry_details
+
+> <LicenseUpdateResponse> update_license_entry_details(opts)
+
+Update a license entry details
+
+This API let’s you to update metadata of a license entry
+
+### 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::LicensesApi.new
+opts = {
+  license_id: 'addon.1zYnCiM9Bpg.1zYn', # String | License Id to filter
+  license_entry_details_update_request: TogaiClient::LicenseEntryDetailsUpdateRequest.new({account_id: 'acc.fdjsl.313', effective_from: Time.parse('2021-03-04T14:25:10Z'), metadata: { key: 'inner_example'}}) # LicenseEntryDetailsUpdateRequest | 
+}
+
+begin
+  # Update a license entry details
+  result = api_instance.update_license_entry_details(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling LicensesApi->update_license_entry_details: #{e}"
+end
+```
+
+#### Using the update_license_entry_details_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LicenseUpdateResponse>, Integer, Hash)> update_license_entry_details_with_http_info(opts)
+
+```ruby
+begin
+  # Update a license entry details
+  data, status_code, headers = api_instance.update_license_entry_details_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LicenseUpdateResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling LicensesApi->update_license_entry_details_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **license_id** | **String** | License Id to filter | [optional] |
+| **license_entry_details_update_request** | [**LicenseEntryDetailsUpdateRequest**](LicenseEntryDetailsUpdateRequest.md) |  | [optional] |
+
+### Return type
+
+[**LicenseUpdateResponse**](LicenseUpdateResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ListCreditsResponse.md

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

data/docs/ListInvoicesResponse.md

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

data/docs/ListPaymentResponse.md

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

data/docs/ManageMiscellaneousChargesRequest.md

@@ -0,0 +1,18 @@
+# TogaiClient::ManageMiscellaneousChargesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<MiscellaneousCharge>**](MiscellaneousCharge.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::ManageMiscellaneousChargesRequest.new(
+  items: null
+)
+```
+

data/docs/MaxQuantityBreachAction.md

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

data/docs/MetricQuery.md

@@ -4,11 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
-| **name** | [**MetricName**](MetricName.md) |  |  |
-| **aggregation_period** | **String** |  |  |
-| **group_by** | **String** |  | [optional] |
-| **filters** | [**Array<MetricQueryFilterEntry>**](MetricQueryFilterEntry.md) |  | [optional] |
+| **id** | **String** | Mandatory  for all request.  User defined ID for identifying the request for your internal reference  |  |
+| **name** | [**MetricName**](MetricName.md) |  | [default to 'EVENTS'] |
+| **aggregation_period** | **String** | Set the aggregation period. Allowed periods are HOUR, DAY, WEEK, MONTH | [default to 'DAY'] |
+| **group_by** | **String** | Group your metric with a groupBy field.  Allowed fields are  ACCOUNT_ID EVENT_STATUS  SCHEMA_NAME  USAGE_METER_ID [Use BILLABLE_ID as this will be deprecated soon...] BILLABLE_ID RAW_EVENT_STATUS Please refer the table above for the list of combinations allowed in the groupBy  | [optional] |
+| **configs** | **Hash<String, String>** | Configurations. | Metric Name       | Config Key | Allowed Values  | Default value |              Description          | |-------------------|------------|-----------------|---------------|-----------------------------------| | REVENUE           | CURRENCY   | BASE or INVOICE | BASE          | currency to return the revenue in | | REVENUE_FOR_CYCLE | CURRENCY   | BASE or INVOICE | BASE          | currency to return the revenue in |  | [optional] |
+| **filters** | [**Array<MetricQueryFilterEntry>**](MetricQueryFilterEntry.md) | Filter on specific fields.  Refer possible fieldNames and fieldValues from the table above.  | [optional] |
 
 ## Example
 
@@ -20,6 +21,7 @@ instance = TogaiClient::MetricQuery.new(
   name: null,
   aggregation_period: null,
   group_by: null,
+  configs: null,
   filters: null
 )
 ```

data/docs/MetricQueryFilterEntry.md

@@ -13,7 +13,7 @@
 require 'togai_client'
 
 instance = TogaiClient::MetricQueryFilterEntry.new(
-  field_name: null,
+  field_name: ACCOUNT_ID,
   field_values: null
 )
 ```

data/docs/MetricQueryResponse.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** |  |  |
-| **name** | [**MetricName**](MetricName.md) |  |  |
+| **name** | [**MetricName**](MetricName.md) |  | [default to 'EVENTS'] |
 | **data** | [**Array<MetricDataPoints>**](MetricDataPoints.md) |  |  |
 
 ## Example

data/docs/MetricsApi.md

@@ -1,19 +1,19 @@
 # TogaiClient::MetricsApi
 
-All URIs are relative to *https://sandbox-api.togai.com*
+All URIs are relative to *https://api.togai.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_metrics**](MetricsApi.md#get_metrics) | **POST** /metrics | Get togai metrics. |
+| [**get_metrics**](MetricsApi.md#get_metrics) | **POST** /metrics | Get Togai Metrics |
 
 
 ## get_metrics
 
 > <GetMetricsResponse> get_metrics(opts)
 
-Get togai metrics.
+Get Togai Metrics
 
-To get the metrics, you make a POST request to the /metrics resource. You can query up to five metrics in a single request. Single response dataset can contain a maximum of 100 data points.
+Togai Metrics API allows you to fetch different metrics from Events, Usage Meters and PricePlans with multiple queryable options. A single request can query up to five metrics.  Single response can contain a maximum of 300 data points. 
 
 ### Examples
 
@@ -28,11 +28,11 @@ end
 
 api_instance = TogaiClient::MetricsApi.new
 opts = {
-  get_metrics_request: TogaiClient::GetMetricsRequest.new({start_time: Time.now, end_time: Time.now, metric_queries: [TogaiClient::MetricQuery.new({id: 'id_example', name: TogaiClient::MetricName::EVENTS, aggregation_period: 'DAY'})]}) # GetMetricsRequest | 
+  get_metrics_request: TogaiClient::GetMetricsRequest.new({start_time: Time.parse('2017-07-21T00:00Z'), end_time: Time.parse('2017-07-21T00:00Z'), metric_queries: [TogaiClient::MetricQuery.new({id: 'id_example', name: TogaiClient::MetricName::EVENTS, aggregation_period: 'HOUR'})]}) # GetMetricsRequest | 
 }
 
 begin
-  # Get togai metrics.
+  # Get Togai Metrics
   result = api_instance.get_metrics(opts)
   p result
 rescue TogaiClient::ApiError => e
@@ -48,7 +48,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get togai metrics.
+  # Get Togai Metrics
   data, status_code, headers = api_instance.get_metrics_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/MigrationMode.md

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

data/docs/MinimumCommitment.md

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

data/docs/MiscellaneousCharge.md

@@ -0,0 +1,26 @@
+# TogaiClient::MiscellaneousCharge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the miscellaneous charge |  |
+| **rate** | **Float** | Rate of the charge | [optional] |
+| **quantity** | **Float** | Quantity of the charge | [optional] |
+| **value** | **String** | Value of the charge Possible values: 1. Fixed number [Example: 10] 2. Json Logic [Example: {\"*\": [{\"var\": \"um.lineitem.id\"}, 0.1]}]    You can use all line item ids as variables in the json logic  | [optional] |
+| **consider_for_revenue** | **Boolean** | Specifies whether to consider this miscellaneous charge for revenue or not | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::MiscellaneousCharge.new(
+  name: Charge 1,
+  rate: 20,
+  quantity: 10,
+  value: 100,
+  consider_for_revenue: true
+)
+```
+

data/docs/MiscellaneousChargesResponse.md

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

data/docs/ModelAlias.md

@@ -0,0 +1,20 @@
+# TogaiClient::ModelAlias
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::ModelAlias.new(
+  value: null,
+  created_at: null
+)
+```
+