docs/AppsApi.md in SematextCloud-0.2.0 vs docs/AppsApi.md in SematextCloud-0.3.0

- old
+ new

@@ -1,93 +1,143 @@ -# SematextCloud::AppsApi +# stcloud::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_delete1**](AppsApi.md#delete_using_delete1) | **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_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 | +# **delete_using_delete1** +> GenericMapBasedApiResponse delete_using_delete1(any_state_app_id) +delete + +### 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::AppsApi.new +any_state_app_id = 789 # Integer | anyStateAppId + + +begin + #delete + result = api_instance.delete_using_delete1(any_state_app_id) + p result +rescue stcloud::ApiError => e + puts "Exception when calling AppsApi->delete_using_delete1: #{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' +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::AppsApi.new +api_instance = stcloud::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 +rescue stcloud::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) +[**AppTypesResponse**](AppTypesResponse.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: 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' +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::AppsApi.new - +api_instance = stcloud::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 +rescue stcloud::ApiError => e puts "Exception when calling AppsApi->get_using_get: #{e}" end ``` ### Parameters @@ -96,63 +146,62 @@ | -------------------- | ----------- | ------------- | ----- | | **any_state_app_id** | **Integer** | anyStateAppId | ### Return type -[**GenericApiResponse**](GenericApiResponse.md) +[**AppResponse**](AppResponse.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: 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' +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::AppsApi.new +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 -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) + result = api_instance.invite_app_guests_using_post(body) p result -rescue SematextCloud::ApiError => e +rescue stcloud::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 | +| 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 [api_key](../README.md#api_key) @@ -161,148 +210,146 @@ - **Content-Type**: application/json - **Accept**: application/json -# **list_apps_users_using_get** -> GenericApiResponse 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 '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::AppsApi.new +api_instance = stcloud::AppsApi.new begin #Get all users of apps accessible to this account - result = api_instance.list_apps_users_using_get + result = api_instance.list_apps_users_using_get1 p result -rescue SematextCloud::ApiError => e - puts "Exception when calling AppsApi->list_apps_users_using_get: #{e}" +rescue stcloud::ApiError => e + puts "Exception when calling AppsApi->list_apps_users_using_get1: #{e}" end ``` ### Parameters This endpoint does not need any parameter. ### Return type -[**GenericApiResponse**](GenericApiResponse.md) +[**AppsResponse**](AppsResponse.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: 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' +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::AppsApi.new +api_instance = stcloud::AppsApi.new begin #Get all apps accessible by account identified with apiKey result = api_instance.list_using_get p result -rescue SematextCloud::ApiError => e +rescue stcloud::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) +[**AppsResponse**](AppsResponse.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json -# **update_description_using_put** -> GenericApiResponse update_description_using_put(any_state_app_id, opts) +# **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 '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::AppsApi.new - +api_instance = stcloud::AppsApi.new any_state_app_id = 789 # Integer | App Id - opts = { - update_details: SematextCloud::AppDescription.new # AppDescription | Update Details + body: stcloud::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}" +rescue stcloud::ApiError => e + puts "Exception when calling AppsApi->update_description_using_put1: #{e}" end ``` ### Parameters | 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 [api_key](../README.md#api_key) @@ -311,54 +358,52 @@ - **Content-Type**: application/json - **Accept**: application/json -# **update_using_put1** -> GenericApiResponse update_using_put1(dto, any_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 '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::AppsApi.new - -dto = SematextCloud::UpdateAppInfo.new # UpdateAppInfo | dto - +api_instance = stcloud::AppsApi.new +body = stcloud::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_put3(bodyany_state_app_id) p result -rescue SematextCloud::ApiError => e - puts "Exception when calling AppsApi->update_using_put1: #{e}" +rescue stcloud::ApiError => e + puts "Exception when calling AppsApi->update_using_put3: #{e}" end ``` ### Parameters | 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 [api_key](../README.md#api_key)