Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HS

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

axios

axios: AxiosInstance = ...

card

card: (args: CardOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: CardOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: CardOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

cardBacks

cardBacks: (args: CardBacksOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: CardBacksOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: CardBacksOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

cardSearch

cardSearch: (args: CardSearchOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: CardSearchOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: CardSearchOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

deck

deck: (args: DeckOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: DeckOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: DeckOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

defaults

defaults: { key: string; locale: Locales; origin: Origins; secret: string; token?: string }

Type declaration

  • key: string
  • locale: Locales
  • origin: Origins
  • secret: string
  • Optional token?: string

metadata

metadata: (args: undefined | null | MetaDataOptions, headers?: Headers) => ResourceResponse<any> = ...

Type declaration

    • (args: undefined | null | MetaDataOptions, headers?: Headers): ResourceResponse<any>

    • Parameters

      • args: undefined | null | MetaDataOptions
      • Optional headers: Headers

      Returns ResourceResponse<any>

ua

ua: string = ...

version

version: string = '4.2.0'

Methods

createClientResourceRequest

  • createClientResourceRequest<T>(fn: ResourceInterface<T, any>): (args: T, headers?: Headers) => ResourceResponse<any>

getApplicationToken

  • getApplicationToken(args?: { key?: string; origin?: string; secret?: string }): Promise<AxiosResponse<AccessToken, any>>

getClientResource

  • getClientResource<T>(url: string, config?: AxiosRequestConfig<any>): Promise<AxiosResponse<T, any>>

prepareResourceRequest

  • prepareResourceRequest(resource: Resource<{}>, args?: Partial<ClientOptions>, headers?: Headers): [string, AxiosRequestConfig<any>]

refreshApplicationToken

  • refreshApplicationToken(args?: { key?: string; origin?: string; secret?: string }): Promise<AxiosResponse<AccessToken, any>>

setApplicationToken

  • setApplicationToken(token: string): void

validateApplicationToken

  • validateApplicationToken(args?: { origin?: string; token?: string }): Promise<AxiosResponse<{ authorities: { authority: string }[]; client_id: string; exp: number; scope?: string[] }, any>>

Generated using TypeDoc