Managing App Types

A business has a set of suites that can be viewed by an admin user and an unlimited number of viewer users. Managing App Types with Shimoku’s SDK goes as follows:
The shimoku.business object has the following methods:
get_app_type(app_type_id: str)
create_app_type(name: str)
update_app_type(app_type_id: str, app_type_metadata: Dict)
delete_app_type(app_type_id: str)
rename_apps_types(app_type_id: str, app_type_data: Dict)
The Methods
1. get_app_type
app_type: Dict[str, Any] = shimoku.app_type.get_app_type(app_type_id)
That returns a dictionary such as:
app_type = {
    "id": "f861-4794-932b-6395de991111",
    "__typename": "AppType",
    "updatedAt": "2020-08-18T10:22:23.898Z",
    "createdAt": "2020-08-18T10:22:23.898Z",
    "appTypeUniverseId": "fffff-94df-49ed-b74b-d9fb9246dbb4",
    "normalizedName": "retention-suite",
    "key": "RETENTION_SUITE"
    "name": "Retention Suite",
}
2. create_app_type
apps: List[Dict[str, Any]] = shimoku.app_type.create_app_type(name)
Where if for example name is Retention Suite, then the
key is assigned to: RETENTION_SUITE
normalizedName to retention-suite
That returns a dictionary such as:
app_type = {
    "id": "f861-4794-932b-6395de991111",
    "__typename": "AppType",
    "updatedAt": "2020-08-18T10:22:23.898Z",
    "createdAt": "2020-08-18T10:22:23.898Z",
    "appTypeUniverseId": "fffff-94df-49ed-b74b-d9fb9246dbb4",
    "normalizedName": "retention-suite",
    "key": "RETENTION_SUITE"
    "name": "Retention Suite",
}

Managing Businesses

Managing Suites (Apps)

Last modified 4mo ago

Copy link

On this page

The Methods

1. get_app_type

2. create_app_type