spartera_api_sdk 1.0.58

data/docs/CompaniesApi.md

@@ -0,0 +1,619 @@
+# SparteraApiSdk::CompaniesApi
+
+All URIs are relative to *https://api.spartera.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**companies_company_id_analytics_assets_get**](CompaniesApi.md#companies_company_id_analytics_assets_get) | **GET** /companies/{company_id}/analytics/assets | Get asset performance analytics     Query params: start_date, end_date, limit, sort_by, include |
+| [**companies_company_id_analytics_customers_get**](CompaniesApi.md#companies_company_id_analytics_customers_get) | **GET** /companies/{company_id}/analytics/customers | Get customer analytics including growth and segmentation     Query params: start_date, end_date, group_by, segment_by |
+| [**companies_company_id_analytics_dashboard_get**](CompaniesApi.md#companies_company_id_analytics_dashboard_get) | **GET** /companies/{company_id}/analytics/dashboard | Get comprehensive dashboard analytics for seller dashboard     Includes all metrics needed for dashboard charts in one call     Query params: start_date, end_date, period (day/week/month/quarter) |
+| [**companies_company_id_analytics_sales_get**](CompaniesApi.md#companies_company_id_analytics_sales_get) | **GET** /companies/{company_id}/analytics/sales | Get sales over time analytics     Query params: start_date, end_date, group_by (day/week/month/quarter), metrics |
+| [**companies_company_id_get**](CompaniesApi.md#companies_company_id_get) | **GET** /companies/{company_id} | Get details of the requestor's own company |
+| [**companies_company_id_objects_get**](CompaniesApi.md#companies_company_id_objects_get) | **GET** /companies/{company_id}/objects | Get all objects (connections, assets) of a single company |
+| [**companies_company_id_patch**](CompaniesApi.md#companies_company_id_patch) | **PATCH** /companies/{company_id} | Update an existing company by ID |
+| [**companies_company_id_requests_plan_get**](CompaniesApi.md#companies_company_id_requests_plan_get) | **GET** /companies/{company_id}/requests/plan | Get the total number of requests allocated in the company's current subscription plan. |
+| [**companies_company_id_requests_usage_get**](CompaniesApi.md#companies_company_id_requests_usage_get) | **GET** /companies/{company_id}/requests/usage | Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included. |
+
+
+## companies_company_id_analytics_assets_get
+
+> Object companies_company_id_analytics_assets_get(company_id)
+
+Get asset performance analytics     Query params: start_date, end_date, limit, sort_by, include
+
+### 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get asset performance analytics     Query params: start_date, end_date, limit, sort_by, include
+  result = api_instance.companies_company_id_analytics_assets_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_analytics_assets_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_analytics_assets_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_analytics_assets_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get asset performance analytics     Query params: start_date, end_date, limit, sort_by, include
+  data, status_code, headers = api_instance.companies_company_id_analytics_assets_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_analytics_assets_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_analytics_customers_get
+
+> Object companies_company_id_analytics_customers_get(company_id)
+
+Get customer analytics including growth and segmentation     Query params: start_date, end_date, group_by, segment_by
+
+### 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get customer analytics including growth and segmentation     Query params: start_date, end_date, group_by, segment_by
+  result = api_instance.companies_company_id_analytics_customers_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_analytics_customers_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_analytics_customers_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_analytics_customers_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get customer analytics including growth and segmentation     Query params: start_date, end_date, group_by, segment_by
+  data, status_code, headers = api_instance.companies_company_id_analytics_customers_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_analytics_customers_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_analytics_dashboard_get
+
+> Object companies_company_id_analytics_dashboard_get(company_id)
+
+Get comprehensive dashboard analytics for seller dashboard     Includes all metrics needed for dashboard charts in one call     Query params: start_date, end_date, period (day/week/month/quarter)
+
+### 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get comprehensive dashboard analytics for seller dashboard     Includes all metrics needed for dashboard charts in one call     Query params: start_date, end_date, period (day/week/month/quarter)
+  result = api_instance.companies_company_id_analytics_dashboard_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_analytics_dashboard_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_analytics_dashboard_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_analytics_dashboard_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get comprehensive dashboard analytics for seller dashboard     Includes all metrics needed for dashboard charts in one call     Query params: start_date, end_date, period (day/week/month/quarter)
+  data, status_code, headers = api_instance.companies_company_id_analytics_dashboard_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_analytics_dashboard_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_analytics_sales_get
+
+> Object companies_company_id_analytics_sales_get(company_id)
+
+Get sales over time analytics     Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
+
+### 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get sales over time analytics     Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
+  result = api_instance.companies_company_id_analytics_sales_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_analytics_sales_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_analytics_sales_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_analytics_sales_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get sales over time analytics     Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
+  data, status_code, headers = api_instance.companies_company_id_analytics_sales_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_analytics_sales_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_get
+
+> Object companies_company_id_get(company_id)
+
+Get details of the requestor's own company
+
+### 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get details of the requestor's own company
+  result = api_instance.companies_company_id_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_get: #{e}"
+end
+```
+
+#### Using the companies_company_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_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get details of the requestor's own company
+  data, status_code, headers = api_instance.companies_company_id_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_objects_get
+
+> Object companies_company_id_objects_get(company_id)
+
+Get all objects (connections, assets) of a single company
+
+### 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get all objects (connections, assets) of a single company
+  result = api_instance.companies_company_id_objects_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_objects_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_objects_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_objects_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get all objects (connections, assets) of a single company
+  data, status_code, headers = api_instance.companies_company_id_objects_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_objects_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_patch
+
+> Object companies_company_id_patch(company_id)
+
+Update an existing company 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Update an existing company by ID
+  result = api_instance.companies_company_id_patch(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_patch: #{e}"
+end
+```
+
+#### Using the companies_company_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_patch_with_http_info(company_id)
+
+```ruby
+begin
+  # Update an existing company by ID
+  data, status_code, headers = api_instance.companies_company_id_patch_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_requests_plan_get
+
+> Object companies_company_id_requests_plan_get(company_id)
+
+Get the total number of requests allocated in the company's current subscription plan.
+
+### 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get the total number of requests allocated in the company's current subscription plan.
+  result = api_instance.companies_company_id_requests_plan_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_requests_plan_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_requests_plan_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_requests_plan_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get the total number of requests allocated in the company's current subscription plan.
+  data, status_code, headers = api_instance.companies_company_id_requests_plan_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_requests_plan_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_requests_usage_get
+
+> Object companies_company_id_requests_usage_get(company_id)
+
+Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
+
+### 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::CompaniesApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
+  result = api_instance.companies_company_id_requests_usage_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_requests_usage_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_requests_usage_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_requests_usage_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get company request usage data for a specific month. Returns JSON metrics by default or CSV logs when download parameter is included.
+  data, status_code, headers = api_instance.companies_company_id_requests_usage_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling CompaniesApi->companies_company_id_requests_usage_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Company.md

@@ -0,0 +1,44 @@
+# SparteraApiSdk::Company
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  | [optional] |
+| **industry_id** | **String** |  | [optional] |
+| **country_id** | **String** |  | [optional] |
+| **company_name** | **String** |  | [optional] |
+| **company_description** | **String** |  | [optional] |
+| **company_handle** | **String** |  |  |
+| **company_domain** | **String** |  |  |
+| **credits_balance** | **String** |  |  |
+| **accepted_eula** | **String** |  | [optional] |
+| **stripe_account_id** | **String** |  | [optional] |
+| **stripe_account_status** | **String** |  | [optional] |
+| **date_created** | **String** |  | [optional] |
+| **last_updated** | **String** |  | [optional] |
+| **active** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::Company.new(
+  company_id: null,
+  industry_id: null,
+  country_id: null,
+  company_name: null,
+  company_description: null,
+  company_handle: null,
+  company_domain: null,
+  credits_balance: null,
+  accepted_eula: null,
+  stripe_account_id: null,
+  stripe_account_status: null,
+  date_created: null,
+  last_updated: null,
+  active: null
+)
+```
+

data/docs/Connection.md

@@ -0,0 +1,54 @@
+# SparteraApiSdk::Connection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_id** | **String** |  | [optional] |
+| **user_id** | **String** |  | [optional] |
+| **engine_id** | **String** |  |  |
+| **company_id** | **String** |  |  |
+| **credential_type** | **String** |  | [optional] |
+| **api_provider** | **String** |  | [optional] |
+| **api_endpoint** | **String** |  | [optional] |
+| **api_key_location** | **String** |  | [optional] |
+| **api_key_param** | **String** |  | [optional] |
+| **api_key_value** | **String** |  | [optional] |
+| **visibility** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **gcp_secret_id** | **String** |  | [optional] |
+| **provider_domain** | **String** |  | [optional] |
+| **verified_usage_ability** | **String** |  | [optional] |
+| **date_created** | **String** |  | [optional] |
+| **last_updated** | **String** |  | [optional] |
+| **active** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::Connection.new(
+  connection_id: null,
+  user_id: null,
+  engine_id: null,
+  company_id: null,
+  credential_type: null,
+  api_provider: null,
+  api_endpoint: null,
+  api_key_location: null,
+  api_key_param: null,
+  api_key_value: null,
+  visibility: null,
+  name: null,
+  description: null,
+  gcp_secret_id: null,
+  provider_domain: null,
+  verified_usage_ability: null,
+  date_created: null,
+  last_updated: null,
+  active: null
+)
+```
+