Function TipLinksApiAxiosParamCreator

TipLinksApi - axios parameter creator export

  • TipLinksApiAxiosParamCreator(configuration?): {
        tipLinkImage: ((image?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        tipLinksCREATE: ((tipLinkCreateDeets?: TipLinkCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        tipLinksGET: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        tipLinksLIST: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        tipLinksSearch: ((contractId?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        tipLinksUpdate: ((id: string, tipLinkUpdateDeets?: TipLinkUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

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

    • tipLinkImage: ((image?: File, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Upload image

      Throws

        • (image?, options?): Promise<RequestArgs>

        • Parameters

          • Optionalimage: File
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • tipLinksCREATE: ((tipLinkCreateDeets?: TipLinkCreateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Create a new Tip Link

      Throws

        • (tipLinkCreateDeets?, options?): Promise<RequestArgs>

        • Parameters

          • OptionaltipLinkCreateDeets: TipLinkCreateDeets
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • tipLinksGET: ((id: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Get data for a single Tip Link by id

      Throws

        • (id, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • tipLinksLIST: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Get data for all Tip Links

      Throws

        • (limit?, page?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • tipLinksSearch: ((contractId?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      summary Search tip links

      Throws

        • (contractId?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • tipLinksUpdate: ((id: string, tipLinkUpdateDeets?: TipLinkUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Make changes to an existing Tip Link

      Throws

        • (id, tipLinkUpdateDeets?, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • OptionaltipLinkUpdateDeets: TipLinkUpdateDeets
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility