togai_client 1.0.1 → 1.0.2

data/docs/FeatureApi.md

@@ -0,0 +1,293 @@
+# TogaiClient::FeatureApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_feature**](FeatureApi.md#create_feature) | **POST** /features | Create a Feature and optionally associate with one or more event_schemas |
+| [**get_feature**](FeatureApi.md#get_feature) | **GET** /features/{feature_id} | Get a Feature |
+| [**get_features**](FeatureApi.md#get_features) | **GET** /features | List Feature |
+| [**update_feature**](FeatureApi.md#update_feature) | **PATCH** /features/{feature_id} | Update a Feature |
+
+
+## create_feature
+
+> <Feature> create_feature(create_feature_request)
+
+Create a Feature and optionally associate with one or more event_schemas
+
+Create a Feature optionally associate with one or more event_schemas
+
+### 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::FeatureApi.new
+create_feature_request = TogaiClient::CreateFeatureRequest.new({name: 'name_example', schema_associations: [TogaiClient::EventSchemasForFeature.new({schema_name: 'schema_name_example', attribute_name: 'attribute_name_example'})]}) # CreateFeatureRequest | Payload to create a Feature along the association with event_schemas
+
+begin
+  # Create a Feature and optionally associate with one or more event_schemas
+  result = api_instance.create_feature(create_feature_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FeatureApi->create_feature: #{e}"
+end
+```
+
+#### Using the create_feature_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Feature>, Integer, Hash)> create_feature_with_http_info(create_feature_request)
+
+```ruby
+begin
+  # Create a Feature and optionally associate with one or more event_schemas
+  data, status_code, headers = api_instance.create_feature_with_http_info(create_feature_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Feature>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FeatureApi->create_feature_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_feature_request** | [**CreateFeatureRequest**](CreateFeatureRequest.md) | Payload to create a Feature along the association with event_schemas |  |
+
+### Return type
+
+[**Feature**](Feature.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_feature
+
+> <Feature> get_feature(feature_id)
+
+Get a Feature
+
+Get details of a Feature
+
+### 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::FeatureApi.new
+feature_id = 'feat.fdjskl.sdkjl' # String | feature_id corresponding to a feature
+
+begin
+  # Get a Feature
+  result = api_instance.get_feature(feature_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FeatureApi->get_feature: #{e}"
+end
+```
+
+#### Using the get_feature_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Feature>, Integer, Hash)> get_feature_with_http_info(feature_id)
+
+```ruby
+begin
+  # Get a Feature
+  data, status_code, headers = api_instance.get_feature_with_http_info(feature_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Feature>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FeatureApi->get_feature_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_id** | **String** | feature_id corresponding to a feature |  |
+
+### Return type
+
+[**Feature**](Feature.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_features
+
+> <FeaturePaginatedListData> get_features(opts)
+
+List Feature
+
+Get a list of features along with its associations
+
+### 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::FeatureApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: 10 # Float | 
+}
+
+begin
+  # List Feature
+  result = api_instance.get_features(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FeatureApi->get_features: #{e}"
+end
+```
+
+#### Using the get_features_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeaturePaginatedListData>, Integer, Hash)> get_features_with_http_info(opts)
+
+```ruby
+begin
+  # List Feature
+  data, status_code, headers = api_instance.get_features_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeaturePaginatedListData>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FeatureApi->get_features_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_token** | **String** |  | [optional] |
+| **page_size** | **Float** |  | [optional] |
+
+### Return type
+
+[**FeaturePaginatedListData**](FeaturePaginatedListData.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_feature
+
+> <Feature> update_feature(feature_id, update_feature_request)
+
+Update a Feature
+
+Update an existing feature and its eventSchema associations 
+
+### 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::FeatureApi.new
+feature_id = 'feat.fdjskl.sdkjl' # String | feature_id corresponding to a feature
+update_feature_request = TogaiClient::UpdateFeatureRequest.new # UpdateFeatureRequest | Payload to update a Feature along the associations with event_schemas
+
+begin
+  # Update a Feature
+  result = api_instance.update_feature(feature_id, update_feature_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FeatureApi->update_feature: #{e}"
+end
+```
+
+#### Using the update_feature_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Feature>, Integer, Hash)> update_feature_with_http_info(feature_id, update_feature_request)
+
+```ruby
+begin
+  # Update a Feature
+  data, status_code, headers = api_instance.update_feature_with_http_info(feature_id, update_feature_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Feature>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FeatureApi->update_feature_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_id** | **String** | feature_id corresponding to a feature |  |
+| **update_feature_request** | [**UpdateFeatureRequest**](UpdateFeatureRequest.md) | Payload to update a Feature along the associations with event_schemas |  |
+
+### Return type
+
+[**Feature**](Feature.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FeatureConfig.md

@@ -0,0 +1,22 @@
+# TogaiClient::FeatureConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **effective_from** | **String** |  | [optional] |
+| **effective_until** | **String** |  |  |
+| **feature_credit_limit** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::FeatureConfig.new(
+  effective_from: null,
+  effective_until: null,
+  feature_credit_limit: null
+)
+```
+

data/docs/FeatureCreditEntry.md

@@ -0,0 +1,32 @@
+# TogaiClient::FeatureCreditEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **source** | **String** | Source of the feature credit |  |
+| **status** | **String** | Status of the feature credit entry |  |
+| **effective_from** | **Time** |  |  |
+| **effective_until** | **Time** |  |  |
+| **granted** | **Float** |  | [optional] |
+| **balance** | **Float** |  | [optional] |
+| **used** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::FeatureCreditEntry.new(
+  id: purchase.20rvWRxQcQK.0ZwPG$1,
+  source: null,
+  status: null,
+  effective_from: 2021-03-04T14:25:10Z,
+  effective_until: 2021-05-20T01:00:10Z,
+  granted: 15,
+  balance: 10,
+  used: 10
+)
+```
+

data/docs/FeatureDetails.md

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

data/docs/FeatureListResponse.md

@@ -0,0 +1,30 @@
+# TogaiClient::FeatureListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **billable_name** | **String** |  | [optional] |
+| **display_name** | **String** | Display name of feature. This is an auto-generated field which contains billableName of feature. If billableName is not provided, name will be used as display name.  |  |
+| **schema_count** | **Integer** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::FeatureListResponse.new(
+  id: null,
+  name: null,
+  billable_name: null,
+  display_name: null,
+  schema_count: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/FeaturePaginatedListData.md

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

data/docs/Field.md

@@ -0,0 +1,26 @@
+# TogaiClient::Field
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **type** | **String** |  |  |
+| **enrichment_type** | **String** |  |  |
+| **value** | **String** |  |  |
+| **order** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Field.new(
+  name: null,
+  type: null,
+  enrichment_type: null,
+  value: null,
+  order: null
+)
+```
+

data/docs/FileDownloadUrlResponse.md

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

data/docs/FileStorageApi.md

@@ -0,0 +1,151 @@
+# TogaiClient::FileStorageApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_download_url**](FileStorageApi.md#get_download_url) | **GET** /files/{file_id}/download_url | Get a download url for a file |
+| [**get_file**](FileStorageApi.md#get_file) | **GET** /files/{file_id} | Get a file |
+
+
+## get_download_url
+
+> <FileDownloadUrlResponse> get_download_url(file_id, opts)
+
+Get a download url for a file
+
+Get a download url for a file
+
+### 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::FileStorageApi.new
+file_id = 'file.20aUyEZSuYq.SoGbS' # String | 
+opts = {
+  expiry: 300 # Integer | 
+}
+
+begin
+  # Get a download url for a file
+  result = api_instance.get_download_url(file_id, opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FileStorageApi->get_download_url: #{e}"
+end
+```
+
+#### Using the get_download_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FileDownloadUrlResponse>, Integer, Hash)> get_download_url_with_http_info(file_id, opts)
+
+```ruby
+begin
+  # Get a download url for a file
+  data, status_code, headers = api_instance.get_download_url_with_http_info(file_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileDownloadUrlResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FileStorageApi->get_download_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** |  |  |
+| **expiry** | **Integer** |  | [optional] |
+
+### Return type
+
+[**FileDownloadUrlResponse**](FileDownloadUrlResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_file
+
+> <ErrorResponse> get_file(file_id)
+
+Get a file
+
+Get a file
+
+### 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::FileStorageApi.new
+file_id = 'file.20aUyEZSuYq.SoGbS' # String | 
+
+begin
+  # Get a file
+  result = api_instance.get_file(file_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FileStorageApi->get_file: #{e}"
+end
+```
+
+#### Using the get_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ErrorResponse>, Integer, Hash)> get_file_with_http_info(file_id)
+
+```ruby
+begin
+  # Get a file
+  data, status_code, headers = api_instance.get_file_with_http_info(file_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ErrorResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling FileStorageApi->get_file_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** |  |  |
+
+### Return type
+
+[**ErrorResponse**](ErrorResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/FinalizeAccountSchedules.md

@@ -0,0 +1,20 @@
+# TogaiClient::FinalizeAccountSchedules
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **pre_actions** | [**Array<PreAction>**](PreAction.md) | Pre actions to be performed before association or disassociation | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::FinalizeAccountSchedules.new(
+  merge_schedules: null,
+  pre_actions: null
+)
+```
+

data/docs/FinalizePricePlanRequest.md

@@ -0,0 +1,20 @@
+# TogaiClient::FinalizePricePlanRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **migration_mode** | [**MigrationMode**](MigrationMode.md) |  | [optional] |
+| **versions_to_migrate** | [**VersionsToMigrate**](VersionsToMigrate.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::FinalizePricePlanRequest.new(
+  migration_mode: null,
+  versions_to_migrate: null
+)
+```
+

data/docs/FixedFeeRateCard.md

@@ -0,0 +1,34 @@
+# TogaiClient::FixedFeeRateCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique Identifier of the attached AddOn |  |
+| **display_name** | **String** | Name of the attached AddOn | [optional] |
+| **name** | **String** | Unique identifier for the rate card in a price plan. If left null it is auto-generated. | [optional] |
+| **tag** | **String** | A tag string to group fixedFeeRateCards | [optional] |
+| **invoice_timing** | [**InvoiceTiming**](InvoiceTiming.md) |  | [optional] |
+| **type** | [**FixedFeeType**](FixedFeeType.md) |  | [optional] |
+| **rate_values** | [**Array<CurrencyRateValue>**](CurrencyRateValue.md) |  |  |
+| **enable_proration** | **Boolean** |  |  |
+| **recurrence_config** | [**RecurrenceConfig**](RecurrenceConfig.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::FixedFeeRateCard.new(
+  id: null,
+  display_name: null,
+  name: null,
+  tag: null,
+  invoice_timing: null,
+  type: null,
+  rate_values: null,
+  enable_proration: false,
+  recurrence_config: null
+)
+```
+