Documentation

Mistake on this page? Email us

Client, gives access to http client with supplied credentials

Hierarchy

  • SdkApiBase
    • Client

Index

Constructors

Methods

Constructors

constructor

  • Initalise new instance of Client

    Parameters

    • config: Config

      The configuration for the Client api calls

    Returns Client

Methods

CallApi

  • Call an api endpoint

    Parameters

    Returns Promise<any>

complete

  • complete(error: any, response: superagent.Response, requestOptions: object, callback?: function): void
  • Parameters

    • error: any
    • response: superagent.Response
    • requestOptions: object
      • [key: string]: any
    • Optional callback: function
        • Parameters

          Returns any

    Returns void

request

  • request(options: object, callback?: function): superagent.SuperAgentRequest
  • Parameters

    • options: object
      • acceptTypes: Array<string>
      • Optional body?: any
      • contentTypes: Array<string>
      • Optional file?: boolean
      • formParams: __type
      • headers: object
        • [key: string]: string
      • method: string
      • pathParams: __type
      • query: __type
      • url: string
    • Optional callback: function
        • Parameters

          Returns any

    Returns superagent.SuperAgentRequest