Class MembraneApiClient

constructor

• new MembraneApiClient(
      __namedParameters?: MembraneClientOptions,
  ): MembraneApiClient

  Parameters

  • Optional__namedParameters: MembraneClientOptions

  Returns MembraneApiClient

setCredentials

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

  Parameters

  • credentials: any

  Returns Promise<any>

getToken

• getToken(): Promise<string>

  Returns Promise<string>

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>

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>

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>

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>

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>

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>

apiUri

uiUri

Optionaltoken