SematextCloud 0.1.5 → 0.4.0

data/docs/AppsApi.md

@@ -1,24 +1,77 @@
 # SematextCloud::AppsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to */*
 
-| 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                                                         |
+| Method                                                                        | HTTP request                                               | Description                                                        |
+| ----------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------ |
+| [**delete_using_delete**](AppsApi.md#delete_using_delete)                     | **DELETE** /users-web/api/v3/apps/{anyStateAppId}          | delete                                                             |
+| [**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_put1**](AppsApi.md#update_description_using_put1) | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description | Update description of the app                                      |
+| [**update_using_put2**](AppsApi.md#update_using_put2)                         | **PUT** /users-web/api/v3/apps/{anyStateAppId}             | Update app                                                         |
 
+# **delete_using_delete**
+
+> GenericMapBasedApiResponse delete_using_delete(any_state_app_id)
+
+delete
+
+### 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
+  #delete
+  result = api_instance.delete_using_delete(any_state_app_id)
+  p result
+rescue SematextCloud::ApiError => e
+  puts "Exception when calling AppsApi->delete_using_delete: #{e}"
+end
+```
+
+### Parameters
+
+| Name                 | Type        | Description   | Notes |
+| -------------------- | ----------- | ------------- | ----- |
+| **any_state_app_id** | **Integer** | anyStateAppId |
+
+### Return type
+
+[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 # **get_app_types_using_get**
-> GenericApiResponse get_app_types_using_get
+
+> AppTypesResponse get_app_types_using_get
 
 Get all App types supported for the account identified with apiKey
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -42,11 +95,12 @@ end
 ```
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**AppTypesResponse**](AppTypesResponse.md)
 
 ### Authorization
 
@@ -54,17 +108,17 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 # **get_using_get**
-> GenericApiResponse get_using_get(any_state_app_id)
+
+> AppResponse get_using_get(any_state_app_id)
 
 Gets defails for one particular App
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -77,7 +131,6 @@ SematextCloud.configure do |config|
 end
 
 api_instance = SematextCloud::AppsApi.new
-
 any_state_app_id = 789 # Integer | anyStateAppId
 
 
@@ -98,7 +151,7 @@ end
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**AppResponse**](AppResponse.md)
 
 ### Authorization
 
@@ -106,17 +159,17 @@ end
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 # **invite_app_guests_using_post**
-> GenericApiResponse invite_app_guests_using_post(invitation)
+
+> GenericMapBasedApiResponse invite_app_guests_using_post(body)
 
 Invite guests to an app
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -129,13 +182,12 @@ SematextCloud.configure do |config|
 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
+body = 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)
+  result = api_instance.invite_app_guests_using_post(body)
   p result
 rescue SematextCloud::ApiError => e
   puts "Exception when calling AppsApi->invite_app_guests_using_post: #{e}"
@@ -144,13 +196,13 @@ 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 |
+| Name     | Type                            | Description                                                                                                                                     | Notes |
+| -------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **body** | [**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)
+[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
 
 ### Authorization
 
@@ -158,17 +210,17 @@ end
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 # **list_apps_users_using_get**
-> GenericApiResponse list_apps_users_using_get
+
+> AppsResponse list_apps_users_using_get
 
 Get all users of apps accessible to this account
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -192,11 +244,12 @@ end
 ```
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**AppsResponse**](AppsResponse.md)
 
 ### Authorization
 
@@ -204,17 +257,17 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 # **list_using_get**
-> GenericApiResponse list_using_get
+
+> AppsResponse list_using_get
 
 Get all apps accessible by account identified with apiKey
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -238,11 +291,12 @@ end
 ```
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**AppsResponse**](AppsResponse.md)
 
 ### Authorization
 
@@ -250,19 +304,19 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
+# **update_description_using_put1**
 
-# **update_description_using_put**
-> GenericApiResponse update_description_using_put(any_state_app_id, opts)
+> AppResponse update_description_using_put1(any_state_app_id, opts)
 
 Update description of the app
 
 App can be in any state
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -275,19 +329,17 @@ SematextCloud.configure do |config|
 end
 
 api_instance = SematextCloud::AppsApi.new
-
 any_state_app_id = 789 # Integer | App Id
