Class SDKConnections

Class providing methods for working with SDK App Connections

Index

Constructors

Methods

create delete get getCommon getSection list setCommon setSection update

Constructors

constructor

new SDKConnections(fetch: FetchFunction): SDKConnections
Parameters
- fetch: FetchFunction
Returns SDKConnections
- Defined in src/endpoints/sdk/connections.ts:79

Methods

create

create(appName: string, body: CreateSDKConnectionBody): Promise<SDKConnection>
Create a new connection for a specific app
Parameters
- appName: string
- body: CreateSDKConnectionBody
Returns Promise<SDKConnection>
- Defined in src/endpoints/sdk/connections.ts:102

delete

delete(connectionName: string): Promise<void>
Delete a connection
Parameters
- connectionName: string
Returns Promise<void>
- Defined in src/endpoints/sdk/connections.ts:124

get

get(connectionName: string): Promise<SDKConnection>
Get a single connection by name
Parameters
- connectionName: string
Returns Promise<SDKConnection>
- Defined in src/endpoints/sdk/connections.ts:94

getCommon

getCommon(connectionName: string): Promise<SDKConnectionCommon>
Get common configuration for a connection
Parameters
- connectionName: string
Returns Promise<SDKConnectionCommon>
- Defined in src/endpoints/sdk/connections.ts:160

getSection

getSection<T extends SDKConnectionSectionType>(
connectionName: string,
section: T,
): Promise<SDKConnectionSection<T>>
Get a specific section of a connection
Type Parameters
- T extends SDKConnectionSectionType
Parameters
- connectionName: string
- section: T
Returns Promise<SDKConnectionSection<T>>
- Defined in src/endpoints/sdk/connections.ts:133

list

list(appName: string): Promise<SDKConnection[]>
List connections for a specific app
Parameters
- appName: string
Returns Promise<SDKConnection[]>
- Defined in src/endpoints/sdk/connections.ts:86

setCommon

setCommon(connectionName: string, body: SDKConnectionCommon): Promise<boolean>
Set common configuration for a connection
Parameters
- connectionName: string
- body: SDKConnectionCommon
Returns Promise<boolean>
- Defined in src/endpoints/sdk/connections.ts:168

setSection

setSection<T extends SDKConnectionSectionType>(
    connectionName: string,
    section: T,
    body: SDKConnectionSection<T>,
): Promise<void>
Set a specific section of a connection
Type Parameters
- T extends SDKConnectionSectionType
Parameters
- connectionName: string
- section: T
- body: SDKConnectionSection<T>
Returns Promise<void>
- Defined in src/endpoints/sdk/connections.ts:146

update

update(
connectionName: string,
body: UpdateSDKConnectionBody,
): Promise<SDKConnection>
Update an existing connection
Parameters
- connectionName: string
- body: UpdateSDKConnectionBody
Returns Promise<SDKConnection>
- Defined in src/endpoints/sdk/connections.ts:113