stcloud.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_get	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_get1	GET /users-web/api/v3/apps/users	Get all users of apps accessible to this account
list_using_get	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

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.AppsApi(stcloud.ApiClient(configuration))
any_state_app_id = 789 # int | anyStateAppId

try:
    # delete
    api_response = api_instance.delete_using_delete(any_state_app_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->delete_using_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
any_state_app_id	int	anyStateAppId

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_app_types_using_get

AppTypesResponse get_app_types_using_get()

Get all App types supported for the account identified with apiKey

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.AppsApi(stcloud.ApiClient(configuration))

try:
    # Get all App types supported for the account identified with apiKey
    api_response = api_instance.get_app_types_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->get_app_types_using_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AppTypesResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_using_get

AppResponse get_using_get(any_state_app_id)

Gets defails for one particular App

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.AppsApi(stcloud.ApiClient(configuration))
any_state_app_id = 789 # int | anyStateAppId

try:
    # Gets defails for one particular App
    api_response = api_instance.get_using_get(any_state_app_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->get_using_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
any_state_app_id	int	anyStateAppId

Return type

AppResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

invite_app_guests_using_post1

GenericMapBasedApiResponse invite_app_guests_using_post1(body)

Invite guests to an app

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.AppsApi(stcloud.ApiClient(configuration))
body = stcloud.Invitation() # Invitation | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values

try:
    # Invite guests to an app
    api_response = api_instance.invite_app_guests_using_post1(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->invite_app_guests_using_post1: %s\n" % e)

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_apps_users_using_get1

AppsResponse list_apps_users_using_get1()

Get all users of apps accessible to this account

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.AppsApi(stcloud.ApiClient(configuration))

try:
    # Get all users of apps accessible to this account
    api_response = api_instance.list_apps_users_using_get1()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->list_apps_users_using_get1: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AppsResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_using_get

AppsResponse list_using_get()

Get all apps accessible by account identified with apiKey

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.AppsApi(stcloud.ApiClient(configuration))

try:
    # Get all apps accessible by account identified with apiKey
    api_response = api_instance.list_using_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->list_using_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AppsResponse

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_description_using_put1

AppResponse update_description_using_put1(any_state_app_id, body=body)

Update description of the app

App can be in any state

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.AppsApi(stcloud.ApiClient(configuration))
any_state_app_id = 789 # int | App Id
body = stcloud.AppDescription() # AppDescription | Update Details (optional)

try:
    # Update description of the app
    api_response = api_instance.update_description_using_put1(any_state_app_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->update_description_using_put1: %s\n" % e)

Parameters

Name	Type	Description	Notes
any_state_app_id	int	App Id
body	AppDescription	Update Details	[optional]

Return type

AppResponse

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_using_put3

AppResponse update_using_put3(body, any_state_app_id)

Update app

App can be in any state

Example

from __future__ import print_function
import time
import stcloud
from stcloud.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = stcloud.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = stcloud.AppsApi(stcloud.ApiClient(configuration))
body = stcloud.UpdateAppInfo() # UpdateAppInfo | dto
any_state_app_id = 789 # int | App Id

try:
    # Update app
    api_response = api_instance.update_using_put3(body, any_state_app_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->update_using_put3: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	UpdateAppInfo	dto
any_state_app_id	int	App Id

Return type

AppResponse

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AppsApi.md

Latest commit

History

AppsApi.md

File metadata and controls

stcloud.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_get

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_get1

Example

Parameters

Return type

Authorization

HTTP request headers

list_using_get

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