Class MembraneApiClient

constructor

• new MembraneApiClient(options?: MembraneClientOptions): MembraneApiClient

  Parameters

  • options: MembraneClientOptions = {}

  Returns MembraneApiClient

apiUri

uiUri

Optionaltoken

setCredentials

• setCredentials(credentials: any): Promise<any>

  Parameters

  • credentials: any

  Returns Promise<any>

getToken

• getToken(): Promise<string>

  Returns a valid access token. When using workspace credentials, mints a fresh JWT on demand. The returned token is valid for at least 60 seconds.

  Returns Promise<string>

get

• get<T = any>(
      uri: string,
      queryParams?: Record<string, any>,
      options?: AxiosRequestConfig<any, any>,
  ): Promise<T>

  Type Parameters

  • T = any

  Parameters

  • uri: string
  • OptionalqueryParams: Record<string, any>
  • Optionaloptions: AxiosRequestConfig<any, any>

  Returns Promise<T>

post

• post<T = any>(
      uri: string,
      data?: any,
      options?: AxiosRequestConfig<any, any>,
  ): Promise<T>

  Type Parameters

  • T = any

  Parameters

  • uri: string
  • Optionaldata: any
  • Optionaloptions: AxiosRequestConfig<any, any>

  Returns Promise<T>

put

• put<T = any>(
      uri: string,
      data?: any,
      options?: AxiosRequestConfig<any, any>,
  ): Promise<T>

  Type Parameters

  • T = any

  Parameters

  • uri: string
  • Optionaldata: any
  • Optionaloptions: AxiosRequestConfig<any, any>

  Returns Promise<T>

patch

• patch<T = any>(
      uri: string,
      data?: any,
      options?: AxiosRequestConfig<any, any>,
  ): Promise<T>

  Type Parameters

  • T = any

  Parameters

  • uri: string
  • Optionaldata: any
  • Optionaloptions: AxiosRequestConfig<any, any>

  Returns Promise<T>

delete

• delete<T = any>(
      uri: string,
      data?: any,
      options?: AxiosRequestConfig<any, any>,
  ): Promise<T>

  Type Parameters

  • T = any

  Parameters

  • uri: string
  • Optionaldata: any
  • Optionaloptions: AxiosRequestConfig<any, any>

  Returns Promise<T>

retrieveLogs

• retrieveLogs(): LogRecord[]

  Returns LogRecord[]

createEventSource

• createEventSource(
      uri: string,
      queryParams?: Record<string, any>,
  ): Promise<EventSource>

  Parameters

  • uri: string
  • OptionalqueryParams: Record<string, any>

  Returns Promise<EventSource>

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>

getScreensEmbedUri

• getScreensEmbedUri(
      page: string,
      pageParams?: Record<string, any>,
  ): Promise<string>

  Get embed URI for SSR-based screens served from the API.

  Parameters

  • page: string
  • OptionalpageParams: Record<string, any>

  Returns Promise<string>

getScreensPostData

• getScreensPostData(
      page: string,
      pageParams?: Record<string, string | undefined>,
  ): Promise<{ url: string; postData: { token: string } }>

  Get URL and POST data for SSR-based screens served from the API. This method returns data suitable for form submission to avoid putting tokens in URLs.

  Parameters

  • page: string
  • OptionalpageParams: Record<string, string | undefined>

  Returns Promise<{ url: string; postData: { token: string } }>