-
-opts = {
-  update_details: SematextCloud::AppDescription.new # AppDescription | Update Details
+opts = { 
+  body: SematextCloud::AppDescription.new # AppDescription | Update Details
 }
 
 begin
   #Update description of the app
-  result = api_instance.update_description_using_put(any_state_app_id, opts)
+  result = api_instance.update_description_using_put1(any_state_app_id, opts)
   p result
 rescue SematextCloud::ApiError => e
-  puts "Exception when calling AppsApi->update_description_using_put: #{e}"
+  puts "Exception when calling AppsApi->update_description_using_put1: #{e}"
 end
 ```
 
@@ -296,11 +348,11 @@ end
 | Name                 | Type                                    | Description    | Notes      |
 | -------------------- | --------------------------------------- | -------------- | ---------- |
 | **any_state_app_id** | **Integer**                             | App Id         |
-| **update_details**   | [**AppDescription**](AppDescription.md) | Update Details | [optional] |
+| **body**             | [**AppDescription**](AppDescription.md) | Update Details | [optional] |
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**AppResponse**](AppResponse.md)
 
 ### Authorization
 
@@ -308,19 +360,19 @@ end
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
+# **update_using_put2**
 
-
-# **update_using_put1**
-> GenericApiResponse update_using_put1(dto, any_state_app_id)
+> AppResponse update_using_put2(bodyany_state_app_id)
 
 Update app
 
 App can be in any state
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -333,18 +385,16 @@ SematextCloud.configure do |config|
 end
 
 api_instance = SematextCloud::AppsApi.new
-
-dto = SematextCloud::UpdateAppInfo.new # UpdateAppInfo | dto
-
+body = 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)
+  result = api_instance.update_using_put2(bodyany_state_app_id)
   p result
 rescue SematextCloud::ApiError => e
-  puts "Exception when calling AppsApi->update_using_put1: #{e}"
+  puts "Exception when calling AppsApi->update_using_put2: #{e}"
 end
 ```
 
@@ -352,12 +402,12 @@ end
 
 | Name                 | Type                                  | Description | Notes |
 | -------------------- | ------------------------------------- | ----------- | ----- |
-| **dto**              | [**UpdateAppInfo**](UpdateAppInfo.md) | dto         |
+| **body**             | [**UpdateAppInfo**](UpdateAppInfo.md) | dto         |
 | **any_state_app_id** | **Integer**                           | App Id      |
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**AppResponse**](AppResponse.md)
 
 ### Authorization
 
@@ -365,5 +415,5 @@ end
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json

data/docs/AppsResponse.md

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

data/docs/AppsResponseEntry.md

@@ -0,0 +1,7 @@
+# SematextCloud::AppsResponseEntry
+
+## Properties
+
+| Name     | Type                           | Description | Notes      |
+| -------- | ------------------------------ | ----------- | ---------- |
+| **apps** | [**Array<App>**](App.md) |             | [optional] |

data/docs/AwsSettingsControllerApi.md

@@ -1,20 +1,21 @@
 # SematextCloud::AwsSettingsControllerApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to */*
 
-| 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 |
+| Method                                                                 | HTTP request                               | Description                               |
+| ---------------------------------------------------------------------- | ------------------------------------------ | ----------------------------------------- |
+| [**update_using_put1**](AwsSettingsControllerApi.md#update_using_put1) | **PUT** /users-web/api/v3/apps/{appId}/aws | Update App's AWS CloudWatch settings |
 
+# **update_using_put1**
 
-# **update_using_put**
-> GenericApiResponse update_using_put(app_id, dto)
+> CloudWatchSettingsResponse update_using_put1(bodyapp_id)
 
 Update App's AWS CloudWatch settings
 
 Applicable only for AWS Apps
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -27,18 +28,16 @@ SematextCloud.configure do |config|
 end
 
 api_instance = SematextCloud::AwsSettingsControllerApi.new
-
+body = SematextCloud::CloudWatchSettings.new # CloudWatchSettings | dto
 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)
+  result = api_instance.update_using_put1(bodyapp_id)
   p result
 rescue SematextCloud::ApiError => e
