spartera_api_sdk 1.0.58

data/docs/AssetPriceHistoryApi.md

@@ -0,0 +1,573 @@
+# SparteraApiSdk::AssetPriceHistoryApi
+
+All URIs are relative to *https://api.spartera.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**companies_company_id_assets_asset_id_prices_active_get**](AssetPriceHistoryApi.md#companies_company_id_assets_asset_id_prices_active_get) | **GET** /companies/{company_id}/assets/{asset_id}/prices/active | Get the currently active price for an asset |
+| [**companies_company_id_assets_asset_id_prices_aph_id_delete**](AssetPriceHistoryApi.md#companies_company_id_assets_asset_id_prices_aph_id_delete) | **DELETE** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Delete single price history record by ID |
+| [**companies_company_id_assets_asset_id_prices_aph_id_get**](AssetPriceHistoryApi.md#companies_company_id_assets_asset_id_prices_aph_id_get) | **GET** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Get single price history record by ID |
+| [**companies_company_id_assets_asset_id_prices_aph_id_patch**](AssetPriceHistoryApi.md#companies_company_id_assets_asset_id_prices_aph_id_patch) | **PATCH** /companies/{company_id}/assets/{asset_id}/prices/{aph_id} | Update an existing price history record by ID |
+| [**companies_company_id_assets_asset_id_prices_calculate_credits_post**](AssetPriceHistoryApi.md#companies_company_id_assets_asset_id_prices_calculate_credits_post) | **POST** /companies/{company_id}/assets/{asset_id}/prices/calculate_credits | Calculate the credit equivalent for a given USD price without saving |
+| [**companies_company_id_assets_asset_id_prices_discount_post**](AssetPriceHistoryApi.md#companies_company_id_assets_asset_id_prices_discount_post) | **POST** /companies/{company_id}/assets/{asset_id}/prices/discount | Apply a discount to the active price for an asset |
+| [**companies_company_id_assets_asset_id_prices_get**](AssetPriceHistoryApi.md#companies_company_id_assets_asset_id_prices_get) | **GET** /companies/{company_id}/assets/{asset_id}/prices | Get all price history records for a specific asset |
+| [**companies_company_id_assets_asset_id_prices_post**](AssetPriceHistoryApi.md#companies_company_id_assets_asset_id_prices_post) | **POST** /companies/{company_id}/assets/{asset_id}/prices | Create a new price history record for an asset |
+
+
+## companies_company_id_assets_asset_id_prices_active_get
+
+> Object companies_company_id_assets_asset_id_prices_active_get(company_id, asset_id)
+
+Get the currently active price for an asset
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AssetPriceHistoryApi.new
+company_id = 'company_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+
+begin
+  # Get the currently active price for an asset
+  result = api_instance.companies_company_id_assets_asset_id_prices_active_get(company_id, asset_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_active_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_assets_asset_id_prices_active_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_prices_active_get_with_http_info(company_id, asset_id)
+
+```ruby
+begin
+  # Get the currently active price for an asset
+  data, status_code, headers = api_instance.companies_company_id_assets_asset_id_prices_active_get_with_http_info(company_id, asset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_active_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_assets_asset_id_prices_aph_id_delete
+
+> Object companies_company_id_assets_asset_id_prices_aph_id_delete(company_id, asset_id, aph_id)
+
+Delete single price history record by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AssetPriceHistoryApi.new
+company_id = 'company_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+aph_id = 'aph_id_example' # String | 
+
+begin
+  # Delete single price history record by ID
+  result = api_instance.companies_company_id_assets_asset_id_prices_aph_id_delete(company_id, asset_id, aph_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_aph_id_delete: #{e}"
+end
+```
+
+#### Using the companies_company_id_assets_asset_id_prices_aph_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_prices_aph_id_delete_with_http_info(company_id, asset_id, aph_id)
+
+```ruby
+begin
+  # Delete single price history record by ID
+  data, status_code, headers = api_instance.companies_company_id_assets_asset_id_prices_aph_id_delete_with_http_info(company_id, asset_id, aph_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_aph_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+| **aph_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_assets_asset_id_prices_aph_id_get
+
+> Object companies_company_id_assets_asset_id_prices_aph_id_get(company_id, asset_id, aph_id)
+
+Get single price history record by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AssetPriceHistoryApi.new
+company_id = 'company_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+aph_id = 'aph_id_example' # String | 
+
+begin
+  # Get single price history record by ID
+  result = api_instance.companies_company_id_assets_asset_id_prices_aph_id_get(company_id, asset_id, aph_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_aph_id_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_assets_asset_id_prices_aph_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_prices_aph_id_get_with_http_info(company_id, asset_id, aph_id)
+
+```ruby
+begin
+  # Get single price history record by ID
+  data, status_code, headers = api_instance.companies_company_id_assets_asset_id_prices_aph_id_get_with_http_info(company_id, asset_id, aph_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_aph_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+| **aph_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_assets_asset_id_prices_aph_id_patch
+
+> Object companies_company_id_assets_asset_id_prices_aph_id_patch(company_id, asset_id, aph_id)
+
+Update an existing price history record by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AssetPriceHistoryApi.new
+company_id = 'company_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+aph_id = 'aph_id_example' # String | 
+
+begin
+  # Update an existing price history record by ID
+  result = api_instance.companies_company_id_assets_asset_id_prices_aph_id_patch(company_id, asset_id, aph_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_aph_id_patch: #{e}"
+end
+```
+
+#### Using the companies_company_id_assets_asset_id_prices_aph_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_prices_aph_id_patch_with_http_info(company_id, asset_id, aph_id)
+
+```ruby
+begin
+  # Update an existing price history record by ID
+  data, status_code, headers = api_instance.companies_company_id_assets_asset_id_prices_aph_id_patch_with_http_info(company_id, asset_id, aph_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_aph_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+| **aph_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_assets_asset_id_prices_calculate_credits_post
+
+> Object companies_company_id_assets_asset_id_prices_calculate_credits_post(company_id, asset_id)
+
+Calculate the credit equivalent for a given USD price without saving
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AssetPriceHistoryApi.new
+company_id = 'company_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+
+begin
+  # Calculate the credit equivalent for a given USD price without saving
+  result = api_instance.companies_company_id_assets_asset_id_prices_calculate_credits_post(company_id, asset_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_calculate_credits_post: #{e}"
+end
+```
+
+#### Using the companies_company_id_assets_asset_id_prices_calculate_credits_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_prices_calculate_credits_post_with_http_info(company_id, asset_id)
+
+```ruby
+begin
+  # Calculate the credit equivalent for a given USD price without saving
+  data, status_code, headers = api_instance.companies_company_id_assets_asset_id_prices_calculate_credits_post_with_http_info(company_id, asset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_calculate_credits_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_assets_asset_id_prices_discount_post
+
+> Object companies_company_id_assets_asset_id_prices_discount_post(company_id, asset_id)
+
+Apply a discount to the active price for an asset
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AssetPriceHistoryApi.new
+company_id = 'company_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+
+begin
+  # Apply a discount to the active price for an asset
+  result = api_instance.companies_company_id_assets_asset_id_prices_discount_post(company_id, asset_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_discount_post: #{e}"
+end
+```
+
+#### Using the companies_company_id_assets_asset_id_prices_discount_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_prices_discount_post_with_http_info(company_id, asset_id)
+
+```ruby
+begin
+  # Apply a discount to the active price for an asset
+  data, status_code, headers = api_instance.companies_company_id_assets_asset_id_prices_discount_post_with_http_info(company_id, asset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_discount_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_assets_asset_id_prices_get
+
+> Object companies_company_id_assets_asset_id_prices_get(company_id, asset_id)
+
+Get all price history records for a specific asset
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AssetPriceHistoryApi.new
+company_id = 'company_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+
+begin
+  # Get all price history records for a specific asset
+  result = api_instance.companies_company_id_assets_asset_id_prices_get(company_id, asset_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_assets_asset_id_prices_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_prices_get_with_http_info(company_id, asset_id)
+
+```ruby
+begin
+  # Get all price history records for a specific asset
+  data, status_code, headers = api_instance.companies_company_id_assets_asset_id_prices_get_with_http_info(company_id, asset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_assets_asset_id_prices_post
+
+> Object companies_company_id_assets_asset_id_prices_post(company_id, asset_id)
+
+Create a new price history record for an asset
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::AssetPriceHistoryApi.new
+company_id = 'company_id_example' # String | 
+asset_id = 'asset_id_example' # String | 
+
+begin
+  # Create a new price history record for an asset
+  result = api_instance.companies_company_id_assets_asset_id_prices_post(company_id, asset_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_post: #{e}"
+end
+```
+
+#### Using the companies_company_id_assets_asset_id_prices_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_assets_asset_id_prices_post_with_http_info(company_id, asset_id)
+
+```ruby
+begin
+  # Create a new price history record for an asset
+  data, status_code, headers = api_instance.companies_company_id_assets_asset_id_prices_post_with_http_info(company_id, asset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling AssetPriceHistoryApi->companies_company_id_assets_asset_id_prices_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **asset_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Assetpricehistory.md

@@ -0,0 +1,38 @@
+# SparteraApiSdk::Assetpricehistory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **aph_id** | **String** |  | [optional] |
+| **asset_id** | **String** |  |  |
+| **price_usd** | **Float** |  | [optional] |
+| **price_credits** | **String** |  | [optional] |
+| **discount_percentage** | **Float** |  | [optional] |
+| **sale_start_date** | **String** |  | [optional] |
+| **sale_end_date** | **String** |  | [optional] |
+| **date_ended** | **String** |  | [optional] |
+| **date_created** | **String** |  | [optional][readonly] |
+| **last_updated** | **String** |  | [optional][readonly] |
+| **active** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::Assetpricehistory.new(
+  aph_id: null,
+  asset_id: null,
+  price_usd: null,
+  price_credits: null,
+  discount_percentage: null,
+  sale_start_date: null,
+  sale_end_date: null,
+  date_ended: null,
+  date_created: null,
+  last_updated: null,
+  active: null
+)
+```
+