Class TipLinksApi

TipLinksApi - object-oriented interface export TipLinksApi

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration

Methods

tipLinkImage tipLinksCREATE tipLinksGET tipLinksLIST tipLinksSearch tipLinksUpdate

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

tipLinkImage

  • tipLinkImage(image?, options?): Promise<AxiosResponse<TipLinksImage, any>>

  • summary Upload image

    Parameters

    • Optionalimage: File

      The image for Tip Links

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TipLinksImage, any>>

    Throws

    memberof TipLinksApi

tipLinksCREATE

  • tipLinksCREATE(tipLinkCreateDeets?, options?): Promise<AxiosResponse<TipLink, any>>

  • summary Create a new Tip Link

    Parameters

    • OptionaltipLinkCreateDeets: TipLinkCreateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TipLink, any>>

    Throws

    memberof TipLinksApi

tipLinksGET

  • tipLinksGET(id, userId?, options?): Promise<AxiosResponse<TipLink, any>>

  • summary Get data for a single Tip Link by id

    Parameters

    • id: string

      The id of the record you wish to retrieve

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TipLink, any>>

    Throws

    memberof TipLinksApi

tipLinksLIST

  • tipLinksLIST(limit?, page?, userId?, options?): Promise<AxiosResponse<TipLinkListResponse, any>>

  • summary Get data for all Tip Links

    Parameters

    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TipLinkListResponse, any>>

    Throws

    memberof TipLinksApi

tipLinksSearch

  • tipLinksSearch(contractId?, limit?, page?, userId?, options?): Promise<AxiosResponse<TipLinkListResponse, any>>

  • Search tip links based on contract id Returns a list of TipLink.

    summary Search tip links

    Parameters

    • OptionalcontractId: string

      The search for contract Id

    • Optionallimit: number

      A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

    • Optionalpage: number

      1-based page index for paginated results

    • OptionaluserId: string

      The user id to operate on their behalf (tenants only)

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TipLinkListResponse, any>>

    Throws

    memberof TipLinksApi

tipLinksUpdate

  • tipLinksUpdate(id, tipLinkUpdateDeets?, options?): Promise<AxiosResponse<TipLink, any>>

  • summary Make changes to an existing Tip Link

    Parameters

    • id: string
    • OptionaltipLinkUpdateDeets: TipLinkUpdateDeets
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<TipLink, any>>

    Throws

    memberof TipLinksApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods