spartera_api_sdk 1.0.62 → 1.0.69

data/docs/ConnectionsApi.md

@@ -8,14 +8,14 @@ All URIs are relative to *https://api.spartera.com*
 | [**companies_company_id_connections_connection_id_get**](ConnectionsApi.md#companies_company_id_connections_connection_id_get) | **GET** /companies/{company_id}/connections/{connection_id} | Get single connection by ID |
 | [**companies_company_id_connections_connection_id_infoschema_get**](ConnectionsApi.md#companies_company_id_connections_connection_id_infoschema_get) | **GET** /companies/{company_id}/connections/{connection_id}/infoschema | Retrieve the information schema for the specified connection |
 | [**companies_company_id_connections_connection_id_patch**](ConnectionsApi.md#companies_company_id_connections_connection_id_patch) | **PATCH** /companies/{company_id}/connections/{connection_id} | Update an existing connection by ID |
-| [**companies_company_id_connections_connection_id_test_get**](ConnectionsApi.md#companies_company_id_connections_connection_id_test_get) | **GET** /companies/{company_id}/connections/{connection_id}/test | Verify the specified connection to ensure it is functioning correctly |
+| [**companies_company_id_connections_connection_id_test_get**](ConnectionsApi.md#companies_company_id_connections_connection_id_test_get) | **GET** /companies/{company_id}/connections/{connection_id}/test | Test the specified connection |
 | [**companies_company_id_connections_get**](ConnectionsApi.md#companies_company_id_connections_get) | **GET** /companies/{company_id}/connections | Get all connections for a specific company |
 | [**companies_company_id_connections_post**](ConnectionsApi.md#companies_company_id_connections_post) | **POST** /companies/{company_id}/connections | Create a new connection by ID |
 
 
 ## companies_company_id_connections_connection_id_delete
 
-> Object companies_company_id_connections_connection_id_delete(company_id, connection_id)
+> <CompaniesCompanyIdConnectionsConnectionIdDelete200Response> companies_company_id_connections_connection_id_delete(company_id, connection_id)
 
 Delete single connection by ID
 
@@ -26,8 +26,10 @@ require 'time'
 require 'spartera_api_sdk'
 # setup authorization
 SparteraApiSdk.configure do |config|
-  # Configure Bearer authorization (JWT): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  # 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::ConnectionsApi.new
@@ -47,7 +49,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_connections_connection_id_delete_with_http_info(company_id, connection_id)
+> <Array(<CompaniesCompanyIdConnectionsConnectionIdDelete200Response>, Integer, Hash)> companies_company_id_connections_connection_id_delete_with_http_info(company_id, connection_id)
 
 ```ruby
 begin
@@ -55,7 +57,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_connections_connection_id_delete_with_http_info(company_id, connection_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdConnectionsConnectionIdDelete200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling ConnectionsApi->companies_company_id_connections_connection_id_delete_with_http_info: #{e}"
 end
@@ -70,11 +72,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdConnectionsConnectionIdDelete200Response**](CompaniesCompanyIdConnectionsConnectionIdDelete200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -84,7 +86,7 @@ end
 
 ## companies_company_id_connections_connection_id_get
 
-> Object companies_company_id_connections_connection_id_get(company_id, connection_id)
+> <CompaniesCompanyIdConnectionsConnectionIdGet200Response> companies_company_id_connections_connection_id_get(company_id, connection_id)
 
 Get single connection by ID
 
@@ -95,8 +97,10 @@ require 'time'
 require 'spartera_api_sdk'
 # setup authorization
 SparteraApiSdk.configure do |config|
-  # Configure Bearer authorization (JWT): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  # 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::ConnectionsApi.new
@@ -116,7 +120,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_connections_connection_id_get_with_http_info(company_id, connection_id)
+> <Array(<CompaniesCompanyIdConnectionsConnectionIdGet200Response>, Integer, Hash)> companies_company_id_connections_connection_id_get_with_http_info(company_id, connection_id)
 
 ```ruby
 begin
@@ -124,7 +128,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_connections_connection_id_get_with_http_info(company_id, connection_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdConnectionsConnectionIdGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling ConnectionsApi->companies_company_id_connections_connection_id_get_with_http_info: #{e}"
 end
@@ -139,11 +143,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdConnectionsConnectionIdGet200Response**](CompaniesCompanyIdConnectionsConnectionIdGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -153,7 +157,7 @@ end
 
 ## companies_company_id_connections_connection_id_infoschema_get
 
-> Object companies_company_id_connections_connection_id_infoschema_get(company_id, connection_id)
+> <CompaniesCompanyIdConnectionsGet200Response> companies_company_id_connections_connection_id_infoschema_get(company_id, connection_id)
 
 Retrieve the information schema for the specified connection
 
@@ -164,8 +168,10 @@ require 'time'
 require 'spartera_api_sdk'
 # setup authorization
 SparteraApiSdk.configure do |config|
-  # Configure Bearer authorization (JWT): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  # 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::ConnectionsApi.new
@@ -185,7 +191,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_connections_connection_id_infoschema_get_with_http_info(company_id, connection_id)
+> <Array(<CompaniesCompanyIdConnectionsGet200Response>, Integer, Hash)> companies_company_id_connections_connection_id_infoschema_get_with_http_info(company_id, connection_id)
 
 ```ruby
 begin
@@ -193,7 +199,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_connections_connection_id_infoschema_get_with_http_info(company_id, connection_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdConnectionsGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling ConnectionsApi->companies_company_id_connections_connection_id_infoschema_get_with_http_info: #{e}"
 end
@@ -208,11 +214,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdConnectionsGet200Response**](CompaniesCompanyIdConnectionsGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -222,7 +228,7 @@ end
 
 ## companies_company_id_connections_connection_id_patch
 
-> Object companies_company_id_connections_connection_id_patch(company_id, connection_id, connection)
+> <CompaniesCompanyIdConnectionsConnectionIdPatch200Response> companies_company_id_connections_connection_id_patch(company_id, connection_id, connection)
 
 Update an existing connection by ID
 
@@ -233,8 +239,10 @@ require 'time'
 require 'spartera_api_sdk'
 # setup authorization
 SparteraApiSdk.configure do |config|
-  # Configure Bearer authorization (JWT): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  # 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::ConnectionsApi.new
@@ -255,7 +263,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_connections_connection_id_patch_with_http_info(company_id, connection_id, connection)
+> <Array(<CompaniesCompanyIdConnectionsConnectionIdPatch200Response>, Integer, Hash)> companies_company_id_connections_connection_id_patch_with_http_info(company_id, connection_id, connection)
 
 ```ruby
 begin
@@ -263,7 +271,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_connections_connection_id_patch_with_http_info(company_id, connection_id, connection)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdConnectionsConnectionIdPatch200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling ConnectionsApi->companies_company_id_connections_connection_id_patch_with_http_info: #{e}"
 end
@@ -279,11 +287,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdConnectionsConnectionIdPatch200Response**](CompaniesCompanyIdConnectionsConnectionIdPatch200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -293,9 +301,9 @@ end
 
 ## companies_company_id_connections_connection_id_test_get
 
-> Object companies_company_id_connections_connection_id_test_get(company_id, connection_id)
+> <CompaniesCompanyIdConnectionsGet200Response> companies_company_id_connections_connection_id_test_get(company_id, connection_id)
 
-Verify the specified connection to ensure it is functioning correctly
+Test the specified connection
 
 ### Examples
 
@@ -304,8 +312,10 @@ require 'time'
 require 'spartera_api_sdk'
 # setup authorization
 SparteraApiSdk.configure do |config|
-  # Configure Bearer authorization (JWT): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  # 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::ConnectionsApi.new
@@ -313,7 +323,7 @@ company_id = 'company_id_example' # String |
 connection_id = 'connection_id_example' # String | 
 
 begin
-  # Verify the specified connection to ensure it is functioning correctly
+  # Test the specified connection
   result = api_instance.companies_company_id_connections_connection_id_test_get(company_id, connection_id)
   p result
 rescue SparteraApiSdk::ApiError => e
@@ -325,15 +335,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_connections_connection_id_test_get_with_http_info(company_id, connection_id)
+> <Array(<CompaniesCompanyIdConnectionsGet200Response>, Integer, Hash)> companies_company_id_connections_connection_id_test_get_with_http_info(company_id, connection_id)
 
 ```ruby
 begin
-  # Verify the specified connection to ensure it is functioning correctly
+  # Test the specified connection
   data, status_code, headers = api_instance.companies_company_id_connections_connection_id_test_get_with_http_info(company_id, connection_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdConnectionsGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling ConnectionsApi->companies_company_id_connections_connection_id_test_get_with_http_info: #{e}"
 end
@@ -348,11 +358,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdConnectionsGet200Response**](CompaniesCompanyIdConnectionsGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -362,7 +372,7 @@ end
 
 ## companies_company_id_connections_get
 
-> Object companies_company_id_connections_get(company_id)
+> <CompaniesCompanyIdConnectionsGet200Response> companies_company_id_connections_get(company_id)
 
 Get all connections for a specific company
 
@@ -373,8 +383,10 @@ require 'time'
 require 'spartera_api_sdk'
 # setup authorization
 SparteraApiSdk.configure do |config|
-  # Configure Bearer authorization (JWT): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  # 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::ConnectionsApi.new
@@ -393,7 +405,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_connections_get_with_http_info(company_id)
+> <Array(<CompaniesCompanyIdConnectionsGet200Response>, Integer, Hash)> companies_company_id_connections_get_with_http_info(company_id)
 
 ```ruby
 begin
@@ -401,7 +413,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_connections_get_with_http_info(company_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdConnectionsGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling ConnectionsApi->companies_company_id_connections_get_with_http_info: #{e}"
 end
@@ -415,11 +427,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdConnectionsGet200Response**](CompaniesCompanyIdConnectionsGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -429,7 +441,7 @@ end
 
 ## companies_company_id_connections_post
 
-> Object companies_company_id_connections_post(company_id, connection)
+> <CompaniesCompanyIdConnectionsPost200Response> companies_company_id_connections_post(company_id, connection)
 
 Create a new connection by ID
 
@@ -440,8 +452,10 @@ require 'time'
 require 'spartera_api_sdk'
 # setup authorization
 SparteraApiSdk.configure do |config|
-  # Configure Bearer authorization (JWT): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  # 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::ConnectionsApi.new
@@ -461,7 +475,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_connections_post_with_http_info(company_id, connection)
+> <Array(<CompaniesCompanyIdConnectionsPost200Response>, Integer, Hash)> companies_company_id_connections_post_with_http_info(company_id, connection)
 
 ```ruby
 begin
@@ -469,7 +483,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_connections_post_with_http_info(company_id, connection)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdConnectionsPost200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling ConnectionsApi->companies_company_id_connections_post_with_http_info: #{e}"
 end
@@ -484,11 +498,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdConnectionsPost200Response**](CompaniesCompanyIdConnectionsPost200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers