Class MembraneApiClient

Hierarchy (View Summary)

MembraneApiClient
- IntegrationAppClient

Index

Constructors

Properties

apiUri uiUri token? fetchToken?

Methods

setCredentials getToken get post put patch delete createEventSource getEmbedUri

Constructors

constructor

new MembraneApiClient(
__namedParameters?: MembraneClientOptions,
): MembraneApiClient
Parameters
- __namedParameters: MembraneClientOptions = {}
Returns MembraneApiClient
- Defined in api-client.ts:56

Properties

apiUri

apiUri: string

uiUri

uiUri: string

`Optional`token

token?: string

`Protected` `Optional`fetchToken

fetchToken?: () => Promise<string>

Methods

setCredentials

setCredentials(credentials: any): Promise<any>
Parameters
- credentials: any
Returns Promise<any>
- Defined in api-client.ts:78

getToken

getToken(): Promise<string>
Returns Promise<string>
- Defined in api-client.ts:82

get

get<T = any>(
    uri: string,
    queryParams?: Record<string, any>,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- OptionalqueryParams: Record<string, any>
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in api-client.ts:109

post

post<T = any>(
    uri: string,
    data?: any,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in api-client.ts:116

put

put<T = any>(
    uri: string,
    data?: any,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in api-client.ts:120

patch

patch<T = any>(
    uri: string,
    data?: any,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in api-client.ts:124

delete

delete<T = any>(
    uri: string,
    data?: any,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in api-client.ts:128

createEventSource

createEventSource(
uri: string,
queryParams?: Record<string, any>,
): Promise<EventSource>
Parameters
- uri: string
- OptionalqueryParams: Record<string, any>
Returns Promise<EventSource>
- Defined in api-client.ts:132

getEmbedUri

getEmbedUri(
    page: string,
    pageParams?: Record<string, any>,
    options?: { embedMode: "isolated-embed" | "popup-embed" },
): Promise<string>
Parameters
- page: string
- OptionalpageParams: Record<string, any>
- Optionaloptions: { embedMode: "isolated-embed" | "popup-embed" }
Returns Promise<string>
- Defined in api-client.ts:142