@revenexx/node 0.1.1 → 0.2.0

package/dist/services/promotions-evaluation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/services/promotions-evaluation.ts"],"names":[],"mappings":";AAAA,SAAS,yBAA+D;AAIjE,IAAM,uBAAN,MAA2B;AAAA,EAG9B,YAAY,QAAgB;AACxB,SAAK,SAAS;AAAA,EAClB;AAAA,EA2CA,8BACI,kBACG,MACQ;AACX,QAAI;AAEJ,QAAK,iBAAiB,OAAO,kBAAkB,YAAY,CAAC,MAAM,QAAQ,aAAa,GAAI;AACvF,eAAU,iBAAiB,CAAC;AAAA,IAChC,OAAO;AACH,eAAS;AAAA,QACL,UAAU;AAAA,QACV,SAAS,KAAK,CAAC;AAAA,QACf,WAAW,KAAK,CAAC;AAAA,QACjB,WAAW,KAAK,CAAC;AAAA,QACjB,OAAO,KAAK,CAAC;AAAA,QACb,QAAQ,KAAK,CAAC;AAAA,QACd,gBAAgB,KAAK,CAAC;AAAA,QACtB,YAAY,KAAK,CAAC;AAAA,QAClB,WAAW,KAAK,CAAC;AAAA,QACjB,UAAU,KAAK,CAAC;AAAA,QAChB,UAAU,KAAK,CAAC;AAAA,QAChB,UAAU,KAAK,EAAE;AAAA,QACjB,aAAa,KAAK,EAAE;AAAA,MACxB;AAAA,IACJ;AAEA,UAAM,WAAW,OAAO;AACxB,UAAM,UAAU,OAAO;AACvB,UAAM,YAAY,OAAO;AACzB,UAAM,YAAY,OAAO;AACzB,UAAM,QAAQ,OAAO;AACrB,UAAM,SAAS,OAAO;AACtB,UAAM,iBAAiB,OAAO;AAC9B,UAAM,aAAa,OAAO;AAC1B,UAAM,YAAY,OAAO;AACzB,UAAM,WAAW,OAAO;AACxB,UAAM,WAAW,OAAO;AACxB,UAAM,WAAW,OAAO;AACxB,UAAM,cAAc,OAAO;AAE3B,QAAI,OAAO,aAAa,aAAa;AACjC,YAAM,IAAI,kBAAkB,wCAAwC;AAAA,IACxE;AAEA,UAAM,UAAU;AAChB,UAAM,aAAsB,CAAC;AAC7B,QAAI,OAAO,YAAY,aAAa;AAChC,iBAAW,SAAS,IAAI;AAAA,IAC5B;AACA,QAAI,OAAO,cAAc,aAAa;AAClC,iBAAW,YAAY,IAAI;AAAA,IAC/B;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,iBAAW,UAAU,IAAI;AAAA,IAC7B;AACA,QAAI,OAAO,cAAc,aAAa;AAClC,iBAAW,YAAY,IAAI;AAAA,IAC/B;AACA,QAAI,OAAO,UAAU,aAAa;AAC9B,iBAAW,OAAO,IAAI;AAAA,IAC1B;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,iBAAW,QAAQ,IAAI;AAAA,IAC3B;AACA,QAAI,OAAO,mBAAmB,aAAa;AACvC,iBAAW,iBAAiB,IAAI;AAAA,IACpC;AACA,QAAI,OAAO,eAAe,aAAa;AACnC,iBAAW,aAAa,IAAI;AAAA,IAChC;AACA,QAAI,OAAO,cAAc,aAAa;AAClC,iBAAW,WAAW,IAAI;AAAA,IAC9B;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,iBAAW,UAAU,IAAI;AAAA,IAC7B;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,iBAAW,UAAU,IAAI;AAAA,IAC7B;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,iBAAW,UAAU,IAAI;AAAA,IAC7B;AACA,QAAI,OAAO,gBAAgB,aAAa;AACpC,iBAAW,cAAc,IAAI;AAAA,IACjC;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,KAAK,OAAO;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA,EAqBA,8BACI,kBACG,MACQ;AACX,QAAI;AAEJ,QAAK,iBAAiB,OAAO,kBAAkB,YAAY,CAAC,MAAM,QAAQ,aAAa,GAAI;AACvF,eAAU,iBAAiB,CAAC;AAAA,IAChC,OAAO;AACH,eAAS;AAAA,QACL,MAAM;AAAA,QACN,WAAW,KAAK,CAAC;AAAA,MACrB;AAAA,IACJ;AAEA,UAAM,OAAO,OAAO;AACpB,UAAM,YAAY,OAAO;AAEzB,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AAEA,UAAM,UAAU;AAChB,UAAM,aAAsB,CAAC;AAC7B,QAAI,OAAO,SAAS,aAAa;AAC7B,iBAAW,MAAM,IAAI;AAAA,IACzB;AACA,QAAI,OAAO,cAAc,aAAa;AAClC,iBAAW,YAAY,IAAI;AAAA,IAC/B;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,KAAK,OAAO;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA,EA+CA,6BACI,kBACG,MACQ;AACX,QAAI;AAEJ,QAAK,iBAAiB,OAAO,kBAAkB,YAAY,CAAC,MAAM,QAAQ,aAAa,GAAI;AACvF,eAAU,iBAAiB,CAAC;AAAA,IAChC,OAAO;AACH,eAAS;AAAA,QACL,UAAU;AAAA,QACV,SAAS,KAAK,CAAC;AAAA,QACf,OAAO,KAAK,CAAC;AAAA,QACb,WAAW,KAAK,CAAC;AAAA,QACjB,WAAW,KAAK,CAAC;AAAA,QACjB,OAAO,KAAK,CAAC;AAAA,QACb,QAAQ,KAAK,CAAC;AAAA,QACd,gBAAgB,KAAK,CAAC;AAAA,QACtB,YAAY,KAAK,CAAC;AAAA,QAClB,WAAW,KAAK,CAAC;AAAA,QACjB,qBAAqB,KAAK,CAAC;AAAA,QAC3B,UAAU,KAAK,EAAE;AAAA,QACjB,UAAU,KAAK,EAAE;AAAA,QACjB,UAAU,KAAK,EAAE;AAAA,QACjB,aAAa,KAAK,EAAE;AAAA,MACxB;AAAA,IACJ;AAEA,UAAM,WAAW,OAAO;AACxB,UAAM,UAAU,OAAO;AACvB,UAAM,QAAQ,OAAO;AACrB,UAAM,YAAY,OAAO;AACzB,UAAM,YAAY,OAAO;AACzB,UAAM,QAAQ,OAAO;AACrB,UAAM,SAAS,OAAO;AACtB,UAAM,iBAAiB,OAAO;AAC9B,UAAM,aAAa,OAAO;AAC1B,UAAM,YAAY,OAAO;AACzB,UAAM,sBAAsB,OAAO;AACnC,UAAM,WAAW,OAAO;AACxB,UAAM,WAAW,OAAO;AACxB,UAAM,WAAW,OAAO;AACxB,UAAM,cAAc,OAAO;AAE3B,QAAI,OAAO,aAAa,aAAa;AACjC,YAAM,IAAI,kBAAkB,wCAAwC;AAAA,IACxE;AAEA,UAAM,UAAU;AAChB,UAAM,aAAsB,CAAC;AAC7B,QAAI,OAAO,YAAY,aAAa;AAChC,iBAAW,SAAS,IAAI;AAAA,IAC5B;AACA,QAAI,OAAO,UAAU,aAAa;AAC9B,iBAAW,OAAO,IAAI;AAAA,IAC1B;AACA,QAAI,OAAO,cAAc,aAAa;AAClC,iBAAW,YAAY,IAAI;AAAA,IAC/B;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,iBAAW,UAAU,IAAI;AAAA,IAC7B;AACA,QAAI,OAAO,cAAc,aAAa;AAClC,iBAAW,YAAY,IAAI;AAAA,IAC/B;AACA,QAAI,OAAO,UAAU,aAAa;AAC9B,iBAAW,OAAO,IAAI;AAAA,IAC1B;AACA,QAAI,OAAO,WAAW,aAAa;AAC/B,iBAAW,QAAQ,IAAI;AAAA,IAC3B;AACA,QAAI,OAAO,mBAAmB,aAAa;AACvC,iBAAW,iBAAiB,IAAI;AAAA,IACpC;AACA,QAAI,OAAO,eAAe,aAAa;AACnC,iBAAW,aAAa,IAAI;AAAA,IAChC;AACA,QAAI,OAAO,cAAc,aAAa;AAClC,iBAAW,WAAW,IAAI;AAAA,IAC9B;AACA,QAAI,OAAO,wBAAwB,aAAa;AAC5C,iBAAW,uBAAuB,IAAI;AAAA,IAC1C;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,iBAAW,UAAU,IAAI;AAAA,IAC7B;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,iBAAW,UAAU,IAAI;AAAA,IAC7B;AACA,QAAI,OAAO,aAAa,aAAa;AACjC,iBAAW,UAAU,IAAI;AAAA,IAC7B;AACA,QAAI,OAAO,gBAAgB,aAAa;AACpC,iBAAW,cAAc,IAAI;AAAA,IACjC;AACA,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C;AAAA,MAC7C,gBAAgB;AAAA,IACpB;AAEA,WAAO,KAAK,OAAO;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,mCAAgD;AAE5C,UAAM,UAAU;AAChB,UAAM,aAAsB,CAAC;AAC7B,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C,CACjD;AAEA,WAAO,KAAK,OAAO;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AAAA,EAiBA,+BACI,eACW;AACX,QAAI;AAEJ,QAAK,iBAAiB,OAAO,kBAAkB,YAAY,CAAC,MAAM,QAAQ,aAAa,GAAI;AACvF,eAAU,iBAAiB,CAAC;AAAA,IAChC,OAAO;AACH,eAAS;AAAA,QACL,MAAM;AAAA,MACV;AAAA,IACJ;AAEA,UAAM,OAAO,OAAO;AAEpB,QAAI,OAAO,SAAS,aAAa;AAC7B,YAAM,IAAI,kBAAkB,oCAAoC;AAAA,IACpE;AAEA,UAAM,UAAU,qCAAqC,QAAQ,UAAU,IAAI;AAC3E,UAAM,aAAsB,CAAC;AAC7B,UAAM,MAAM,IAAI,IAAI,KAAK,OAAO,OAAO,WAAW,OAAO;AAEzD,UAAM,aAA2C,CACjD;AAEA,WAAO,KAAK,OAAO;AAAA,MACf;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACJ;AAAA,EACJ;AACJ","sourcesContent":["import { RevenexxException, Client, type Payload, UploadProgress } from '../client';\nimport type { Models } from '../models';\n\n\nexport class PromotionsEvaluation {\n    client: Client;\n\n    constructor(client: Client) {\n        this.client = client;\n    }\n\n    /**\n     * A different question from what a cart is owed: a shop that can only answer the second can only tell a buyer about a discount after they have earned it. With a cart, each promotion states how far away it is — \"12 euro more\" is the sentence that raises an order value. A promotion needing a code is listed as needing one, and no code appears in the answer.\n     *\n     * @param {string} params.currency - The three-letter currency the cart is stated in. A promotion in another currency is skipped rather than converted.\n     * @param {string} params.channel - The sales channel.\n     * @param {string} params.contactId - The person buying.\n     * @param {number} params.itemCount - Units in the cart, for a quantity condition. Derived from the lines when absent.\n     * @param {Models.PricedCartLine[]} params.lines - The priced cart lines. At most 500.\n     * @param {string} params.market - The market the call is for. Also taken from the x-revenexx-market header.\n     * @param {string} params.organizationId - The company they buy for.\n     * @param {number} params.paymentFee - The payment fee, so an effect can reduce it.\n     * @param {number} params.precision - Decimals every derived amount is rounded to. Follows the tenant price policy.\n     * @param {string} params.rounding - How a fraction of a cent is rounded: half_up, half_even, up or down.\n     * @param {number} params.shipping - The freight cost, so an effect can reduce it.\n     * @param {number} params.subtotal - The goods value before any promotion. Derived from the lines when absent.\n     * @param {boolean} params.taxIncluded - Whether the prices are gross. A net discount subtracted from a gross line is wrong by exactly the tax rate.\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     */\n    promotionsEvaluationAvailable(params: { currency: string, channel?: string, contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean }): Promise<{}>;\n    /**\n     * A different question from what a cart is owed: a shop that can only answer the second can only tell a buyer about a discount after they have earned it. With a cart, each promotion states how far away it is — \"12 euro more\" is the sentence that raises an order value. A promotion needing a code is listed as needing one, and no code appears in the answer.\n     *\n     * @param {string} currency - The three-letter currency the cart is stated in. A promotion in another currency is skipped rather than converted.\n     * @param {string} channel - The sales channel.\n     * @param {string} contactId - The person buying.\n     * @param {number} itemCount - Units in the cart, for a quantity condition. Derived from the lines when absent.\n     * @param {Models.PricedCartLine[]} lines - The priced cart lines. At most 500.\n     * @param {string} market - The market the call is for. Also taken from the x-revenexx-market header.\n     * @param {string} organizationId - The company they buy for.\n     * @param {number} paymentFee - The payment fee, so an effect can reduce it.\n     * @param {number} precision - Decimals every derived amount is rounded to. Follows the tenant price policy.\n     * @param {string} rounding - How a fraction of a cent is rounded: half_up, half_even, up or down.\n     * @param {number} shipping - The freight cost, so an effect can reduce it.\n     * @param {number} subtotal - The goods value before any promotion. Derived from the lines when absent.\n     * @param {boolean} taxIncluded - Whether the prices are gross. A net discount subtracted from a gross line is wrong by exactly the tax rate.\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     * @deprecated Use the object parameter style method for a better developer experience.\n     */\n    promotionsEvaluationAvailable(currency: string, channel?: string, contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean): Promise<{}>;\n    promotionsEvaluationAvailable(\n        paramsOrFirst: { currency: string, channel?: string, contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean } | string,\n        ...rest: [(string)?, (string)?, (number)?, (Models.PricedCartLine[])?, (string)?, (string)?, (number)?, (number)?, (string)?, (number)?, (number)?, (boolean)?]    \n    ): Promise<{}> {\n        let params: { currency: string, channel?: string, contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean };\n        \n        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {\n            params = (paramsOrFirst || {}) as { currency: string, channel?: string, contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean };\n        } else {\n            params = {\n                currency: paramsOrFirst as string,\n                channel: rest[0] as string,\n                contactId: rest[1] as string,\n                itemCount: rest[2] as number,\n                lines: rest[3] as Models.PricedCartLine[],\n                market: rest[4] as string,\n                organizationId: rest[5] as string,\n                paymentFee: rest[6] as number,\n                precision: rest[7] as number,\n                rounding: rest[8] as string,\n                shipping: rest[9] as number,\n                subtotal: rest[10] as number,\n                taxIncluded: rest[11] as boolean            \n            };\n        }\n        \n        const currency = params.currency;\n        const channel = params.channel;\n        const contactId = params.contactId;\n        const itemCount = params.itemCount;\n        const lines = params.lines;\n        const market = params.market;\n        const organizationId = params.organizationId;\n        const paymentFee = params.paymentFee;\n        const precision = params.precision;\n        const rounding = params.rounding;\n        const shipping = params.shipping;\n        const subtotal = params.subtotal;\n        const taxIncluded = params.taxIncluded;\n\n        if (typeof currency === 'undefined') {\n            throw new RevenexxException('Missing required parameter: \"currency\"');\n        }\n\n        const apiPath = '/v1/promotions/available';\n        const apiPayload: Payload = {};\n        if (typeof channel !== 'undefined') {\n            apiPayload['channel'] = channel;\n        }\n        if (typeof contactId !== 'undefined') {\n            apiPayload['contact_id'] = contactId;\n        }\n        if (typeof currency !== 'undefined') {\n            apiPayload['currency'] = currency;\n        }\n        if (typeof itemCount !== 'undefined') {\n            apiPayload['item_count'] = itemCount;\n        }\n        if (typeof lines !== 'undefined') {\n            apiPayload['lines'] = lines;\n        }\n        if (typeof market !== 'undefined') {\n            apiPayload['market'] = market;\n        }\n        if (typeof organizationId !== 'undefined') {\n            apiPayload['organization_id'] = organizationId;\n        }\n        if (typeof paymentFee !== 'undefined') {\n            apiPayload['payment_fee'] = paymentFee;\n        }\n        if (typeof precision !== 'undefined') {\n            apiPayload['precision'] = precision;\n        }\n        if (typeof rounding !== 'undefined') {\n            apiPayload['rounding'] = rounding;\n        }\n        if (typeof shipping !== 'undefined') {\n            apiPayload['shipping'] = shipping;\n        }\n        if (typeof subtotal !== 'undefined') {\n            apiPayload['subtotal'] = subtotal;\n        }\n        if (typeof taxIncluded !== 'undefined') {\n            apiPayload['tax_included'] = taxIncluded;\n        }\n        const uri = new URL(this.client.config.endpoint + apiPath);\n\n        const apiHeaders: { [header: string]: string } = {\n            'content-type': 'application/json',\n        }\n\n        return this.client.call(\n            'post',\n            uri,\n            apiHeaders,\n            apiPayload,\n        );\n    }\n\n    /**\n     * A landing page shows an offer before a buyer has added anything, and should not have to invent a cart to find out whether it is still live. The answer never says WHO a code belongs to — the address is reachable by anyone who can guess a code, and one that answered with a customer name would be a data leak with a search box.\n     *\n     * @param {string} params.code - The code to check.\n     * @param {string} params.contactId - Who is asking, so a code held for them is reported as usable.\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     */\n    promotionsEvaluationCheckCode(params: { code: string, contactId?: string }): Promise<{}>;\n    /**\n     * A landing page shows an offer before a buyer has added anything, and should not have to invent a cart to find out whether it is still live. The answer never says WHO a code belongs to — the address is reachable by anyone who can guess a code, and one that answered with a customer name would be a data leak with a search box.\n     *\n     * @param {string} code - The code to check.\n     * @param {string} contactId - Who is asking, so a code held for them is reported as usable.\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     * @deprecated Use the object parameter style method for a better developer experience.\n     */\n    promotionsEvaluationCheckCode(code: string, contactId?: string): Promise<{}>;\n    promotionsEvaluationCheckCode(\n        paramsOrFirst: { code: string, contactId?: string } | string,\n        ...rest: [(string)?]    \n    ): Promise<{}> {\n        let params: { code: string, contactId?: string };\n        \n        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {\n            params = (paramsOrFirst || {}) as { code: string, contactId?: string };\n        } else {\n            params = {\n                code: paramsOrFirst as string,\n                contactId: rest[0] as string            \n            };\n        }\n        \n        const code = params.code;\n        const contactId = params.contactId;\n\n        if (typeof code === 'undefined') {\n            throw new RevenexxException('Missing required parameter: \"code\"');\n        }\n\n        const apiPath = '/v1/promotions/codes/check';\n        const apiPayload: Payload = {};\n        if (typeof code !== 'undefined') {\n            apiPayload['code'] = code;\n        }\n        if (typeof contactId !== 'undefined') {\n            apiPayload['contact_id'] = contactId;\n        }\n        const uri = new URL(this.client.config.endpoint + apiPath);\n\n        const apiHeaders: { [header: string]: string } = {\n            'content-type': 'application/json',\n        }\n\n        return this.client.call(\n            'post',\n            uri,\n            apiHeaders,\n            apiPayload,\n        );\n    }\n\n    /**\n     * THE promotion call, and the designated override point. A priced cart goes in; a list of attributed effects comes out, each naming the promotion behind it and the amount it takes off. It writes nothing, so a storefront may call it on every keystroke, and it prices nothing, so a line with no resolved unit price is refused rather than guessed at. Promotions that matched and lost are named with the reason, unless the tenant switched disclosure off. The answer carries the policy it was computed under, so a discount can be re-derived from its own payload.\n     *\n     * @param {string} params.currency - The three-letter currency the cart is stated in. A promotion in another currency is skipped rather than converted.\n     * @param {string} params.channel - The sales channel.\n     * @param {string[]} params.codes - Codes the buyer entered. Matched trimmed and case-insensitively unless the tenant made codes case-sensitive.\n     * @param {string} params.contactId - The person buying.\n     * @param {number} params.itemCount - Units in the cart, for a quantity condition. Derived from the lines when absent.\n     * @param {Models.PricedCartLine[]} params.lines - The priced cart lines. At most 500.\n     * @param {string} params.market - The market the call is for. Also taken from the x-revenexx-market header.\n     * @param {string} params.organizationId - The company they buy for.\n     * @param {number} params.paymentFee - The payment fee, so an effect can reduce it.\n     * @param {number} params.precision - Decimals every derived amount is rounded to. Follows the tenant price policy.\n     * @param {string[]} params.previewPromotionIds - Promotions to evaluate although they are not live — a merchant testing a drafted offer against a real cart. Nothing about them is changed.\n     * @param {string} params.rounding - How a fraction of a cent is rounded: half_up, half_even, up or down.\n     * @param {number} params.shipping - The freight cost, so an effect can reduce it.\n     * @param {number} params.subtotal - The goods value before any promotion. Derived from the lines when absent.\n     * @param {boolean} params.taxIncluded - Whether the prices are gross. A net discount subtracted from a gross line is wrong by exactly the tax rate.\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     */\n    promotionsEvaluationEvaluate(params: { currency: string, channel?: string, codes?: string[], contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, previewPromotionIds?: string[], rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean }): Promise<{}>;\n    /**\n     * THE promotion call, and the designated override point. A priced cart goes in; a list of attributed effects comes out, each naming the promotion behind it and the amount it takes off. It writes nothing, so a storefront may call it on every keystroke, and it prices nothing, so a line with no resolved unit price is refused rather than guessed at. Promotions that matched and lost are named with the reason, unless the tenant switched disclosure off. The answer carries the policy it was computed under, so a discount can be re-derived from its own payload.\n     *\n     * @param {string} currency - The three-letter currency the cart is stated in. A promotion in another currency is skipped rather than converted.\n     * @param {string} channel - The sales channel.\n     * @param {string[]} codes - Codes the buyer entered. Matched trimmed and case-insensitively unless the tenant made codes case-sensitive.\n     * @param {string} contactId - The person buying.\n     * @param {number} itemCount - Units in the cart, for a quantity condition. Derived from the lines when absent.\n     * @param {Models.PricedCartLine[]} lines - The priced cart lines. At most 500.\n     * @param {string} market - The market the call is for. Also taken from the x-revenexx-market header.\n     * @param {string} organizationId - The company they buy for.\n     * @param {number} paymentFee - The payment fee, so an effect can reduce it.\n     * @param {number} precision - Decimals every derived amount is rounded to. Follows the tenant price policy.\n     * @param {string[]} previewPromotionIds - Promotions to evaluate although they are not live — a merchant testing a drafted offer against a real cart. Nothing about them is changed.\n     * @param {string} rounding - How a fraction of a cent is rounded: half_up, half_even, up or down.\n     * @param {number} shipping - The freight cost, so an effect can reduce it.\n     * @param {number} subtotal - The goods value before any promotion. Derived from the lines when absent.\n     * @param {boolean} taxIncluded - Whether the prices are gross. A net discount subtracted from a gross line is wrong by exactly the tax rate.\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     * @deprecated Use the object parameter style method for a better developer experience.\n     */\n    promotionsEvaluationEvaluate(currency: string, channel?: string, codes?: string[], contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, previewPromotionIds?: string[], rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean): Promise<{}>;\n    promotionsEvaluationEvaluate(\n        paramsOrFirst: { currency: string, channel?: string, codes?: string[], contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, previewPromotionIds?: string[], rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean } | string,\n        ...rest: [(string)?, (string[])?, (string)?, (number)?, (Models.PricedCartLine[])?, (string)?, (string)?, (number)?, (number)?, (string[])?, (string)?, (number)?, (number)?, (boolean)?]    \n    ): Promise<{}> {\n        let params: { currency: string, channel?: string, codes?: string[], contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, previewPromotionIds?: string[], rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean };\n        \n        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {\n            params = (paramsOrFirst || {}) as { currency: string, channel?: string, codes?: string[], contactId?: string, itemCount?: number, lines?: Models.PricedCartLine[], market?: string, organizationId?: string, paymentFee?: number, precision?: number, previewPromotionIds?: string[], rounding?: string, shipping?: number, subtotal?: number, taxIncluded?: boolean };\n        } else {\n            params = {\n                currency: paramsOrFirst as string,\n                channel: rest[0] as string,\n                codes: rest[1] as string[],\n                contactId: rest[2] as string,\n                itemCount: rest[3] as number,\n                lines: rest[4] as Models.PricedCartLine[],\n                market: rest[5] as string,\n                organizationId: rest[6] as string,\n                paymentFee: rest[7] as number,\n                precision: rest[8] as number,\n                previewPromotionIds: rest[9] as string[],\n                rounding: rest[10] as string,\n                shipping: rest[11] as number,\n                subtotal: rest[12] as number,\n                taxIncluded: rest[13] as boolean            \n            };\n        }\n        \n        const currency = params.currency;\n        const channel = params.channel;\n        const codes = params.codes;\n        const contactId = params.contactId;\n        const itemCount = params.itemCount;\n        const lines = params.lines;\n        const market = params.market;\n        const organizationId = params.organizationId;\n        const paymentFee = params.paymentFee;\n        const precision = params.precision;\n        const previewPromotionIds = params.previewPromotionIds;\n        const rounding = params.rounding;\n        const shipping = params.shipping;\n        const subtotal = params.subtotal;\n        const taxIncluded = params.taxIncluded;\n\n        if (typeof currency === 'undefined') {\n            throw new RevenexxException('Missing required parameter: \"currency\"');\n        }\n\n        const apiPath = '/v1/promotions/evaluate';\n        const apiPayload: Payload = {};\n        if (typeof channel !== 'undefined') {\n            apiPayload['channel'] = channel;\n        }\n        if (typeof codes !== 'undefined') {\n            apiPayload['codes'] = codes;\n        }\n        if (typeof contactId !== 'undefined') {\n            apiPayload['contact_id'] = contactId;\n        }\n        if (typeof currency !== 'undefined') {\n            apiPayload['currency'] = currency;\n        }\n        if (typeof itemCount !== 'undefined') {\n            apiPayload['item_count'] = itemCount;\n        }\n        if (typeof lines !== 'undefined') {\n            apiPayload['lines'] = lines;\n        }\n        if (typeof market !== 'undefined') {\n            apiPayload['market'] = market;\n        }\n        if (typeof organizationId !== 'undefined') {\n            apiPayload['organization_id'] = organizationId;\n        }\n        if (typeof paymentFee !== 'undefined') {\n            apiPayload['payment_fee'] = paymentFee;\n        }\n        if (typeof precision !== 'undefined') {\n            apiPayload['precision'] = precision;\n        }\n        if (typeof previewPromotionIds !== 'undefined') {\n            apiPayload['preview_promotion_ids'] = previewPromotionIds;\n        }\n        if (typeof rounding !== 'undefined') {\n            apiPayload['rounding'] = rounding;\n        }\n        if (typeof shipping !== 'undefined') {\n            apiPayload['shipping'] = shipping;\n        }\n        if (typeof subtotal !== 'undefined') {\n            apiPayload['subtotal'] = subtotal;\n        }\n        if (typeof taxIncluded !== 'undefined') {\n            apiPayload['tax_included'] = taxIncluded;\n        }\n        const uri = new URL(this.client.config.endpoint + apiPath);\n\n        const apiHeaders: { [header: string]: string } = {\n            'content-type': 'application/json',\n        }\n\n        return this.client.call(\n            'post',\n            uri,\n            apiHeaders,\n            apiPayload,\n        );\n    }\n\n    /**\n     * The subjects a condition may ask about, the comparisons it may use, the effect kinds and target scopes, the stacking modes, and the closed lists of refusal, skip and release reasons. A caller building a form reads these rather than hardcoding them.\n     *\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     */\n    promotionsEvaluationVocabularies(): Promise<{}> {\n\n        const apiPath = '/v1/promotions/vocabularies';\n        const apiPayload: Payload = {};\n        const uri = new URL(this.client.config.endpoint + apiPath);\n\n        const apiHeaders: { [header: string]: string } = {\n        }\n\n        return this.client.call(\n            'get',\n            uri,\n            apiHeaders,\n            apiPayload,\n        );\n    }\n\n    /**\n     *\n     * @param {string} params.name - The vocabulary name, as the list answers it.\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     */\n    promotionsEvaluationVocabulary(params: { name: string }): Promise<{}>;\n    /**\n     *\n     * @param {string} name - The vocabulary name, as the list answers it.\n     * @throws {RevenexxException}\n     * @returns {Promise<{}>}\n     * @deprecated Use the object parameter style method for a better developer experience.\n     */\n    promotionsEvaluationVocabulary(name: string): Promise<{}>;\n    promotionsEvaluationVocabulary(\n        paramsOrFirst: { name: string } | string    \n    ): Promise<{}> {\n        let params: { name: string };\n        \n        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {\n            params = (paramsOrFirst || {}) as { name: string };\n        } else {\n            params = {\n                name: paramsOrFirst as string            \n            };\n        }\n        \n        const name = params.name;\n\n        if (typeof name === 'undefined') {\n            throw new RevenexxException('Missing required parameter: \"name\"');\n        }\n\n        const apiPath = '/v1/promotions/vocabularies/{name}'.replace('{name}', name);\n        const apiPayload: Payload = {};\n        const uri = new URL(this.client.config.endpoint + apiPath);\n\n        const apiHeaders: { [header: string]: string } = {\n        }\n\n        return this.client.call(\n            'get',\n            uri,\n            apiHeaders,\n            apiPayload,\n        );\n    }\n}\n"]}