spartera_api_sdk 0.3.7 → 1.0.58

data/docs/IndustriesApi.md

@@ -1,237 +0,0 @@
-# SparteraApiSdk::IndustriesApi
-
-All URIs are relative to *https://api.spartera.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_industries_by_id**](IndustriesApi.md#get_industries_by_id) | **GET** /industries/{industry_id} | Get single industry by ID |
-| [**list_industries**](IndustriesApi.md#list_industries) | **GET** /industries | Get a list of all industries |
-| [**list_industries_active**](IndustriesApi.md#list_industries_active) | **GET** /industries/active | Get a list of industries that have active marketplace products |
-
-
-## get_industries_by_id
-
-> <GetIndustriesById200Response> get_industries_by_id(industry_id)
-
-Get single industry by ID
-
-### Examples
-
-```ruby
-require 'time'
-require 'spartera_api_sdk'
-# setup authorization
-SparteraApiSdk.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = SparteraApiSdk::IndustriesApi.new
-industry_id = 'industry_id_example' # String | Unique identifier for the Industry
-
-begin
-  # Get single industry by ID
-  result = api_instance.get_industries_by_id(industry_id)
-  p result
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling IndustriesApi->get_industries_by_id: #{e}"
-end
-```
-
-#### Using the get_industries_by_id_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<GetIndustriesById200Response>, Integer, Hash)> get_industries_by_id_with_http_info(industry_id)
-
-```ruby
-begin
-  # Get single industry by ID
-  data, status_code, headers = api_instance.get_industries_by_id_with_http_info(industry_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <GetIndustriesById200Response>
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling IndustriesApi->get_industries_by_id_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **industry_id** | **String** | Unique identifier for the Industry |  |
-
-### Return type
-
-[**GetIndustriesById200Response**](GetIndustriesById200Response.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list_industries
-
-> <ListIndustries200Response> list_industries(opts)
-
-Get a list of all industries
-
-### Examples
-
-```ruby
-require 'time'
-require 'spartera_api_sdk'
-# setup authorization
-SparteraApiSdk.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = SparteraApiSdk::IndustriesApi.new
-opts = {
-  page: 56, # Integer | Page number for pagination
-  limit: 56, # Integer | Number of items per page
-  sort_by: 'sort_by_example', # String | Field to sort by
-  sort_order: 'asc', # String | Sort order (ascending or descending)
-  search: 'search_example' # String | Search term to filter results
-}
-
-begin
-  # Get a list of all industries
-  result = api_instance.list_industries(opts)
-  p result
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling IndustriesApi->list_industries: #{e}"
-end
-```
-
-#### Using the list_industries_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListIndustries200Response>, Integer, Hash)> list_industries_with_http_info(opts)
-
-```ruby
-begin
-  # Get a list of all industries
-  data, status_code, headers = api_instance.list_industries_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListIndustries200Response>
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling IndustriesApi->list_industries_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
-| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
-| **sort_by** | **String** | Field to sort by | [optional] |
-| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to &#39;desc&#39;] |
-| **search** | **String** | Search term to filter results | [optional] |
-
-### Return type
-
-[**ListIndustries200Response**](ListIndustries200Response.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list_industries_active
-
-> <ListIndustries200Response> list_industries_active(opts)
-
-Get a list of industries that have active marketplace products
-
-### Examples
-
-```ruby
-require 'time'
-require 'spartera_api_sdk'
-# setup authorization
-SparteraApiSdk.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = SparteraApiSdk::IndustriesApi.new
-opts = {
-  page: 56, # Integer | Page number for pagination
-  limit: 56, # Integer | Number of items per page
-  sort_by: 'sort_by_example', # String | Field to sort by
-  sort_order: 'asc', # String | Sort order (ascending or descending)
-  search: 'search_example' # String | Search term to filter results
-}
-
-begin
-  # Get a list of industries that have active marketplace products
-  result = api_instance.list_industries_active(opts)
-  p result
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling IndustriesApi->list_industries_active: #{e}"
-end
-```
-
-#### Using the list_industries_active_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListIndustries200Response>, Integer, Hash)> list_industries_active_with_http_info(opts)
-
-```ruby
-begin
-  # Get a list of industries that have active marketplace products
-  data, status_code, headers = api_instance.list_industries_active_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListIndustries200Response>
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling IndustriesApi->list_industries_active_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
-| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
-| **sort_by** | **String** | Field to sort by | [optional] |
-| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to &#39;desc&#39;] |
-| **search** | **String** | Search term to filter results | [optional] |
-
-### Return type
-
-[**ListIndustries200Response**](ListIndustries200Response.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/InlineObject4.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::InlineObject4
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **code** | **Integer** |  | [optional] |
-| **message** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::InlineObject4.new(
-  code: 409,
-  message: Resource already exists
-)
-```
-

data/docs/InlineObject5.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::InlineObject5
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **code** | **Integer** |  | [optional] |
-| **message** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::InlineObject5.new(
-  code: 422,
-  message: Cannot process request
-)
-```
-

data/docs/InlineObject6.md

@@ -1,22 +0,0 @@
-# SparteraApiSdk::InlineObject6
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **code** | **Integer** |  | [optional] |
-| **message** | **String** |  | [optional] |
-| **retry_after** | **Integer** | Seconds to wait before retrying | [optional] |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::InlineObject6.new(
-  code: 429,
-  message: Rate limit exceeded,
-  retry_after: 60
-)
-```
-

data/docs/InlineObject7.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::InlineObject7
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **code** | **Integer** |  | [optional] |
-| **message** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::InlineObject7.new(
-  code: 500,
-  message: Internal server error
-)
-```
-

data/docs/JobFunctions.md

@@ -1,24 +0,0 @@
-# SparteraApiSdk::JobFunctions
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **date_created** | **Time** | Optional. | [optional] |
-| **last_updated** | **Time** | Optional. | [optional] |
-| **function_id** | **Integer** | Auto-generated unique identifier. |  |
-| **name** | **String** | Required. Must be unique. |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::JobFunctions.new(
-  date_created: 2025-04-01T00:00:00Z,
-  last_updated: 2025-04-01T00:00:00Z,
-  function_id: 1,
-  name: Example Name
-)
-```
-

data/docs/JobFunctionsApi.md

@@ -1,157 +0,0 @@
-# SparteraApiSdk::JobFunctionsApi
-
-All URIs are relative to *https://api.spartera.com*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_job_functions_by_id**](JobFunctionsApi.md#get_job_functions_by_id) | **GET** /job-functions/{function_id} | Get single job function by ID |
-| [**list_job_functions**](JobFunctionsApi.md#list_job_functions) | **GET** /job-functions | Get a list of all job functions |
-
-
-## get_job_functions_by_id
-
-> <GetJobFunctionsById200Response> get_job_functions_by_id(function_id)
-
-Get single job function by ID
-
-### Examples
-
-```ruby
-require 'time'
-require 'spartera_api_sdk'
-# setup authorization
-SparteraApiSdk.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = SparteraApiSdk::JobFunctionsApi.new
-function_id = 'function_id_example' # String | Unique identifier for the Function
-
-begin
-  # Get single job function by ID
-  result = api_instance.get_job_functions_by_id(function_id)
-  p result
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling JobFunctionsApi->get_job_functions_by_id: #{e}"
-end
-```
-
-#### Using the get_job_functions_by_id_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<GetJobFunctionsById200Response>, Integer, Hash)> get_job_functions_by_id_with_http_info(function_id)
-
-```ruby
-begin
-  # Get single job function by ID
-  data, status_code, headers = api_instance.get_job_functions_by_id_with_http_info(function_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <GetJobFunctionsById200Response>
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling JobFunctionsApi->get_job_functions_by_id_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **function_id** | **String** | Unique identifier for the Function |  |
-
-### Return type
-
-[**GetJobFunctionsById200Response**](GetJobFunctionsById200Response.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## list_job_functions
-
-> <ListJobFunctions200Response> list_job_functions(opts)
-
-Get a list of all job functions
-
-### Examples
-
-```ruby
-require 'time'
-require 'spartera_api_sdk'
-# setup authorization
-SparteraApiSdk.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['x-api-key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['x-api-key'] = 'Bearer'
-end
-
-api_instance = SparteraApiSdk::JobFunctionsApi.new
-opts = {
-  page: 56, # Integer | Page number for pagination
-  limit: 56, # Integer | Number of items per page
-  sort_by: 'sort_by_example', # String | Field to sort by
-  sort_order: 'asc', # String | Sort order (ascending or descending)
-  search: 'search_example' # String | Search term to filter results
-}
-
-begin
-  # Get a list of all job functions
-  result = api_instance.list_job_functions(opts)
-  p result
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling JobFunctionsApi->list_job_functions: #{e}"
-end
-```
-
-#### Using the list_job_functions_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListJobFunctions200Response>, Integer, Hash)> list_job_functions_with_http_info(opts)
-
-```ruby
-begin
-  # Get a list of all job functions
-  data, status_code, headers = api_instance.list_job_functions_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListJobFunctions200Response>
-rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling JobFunctionsApi->list_job_functions_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
-| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
-| **sort_by** | **String** | Field to sort by | [optional] |
-| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to &#39;desc&#39;] |
-| **search** | **String** | Search term to filter results | [optional] |
-
-### Return type
-
-[**ListJobFunctions200Response**](ListJobFunctions200Response.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/JobFunctionsInput.md

@@ -1,18 +0,0 @@
-# SparteraApiSdk::JobFunctionsInput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | Required. Must be unique. |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::JobFunctionsInput.new(
-  name: Example Name
-)
-```
-

data/docs/JobFunctionsUpdate.md

@@ -1,18 +0,0 @@
-# SparteraApiSdk::JobFunctionsUpdate
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | Required. Must be unique. | [optional] |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::JobFunctionsUpdate.new(
-  name: Example Name
-)
-```
-

data/docs/ListApiKeys200Response.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::ListApiKeys200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Response status message |  |
-| **data** | [**Array<ApiKeys>**](ApiKeys.md) |  |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::ListApiKeys200Response.new(
-  message: success,
-  data: null
-)
-```
-

data/docs/ListAssetUsecases200Response.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::ListAssetUsecases200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Response status message |  |
-| **data** | [**Array<AssetUsecases>**](AssetUsecases.md) |  |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::ListAssetUsecases200Response.new(
-  message: success,
-  data: null
-)
-```
-

data/docs/ListAssets200Response.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::ListAssets200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Response status message |  |
-| **data** | [**Array<Assets>**](Assets.md) |  |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::ListAssets200Response.new(
-  message: success,
-  data: null
-)
-```
-

data/docs/ListCloudProviders200Response.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::ListCloudProviders200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Response status message |  |
-| **data** | [**Array<CloudProviders>**](CloudProviders.md) |  |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::ListCloudProviders200Response.new(
-  message: success,
-  data: null
-)
-```
-

data/docs/ListCompaniesAnalyticsAssets200Response.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::ListCompaniesAnalyticsAssets200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Response status message |  |
-| **data** | [**Array<Companies>**](Companies.md) |  |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::ListCompaniesAnalyticsAssets200Response.new(
-  message: success,
-  data: null
-)
-```
-

data/docs/ListConnections200Response.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::ListConnections200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Response status message |  |
-| **data** | [**Array<Connections>**](Connections.md) |  |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::ListConnections200Response.new(
-  message: success,
-  data: null
-)
-```
-

data/docs/ListEndpoints200Response.md

@@ -1,20 +0,0 @@
-# SparteraApiSdk::ListEndpoints200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Response status message |  |
-| **data** | [**Array<Endpoints>**](Endpoints.md) |  |  |
-
-## Example
-
-```ruby
-require 'spartera_api_sdk'
-
-instance = SparteraApiSdk::ListEndpoints200Response.new(
-  message: success,
-  data: null
-)
-```
-