SematextCloud 0.1.2 → 0.3.0

data/docs/SubscriptionDashboardDto.md

@@ -0,0 +1,16 @@
+# stcloud::SubscriptionDashboardDto
+
+## Properties
+| Name             | Type         | Description | Notes      |
+| ---------------- | ------------ | ----------- | ---------- |
+| **addresses**    | **String**   |             | [optional] |
+| **dashboard_id** | **Integer**  |             | [optional] |
+| **enable**       | **BOOLEAN**  |             | [optional] |
+| **filters**      | **String**   |             | [optional] |
+| **frequency**    | **String**   |             | [optional] |
+| **id**           | **Integer**  |             | [optional] |
+| **report_name**  | **String**   |             | [optional] |
+| **send_time**    | **DateTime** |             | [optional] |
+| **subject**      | **String**   |             | [optional] |
+| **text**         | **String**   |             | [optional] |
+| **time_range**   | **String**   |             | [optional] |

data/docs/SubscriptionDto.md

@@ -0,0 +1,17 @@
+# stcloud::SubscriptionDto
+
+## Properties
+| Name                 | Type                                      | Description | Notes      |
+| -------------------- | ----------------------------------------- | ----------- | ---------- |
+| **addresses**        | **String**                                |             | [optional] |
+| **enable**           | **BOOLEAN**                               |             | [optional] |
+| **filters**          | **String**                                |             | [optional] |
+| **frequency**        | **String**                                |             | [optional] |
+| **id**               | **Integer**                               |             | [optional] |
+| **report_name**      | **String**                                |             | [optional] |
+| **send_time**        | **DateTime**                              |             | [optional] |
+| **subject**          | **String**                                |             | [optional] |
+| **system_id**        | **Integer**                               |             | [optional] |
+| **text**             | **String**                                |             | [optional] |
+| **time_range**       | **String**                                |             | [optional] |
+| **user_permissions** | [**UserPermissions**](UserPermissions.md) |             | [optional] |

data/docs/SubscriptionResponse.md

@@ -0,0 +1,9 @@
+# stcloud::SubscriptionResponse
+
+## Properties
+| Name        | Type                                                          | Description | Notes      |
+| ----------- | ------------------------------------------------------------- | ----------- | ---------- |
+| **data**    | [**SubscriptionResponseEntry**](SubscriptionResponseEntry.md) |             | [optional] |
+| **errors**  | [**Array<Error>**](Error.md)                            |             | [optional] |
+| **message** | **String**                                                    |             | [optional] |
+| **success** | **BOOLEAN**                                                   |             | [optional] |

data/docs/SubscriptionResponseEntry.md

@@ -0,0 +1,6 @@
+# stcloud::SubscriptionResponseEntry
+
+## Properties
+| Name             | Type                                | Description | Notes      |
+| ---------------- | ----------------------------------- | ----------- | ---------- |
+| **subscription** | [**Subscription**](Subscription.md) |             | [optional] |

data/docs/SubscriptionsApi.md

