Function TipLinksApiFactory

TipLinksApi - factory interface export

  • TipLinksApiFactory(configuration?, basePath?, axios?): {
        tipLinkImage(image?: File, options?: RawAxiosRequestConfig): AxiosPromise<TipLinksImage>;
        tipLinksCREATE(tipLinkCreateDeets?: TipLinkCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<TipLink>;
        tipLinksGET(id: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<TipLink>;
        tipLinksLIST(limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<TipLinkListResponse>;
        tipLinksSearch(contractId?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<TipLinkListResponse>;
        tipLinksUpdate(id: string, tipLinkUpdateDeets?: TipLinkUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<TipLink>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        tipLinkImage(image?: File, options?: RawAxiosRequestConfig): AxiosPromise<TipLinksImage>;
        tipLinksCREATE(tipLinkCreateDeets?: TipLinkCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<TipLink>;
        tipLinksGET(id: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<TipLink>;
        tipLinksLIST(limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<TipLinkListResponse>;
        tipLinksSearch(contractId?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<TipLinkListResponse>;
        tipLinksUpdate(id: string, tipLinkUpdateDeets?: TipLinkUpdateDeets, options?: RawAxiosRequestConfig): AxiosPromise<TipLink>;
    }

    • tipLinkImage:function
      • tipLinkImage(image?, options?): AxiosPromise<TipLinksImage>

      • summary Upload image

        Parameters

        • Optionalimage: File
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<TipLinksImage>

        Throws

    • tipLinksCREATE:function
      • tipLinksCREATE(tipLinkCreateDeets?, options?): AxiosPromise<TipLink>

      • summary Create a new Tip Link

        Parameters

        • OptionaltipLinkCreateDeets: TipLinkCreateDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<TipLink>

        Throws

    • tipLinksGET:function
      • tipLinksGET(id, userId?, options?): AxiosPromise<TipLink>

      • 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 AxiosPromise<TipLink>

        Throws

    • tipLinksLIST:function
      • tipLinksLIST(limit?, page?, userId?, options?): AxiosPromise<TipLinkListResponse>

      • 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 AxiosPromise<TipLinkListResponse>

        Throws

    • tipLinksSearch:function
      • tipLinksSearch(contractId?, limit?, page?, userId?, options?): AxiosPromise<TipLinkListResponse>

      • 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 AxiosPromise<TipLinkListResponse>

        Throws

    • tipLinksUpdate:function
      • tipLinksUpdate(id, tipLinkUpdateDeets?, options?): AxiosPromise<TipLink>

      • summary Make changes to an existing Tip Link

        Parameters

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

          Override http request option.

        Returns AxiosPromise<TipLink>

        Throws

Settings

Member Visibility