spartera_api_sdk 1.0.73 → 1.0.77

data/docs/UsersApi.md

@@ -9,7 +9,7 @@ All URIs are relative to *https://api.spartera.com*
 | [**companies_company_id_users_user_id_delete**](UsersApi.md#companies_company_id_users_user_id_delete) | **DELETE** /companies/{company_id}/users/{user_id} | Delete single user by ID |
 | [**companies_company_id_users_user_id_get**](UsersApi.md#companies_company_id_users_user_id_get) | **GET** /companies/{company_id}/users/{user_id} | Get single user by ID |
 | [**companies_company_id_users_user_id_patch**](UsersApi.md#companies_company_id_users_user_id_patch) | **PATCH** /companies/{company_id}/users/{user_id} | Update an existing user by ID |
-| [**me_get**](UsersApi.md#me_get) | **GET** /me | Get current authenticated user's profile information.              Returns:                 JSON response with user profile data from database |
+| [**me_get**](UsersApi.md#me_get) | **GET** /me | Get current authenticated user's profile. |
 
 
 ## companies_company_id_users_get
@@ -83,7 +83,7 @@ end
 
 ## companies_company_id_users_post
 
-> <CompaniesCompanyIdUsersPost200Response> companies_company_id_users_post(company_id, user)
+> <CompaniesCompanyIdUsersPost200Response> companies_company_id_users_post(company_id, users_input)
 
 Create a new user
 
@@ -102,11 +102,11 @@ end
 
 api_instance = SparteraApiSdk::UsersApi.new
 company_id = 'company_id_example' # String | 
-user = SparteraApiSdk::User.new({company_id: 'company_id_example', status: 'status_example'}) # User | 
+users_input = SparteraApiSdk::UsersInput.new({company_id: 'company_id_example'}) # UsersInput | 
 
 begin
   # Create a new user
-  result = api_instance.companies_company_id_users_post(company_id, user)
+  result = api_instance.companies_company_id_users_post(company_id, users_input)
   p result
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling UsersApi->companies_company_id_users_post: #{e}"
@@ -117,12 +117,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CompaniesCompanyIdUsersPost200Response>, Integer, Hash)> companies_company_id_users_post_with_http_info(company_id, user)
+> <Array(<CompaniesCompanyIdUsersPost200Response>, Integer, Hash)> companies_company_id_users_post_with_http_info(company_id, users_input)
 
 ```ruby
 begin
   # Create a new user
-  data, status_code, headers = api_instance.companies_company_id_users_post_with_http_info(company_id, user)
+  data, status_code, headers = api_instance.companies_company_id_users_post_with_http_info(company_id, users_input)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CompaniesCompanyIdUsersPost200Response>
@@ -136,7 +136,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **company_id** | **String** |  |  |
-| **user** | [**User**](User.md) |  |  |
+| **users_input** | [**UsersInput**](UsersInput.md) |  |  |
 
 ### Return type
 
@@ -296,7 +296,7 @@ end
 
 ## companies_company_id_users_user_id_patch
 
-> <CompaniesCompanyIdUsersUserIdPatch200Response> companies_company_id_users_user_id_patch(company_id, user_id, user)
+> <CompaniesCompanyIdUsersUserIdPatch200Response> companies_company_id_users_user_id_patch(company_id, user_id, users_update)
 
 Update an existing user by ID
 
@@ -316,11 +316,11 @@ end
 api_instance = SparteraApiSdk::UsersApi.new
 company_id = 'company_id_example' # String | 
 user_id = 'user_id_example' # String | 
-user = SparteraApiSdk::User.new({company_id: 'company_id_example', status: 'status_example'}) # User | 
+users_update = SparteraApiSdk::UsersUpdate.new # UsersUpdate | 
 
 begin
   # Update an existing user by ID
-  result = api_instance.companies_company_id_users_user_id_patch(company_id, user_id, user)
+  result = api_instance.companies_company_id_users_user_id_patch(company_id, user_id, users_update)
   p result
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling UsersApi->companies_company_id_users_user_id_patch: #{e}"
@@ -331,12 +331,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CompaniesCompanyIdUsersUserIdPatch200Response>, Integer, Hash)> companies_company_id_users_user_id_patch_with_http_info(company_id, user_id, user)
+> <Array(<CompaniesCompanyIdUsersUserIdPatch200Response>, Integer, Hash)> companies_company_id_users_user_id_patch_with_http_info(company_id, user_id, users_update)
 
 ```ruby
 begin
   # Update an existing user by ID
-  data, status_code, headers = api_instance.companies_company_id_users_user_id_patch_with_http_info(company_id, user_id, user)
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_patch_with_http_info(company_id, user_id, users_update)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CompaniesCompanyIdUsersUserIdPatch200Response>
@@ -351,7 +351,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **company_id** | **String** |  |  |
 | **user_id** | **String** |  |  |
-| **user** | [**User**](User.md) |  |  |
+| **users_update** | [**UsersUpdate**](UsersUpdate.md) |  |  |
 
 ### Return type
 
@@ -369,9 +369,9 @@ end
 
 ## me_get
 
-> <MeGet200Response> me_get
+> <CompaniesCompanyIdUsersGet200Response> me_get
 
-Get current authenticated user's profile information.              Returns:                 JSON response with user profile data from database
+Get current authenticated user's profile.
 
 ### Examples
 
@@ -389,7 +389,7 @@ end
 api_instance = SparteraApiSdk::UsersApi.new
 
 begin
-  # Get current authenticated user's profile information.              Returns:                 JSON response with user profile data from database
+  # Get current authenticated user's profile.
   result = api_instance.me_get
   p result
 rescue SparteraApiSdk::ApiError => e
@@ -401,15 +401,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<MeGet200Response>, Integer, Hash)> me_get_with_http_info
+> <Array(<CompaniesCompanyIdUsersGet200Response>, Integer, Hash)> me_get_with_http_info
 
 ```ruby
 begin
-  # Get current authenticated user's profile information.              Returns:                 JSON response with user profile data from database
+  # Get current authenticated user's profile.
   data, status_code, headers = api_instance.me_get_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <MeGet200Response>
+  p data # => <CompaniesCompanyIdUsersGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling UsersApi->me_get_with_http_info: #{e}"
 end
@@ -421,7 +421,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**MeGet200Response**](MeGet200Response.md)
+[**CompaniesCompanyIdUsersGet200Response**](CompaniesCompanyIdUsersGet200Response.md)
 
 ### Authorization
 

data/docs/UsersInput.md

@@ -0,0 +1,26 @@
+# SparteraApiSdk::UsersInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **function_id** | **Integer** |  | [optional] |
+| **status** | **String** | Enum type: StatusCodes | [optional] |
+| **email_address** | **String** |  | [optional] |
+| **timezone** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UsersInput.new(
+  company_id: null,
+  function_id: null,
+  status: null,
+  email_address: null,
+  timezone: null
+)
+```
+

data/docs/UsersUpdate.md

@@ -0,0 +1,26 @@
+# SparteraApiSdk::UsersUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  | [optional] |
+| **function_id** | **Integer** |  | [optional] |
+| **status** | **String** | Enum type: StatusCodes | [optional] |
+| **email_address** | **String** |  | [optional] |
+| **timezone** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::UsersUpdate.new(
+  company_id: null,
+  function_id: null,
+  status: null,
+  email_address: null,
+  timezone: null
+)
+```
+

data/lib/spartera_api_sdk/api/alerts_api.rb

@@ -3,7 +3,7 @@
 
 #Auto-generated API documentation for REST services of the Spartera platform
 
-The version of the OpenAPI document: 0.0.0
+The version of the OpenAPI document: 1.24.0
 Contact: support@spartera.com
 Generated by: https://openapi-generator.tech
 Generator version: 7.13.0
@@ -97,7 +97,7 @@ module SparteraApiSdk
     # @param user_id [String] 
     # @param alert_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response]
+    # @return [CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response]
     def companies_company_id_users_user_id_alerts_alert_id_get(company_id, user_id, alert_id, opts = {})
       data, _status_code, _headers = companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id, opts)
       data
@@ -108,7 +108,7 @@ module SparteraApiSdk
     # @param user_id [String] 
     # @param alert_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response, Integer, Hash)>] CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response data, response status code and response headers
+    # @return [Array<(CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response, Integer, Hash)>] CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response data, response status code and response headers
     def companies_company_id_users_user_id_alerts_alert_id_get_with_http_info(company_id, user_id, alert_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AlertsApi.companies_company_id_users_user_id_alerts_alert_id_get ...'
@@ -143,7 +143,7 @@ module SparteraApiSdk
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response'
+      return_type = opts[:debug_return_type] || 'CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
@@ -169,11 +169,11 @@ module SparteraApiSdk
     # @param company_id [String] 
     # @param user_id [String] 
     # @param alert_id [String] 
-    # @param alert [Alert] 
+    # @param alerts_update [AlertsUpdate] 
     # @param [Hash] opts the optional parameters
     # @return [CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response]
-    def companies_company_id_users_user_id_alerts_alert_id_patch(company_id, user_id, alert_id, alert, opts = {})
-      data, _status_code, _headers = companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert, opts)
+    def companies_company_id_users_user_id_alerts_alert_id_patch(company_id, user_id, alert_id, alerts_update, opts = {})
+      data, _status_code, _headers = companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alerts_update, opts)
       data
     end
 
@@ -181,10 +181,10 @@ module SparteraApiSdk
     # @param company_id [String] 
     # @param user_id [String] 
     # @param alert_id [String] 
-    # @param alert [Alert] 
+    # @param alerts_update [AlertsUpdate] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response, Integer, Hash)>] CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response data, response status code and response headers
-    def companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alert, opts = {})
+    def companies_company_id_users_user_id_alerts_alert_id_patch_with_http_info(company_id, user_id, alert_id, alerts_update, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AlertsApi.companies_company_id_users_user_id_alerts_alert_id_patch ...'
       end
@@ -200,9 +200,9 @@ module SparteraApiSdk
       if @api_client.config.client_side_validation && alert_id.nil?
         fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertsApi.companies_company_id_users_user_id_alerts_alert_id_patch"
       end
-      # verify the required parameter 'alert' is set
-      if @api_client.config.client_side_validation && alert.nil?
-        fail ArgumentError, "Missing the required parameter 'alert' when calling AlertsApi.companies_company_id_users_user_id_alerts_alert_id_patch"
+      # verify the required parameter 'alerts_update' is set
+      if @api_client.config.client_side_validation && alerts_update.nil?
+        fail ArgumentError, "Missing the required parameter 'alerts_update' when calling AlertsApi.companies_company_id_users_user_id_alerts_alert_id_patch"
       end
       # resource path
       local_var_path = '/companies/{company_id}/users/{user_id}/alerts/{alert_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'alert_id' + '}', CGI.escape(alert_id.to_s))
@@ -224,7 +224,7 @@ module SparteraApiSdk
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(alert)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(alerts_update)
 
       # return_type
       return_type = opts[:debug_return_type] || 'CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response'
@@ -327,7 +327,7 @@ module SparteraApiSdk
     # @param user_id [String] 
     # @param asset_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response]
+    # @return [CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response]
     def companies_company_id_users_user_id_alerts_asset_asset_id_get(company_id, user_id, asset_id, opts = {})
       data, _status_code, _headers = companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id, opts)
       data
@@ -338,7 +338,7 @@ module SparteraApiSdk
     # @param user_id [String] 
     # @param asset_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response, Integer, Hash)>] CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response data, response status code and response headers
+    # @return [Array<(CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response, Integer, Hash)>] CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response data, response status code and response headers
     def companies_company_id_users_user_id_alerts_asset_asset_id_get_with_http_info(company_id, user_id, asset_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AlertsApi.companies_company_id_users_user_id_alerts_asset_asset_id_get ...'
@@ -373,7 +373,7 @@ module SparteraApiSdk
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'CompaniesCompanyIdUsersUserIdAlertsAlertIdGet200Response'
+      return_type = opts[:debug_return_type] || 'CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
@@ -465,21 +465,21 @@ module SparteraApiSdk
     # POST /companies/{company_id}/users/{user_id}/alerts
     # @param company_id [String] 
     # @param user_id [String] 
-    # @param alert [Alert] 
+    # @param alerts_input [AlertsInput] 
     # @param [Hash] opts the optional parameters
     # @return [CompaniesCompanyIdUsersUserIdAlertsPost200Response]
-    def companies_company_id_users_user_id_alerts_post(company_id, user_id, alert, opts = {})
-      data, _status_code, _headers = companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert, opts)
+    def companies_company_id_users_user_id_alerts_post(company_id, user_id, alerts_input, opts = {})
+      data, _status_code, _headers = companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alerts_input, opts)
       data
     end
 
     # POST /companies/{company_id}/users/{user_id}/alerts
     # @param company_id [String] 
     # @param user_id [String] 
-    # @param alert [Alert] 
+    # @param alerts_input [AlertsInput] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CompaniesCompanyIdUsersUserIdAlertsPost200Response, Integer, Hash)>] CompaniesCompanyIdUsersUserIdAlertsPost200Response data, response status code and response headers
-    def companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alert, opts = {})
+    def companies_company_id_users_user_id_alerts_post_with_http_info(company_id, user_id, alerts_input, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AlertsApi.companies_company_id_users_user_id_alerts_post ...'
       end
@@ -491,9 +491,9 @@ module SparteraApiSdk
       if @api_client.config.client_side_validation && user_id.nil?
         fail ArgumentError, "Missing the required parameter 'user_id' when calling AlertsApi.companies_company_id_users_user_id_alerts_post"
       end
-      # verify the required parameter 'alert' is set
-      if @api_client.config.client_side_validation && alert.nil?
-        fail ArgumentError, "Missing the required parameter 'alert' when calling AlertsApi.companies_company_id_users_user_id_alerts_post"
+      # verify the required parameter 'alerts_input' is set
+      if @api_client.config.client_side_validation && alerts_input.nil?
+        fail ArgumentError, "Missing the required parameter 'alerts_input' when calling AlertsApi.companies_company_id_users_user_id_alerts_post"
       end
       # resource path
       local_var_path = '/companies/{company_id}/users/{user_id}/alerts'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
@@ -515,7 +515,7 @@ module SparteraApiSdk
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(alert)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(alerts_input)
 
       # return_type
       return_type = opts[:debug_return_type] || 'CompaniesCompanyIdUsersUserIdAlertsPost200Response'