docs/AppsApi.md in SematextCloud-0.3.1 vs docs/AppsApi.md in SematextCloud-0.4.0
- old
+ new
@@ -1,47 +1,49 @@
-# stcloud::AppsApi
+# SematextCloud::AppsApi
All URIs are relative to */*
| Method | HTTP request | Description |
| ----------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------ |
-| [**delete_using_delete1**](AppsApi.md#delete_using_delete1) | **DELETE** /users-web/api/v3/apps/{anyStateAppId} | delete |
+| [**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_get1**](AppsApi.md#list_apps_users_using_get1) | **GET** /users-web/api/v3/apps/users | Get all users of apps accessible to this account |
+| [**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_put3**](AppsApi.md#update_using_put3) | **PUT** /users-web/api/v3/apps/{anyStateAppId} | Update app |
+| [**update_using_put2**](AppsApi.md#update_using_put2) | **PUT** /users-web/api/v3/apps/{anyStateAppId} | Update app |
-# **delete_using_delete1**
-> GenericMapBasedApiResponse delete_using_delete1(any_state_app_id)
+# **delete_using_delete**
+> GenericMapBasedApiResponse delete_using_delete(any_state_app_id)
+
delete
### Example
+
```ruby
# load the gem
-require 'stcloud'
+require 'SematextCloud'
# setup authorization
-stcloud.configure do |config|
+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 = stcloud::AppsApi.new
+api_instance = SematextCloud::AppsApi.new
any_state_app_id = 789 # Integer | anyStateAppId
begin
#delete
- result = api_instance.delete_using_delete1(any_state_app_id)
+ result = api_instance.delete_using_delete(any_state_app_id)
p result
-rescue stcloud::ApiError => e
- puts "Exception when calling AppsApi->delete_using_delete1: #{e}"
+rescue SematextCloud::ApiError => e
+ puts "Exception when calling AppsApi->delete_using_delete: #{e}"
end
```
### Parameters
@@ -57,44 +59,45 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
-
-
# **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 'stcloud'
+require 'SematextCloud'
# setup authorization
-stcloud.configure do |config|
+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 = stcloud::AppsApi.new
+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 stcloud::ApiError => e
+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
[**AppTypesResponse**](AppTypesResponse.md)
@@ -103,41 +106,41 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
-
-
# **get_using_get**
+
> AppResponse get_using_get(any_state_app_id)
Gets defails for one particular App
### Example
+
```ruby
# load the gem
-require 'stcloud'
+require 'SematextCloud'
# setup authorization
-stcloud.configure do |config|
+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 = stcloud::AppsApi.new
+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 stcloud::ApiError => e
+rescue SematextCloud::ApiError => e
puts "Exception when calling AppsApi->get_using_get: #{e}"
end
```
### Parameters
@@ -154,41 +157,41 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
-
-
# **invite_app_guests_using_post**
+
> GenericMapBasedApiResponse invite_app_guests_using_post(body)
Invite guests to an app
### Example
+
```ruby
# load the gem
-require 'stcloud'
+require 'SematextCloud'
# setup authorization
-stcloud.configure do |config|
+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 = stcloud::AppsApi.new
-body = stcloud::Invitation.new # Invitation | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values
+api_instance = SematextCloud::AppsApi.new
+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(body)
p result
-rescue stcloud::ApiError => e
+rescue SematextCloud::ApiError => e
puts "Exception when calling AppsApi->invite_app_guests_using_post: #{e}"
end
```
### Parameters
@@ -205,44 +208,45 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
+# **list_apps_users_using_get**
+> AppsResponse list_apps_users_using_get
-# **list_apps_users_using_get1**
-> AppsResponse list_apps_users_using_get1
-
Get all users of apps accessible to this account
### Example
+
```ruby
# load the gem
-require 'stcloud'
+require 'SematextCloud'
# setup authorization
-stcloud.configure do |config|
+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 = stcloud::AppsApi.new
+api_instance = SematextCloud::AppsApi.new
begin
#Get all users of apps accessible to this account
- result = api_instance.list_apps_users_using_get1
+ result = api_instance.list_apps_users_using_get
p result
-rescue stcloud::ApiError => e
- puts "Exception when calling AppsApi->list_apps_users_using_get1: #{e}"
+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
[**AppsResponse**](AppsResponse.md)
@@ -251,44 +255,45 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
-
-
# **list_using_get**
+
> AppsResponse list_using_get
Get all apps accessible by account identified with apiKey
### Example
+
```ruby
# load the gem
-require 'stcloud'
+require 'SematextCloud'
# setup authorization
-stcloud.configure do |config|
+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 = stcloud::AppsApi.new
+api_instance = SematextCloud::AppsApi.new
begin
#Get all apps accessible by account identified with apiKey
result = api_instance.list_using_get
p result
-rescue stcloud::ApiError => e
+rescue SematextCloud::ApiError => e
puts "Exception when calling AppsApi->list_using_get: #{e}"
end
```
### Parameters
+
This endpoint does not need any parameter.
### Return type
[**AppsResponse**](AppsResponse.md)
@@ -297,45 +302,45 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
-
-
# **update_description_using_put1**
+
> 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 'stcloud'
+require 'SematextCloud'
# setup authorization
-stcloud.configure do |config|
+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 = stcloud::AppsApi.new
+api_instance = SematextCloud::AppsApi.new
any_state_app_id = 789 # Integer | App Id
-opts = {
- body: stcloud::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_put1(any_state_app_id, opts)
p result
-rescue stcloud::ApiError => e
+rescue SematextCloud::ApiError => e
puts "Exception when calling AppsApi->update_description_using_put1: #{e}"
end
```
### Parameters
@@ -353,45 +358,45 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
+# **update_using_put2**
+> AppResponse update_using_put2(bodyany_state_app_id)
-# **update_using_put3**
-> AppResponse update_using_put3(bodyany_state_app_id)
-
Update app
App can be in any state
### Example
+
```ruby
# load the gem
-require 'stcloud'
+require 'SematextCloud'
# setup authorization
-stcloud.configure do |config|
+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 = stcloud::AppsApi.new
-body = stcloud::UpdateAppInfo.new # UpdateAppInfo | dto
+api_instance = SematextCloud::AppsApi.new
+body = SematextCloud::UpdateAppInfo.new # UpdateAppInfo | dto
any_state_app_id = 789 # Integer | App Id
begin
#Update app
- result = api_instance.update_using_put3(bodyany_state_app_id)
+ result = api_instance.update_using_put2(bodyany_state_app_id)
p result
-rescue stcloud::ApiError => e
- puts "Exception when calling AppsApi->update_using_put3: #{e}"
+rescue SematextCloud::ApiError => e
+ puts "Exception when calling AppsApi->update_using_put2: #{e}"
end
```
### Parameters
@@ -408,7 +413,7 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json