Class SDKApps

Class providing methods for working with Apps

Index

Constructors

constructor

Methods

create delete get getCommon getDocs getSection list setCommon setDocs setSection update

Constructors

constructor

new SDKApps(fetch: FetchFunction): SDKApps
Parameters
- fetch: FetchFunction
Returns SDKApps
- Defined in src/endpoints/sdk/apps.ts:145

Methods

create

create(
    body: CreateSDKAppBody,
): Promise<
    Pick<
        SDKApp,
        | "name"
        | "public"
        | "description"
        | "theme"
        | "label"
        | "version"
        | "approved",
    >,
>
Create a new app
Parameters
- body: CreateSDKAppBody
Returns Promise<
    Pick<
        SDKApp,
        | "name"
        | "public"
        | "description"
        | "theme"
        | "label"
        | "version"
        | "approved",
    >,
>
- Defined in src/endpoints/sdk/apps.ts:176

delete

delete(name: string, version: number): Promise<void>
Delete an app
Parameters
- name: string
- version: number
Returns Promise<void>
- Defined in src/endpoints/sdk/apps.ts:198

get

get<C extends keyof SDKApp = never>(
    name: string,
    version: number,
    options?: GetSDKAppsOptions<C>,
): Promise<PickColumns<SDKApp, C>>
Get a single app by name and version
Type Parameters
- C extends keyof SDKApp = never
Parameters
- name: string
- version: number
- options: GetSDKAppsOptions<C> = {}
Returns Promise<PickColumns<SDKApp, C>>
- Defined in src/endpoints/sdk/apps.ts:162

getCommon

getCommon(name: string, version: number): Promise<SDKAppCommon>
Get app common data (client credentials and shared configuration)
Parameters
- name: string
- version: number
Returns Promise<SDKAppCommon>
- Defined in src/endpoints/sdk/apps.ts:249

getDocs

getDocs(name: string, version: number): Promise<string>
Get app documentation (readme)
Parameters
- name: string
- version: number
Returns Promise<string>
- Defined in src/endpoints/sdk/apps.ts:227

getSection

getSection(
    name: string,
    version: number,
    section: SDKAppSectionType,
): Promise<SDKAppSection>
Get a specific section of an app Available sections: base, groups, install, installSpec
Parameters
- name: string
- version: number
- section: SDKAppSectionType
Returns Promise<SDKAppSection>
- Defined in src/endpoints/sdk/apps.ts:208

list

list<C extends keyof SDKApp = never>(
options?: ListSDKAppsOptions<C>,
): Promise<PickColumns<SDKApp, C>[]>
List apps with optional filtering
Type Parameters
- C extends keyof SDKApp = never
Parameters
- options: ListSDKAppsOptions<C> = {}
Returns Promise<PickColumns<SDKApp, C>[]>
- Defined in src/endpoints/sdk/apps.ts:152

setCommon

setCommon(name: string, version: number, common: SDKAppCommon): Promise<boolean>
Set app common data (client credentials and shared configuration)
Parameters
- name: string
- version: number
- common: SDKAppCommon
Returns Promise<boolean>
- Defined in src/endpoints/sdk/apps.ts:257

setDocs

setDocs(name: string, version: number, docs: string): Promise<boolean>
Set app documentation (readme)
Parameters
- name: string
- version: number
- docs: string
Returns Promise<boolean>
- Defined in src/endpoints/sdk/apps.ts:235

setSection

setSection(
    name: string,
    version: number,
    section: SDKAppSectionType,
    body: SDKAppSection,
): Promise<void>
Set/update a specific section of an app Available sections: base, groups, install, installSpec
Parameters
- name: string
- version: number
- section: SDKAppSectionType
- body: SDKAppSection
Returns Promise<void>
- Defined in src/endpoints/sdk/apps.ts:217

update

update(
    name: string,
    version: number,
    body: UpdateSDKAppBody,
): Promise<
    Pick<
        SDKApp,
        | "name"
        | "public"
        | "description"
        | "theme"
        | "label"
        | "version"
        | "approved",
    >,
>
Update an existing app
Parameters
- name: string
- version: number
- body: UpdateSDKAppBody
Returns Promise<
    Pick<
        SDKApp,
        | "name"
        | "public"
        | "description"
        | "theme"
        | "label"
        | "version"
        | "approved",
    >,
>
- Defined in src/endpoints/sdk/apps.ts:187

Class SDKApps

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SDKApps

Methods

create

Parameters

Returns Promise< Pick< SDKApp, | "name" | "public" | "description" | "theme" | "label" | "version" | "approved", >,>

delete

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<PickColumns<SDKApp, C>>

getCommon

Parameters

Returns Promise<SDKAppCommon>

getDocs

Parameters

Returns Promise<string>

getSection

Parameters

Returns Promise<SDKAppSection>

list

Type Parameters

Parameters

Returns Promise<PickColumns<SDKApp, C>[]>

setCommon

Parameters

Returns Promise<boolean>

setDocs

Parameters

Returns Promise<boolean>

setSection

Parameters

Returns Promise<void>

update

Parameters

Returns Promise< Pick< SDKApp, | "name" | "public" | "description" | "theme" | "label" | "version" | "approved", >,>

Settings

On This Page

Returns Promise<
Pick<
SDKApp,
| "name"
| "public"
| "description"
| "theme"
| "label"
| "version"
| "approved",
>,
>

Returns Promise<
Pick<
SDKApp,
| "name"
| "public"
| "description"
| "theme"
| "label"
| "version"
| "approved",
>,
>