Class SDKModules

Class providing methods for working with App Modules

Index

Constructors

Methods

create delete get getSection list setSection update

Constructors

constructor

new SDKModules(fetch: FetchFunction): SDKModules
Parameters
- fetch: FetchFunction
Returns SDKModules
- Defined in src/endpoints/sdk/modules.ts:95

Methods

create

create(
    appName: string,
    appVersion: number,
    body: CreateSDKModuleBody,
): Promise<SDKModule>
Create a new module
Parameters
- appName: string
- appVersion: number
- body: CreateSDKModuleBody
Returns Promise<SDKModule>
- Defined in src/endpoints/sdk/modules.ts:120

delete

delete(appName: string, appVersion: number, moduleName: string): Promise<void>
Delete a module
Parameters
- appName: string
- appVersion: number
- moduleName: string
Returns Promise<void>
- Defined in src/endpoints/sdk/modules.ts:150

get

get(appName: string, appVersion: number, moduleName: string): Promise<SDKModule>
Get a single module by name
Parameters
- appName: string
- appVersion: number
- moduleName: string
Returns Promise<SDKModule>
- Defined in src/endpoints/sdk/modules.ts:110

getSection

getSection<T extends SDKModuleSectionType>(
    appName: string,
    appVersion: number,
    moduleName: string,
    section: T,
): Promise<SDKModuleSection<T>>
Get a specific section of a module Available sections: api, epoch, parameters, expect, interface, samples, scope
Type Parameters
- T extends SDKModuleSectionType
Parameters
- appName: string
- appVersion: number
- moduleName: string
- section: T
Returns Promise<SDKModuleSection<T>>
- Defined in src/endpoints/sdk/modules.ts:160

list

list(appName: string, appVersion: number): Promise<SDKModule[]>
List modules for the app with optional filtering
Parameters
- appName: string
- appVersion: number
Returns Promise<SDKModule[]>
- Defined in src/endpoints/sdk/modules.ts:102

setSection

setSection<T extends SDKModuleSectionType>(
    appName: string,
    appVersion: number,
    moduleName: string,
    section: T,
    body: SDKModuleSection<T>,
): Promise<void>
Set/update a specific section of a module Available sections: api, epoch, parameters, expect, interface, samples, scope
Type Parameters
- T extends SDKModuleSectionType
Parameters
- appName: string
- appVersion: number
- moduleName: string
- section: T
- body: SDKModuleSection<T>
Returns Promise<void>
- Defined in src/endpoints/sdk/modules.ts:176

update

update(
    appName: string,
    appVersion: number,
    moduleName: string,
    body: UpdateSDKModuleBody,
): Promise<SDKModule>
Update an existing module
Parameters
- appName: string
- appVersion: number
- moduleName: string
- body: UpdateSDKModuleBody
Returns Promise<SDKModule>
- Defined in src/endpoints/sdk/modules.ts:131