Class SDKRPCs

Class providing methods for working with RPCs within Apps

Index

Constructors

Methods

create delete get getSection list setSection test update

Constructors

constructor

new SDKRPCs(fetch: FetchFunction): SDKRPCs
Parameters
- fetch: FetchFunction
Returns SDKRPCs
- Defined in src/endpoints/sdk/rpcs.ts:97

Methods

create

create(
    appName: string,
    appVersion: number,
    body: CreateSDKRPCBody,
): Promise<Pick<SDKRPC, "name" | "label">>
Create a new RPC
Parameters
- appName: string
- appVersion: number
- body: CreateSDKRPCBody
Returns Promise<Pick<SDKRPC, "name" | "label">>
- Defined in src/endpoints/sdk/rpcs.ts:120

delete

delete(appName: string, appVersion: number, rpcName: string): Promise<void>
Delete an RPC
Parameters
- appName: string
- appVersion: number
- rpcName: string
Returns Promise<void>
- Defined in src/endpoints/sdk/rpcs.ts:142

get

get(appName: string, appVersion: number, rpcName: string): Promise<SDKRPC>
Get a single RPC by name
Parameters
- appName: string
- appVersion: number
- rpcName: string
Returns Promise<SDKRPC>
- Defined in src/endpoints/sdk/rpcs.ts:112

getSection

getSection<T extends SDKRPCSectionType>(
    appName: string,
    appVersion: number,
    rpcName: string,
    section: T,
): Promise<SDKRPCSection<T>>
Get RPC section data
Type Parameters
- T extends SDKRPCSectionType
Parameters
- appName: string
- appVersion: number
- rpcName: string
- section: T
Returns Promise<SDKRPCSection<T>>
- Defined in src/endpoints/sdk/rpcs.ts:162

list

list(appName: string, appVersion: number): Promise<SDKRPC[]>
List all RPCs for the app
Parameters
- appName: string
- appVersion: number
Returns Promise<SDKRPC[]>
- Defined in src/endpoints/sdk/rpcs.ts:104

setSection

setSection<T extends SDKRPCSectionType>(
    appName: string,
    appVersion: number,
    rpcName: string,
    section: T,
    body: SDKRPCSection<T>,
): Promise<void>
Set RPC section data
Type Parameters
- T extends SDKRPCSectionType
Parameters
- appName: string
- appVersion: number
- rpcName: string
- section: T
- body: SDKRPCSection<T>
Returns Promise<void>
- Defined in src/endpoints/sdk/rpcs.ts:177

test

test(
    appName: string,
    appVersion: number,
    rpcName: string,
    body: TestSDKRPCBody,
): Promise<unknown>
Test an RPC with provided data and schema
Parameters
- appName: string
- appVersion: number
- rpcName: string
- body: TestSDKRPCBody
Returns Promise<unknown>
The test result
- Defined in src/endpoints/sdk/rpcs.ts:152

update

update(
    appName: string,
    appVersion: number,
    rpcName: string,
    body: UpdateSDKRPCBody,
): Promise<SDKRPC>
Update an existing RPC
Parameters
- appName: string
- appVersion: number
- rpcName: string
- body: UpdateSDKRPCBody
Returns Promise<SDKRPC>
- Defined in src/endpoints/sdk/rpcs.ts:131