Function PricingTemplatesApiFp

  • PricingTemplatesApi - functional programming interface

    Export

    Parameters

    Returns {
        getPricingTemplate(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<PricingTemplate>)>;
        listPricingTemplates(tilled_account, type?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListPricingTemplates200Response>)>;
    }

    • getPricingTemplate:function
      • Retrieves the details of an existing Pricing Template.

        Summary

        Get a Pricing Template

        Throws

        Parameters

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<PricingTemplate>)>

    • listPricingTemplates:function
      • Returns a list of Pricing Templates. The Pricing Templates are sorted with the most recently created appearing first.

        Summary

        List all Pricing Templates

        Throws

        Parameters

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • Optional type: ListPricingTemplatesType

          String indicating the type to filter the result by.

        • Optional offset: number

          The (zero-based) offset of the first item in the collection to return.

        • Optional limit: number

          The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<ListPricingTemplates200Response>)>

Generated using TypeDoc