nucleus_api 1.8.0 → 1.9.1

data/docs/ReasonCode.md

@@ -1,17 +0,0 @@
-# NucleusApi::ReasonCode
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**category** | **String** | category | [optional] 
-**create_date** | **DateTime** |  | [optional] 
-**id** | **String** |  | [optional] 
-**metadata** | **Hash<String, String>** |  | [optional] 
-**reason_code** | **String** | reasonCode | 
-**reason_code_description** | **String** | reasonCodeDescription | [optional] 
-**reason_type** | **String** | reasonType | [optional] 
-**secondary_id** | **String** |  | [optional] 
-**subcategory** | **String** | subcategory | [optional] 
-**update_date** | **DateTime** |  | [optional] 
-
-

data/docs/ResourceApi.md

@@ -1,534 +0,0 @@
-# NucleusApi::ResourceApi
-
-All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_aggregation_account_category_mapping_using_get**](ResourceApi.md#get_aggregation_account_category_mapping_using_get) | **GET** /resource/account_category | Get All Aggregation Account Category mapping
-[**get_aggregation_account_transaction_category_mapping_using_get**](ResourceApi.md#get_aggregation_account_transaction_category_mapping_using_get) | **GET** /resource/merchant_category | Get All Aggregation Account Transaction Category mapping
-[**get_all_country_using_get**](ResourceApi.md#get_all_country_using_get) | **GET** /resource/country | Get All Countries
-[**get_all_currency_using_get**](ResourceApi.md#get_all_currency_using_get) | **GET** /resource/currency | Get All Currencies
-[**get_all_merchant_category_code_using_get**](ResourceApi.md#get_all_merchant_category_code_using_get) | **GET** /resource/merchant_category_code | Get All Merchant Category Codes
-[**get_all_states_using_get**](ResourceApi.md#get_all_states_using_get) | **GET** /resource/state | List all state resource
-[**get_all_statistics_using_get**](ResourceApi.md#get_all_statistics_using_get) | **GET** /resource/statistic | List all statistic resource
-[**get_currency_exchange_rate_all_using_get**](ResourceApi.md#get_currency_exchange_rate_all_using_get) | **GET** /resource/fx_rate | List all fxRates
-[**get_merchants_all_using_get**](ResourceApi.md#get_merchants_all_using_get) | **GET** /resource/merchant | Get all merchants
-
-
-# **get_aggregation_account_category_mapping_using_get**
-> Array<CategoryResponseVO> get_aggregation_account_category_mapping_using_get(opts)
-
-Get All Aggregation Account Category mapping
-
-Get All Aggregation Account Category mapping.
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-opts = { 
-  categories: 'categories_example', # String | categories
-  tenant_name: 'tenant_name_example', # String | tenant_name
-  vendor_name: 'vendor_name_example' # String | vendor_name
-}
-
-begin
-  #Get All Aggregation Account Category mapping
-  result = api_instance.get_aggregation_account_category_mapping_using_get(opts)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_aggregation_account_category_mapping_using_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **categories** | **String**| categories | [optional] 
- **tenant_name** | **String**| tenant_name | [optional] 
- **vendor_name** | **String**| vendor_name | [optional] 
-
-### Return type
-
-[**Array<CategoryResponseVO>**](CategoryResponseVO.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_aggregation_account_transaction_category_mapping_using_get**
-> Array<CategoryResponseVO> get_aggregation_account_transaction_category_mapping_using_get(opts)
-
-Get All Aggregation Account Transaction Category mapping
-
-Get All Aggregation Account Transaction Category mapping.
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-opts = { 
-  categories: 'categories_example', # String | categories
-  tenant_name: 'tenant_name_example', # String | tenant_name
-  vendor_name: 'vendor_name_example' # String | vendor_name
-}
-
-begin
-  #Get All Aggregation Account Transaction Category mapping
-  result = api_instance.get_aggregation_account_transaction_category_mapping_using_get(opts)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_aggregation_account_transaction_category_mapping_using_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **categories** | **String**| categories | [optional] 
- **tenant_name** | **String**| tenant_name | [optional] 
- **vendor_name** | **String**| vendor_name | [optional] 
-
-### Return type
-
-[**Array<CategoryResponseVO>**](CategoryResponseVO.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_all_country_using_get**
-> Array<Country> get_all_country_using_get
-
-Get All Countries
-
-Get All Countries. 
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-begin
-  #Get All Countries
-  result = api_instance.get_all_country_using_get
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_all_country_using_get: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Array<Country>**](Country.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_all_currency_using_get**
-> Array<Currency> get_all_currency_using_get
-
-Get All Currencies
-
-Get All Currencies. 
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-begin
-  #Get All Currencies
-  result = api_instance.get_all_currency_using_get
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_all_currency_using_get: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Array<Currency>**](Currency.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_all_merchant_category_code_using_get**
-> Array<MerchantCategoryCode> get_all_merchant_category_code_using_get(opts)
-
-Get All Merchant Category Codes
-
-Get All Merchant Category Codes.
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-opts = { 
-  filter: 'filter_example' # String | filter
-}
-
-begin
-  #Get All Merchant Category Codes
-  result = api_instance.get_all_merchant_category_code_using_get(opts)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_all_merchant_category_code_using_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filter** | **String**| filter | [optional] 
-
-### Return type
-
-[**Array<MerchantCategoryCode>**](MerchantCategoryCode.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_all_states_using_get**
-> Array<State> get_all_states_using_get(opts)
-
-List all state resource
-
-Get the information for all possible state resource.
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-opts = { 
-  country_code: 'US' # String | country_code
-}
-
-begin
-  #List all state resource
-  result = api_instance.get_all_states_using_get(opts)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_all_states_using_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **country_code** | **String**| country_code | [optional] [default to US]
-
-### Return type
-
-[**Array<State>**](State.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_all_statistics_using_get**
-> Hash<String, Array<StatisticResourceVO>> get_all_statistics_using_get
-
-List all statistic resource
-
-Get the information for all possible statistic resource.
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-begin
-  #List all statistic resource
-  result = api_instance.get_all_statistics_using_get
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_all_statistics_using_get: #{e}"
-end
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-**Hash<String, Array<StatisticResourceVO>>**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_currency_exchange_rate_all_using_get**
-> Array<FxRateView> get_currency_exchange_rate_all_using_get(opts)
-
-List all fxRates
-
-Get information for all fxRates defined for your firm.
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-opts = { 
-  filter: 'filter_example' # String | filter
-}
-
-begin
-  #List all fxRates
-  result = api_instance.get_currency_exchange_rate_all_using_get(opts)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_currency_exchange_rate_all_using_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filter** | **String**| filter | [optional] 
-
-### Return type
-
-[**Array<FxRateView>**](FxRateView.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: */*
-
-
-
-# **get_merchants_all_using_get**
-> MXMerchantRes get_merchants_all_using_get(opts)
-
-Get all merchants
-
-List all merchants.
-
-### Example
-```ruby
-# load the gem
-require 'nucleus_api'
-# Setup authorization
-NucleusApi.configure do |config|
-# Use one of the below method to generate oauth token        
-# Creating a token for grant_type=client_credentials
- config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
-# Creating a token for grant_type=password
- config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
-# Creating a token using client token
- config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
-end
-
-api_instance = NucleusApi::ResourceApi.new
-
-opts = { 
-  ascending: false, # BOOLEAN | ascending
-  filter: 'filter_example', # String | filter
-  order_by: 'id', # String | order_by
-  page: 0, # Integer | page
-  size: 25 # Integer | size
-}
-
-begin
-  #Get all merchants
-  result = api_instance.get_merchants_all_using_get(opts)
-  p result
-rescue NucleusApi::ApiError => e
-  puts "Exception when calling ResourceApi->get_merchants_all_using_get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ascending** | **BOOLEAN**| ascending | [optional] [default to false]
- **filter** | **String**| filter | [optional] 
- **order_by** | **String**| order_by | [optional] [default to id]
- **page** | **Integer**| page | [optional] [default to 0]
- **size** | **Integer**| size | [optional] [default to 25]
-
-### Return type
-
-[**MXMerchantRes**](MXMerchantRes.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: */*
-
-
-