Class ChameleonREST

constructor

• new ChameleonREST(options: ChameleonRESTOptions): ChameleonREST

  Parameters

  • options: ChameleonRESTOptions

  Returns ChameleonREST

Readonlytoken

Readonlyversion

request

• request<T = unknown>(
      method: HttpMethod,
      endpoint: string,
      body?: unknown,
      headers?: Record<string, string>,
  ): Promise<ChameleonAPIResult<T>>

  Internal generic request handler that doesn't throw, returning { ok: boolean, ... } shape

  Type Parameters

  • T = unknown

  Parameters

  • method: HttpMethod
  • endpoint: string
  • Optionalbody: unknown
  • Optionalheaders: Record<string, string>

  Returns Promise<ChameleonAPIResult<T>>

get

• get<T = unknown>(
      endpoint: string,
      headers?: Record<string, string>,
  ): Promise<ChameleonAPIResult<T>>

  Type Parameters

  • T = unknown

  Parameters

  • endpoint: string
  • Optionalheaders: Record<string, string>

  Returns Promise<ChameleonAPIResult<T>>

post

• post<T = unknown>(
      endpoint: string,
      body?: unknown,
      headers?: Record<string, string>,
  ): Promise<ChameleonAPIResult<T>>

  Type Parameters

  • T = unknown

  Parameters

  • endpoint: string
  • Optionalbody: unknown
  • Optionalheaders: Record<string, string>

  Returns Promise<ChameleonAPIResult<T>>

put

• put<T = unknown>(
      endpoint: string,
      body?: unknown,
      headers?: Record<string, string>,
  ): Promise<ChameleonAPIResult<T>>

  Type Parameters

  • T = unknown

  Parameters

  • endpoint: string
  • Optionalbody: unknown
  • Optionalheaders: Record<string, string>

  Returns Promise<ChameleonAPIResult<T>>

patch

• patch<T = unknown>(
      endpoint: string,
      body?: unknown,
      headers?: Record<string, string>,
  ): Promise<ChameleonAPIResult<T>>

  Type Parameters

  • T = unknown

  Parameters

  • endpoint: string
  • Optionalbody: unknown
  • Optionalheaders: Record<string, string>

  Returns Promise<ChameleonAPIResult<T>>

delete

• delete<T = unknown>(
      endpoint: string,
      headers?: Record<string, string>,
  ): Promise<ChameleonAPIResult<T>>

  Type Parameters

  • T = unknown

  Parameters

  • endpoint: string
  • Optionalheaders: Record<string, string>

  Returns Promise<ChameleonAPIResult<T>>