SematextCloud::AppsApi

All URIs are relative to /

Method	HTTP request	Description
delete_using_delete	DELETE /users-web/api/v3/apps/{anyStateAppId}	delete
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_get1	GET /users-web/api/v3/apps/{anyStateAppId}	Gets defails for one particular App
invite_app_guests_using_post1	POST /users-web/api/v3/apps/guests	Invite guests to an app
list_apps_users_using_get	GET /users-web/api/v3/apps/users	Get all users of apps accessible to this account
list_using_get1	GET /users-web/api/v3/apps	Get all apps accessible by account identified with apiKey
update_description_using_put1	PUT /users-web/api/v3/apps/{anyStateAppId}/description	Update description of the app
update_using_put3	PUT /users-web/api/v3/apps/{anyStateAppId}	Update app

delete_using_delete

GenericMapBasedApiResponse delete_using_delete(any_state_app_id)

delete

Example

# 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

Authorization

api_key

HTTP request headers

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

# 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

AppTypesResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_using_get1

AppResponse get_using_get1(any_state_app_id)

Gets defails for one particular App

Example

# 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_get1(any_state_app_id)
  p result
rescue SematextCloud::ApiError => e
  puts "Exception when calling AppsApi->get_using_get1: #{e}"
end

Parameters

Name	Type	Description	Notes
any_state_app_id	Integer	anyStateAppId

Return type

AppResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

invite_app_guests_using_post1

GenericMapBasedApiResponse invite_app_guests_using_post1(body)

Invite guests to an app

Example

# 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
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_post1(body)
  p result
rescue SematextCloud::ApiError => e
  puts "Exception when calling AppsApi->invite_app_guests_using_post1: #{e}"
end

Parameters

Name	Type	Description	Notes
body	Invitation	For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

list_apps_users_using_get

AppsResponse list_apps_users_using_get

Get all users of apps accessible to this account

Example

# 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

AppsResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

list_using_get1

AppsResponse list_using_get1

Get all apps accessible by account identified with apiKey

Example

# 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_get1
  p result
rescue SematextCloud::ApiError => e
  puts "Exception when calling AppsApi->list_using_get1: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

AppsResponse

Authorization

api_key

HTTP request headers

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

# 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 = { 
  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 SematextCloud::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
body	AppDescription	Update Details	[optional]

Return type

AppResponse

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

update_using_put3

AppResponse update_using_put3(bodyany_state_app_id)

Update app

App can be in any state

Example

# 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
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)
  p result
rescue SematextCloud::ApiError => e
  puts "Exception when calling AppsApi->update_using_put3: #{e}"
end

Parameters

Name	Type	Description	Notes
body	UpdateAppInfo	dto
any_state_app_id	Integer	App Id

Return type

AppResponse

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

AppsApi.md

Latest commit

History

AppsApi.md

File metadata and controls

SematextCloud::AppsApi

delete_using_delete

Example

Parameters

Return type

Authorization

HTTP request headers

get_app_types_using_get

Example

Parameters

Return type

Authorization

HTTP request headers

get_using_get1

Example

Parameters

Return type

Authorization

HTTP request headers

invite_app_guests_using_post1

Example

Parameters

Return type

Authorization

HTTP request headers

list_apps_users_using_get

Example

Parameters

Return type

Authorization

HTTP request headers

list_using_get1

Example

Parameters

Return type

Authorization

HTTP request headers

update_description_using_put1

Example

Parameters

Return type

Authorization

HTTP request headers

update_using_put3

Example

Parameters

Return type

Authorization

HTTP request headers