@@ -1,53 +1,368 @@
-# SematextCloud::SubscriptionsApi
+# stcloud::SubscriptionsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to */*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list_using_get1**](SubscriptionsApi.md#list_using_get1) | **GET** /users-web/api/v3/apps/{appId}/subscriptions | Get subscriptions for an app
-[**send_report_using_post**](SubscriptionsApi.md#send_report_using_post) | **POST** /users-web/api/v3/apps/{appId}/report/send | Trigger emailing of report for an app
+| Method                                                                             | HTTP request                                                          | Description                              |
+| ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------- |
+| [**create_for_app_using_post1**](SubscriptionsApi.md#create_for_app_using_post1)   | **POST** /users-web/api/v3/apps/{appId}/subscription                  | Create App subscription                  |
+| [**create_for_dash_using_post1**](SubscriptionsApi.md#create_for_dash_using_post1) | **POST** /users-web/api/v3/dashboards/{dashId}/subscription           | Create dashboard subscription            |
+| [**delete_using_delete3**](SubscriptionsApi.md#delete_using_delete3)               | **DELETE** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Delete subscription                      |
+| [**list_using_get3**](SubscriptionsApi.md#list_using_get3)                         | **GET** /users-web/api/v3/apps/{appId}/subscriptions                  | Get subscriptions for an App             |
+| [**list_using_get5**](SubscriptionsApi.md#list_using_get5)                         | **GET** /users-web/api/v3/subscriptions                               | Get current account's subscriptions |
+| [**send_app_report_using_post**](SubscriptionsApi.md#send_app_report_using_post)   | **POST** /users-web/api/v3/apps/{appId}/report/send                   | Email an App report                      |
+| [**send_dash_report_using_post**](SubscriptionsApi.md#send_dash_report_using_post) | **POST** /users-web/api/v3/dashboards/{dashId}/report/send            | Email a dashboard report                 |
+| [**toggle_enabled_using_put1**](SubscriptionsApi.md#toggle_enabled_using_put1)     | **PUT** /users-web/api/v3/subscriptions/{updateableSubscriptionId}    | Toggle subscription status               |
+| [**update_for_app_using_put1**](SubscriptionsApi.md#update_for_app_using_put1)     | **PUT** /users-web/api/v3/apps/{appId}/subscription                   | Update App subscription                  |
+| [**update_for_dash_using_put1**](SubscriptionsApi.md#update_for_dash_using_put1)   | **PUT** /users-web/api/v3/dashboards/{dashId}/subscription            | Update dashboard subscription            |
 
+# **create_for_app_using_post1**
+> SubscriptionResponse create_for_app_using_post1(bodyapp_id)
 
-# **list_using_get1**
-> GenericApiResponse list_using_get1(app_id)
+Create App subscription
 
-Get subscriptions for an app
+### Example
+```ruby
+# load the gem
+require 'stcloud'
+# setup authorization
+stcloud.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 = stcloud::SubscriptionsApi.new
+body = stcloud::SubscriptionDto.new # SubscriptionDto | subscription
+app_id = 789 # Integer | appId
+
+
+begin
+  #Create App subscription
+  result = api_instance.create_for_app_using_post1(bodyapp_id)
+  p result
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->create_for_app_using_post1: #{e}"
+end
+```
+
+### Parameters
+
+| Name       | Type                                      | Description  | Notes |
+| ---------- | ----------------------------------------- | ------------ | ----- |
+| **body**   | [**SubscriptionDto**](SubscriptionDto.md) | subscription |
+| **app_id** | **Integer**                               | appId        |
+
+### Return type
+
+[**SubscriptionResponse**](SubscriptionResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_for_dash_using_post1**
+> SubscriptionResponse create_for_dash_using_post1(bodydash_id)
+
+Create dashboard subscription
 
 ### Example
 ```ruby
 # load the gem
-require 'SematextCloud'
+require 'stcloud'
 # setup authorization
-SematextCloud.configure do |config|
+stcloud.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::SubscriptionsApi.new
+api_instance = stcloud::SubscriptionsApi.new
+body = stcloud::SubscriptionDashboardDto.new # SubscriptionDashboardDto | subscription
+dash_id = 789 # Integer | dashId
+
+
+begin
+  #Create dashboard subscription
+  result = api_instance.create_for_dash_using_post1(bodydash_id)
+  p result
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->create_for_dash_using_post1: #{e}"
+end
+```
+
+### Parameters
+
+| Name        | Type                                                        | Description  | Notes |
+| ----------- | ----------------------------------------------------------- | ------------ | ----- |
+| **body**    | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription |
+| **dash_id** | **Integer**                                                 | dashId       |
+
+### Return type
+
+[**SubscriptionResponse**](SubscriptionResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_using_delete3**
+> GenericMapBasedApiResponse delete_using_delete3(updateable_subscription_id)
+
+Delete subscription
+
+### Example
+```ruby
+# load the gem
+require 'stcloud'
+# setup authorization
+stcloud.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 = stcloud::SubscriptionsApi.new
+updateable_subscription_id = 789 # Integer | updateableSubscriptionId
+
+
+begin
+  #Delete subscription
+  result = api_instance.delete_using_delete3(updateable_subscription_id)
+  p result
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->delete_using_delete3: #{e}"
+end
+```
+
+### Parameters
+
+| Name                           | Type        | Description              | Notes |
+| ------------------------------ | ----------- | ------------------------ | ----- |
+| **updateable_subscription_id** | **Integer** | updateableSubscriptionId |
+
+### Return type
+
+[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_using_get3**
+> SubscriptionsResponse list_using_get3(app_id)
+
+Get subscriptions for an App
+
+### Example
+```ruby
+# load the gem
+require 'stcloud'
+# setup authorization
+stcloud.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 = stcloud::SubscriptionsApi.new
 app_id = 789 # Integer | appId
 
 
 begin
-  #Get subscriptions for an app
-  result = api_instance.list_using_get1(app_id)
+  #Get subscriptions for an App
+  result = api_instance.list_using_get3(app_id)
   p result
-rescue SematextCloud::ApiError => e
-  puts "Exception when calling SubscriptionsApi->list_using_get1: #{e}"
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->list_using_get3: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **app_id** | **Integer**| appId |
+| Name       | Type        | Description | Notes |
+| ---------- | ----------- | ----------- | ----- |
+| **app_id** | **Integer** | appId       |
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**SubscriptionsResponse**](SubscriptionsResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_using_get5**
+> SubscriptionsResponse list_using_get5
+
+Get current account's subscriptions
+
+### Example
+```ruby
+# load the gem
+require 'stcloud'
+# setup authorization
+stcloud.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 = stcloud::SubscriptionsApi.new
+
+begin
+  #Get current account's subscriptions
+  result = api_instance.list_using_get5
+  p result
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->list_using_get5: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SubscriptionsResponse**](SubscriptionsResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **send_app_report_using_post**
+> MailReportResponse send_app_report_using_post(bodyapp_id)
+
+Email an App report
+
+### Example
+```ruby
+# load the gem
+require 'stcloud'
+# setup authorization
+stcloud.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 = stcloud::SubscriptionsApi.new
+body = stcloud::ReportInfo.new # ReportInfo | emailDto
+app_id = 789 # Integer | appId
+
+
+begin
+  #Email an App report
+  result = api_instance.send_app_report_using_post(bodyapp_id)
+  p result
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->send_app_report_using_post: #{e}"
+end
+```
+
+### Parameters
+
+| Name       | Type                            | Description | Notes |
+| ---------- | ------------------------------- | ----------- | ----- |
+| **body**   | [**ReportInfo**](ReportInfo.md) | emailDto    |
+| **app_id** | **Integer**                     | appId       |
+
+### Return type
+
+[**MailReportResponse**](MailReportResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **send_dash_report_using_post**
+> MailReportResponse send_dash_report_using_post(bodydash_id)
+
+Email a dashboard report
+
+### Example
+```ruby
+# load the gem
+require 'stcloud'
+# setup authorization
+stcloud.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 = stcloud::SubscriptionsApi.new
+body = stcloud::ReportInfo.new # ReportInfo | emailDto
+dash_id = 789 # Integer | dashId
+
+
+begin
+  #Email a dashboard report
+  result = api_instance.send_dash_report_using_post(bodydash_id)
+  p result
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->send_dash_report_using_post: #{e}"
+end
+```
+
+### Parameters
+
+| Name        | Type                            | Description | Notes |
+| ----------- | ------------------------------- | ----------- | ----- |
+| **body**    | [**ReportInfo**](ReportInfo.md) | emailDto    |
+| **dash_id** | **Integer**                     | dashId      |
+
+### Return type
+
+[**MailReportResponse**](MailReportResponse.md)
 
 ### Authorization
 
@@ -60,49 +375,153 @@ Name | Type | Description  | Notes
 
 
 
-# **send_report_using_post**
-> GenericApiResponse send_report_using_post(app_id, email_dto)
+# **toggle_enabled_using_put1**
+> SubscriptionResponse toggle_enabled_using_put1(bodyupdateable_subscription_id)
 
-Trigger emailing of report for an app
+Toggle subscription status
 
 ### Example
 ```ruby
 # load the gem
-require 'SematextCloud'
+require 'stcloud'
 # setup authorization
-SematextCloud.configure do |config|
+stcloud.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::SubscriptionsApi.new
+api_instance = stcloud::SubscriptionsApi.new
+body = stcloud::UpdateSubscriptionDto.new # UpdateSubscriptionDto | dto
+updateable_subscription_id = 789 # Integer | updateableSubscriptionId
 
+
+begin
+  #Toggle subscription status
+  result = api_instance.toggle_enabled_using_put1(bodyupdateable_subscription_id)
+  p result
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->toggle_enabled_using_put1: #{e}"
+end
+```
+
+### Parameters
+
+| Name                           | Type                                                  | Description              | Notes |
+| ------------------------------ | ----------------------------------------------------- | ------------------------ | ----- |
+| **body**                       | [**UpdateSubscriptionDto**](UpdateSubscriptionDto.md) | dto                      |
+| **updateable_subscription_id** | **Integer**                                           | updateableSubscriptionId |
+
+### Return type
+
+[**SubscriptionResponse**](SubscriptionResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_for_app_using_put1**
+> SubscriptionResponse update_for_app_using_put1(bodyapp_id)
+
+Update App subscription
+
+### Example
+```ruby
+# load the gem
+require 'stcloud'
+# setup authorization
+stcloud.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 = stcloud::SubscriptionsApi.new
+body = stcloud::SubscriptionDto.new # SubscriptionDto | subscription
 app_id = 789 # Integer | appId
 
-email_dto = SematextCloud::ReportInfo.new # ReportInfo | emailDto
+
+begin
+  #Update App subscription
+  result = api_instance.update_for_app_using_put1(bodyapp_id)
+  p result
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->update_for_app_using_put1: #{e}"
+end
+```
+
+### Parameters
+
+| Name       | Type                                      | Description  | Notes |
+| ---------- | ----------------------------------------- | ------------ | ----- |
+| **body**   | [**SubscriptionDto**](SubscriptionDto.md) | subscription |
+| **app_id** | **Integer**                               | appId        |
+
+### Return type
+
+[**SubscriptionResponse**](SubscriptionResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_for_dash_using_put1**
+> SubscriptionResponse update_for_dash_using_put1(bodydash_id)
+
+Update dashboard subscription
+
+### Example
+```ruby
+# load the gem
+require 'stcloud'
+# setup authorization
+stcloud.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 = stcloud::SubscriptionsApi.new
+body = stcloud::SubscriptionDashboardDto.new # SubscriptionDashboardDto | subscription
+dash_id = 789 # Integer | dashId
 
 
 begin
-  #Trigger emailing of report for an app
-  result = api_instance.send_report_using_post(app_id, email_dto)
+  #Update dashboard subscription
+  result = api_instance.update_for_dash_using_put1(bodydash_id)
   p result
-rescue SematextCloud::ApiError => e
-  puts "Exception when calling SubscriptionsApi->send_report_using_post: #{e}"
+rescue stcloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->update_for_dash_using_put1: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **app_id** | **Integer**| appId |
- **email_dto** | [**ReportInfo**](ReportInfo.md)| emailDto |
+| Name        | Type                                                        | Description  | Notes |
+| ----------- | ----------------------------------------------------------- | ------------ | ----- |
+| **body**    | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription |
+| **dash_id** | **Integer**                                                 | dashId       |
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**SubscriptionResponse**](SubscriptionResponse.md)
 
 ### Authorization