import { RequestOptionsFactory } from '@wix/sdk-types'; /** * Previews a tip for a list of line items. * * * If you provide the Wix Bookings app ID `13d21c63-b5ec-5912-8397-c3a5ddb27a97` as `lineItemInfo.catalogReference.appId`, the response includes tip * distributions for each associated Bookings staff member. * * If you don't provide a `tipSettingsId`, the `staffDistributionMethod` is * based on the site's default tip settings. */ export declare function previewTip(payload: object): RequestOptionsFactory; /** * Retrieves the tip that's associated with an * [eCommerce order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup). */ export declare function getTipByOrderId(payload: object): RequestOptionsFactory; /** * Retrieves the tip that's associated with an eCommerce draft order. * * *
* * __Important:__ * The eCommerce Draft Orders API is currently under development and not yet available to users. * *
*/ export declare function getTipByDraftOrderId(payload: object): RequestOptionsFactory; /** * Retrieves the tip choice that's currently selected by the customer for a specific [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup). * If the customer hasn't yet selected a tip choice, the response is empty. */ export declare function getTipChoice(payload: object): RequestOptionsFactory; /** Updates the tip choice that's currently selected by the customer for a specific [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup). */ export declare function updateTipChoice(payload: object): RequestOptionsFactory; /** Updates the tip choice that's currently selected by the customer for a specific [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup). */ export declare function setTipOnOrder(payload: object): RequestOptionsFactory; /** * Removes a tip from an * [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction). * * * If no tip exists on the order, the call succeeds and the response contains an * empty `OrderInfo` object. * * The call fails if the customer has already been charged for at least one of * the associated tip distributions. */ export declare function removeTipFromOrder(payload: object): RequestOptionsFactory; /** * Adds tip distributions to an * [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction). * * * If no tip exists on the order, an `additionalFee` is added and the total tip * amount is equal to the sum of all distribution amounts. If a tip is already * present, the existing `additionalFee` is replaced and the total tip amount is * increased by the sum of the new tip distributions. * * The call fails if: * + The order's `paymentStatus` is either `FULLY_REFUNDED` or `PARTIALLY_REFUNDED`. * + Any of the tip distribution amounts is zero or negative. */ export declare function addTipDistributionsToOrder(payload: object): RequestOptionsFactory; /** * Creates a query to retrieve a list of tip distributions. * * The `queryTipDistributions()` function builds a query to retrieve a list of tip distributions and returns a `TipDistributionsQueryBuilder` object. * * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/ecom/tips/tip-distributions-query-builder/find) function. * * You can refine the query by chaining `TipDistributionsQueryBuilder` functions onto the query. `TipDistributionsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTipDistributions()` returns. * * `queryTipDistributions()` runs with the following `TipDistributionsQueryBuilder` default that you can override: * * + `limit` is `50` * * The functions that are chained to `queryTipDistributions()` are applied in the order they are called. For example, if you apply `ascending("transaction.transactionDate")` and then `ascending("staff.id")`, the results are sorted first by the `"transaction.transactionDate"`, and then, if there are multiple results with the same `"transaction.transactionDate"`, the items are sorted by `"staff.id"`. * * When setting a date filter remember to use * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). * * The following `TipDistributionsQueryBuilder` functions are supported for the `queryTipDistributions()` function. For a full description of the tip distributions object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/ecom/tips/tip-distributions-query-result/items) property in `TipDistributionsQueryResult`. * */ export declare function queryTipDistributions(payload: object): RequestOptionsFactory; /** Sums tip distribution amounts, given the provided filtering. */ export declare function sumTipDistributionAmounts(payload: object): RequestOptionsFactory;