SematextCloud 0.1.0

data/docs/App.md

@@ -0,0 +1,32 @@
+# SematextCloud::App
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ajax_threshold** | **Integer** |  | [optional]
+**app_type** | **String** |  | [optional]
+**app_type_id** | **Integer** |  | [optional]
+**creator_email** | **String** |  | [optional]
+**credit_card_expiry** | **String** |  | [optional]
+**credit_card_number** | **String** |  | [optional]
+**description** | **String** |  | [optional]
+**display_status** | **String** |  | [optional]
+**first_data_saved_date** | **Integer** |  | [optional]
+**id** | **Integer** |  | [optional]
+**integration** | [**ServiceIntegration**](ServiceIntegration.md) |  | [optional]
+**last_data_received_date** | **Integer** |  | [optional]
+**last_data_saved_date** | **Integer** |  | [optional]
+**logged_in_user_app_role** | **String** |  | [optional]
+**monthly_invoice_account** | **BOOLEAN** |  | [optional]
+**name** | **String** |  | [optional]
+**owner_email** | **String** |  | [optional]
+**owning_organization** | [**BasicOrganizationDto**](BasicOrganizationDto.md) |  | [optional]
+**page_load_threshold** | **Integer** |  | [optional]
+**payment_method_id** | **Integer** |  | [optional]
+**plan** | [**Plan**](Plan.md) |  | [optional]
+**prepaid_account** | **BOOLEAN** |  | [optional]
+**status** | **String** |  | [optional]
+**token** | **String** |  | [optional]
+**trial_end_date** | **Integer** |  | [optional]
+**url_group_limit** | **Integer** |  | [optional]
+**user_roles** | [**Array<UserRole>**](UserRole.md) |  | [optional]

data/docs/AppDescription.md

@@ -0,0 +1,6 @@
+# SematextCloud::AppDescription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** |  | [optional]

data/docs/AppMetadata.md

@@ -0,0 +1,10 @@
+# SematextCloud::AppMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aws_cloud_watch_access_key** | **String** |  | [optional]
+**aws_cloud_watch_secret_key** | **String** |  | [optional]
+**aws_fetch_frequency** | **String** |  | [optional]
+**aws_region** | **String** |  | [optional]
+**sub_types** | **Array<String>** | Comma separated list of AWS types monitored by created app | [optional]

data/docs/AppsApi.md

@@ -0,0 +1,369 @@
+# SematextCloud::AppsApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_app_types_using_get**](AppsApi.md#get_app_types_using_get) | **GET** /users-web/api/v3/apps/types | Get all App types supported for the account identified with apiKey
+[**get_using_get**](AppsApi.md#get_using_get) | **GET** /users-web/api/v3/apps/{anyStateAppId} | Gets defails for one particular App
+[**invite_app_guests_using_post**](AppsApi.md#invite_app_guests_using_post) | **POST** /users-web/api/v3/apps/guests | Invite guests to an app
+[**list_apps_users_using_get**](AppsApi.md#list_apps_users_using_get) | **GET** /users-web/api/v3/apps/users | Get all users of apps accessible to this account
+[**list_using_get**](AppsApi.md#list_using_get) | **GET** /users-web/api/v3/apps | Get all apps accessible by account identified with apiKey
+[**update_description_using_put**](AppsApi.md#update_description_using_put) | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description | Update description of the app
+[**update_using_put1**](AppsApi.md#update_using_put1) | **PUT** /users-web/api/v3/apps/{anyStateAppId} | Update app
+
+
+# **get_app_types_using_get**
+> GenericApiResponse get_app_types_using_get
+
+Get all App types supported for the account identified with apiKey
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::AppsApi.new
+
+begin
+  #Get all App types supported for the account identified with apiKey
+  result = api_instance.get_app_types_using_get
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AppsApi->get_app_types_using_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_using_get**
+> GenericApiResponse get_using_get(any_state_app_id)
+
+Gets defails for one particular App
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::AppsApi.new
+
+any_state_app_id = 789 # Integer | anyStateAppId
+
+
+begin
+  #Gets defails for one particular App
+  result = api_instance.get_using_get(any_state_app_id)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AppsApi->get_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **any_state_app_id** | **Integer**| anyStateAppId |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **invite_app_guests_using_post**
+> GenericApiResponse invite_app_guests_using_post(invitation)
+
+Invite guests to an app
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::AppsApi.new
+
+invitation = SematextCloud::Invitation.new # Invitation | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values
+
+
+begin
+  #Invite guests to an app
+  result = api_instance.invite_app_guests_using_post(invitation)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AppsApi->invite_app_guests_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **invitation** | [**Invitation**](Invitation.md)| For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_apps_users_using_get**
+> GenericApiResponse list_apps_users_using_get
+
+Get all users of apps accessible to this account
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::AppsApi.new
+
+begin
+  #Get all users of apps accessible to this account
+  result = api_instance.list_apps_users_using_get
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AppsApi->list_apps_users_using_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_using_get**
+> GenericApiResponse list_using_get
+
+Get all apps accessible by account identified with apiKey
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::AppsApi.new
+
+begin
+  #Get all apps accessible by account identified with apiKey
+  result = api_instance.list_using_get
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AppsApi->list_using_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_description_using_put**
+> GenericApiResponse update_description_using_put(any_state_app_id, opts)
+
+Update description of the app
+
+App can be in any state
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::AppsApi.new
+
+any_state_app_id = 789 # Integer | App Id
+
+opts = {
+  update_details: SematextCloud::AppDescription.new # AppDescription | Update Details
+}
+
+begin
+  #Update description of the app
+  result = api_instance.update_description_using_put(any_state_app_id, opts)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AppsApi->update_description_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **any_state_app_id** | **Integer**| App Id |
+ **update_details** | [**AppDescription**](AppDescription.md)| Update Details | [optional]
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_using_put1**
+> GenericApiResponse update_using_put1(dto, any_state_app_id)
+
+Update app
+
+App can be in any state
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::AppsApi.new
+
+dto = SematextCloud::UpdateAppInfo.new # UpdateAppInfo | dto
+
+any_state_app_id = 789 # Integer | App Id
+
+
+begin
+  #Update app
+  result = api_instance.update_using_put1(dto, any_state_app_id)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AppsApi->update_using_put1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dto** | [**UpdateAppInfo**](UpdateAppInfo.md)| dto |
+ **any_state_app_id** | **Integer**| App Id |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json

data/docs/AwsSettingsControllerApi.md

@@ -0,0 +1,63 @@
+# SematextCloud::AwsSettingsControllerApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**update_using_put**](AwsSettingsControllerApi.md#update_using_put) | **PUT** /users-web/api/v3/apps/{appId}/aws | Update App's AWS CloudWatch settings
+
+
+# **update_using_put**
+> GenericApiResponse update_using_put(app_id, dto)
+
+Update App's AWS CloudWatch settings
+
+Applicable only for AWS Apps
+
+### Example
+```ruby
+# load the gem
+require 'SematextCloud'
+# setup authorization
+SematextCloud.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = SematextCloud::AwsSettingsControllerApi.new
+
+app_id = 789 # Integer | appId
+
+dto = SematextCloud::CloudWatchSettings.new # CloudWatchSettings | dto
+
+
+begin
+  #Update App's AWS CloudWatch settings
+  result = api_instance.update_using_put(app_id, dto)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AwsSettingsControllerApi->update_using_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **Integer**| appId |
+ **dto** | [**CloudWatchSettings**](CloudWatchSettings.md)| dto |
+
+### Return type
+
+[**GenericApiResponse**](GenericApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json