Class SDKEndpoints

Class providing methods for working with App Endpoints

Index

Constructors

Methods

create delete get getSection list makePrivate makePublic setSection update

Constructors

constructor

new SDKEndpoints(fetch: FetchFunction): SDKEndpoints
Parameters
- fetch: FetchFunction
Returns SDKEndpoints
- Defined in src/endpoints/sdk/endpoints.ts:107

Methods

create

create(
    appName: string,
    appVersion: number,
    body: CreateSDKEndpointBody,
): Promise<SDKEndpoint>
Create a new Endpoint
Parameters
- appName: string
- appVersion: number
- body: CreateSDKEndpointBody
Returns Promise<SDKEndpoint>
- Defined in src/endpoints/sdk/endpoints.ts:132

delete

delete(appName: string, appVersion: number, endpointName: string): Promise<void>
Delete an Endpoint
Parameters
- appName: string
- appVersion: number
- endpointName: string
Returns Promise<void>
- Defined in src/endpoints/sdk/endpoints.ts:162

get

get(
    appName: string,
    appVersion: number,
    endpointName: string,
): Promise<SDKEndpoint>
Get a single Endpoint by name
Parameters
- appName: string
- appVersion: number
- endpointName: string
Returns Promise<SDKEndpoint>
- Defined in src/endpoints/sdk/endpoints.ts:122

getSection

getSection(
    appName: string,
    appVersion: number,
    endpointName: string,
    section: SDKEndpointSectionType,
): Promise<string>
Get a specific section of an Endpoint Available sections: api, scope, inputParameters, outputParameters
Parameters
- appName: string
- appVersion: number
- endpointName: string
- section: SDKEndpointSectionType
Returns Promise<string>
- Defined in src/endpoints/sdk/endpoints.ts:172

list

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

makePrivate

makePrivate(
    appName: string,
    appVersion: number,
    endpointName: string,
): Promise<void>
Make an Endpoint private.
Parameters
- appName: string
- appVersion: number
- endpointName: string
Returns Promise<void>
- Defined in src/endpoints/sdk/endpoints.ts:214

makePublic

makePublic(
    appName: string,
    appVersion: number,
    endpointName: string,
): Promise<void>
Make an Endpoint public.
Parameters
- appName: string
- appVersion: number
- endpointName: string
Returns Promise<void>
- Defined in src/endpoints/sdk/endpoints.ts:207

setSection

setSection(
    appName: string,
    appVersion: number,
    endpointName: string,
    section: SDKEndpointSectionType,
    body: string,
): Promise<void>
Set/update a specific section of an Endpoint Available sections: api, scope, inputParameters, outputParameters
Parameters
- appName: string
- appVersion: number
- endpointName: string
- section: SDKEndpointSectionType
- body: string
Returns Promise<void>
- Defined in src/endpoints/sdk/endpoints.ts:188

update

update(
    appName: string,
    appVersion: number,
    endpointName: string,
    body: UpdateSDKEndpointBody,
): Promise<SDKEndpoint>
Update an existing Endpoint's metadata
Parameters
- appName: string
- appVersion: number
- endpointName: string
- body: UpdateSDKEndpointBody
Returns Promise<SDKEndpoint>
- Defined in src/endpoints/sdk/endpoints.ts:143