-  puts "Exception when calling AwsSettingsControllerApi->update_using_put: #{e}"
+  puts "Exception when calling AwsSettingsControllerApi->update_using_put1: #{e}"
 end
 ```
 
@@ -46,12 +45,12 @@ end
 
 | Name       | Type                                            | Description | Notes |
 | ---------- | ----------------------------------------------- | ----------- | ----- |
+| **body**   | [**CloudWatchSettings**](CloudWatchSettings.md) | dto         |
 | **app_id** | **Integer**                                     | appId       |
-| **dto**    | [**CloudWatchSettings**](CloudWatchSettings.md) | dto         |
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**CloudWatchSettingsResponse**](CloudWatchSettingsResponse.md)
 
 ### Authorization
 
@@ -59,5 +58,5 @@ end
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json

data/docs/BasicAuthMethodDto.md

@@ -1,6 +1,7 @@
 # SematextCloud::BasicAuthMethodDto
 
 ## Properties
+
 | Name          | Type       | Description | Notes      |
 | ------------- | ---------- | ----------- | ---------- |
 | **auth_type** | **String** |             | [optional] |

data/docs/BasicOrganizationDto.md

@@ -1,6 +1,7 @@
 # SematextCloud::BasicOrganizationDto
 
 ## Properties
+
 | Name             | Type                                                         | Description | Notes      |
 | ---------------- | ------------------------------------------------------------ | ----------- | ---------- |
 | **auth_methods** | [**Array<BasicAuthMethodDto>**](BasicAuthMethodDto.md) |             | [optional] |

data/docs/BillingApi.md

@@ -1,20 +1,21 @@
 # SematextCloud::BillingApi
 
-All URIs are relative to *https://localhost*
-
-| Method                                                                             | HTTP request                                                       | Description            |
-| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ---------------------- |
-| [**get_detailed_invoice_using_get**](BillingApi.md#get_detailed_invoice_using_get) | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month} | Get invoice details    |
-| [**list_available_plans_using_get**](BillingApi.md#list_available_plans_using_get) | **GET** /users-web/api/v3/billing/availablePlans                   | Get available plans    |
-| [**update_plan_using_put**](BillingApi.md#update_plan_using_put)                   | **PUT** /users-web/api/v3/billing/info/{appId}                     | Update plan for an app |
+All URIs are relative to */*
 
+| Method                                                                               | HTTP request                                                       | Description            |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | ---------------------- |
+| [**get_detailed_invoice_using_get**](BillingApi.md#get_detailed_invoice_using_get)   | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month} | Get invoice details    |
+| [**list_available_plans_using_get1**](BillingApi.md#list_available_plans_using_get1) | **GET** /users-web/api/v3/billing/availablePlans                   | Get available plans    |
+| [**update_plan_using_put**](BillingApi.md#update_plan_using_put)                     | **PUT** /users-web/api/v3/billing/info/{appId}                     | Update plan for an app |
 
 # **get_detailed_invoice_using_get**
-> GenericApiResponse get_detailed_invoice_using_get(service, year, month)
+
+> InvoiceResponse get_detailed_invoice_using_get(service, year, month)
 
 Get invoice details
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -27,11 +28,8 @@ SematextCloud.configure do |config|
 end
 
 api_instance = SematextCloud::BillingApi.new
-
 service = 'service_example' # String | service
-
 year = 56 # Integer | year
-
 month = 56 # Integer | month
 
 
@@ -54,7 +52,7 @@ end
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**InvoiceResponse**](InvoiceResponse.md)
 
 ### Authorization
 
@@ -62,17 +60,17 @@ end
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
+# **list_available_plans_using_get1**
 
-
-# **list_available_plans_using_get**
-> GenericApiResponse list_available_plans_using_get(opts)
+> PlansResponse list_available_plans_using_get1(opts)
 
 Get available plans
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -85,18 +83,17 @@ SematextCloud.configure do |config|
 end
 
 api_instance = SematextCloud::BillingApi.new
-
-opts = {
+opts = { 
   integration_id: 789, # Integer | integrationId
   app_type: 'app_type_example' # String | appType
 }
 
 begin
   #Get available plans
-  result = api_instance.list_available_plans_using_get(opts)
+  result = api_instance.list_available_plans_using_get1(opts)
   p result
 rescue SematextCloud::ApiError => e
-  puts "Exception when calling BillingApi->list_available_plans_using_get: #{e}"
+  puts "Exception when calling BillingApi->list_available_plans_using_get1: #{e}"
 end
 ```
 
@@ -109,7 +106,7 @@ end
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**PlansResponse**](PlansResponse.md)
 
 ### Authorization
 
@@ -117,17 +114,17 @@ end
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 # **update_plan_using_put**
-> GenericApiResponse update_plan_using_put(app_id, dto)
+
+> UpdatePlanResponse update_plan_using_put(bodyapp_id)
 
 Update plan for an app
 
 ### Example
+
 ```ruby
 # load the gem
 require 'SematextCloud'
@@ -140,15 +137,13 @@ SematextCloud.configure do |config|
 end
 
 api_instance = SematextCloud::BillingApi.new
-
+body = SematextCloud::BillingInfo.new # BillingInfo | dto
 app_id = 789 # Integer | appId
 
-dto = SematextCloud::BillingInfo.new # BillingInfo | dto
-
 
 begin
   #Update plan for an app
-  result = api_instance.update_plan_using_put(app_id, dto)
+  result = api_instance.update_plan_using_put(bodyapp_id)
   p result
 rescue SematextCloud::ApiError => e
   puts "Exception when calling BillingApi->update_plan_using_put: #{e}"
@@ -159,12 +154,12 @@ end
 
 | Name       | Type                              | Description | Notes |
 | ---------- | --------------------------------- | ----------- | ----- |
+| **body**   | [**BillingInfo**](BillingInfo.md) | dto         |
 | **app_id** | **Integer**                       | appId       |
-| **dto**    | [**BillingInfo**](BillingInfo.md) | dto         |
 
 ### Return type
 
-[**GenericApiResponse**](GenericApiResponse.md)
+[**UpdatePlanResponse**](UpdatePlanResponse.md)
 
 ### Authorization
 
@@ -172,5 +167,5 @@ end
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json