spartera_api_sdk 1.0.62 → 1.0.69

data/docs/StorageEnginesApi.md

@@ -0,0 +1,149 @@
+# SparteraApiSdk::StorageEnginesApi
+
+All URIs are relative to *https://api.spartera.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cloud_providers_provider_id_storage_engines_engine_id_get**](StorageEnginesApi.md#cloud_providers_provider_id_storage_engines_engine_id_get) | **GET** /cloud-providers/{provider_id}/storage-engines/{engine_id} | Get single storage engine by ID |
+| [**cloud_providers_provider_id_storage_engines_get**](StorageEnginesApi.md#cloud_providers_provider_id_storage_engines_get) | **GET** /cloud-providers/{provider_id}/storage-engines | Get a list of all storage engines |
+
+
+## cloud_providers_provider_id_storage_engines_engine_id_get
+
+> <CompaniesCompanyIdApiKeysGet200Response> cloud_providers_provider_id_storage_engines_engine_id_get(provider_id, engine_id)
+
+Get single storage engine 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::StorageEnginesApi.new
+provider_id = 'provider_id_example' # String | 
+engine_id = 'engine_id_example' # String | 
+
+begin
+  # Get single storage engine by ID
+  result = api_instance.cloud_providers_provider_id_storage_engines_engine_id_get(provider_id, engine_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling StorageEnginesApi->cloud_providers_provider_id_storage_engines_engine_id_get: #{e}"
+end
+```
+
+#### Using the cloud_providers_provider_id_storage_engines_engine_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> cloud_providers_provider_id_storage_engines_engine_id_get_with_http_info(provider_id, engine_id)
+
+```ruby
+begin
+  # Get single storage engine by ID
+  data, status_code, headers = api_instance.cloud_providers_provider_id_storage_engines_engine_id_get_with_http_info(provider_id, engine_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompaniesCompanyIdApiKeysGet200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling StorageEnginesApi->cloud_providers_provider_id_storage_engines_engine_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider_id** | **String** |  |  |
+| **engine_id** | **String** |  |  |
+
+### Return type
+
+[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## cloud_providers_provider_id_storage_engines_get
+
+> <CompaniesCompanyIdApiKeysGet200Response> cloud_providers_provider_id_storage_engines_get(provider_id)
+
+Get a list of all storage engines
+
+### 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::StorageEnginesApi.new
+provider_id = 'provider_id_example' # String | 
+
+begin
+  # Get a list of all storage engines
+  result = api_instance.cloud_providers_provider_id_storage_engines_get(provider_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling StorageEnginesApi->cloud_providers_provider_id_storage_engines_get: #{e}"
+end
+```
+
+#### Using the cloud_providers_provider_id_storage_engines_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompaniesCompanyIdApiKeysGet200Response>, Integer, Hash)> cloud_providers_provider_id_storage_engines_get_with_http_info(provider_id)
+
+```ruby
+begin
+  # Get a list of all storage engines
+  data, status_code, headers = api_instance.cloud_providers_provider_id_storage_engines_get_with_http_info(provider_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompaniesCompanyIdApiKeysGet200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling StorageEnginesApi->cloud_providers_provider_id_storage_engines_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider_id** | **String** |  |  |
+
+### Return type
+
+[**CompaniesCompanyIdApiKeysGet200Response**](CompaniesCompanyIdApiKeysGet200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/UsersApi.md

@@ -4,18 +4,19 @@ All URIs are relative to *https://api.spartera.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**companies_company_id_users_get**](UsersApi.md#companies_company_id_users_get) | **GET** /companies/{company_id}/users | Get a list of all users for a particular company |
+| [**companies_company_id_users_get**](UsersApi.md#companies_company_id_users_get) | **GET** /companies/{company_id}/users | Get a list of all users in a company |
 | [**companies_company_id_users_post**](UsersApi.md#companies_company_id_users_post) | **POST** /companies/{company_id}/users | Create a new user |
 | [**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 |
 
 
 ## companies_company_id_users_get
 
-> Object companies_company_id_users_get(company_id)
+> <CompaniesCompanyIdUsersGet200Response> companies_company_id_users_get(company_id)
 
-Get a list of all users for a particular company
+Get a list of all users in a company
 
 ### Examples
 
@@ -24,15 +25,17 @@ 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::UsersApi.new
 company_id = 'company_id_example' # String | 
 
 begin
-  # Get a list of all users for a particular company
+  # Get a list of all users in a company
   result = api_instance.companies_company_id_users_get(company_id)
   p result
 rescue SparteraApiSdk::ApiError => e
@@ -44,15 +47,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> companies_company_id_users_get_with_http_info(company_id)
+> <Array(<CompaniesCompanyIdUsersGet200Response>, Integer, Hash)> companies_company_id_users_get_with_http_info(company_id)
 
 ```ruby
 begin
-  # Get a list of all users for a particular company
+  # Get a list of all users in a company
   data, status_code, headers = api_instance.companies_company_id_users_get_with_http_info(company_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling UsersApi->companies_company_id_users_get_with_http_info: #{e}"
 end
@@ -66,11 +69,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersGet200Response**](CompaniesCompanyIdUsersGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -80,7 +83,7 @@ end
 
 ## companies_company_id_users_post
 
-> Object companies_company_id_users_post(company_id, user)
+> <CompaniesCompanyIdUsersPost200Response> companies_company_id_users_post(company_id, user)
 
 Create a new user
 
@@ -91,8 +94,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::UsersApi.new
@@ -112,7 +117,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, 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, user)
 
 ```ruby
 begin
@@ -120,7 +125,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_post_with_http_info(company_id, user)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersPost200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling UsersApi->companies_company_id_users_post_with_http_info: #{e}"
 end
@@ -135,11 +140,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersPost200Response**](CompaniesCompanyIdUsersPost200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -149,7 +154,7 @@ end
 
 ## companies_company_id_users_user_id_delete
 
-> Object companies_company_id_users_user_id_delete(company_id, user_id)
+> <CompaniesCompanyIdUsersUserIdDelete200Response> companies_company_id_users_user_id_delete(company_id, user_id)
 
 Delete single user by ID
 
@@ -160,8 +165,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::UsersApi.new
@@ -181,7 +188,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_delete_with_http_info(company_id, user_id)
+> <Array(<CompaniesCompanyIdUsersUserIdDelete200Response>, Integer, Hash)> companies_company_id_users_user_id_delete_with_http_info(company_id, user_id)
 
 ```ruby
 begin
@@ -189,7 +196,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_user_id_delete_with_http_info(company_id, user_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdDelete200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling UsersApi->companies_company_id_users_user_id_delete_with_http_info: #{e}"
 end
@@ -204,11 +211,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdDelete200Response**](CompaniesCompanyIdUsersUserIdDelete200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -218,7 +225,7 @@ end
 
 ## companies_company_id_users_user_id_get
 
-> Object companies_company_id_users_user_id_get(company_id, user_id)
+> <CompaniesCompanyIdUsersUserIdGet200Response> companies_company_id_users_user_id_get(company_id, user_id)
 
 Get single user by ID
 
@@ -229,8 +236,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::UsersApi.new
@@ -250,7 +259,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_get_with_http_info(company_id, user_id)
+> <Array(<CompaniesCompanyIdUsersUserIdGet200Response>, Integer, Hash)> companies_company_id_users_user_id_get_with_http_info(company_id, user_id)
 
 ```ruby
 begin
@@ -258,7 +267,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_user_id_get_with_http_info(company_id, user_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdGet200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling UsersApi->companies_company_id_users_user_id_get_with_http_info: #{e}"
 end
@@ -273,11 +282,11 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdGet200Response**](CompaniesCompanyIdUsersUserIdGet200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
@@ -287,7 +296,7 @@ end
 
 ## companies_company_id_users_user_id_patch
 
-> Object companies_company_id_users_user_id_patch(company_id, user_id, user)
+> <CompaniesCompanyIdUsersUserIdPatch200Response> companies_company_id_users_user_id_patch(company_id, user_id, user)
 
 Update an existing user by ID
 
@@ -298,8 +307,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::UsersApi.new
@@ -320,7 +331,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_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, user)
 
 ```ruby
 begin
@@ -328,7 +339,7 @@ begin
   data, status_code, headers = api_instance.companies_company_id_users_user_id_patch_with_http_info(company_id, user_id, user)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => Object
+  p data # => <CompaniesCompanyIdUsersUserIdPatch200Response>
 rescue SparteraApiSdk::ApiError => e
   puts "Error when calling UsersApi->companies_company_id_users_user_id_patch_with_http_info: #{e}"
 end
@@ -344,14 +355,80 @@ end
 
 ### Return type
 
-**Object**
+[**CompaniesCompanyIdUsersUserIdPatch200Response**](CompaniesCompanyIdUsersUserIdPatch200Response.md)
 
 ### Authorization
 
-[bearerAuth](../README.md#bearerAuth)
+[ApiKeyAuth](../README.md#ApiKeyAuth)
 
 ### HTTP request headers
 
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## me_get
+
+> <MeGet200Response> me_get
+
+Get current authenticated user's profile information.              Returns:                 JSON response with user profile data from database
+
+### 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::UsersApi.new
+
+begin
+  # Get current authenticated user's profile information.              Returns:                 JSON response with user profile data from database
+  result = api_instance.me_get
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->me_get: #{e}"
+end
+```
+
+#### Using the me_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeGet200Response>, 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
+  data, status_code, headers = api_instance.me_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeGet200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->me_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**MeGet200Response**](MeGet200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+