spartera_api_sdk 1.0.62 → 1.0.69

data/docs/AlertsApi.md

@@ -7,15 +7,15 @@ All URIs are relative to *https://api.spartera.com*
 | [**companies_company_id_users_user_id_alerts_alert_id_delete**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_delete) | **DELETE** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Delete single alert by ID |
 | [**companies_company_id_users_user_id_alerts_alert_id_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Get single alert by ID |
 | [**companies_company_id_users_user_id_alerts_alert_id_patch**](AlertsApi.md#companies_company_id_users_user_id_alerts_alert_id_patch) | **PATCH** /companies/{company_id}/users/{user_id}/alerts/{alert_id} | Update an existing alert by ID |
-| [**companies_company_id_users_user_id_alerts_asset_asset_id_all_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_asset_asset_id_all_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id}/all | Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins |
-| [**companies_company_id_users_user_id_alerts_asset_asset_id_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_asset_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id} | Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset |
+| [**companies_company_id_users_user_id_alerts_asset_asset_id_all_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_asset_asset_id_all_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id}/all | Get all alerts for a specific asset |
+| [**companies_company_id_users_user_id_alerts_asset_asset_id_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_asset_asset_id_get) | **GET** /companies/{company_id}/users/{user_id}/alerts/asset/{asset_id} | Get all alerts for a specific asset (by user) |
 | [**companies_company_id_users_user_id_alerts_get**](AlertsApi.md#companies_company_id_users_user_id_alerts_get) | **GET** /companies/{company_id}/users/{user_id}/alerts | Get a list of all alerts for a specific user |
 | [**companies_company_id_users_user_id_alerts_post**](AlertsApi.md#companies_company_id_users_user_id_alerts_post) | **POST** /companies/{company_id}/users/{user_id}/alerts | POST /companies/{company_id}/users/{user_id}/alerts |
 
 
 ## companies_company_id_users_user_id_alerts_alert_id_delete
 
-> Object companies_company_id_users_user_id_alerts_alert_id_delete(company_id, user_id, alert_id)
+> <CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response> companies_company_id_users_user_id_alerts_alert_id_delete(company_id, user_id, alert_id)
 
 Delete single alert 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::AlertsApi.new
@@ -48,7 +50,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info(company_id, user_id, alert_id)
+> <Array(<CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response>, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info(company_id, user_id, alert_id)
 
 ```ruby
 begin
@@ -56,7 +58,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info(company_id, user_id, alert_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_delete_with_http_info: #{e}"
 end
@@ -72,11 +74,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response**](CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -86,7 +88,7 @@ end
 
 ## companies_company_id_users_user_id_alerts_alert_id_get
 
-> Object companies_company_id_users_user_id_alerts_alert_id_get(company_id, user_id, alert_id)
+> <CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response> companies_company_id_users_user_id_alerts_alert_id_get(company_id, user_id, alert_id)
 
 Get single alert by ID
 
@@ -97,8 +99,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::AlertsApi.new
@@ -119,7 +123,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id)
+> <Array(<CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response>, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id)
 
 ```ruby
 begin
@@ -127,7 +131,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_get_with_http_info: #{e}"
 end
@@ -143,11 +147,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response**](CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -157,7 +161,7 @@ end
 
 ## companies_company_id_users_user_id_alerts_alert_id_patch
 
-> Object companies_company_id_users_user_id_alerts_alert_id_patch(company_id, user_id, alert_id, alert)
+> <CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response> companies_company_id_users_user_id_alerts_alert_id_patch(company_id, user_id, alert_id, alert)
 
 Update an existing alert by ID
 
@@ -168,8 +172,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::AlertsApi.new
@@ -191,7 +197,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert)
+> <Array(<CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response>, Integer, Hash)> companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert)
 
 ```ruby
 begin
@@ -199,7 +205,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info: #{e}"
 end
@@ -216,11 +222,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response**](CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -230,9 +236,9 @@ end
 
 ## companies_company_id_users_user_id_alerts_asset_asset_id_all_get
 
-> Object companies_company_id_users_user_id_alerts_asset_asset_id_all_get(company_id, user_id, asset_id)
+> <CompaniesCompanyIdUsersUserIdAlertsGet200Response> companies_company_id_users_user_id_alerts_asset_asset_id_all_get(company_id, user_id, asset_id)
 
-Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins
+Get all alerts for a specific asset
 
 ### Examples
 
@@ -241,8 +247,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::AlertsApi.new
@@ -251,7 +259,7 @@ user_id = 'user_id_example' # String |
 asset_id = 'asset_id_example' # String | 
 
 begin
-  # Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins
+  # Get all alerts for a specific asset
   result = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_all_get(company_id, user_id, asset_id)
   p result
 rescue SparteraApiSdk::ApiError => e
@@ -263,15 +271,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info(company_id, user_id, asset_id)
+> <Array(<CompaniesCompanyIdUsersUserIdAlertsGet200Response>, Integer, Hash)> companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info(company_id, user_id, asset_id)
 
 ```ruby
 begin
-  # Get all alerts for a specific asset (from all users)     This would typically be restricted to asset owners or admins
+  # Get all alerts for a specific asset
   data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info(company_id, user_id, asset_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdAlertsGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_all_get_with_http_info: #{e}"
 end
@@ -287,11 +295,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdAlertsGet200Response**](CompaniesCompanyIdUsersUserIdAlertsGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -301,9 +309,9 @@ end
 
 ## companies_company_id_users_user_id_alerts_asset_asset_id_get
 
-> Object companies_company_id_users_user_id_alerts_asset_asset_id_get(company_id, user_id, asset_id)
+> <CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response> companies_company_id_users_user_id_alerts_asset_asset_id_get(company_id, user_id, asset_id)
 
-Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset
+Get all alerts for a specific asset (by user)
 
 ### Examples
 
@@ -312,8 +320,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::AlertsApi.new
@@ -322,7 +332,7 @@ user_id = 'user_id_example' # String |
 asset_id = 'asset_id_example' # String | 
 
 begin
-  # Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset
+  # Get all alerts for a specific asset (by user)
   result = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_get(company_id, user_id, asset_id)
   p result
 rescue SparteraApiSdk::ApiError => e
@@ -334,15 +344,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id)
+> <Array(<CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response>, Integer, Hash)> companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id)
 
 ```ruby
 begin
-  # Get all alerts for a specific asset by the specified user     Useful for checking if user already has an alert set up for an asset
+  # Get all alerts for a specific asset (by user)
   data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info: #{e}"
 end
@@ -358,11 +368,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response**](CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -372,7 +382,7 @@ end
 
 ## companies_company_id_users_user_id_alerts_get
 
-> Object companies_company_id_users_user_id_alerts_get(company_id, user_id)
+> <CompaniesCompanyIdUsersUserIdAlertsGet200Response> companies_company_id_users_user_id_alerts_get(company_id, user_id)
 
 Get a list of all alerts for a specific user
 
@@ -383,8 +393,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::AlertsApi.new
@@ -404,7 +416,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_get_with_http_info(company_id, user_id)
+> <Array(<CompaniesCompanyIdUsersUserIdAlertsGet200Response>, Integer, Hash)> companies_company_id_users_user_id_alerts_get_with_http_info(company_id, user_id)
 
 ```ruby
 begin
@@ -412,7 +424,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_get_with_http_info(company_id, user_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdAlertsGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_get_with_http_info: #{e}"
 end
@@ -427,11 +439,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdAlertsGet200Response**](CompaniesCompanyIdUsersUserIdAlertsGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -441,7 +453,7 @@ end
 
 ## companies_company_id_users_user_id_alerts_post
 
-> Object companies_company_id_users_user_id_alerts_post(company_id, user_id, alert)
+> <CompaniesCompanyIdUsersUserIdAlertsPost200Response> companies_company_id_users_user_id_alerts_post(company_id, user_id, alert)
 
 POST /companies/{company_id}/users/{user_id}/alerts
 
@@ -452,8 +464,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::AlertsApi.new
@@ -474,7 +488,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert)
+> <Array(<CompaniesCompanyIdUsersUserIdAlertsPost200Response>, Integer, Hash)> companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert)
 
 ```ruby
 begin
@@ -482,7 +496,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdAlertsPost200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling AlertsApi->companies_company_id_users_user_id_alerts_post_with_http_info: #{e}"
 end
@@ -498,11 +512,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdAlertsPost200Response**](CompaniesCompanyIdUsersUserIdAlertsPost200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers