@augno/sdk 0.17.0 → 0.18.1

package/resources/sales/order-discounts/order-discounts.d.mts

@@ -0,0 +1,365 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { ActionFindByCodeParams, Actions, FindOrderDiscountByCodeRequest } from "./actions.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * List and manage order discounts.
+ */
+export declare class OrderDiscounts extends APIResource {
+    actions: ActionsAPI.Actions;
+    /**
+     * Returns a paginated list of the order discounts defined for the current account,
+     * newest first.
+     *
+     * Pass `q` to narrow the list to discounts whose name or code contains the search
+     * text.
+     *
+     * This endpoint requires the permissions: `discounts:read`, `customers:read`,
+     * `suppliers:read`.
+     *
+     * @example
+     * ```ts
+     * const listOrderDiscount =
+     *   await client.sales.orderDiscounts.list();
+     * ```
+     */
+    list(query?: OrderDiscountListParams | null | undefined, options?: RequestOptions): APIPromise<ListOrderDiscount>;
+    /**
+     * Returns an order discount by ID.
+     *
+     * This endpoint requires the permission: `discounts:read`.
+     *
+     * @example
+     * ```ts
+     * const orderDiscount =
+     *   await client.sales.orderDiscounts.retrieve(
+     *     'ords_qnbrjvq5ih2q',
+     *   );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<OrderDiscount>;
+    /**
+     * Creates an order discount that buyers can then redeem on a sales order by its
+     * code.
+     *
+     * The code must be unique within your account; reusing a code that another
+     * discount already holds returns a conflict error. Creating the discount does not
+     * apply it to anything — a discount only affects an order once that order
+     * references it.
+     *
+     * This endpoint requires the permission: `discounts:create`.
+     *
+     * @example
+     * ```ts
+     * const orderDiscount =
+     *   await client.sales.orderDiscounts.create({
+     *     code: 'SAVE10',
+     *     discount_type: 'percentage',
+     *     name: '10% Off',
+     *     percentage: '0.1',
+     *   });
+     * ```
+     */
+    create(body: OrderDiscountCreateParams, options?: RequestOptions): APIPromise<OrderDiscount>;
+    /**
+     * Partially updates an order discount.
+     *
+     * Only the fields you send are changed; the rest keep their current values.
+     * Changing `code` to one another discount already holds returns a conflict error.
+     * Edits apply to future orders only — orders that already used this discount keep
+     * the reduction they were given.
+     *
+     * This endpoint requires the permission: `discounts:update`.
+     *
+     * @example
+     * ```ts
+     * const orderDiscount =
+     *   await client.sales.orderDiscounts.update(
+     *     'ords_qnbrjvq5ih2q',
+     *     { code: 'SAVE15', name: '15% Off' },
+     *   );
+     * ```
+     */
+    update(id: string, body?: OrderDiscountUpdateParams | null | undefined, options?: RequestOptions): APIPromise<OrderDiscount>;
+    /**
+     * Deletes an order discount and returns it as it was just before deletion.
+     *
+     * Deletion is permanent; further requests against the deleted ID return an error.
+     *
+     * The code can no longer be redeemed, but sales orders that already used the
+     * discount keep the reduction that was applied to them; their totals are not
+     * recalculated.
+     *
+     * This endpoint requires the permission: `discounts:delete`.
+     *
+     * @example
+     * ```ts
+     * const orderDiscount =
+     *   await client.sales.orderDiscounts.delete(
+     *     'ords_qnbrjvq5ih2q',
+     *   );
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<OrderDiscount>;
+}
+/**
+ * Request to create an order discount.
+ */
+export interface CreateOrderDiscountRequest {
+    /**
+     * The code a buyer enters to apply this discount to an order.
+     *
+     * Codes are unique within your account and are compared without regard to letter
+     * case, so `SAVE10` collides with `save10`.
+     */
+    code: string;
+    /**
+     * How the discount is calculated.
+     *
+     * - `percentage`: the order total is reduced by the fraction in `percentage`.
+     * - `amount`: the order total is reduced by the flat amount in `amount`.
+     */
+    discount_type: 'percentage' | 'amount';
+    /**
+     * Display name of the discount.
+     */
+    name: string;
+    /**
+     * The flat amount to take off the order total, as a decimal string.
+     *
+     * Only read when `discount_type` is `amount`. Leaving it out stores `0`, which
+     * produces a discount that takes nothing off.
+     */
+    amount?: string;
+    /**
+     * The fraction of the order total to take off, as a decimal string.
+     *
+     * This is a multiplier, not a whole percent: send `0.1` to take 10% off. Only read
+     * when `discount_type` is `percentage`. Leaving it out stores `0`, which produces
+     * a discount that takes nothing off.
+     */
+    percentage?: string;
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListOrderDiscount {
+    /**
+     * Resources in this page.
+     */
+    data: Array<OrderDiscount>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo describes where the current page sits within a paginated result set and
+     * how to move to the adjacent pages.
+     *
+     * Page a list by following the URLs below rather than assembling cursors yourself.
+     * For a top-level list endpoint the URL repeats the original request's query
+     * string with only the cursor swapped, so following it preserves the same filters,
+     * search term, and page size.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * A discount code that can be applied to a sales order.
+ *
+ * An order discount reduces the order total by either a percentage or a fixed
+ * amount, depending on `discount_type`. The reduction is capped at the order total
+ * and rounded to the nearest cent.
+ */
+export interface OrderDiscount {
+    /**
+     * Order discount ID.
+     */
+    id: string;
+    /**
+     * The flat amount taken off the order total, as a decimal string.
+     *
+     * Only read when `discount_type` is `amount`.
+     */
+    amount: string;
+    /**
+     * The code a buyer enters to apply this discount to an order.
+     *
+     * Codes are unique within your account and are matched without regard to letter
+     * case.
+     */
+    code: string;
+    /**
+     * Creation timestamp.
+     */
+    created_at: string;
+    /**
+     * How the discount is calculated.
+     *
+     * - `percentage`: the order total is reduced by the fraction in `percentage`.
+     * - `amount`: the order total is reduced by the flat amount in `amount`.
+     */
+    discount_type: 'percentage' | 'amount';
+    /**
+     * Display name of the discount.
+     */
+    name: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'order_discount';
+    /**
+     * How many sales orders this discount has been applied to, across all buyers.
+     */
+    order_count: number;
+    /**
+     * The fraction of the order total taken off, as a decimal string.
+     *
+     * This is a multiplier, not a whole percent: `0.1` takes 10% off. Only read when
+     * `discount_type` is `percentage`.
+     */
+    percentage: string;
+    /**
+     * Last updated timestamp.
+     */
+    updated_at: string;
+}
+/**
+ * Request to partially update an order discount.
+ */
+export interface UpdateOrderDiscountRequest {
+    /**
+     * The flat amount to take off the order total, as a decimal string.
+     *
+     * Only read when `discount_type` is `amount`.
+     */
+    amount?: string;
+    /**
+     * The code a buyer enters to apply this discount to an order.
+     *
+     * Codes are unique within your account and are compared without regard to letter
+     * case.
+     */
+    code?: string;
+    /**
+     * How the discount is calculated.
+     *
+     * - `percentage`: the order total is reduced by the fraction in `percentage`.
+     * - `amount`: the order total is reduced by the flat amount in `amount`.
+     *
+     * Switching the type does not move the stored figure across, so send the matching
+     * `percentage` or `amount` in the same request or the discount will take nothing
+     * off.
+     */
+    discount_type?: 'percentage' | 'amount';
+    /**
+     * Display name of the discount.
+     */
+    name?: string;
+    /**
+     * The fraction of the order total to take off, as a decimal string.
+     *
+     * This is a multiplier, not a whole percent: send `0.1` to take 10% off. Only read
+     * when `discount_type` is `percentage`.
+     */
+    percentage?: string;
+}
+export interface OrderDiscountListParams {
+    /**
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
+     */
+    cursor?: string;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+}
+export interface OrderDiscountCreateParams {
+    /**
+     * The code a buyer enters to apply this discount to an order.
+     *
+     * Codes are unique within your account and are compared without regard to letter
+     * case, so `SAVE10` collides with `save10`.
+     */
+    code: string;
+    /**
+     * How the discount is calculated.
+     *
+     * - `percentage`: the order total is reduced by the fraction in `percentage`.
+     * - `amount`: the order total is reduced by the flat amount in `amount`.
+     */
+    discount_type: 'percentage' | 'amount';
+    /**
+     * Display name of the discount.
+     */
+    name: string;
+    /**
+     * The flat amount to take off the order total, as a decimal string.
+     *
+     * Only read when `discount_type` is `amount`. Leaving it out stores `0`, which
+     * produces a discount that takes nothing off.
+     */
+    amount?: string;
+    /**
+     * The fraction of the order total to take off, as a decimal string.
+     *
+     * This is a multiplier, not a whole percent: send `0.1` to take 10% off. Only read
+     * when `discount_type` is `percentage`. Leaving it out stores `0`, which produces
+     * a discount that takes nothing off.
+     */
+    percentage?: string;
+}
+export interface OrderDiscountUpdateParams {
+    /**
+     * The flat amount to take off the order total, as a decimal string.
+     *
+     * Only read when `discount_type` is `amount`.
+     */
+    amount?: string;
+    /**
+     * The code a buyer enters to apply this discount to an order.
+     *
+     * Codes are unique within your account and are compared without regard to letter
+     * case.
+     */
+    code?: string;
+    /**
+     * How the discount is calculated.
+     *
+     * - `percentage`: the order total is reduced by the fraction in `percentage`.
+     * - `amount`: the order total is reduced by the flat amount in `amount`.
+     *
+     * Switching the type does not move the stored figure across, so send the matching
+     * `percentage` or `amount` in the same request or the discount will take nothing
+     * off.
+     */
+    discount_type?: 'percentage' | 'amount';
+    /**
+     * Display name of the discount.
+     */
+    name?: string;
+    /**
+     * The fraction of the order total to take off, as a decimal string.
+     *
+     * This is a multiplier, not a whole percent: send `0.1` to take 10% off. Only read
+     * when `discount_type` is `percentage`.
+     */
+    percentage?: string;
+}
+export declare namespace OrderDiscounts {
+    export { type CreateOrderDiscountRequest as CreateOrderDiscountRequest, type ListOrderDiscount as ListOrderDiscount, type OrderDiscount as OrderDiscount, type UpdateOrderDiscountRequest as UpdateOrderDiscountRequest, type OrderDiscountListParams as OrderDiscountListParams, type OrderDiscountCreateParams as OrderDiscountCreateParams, type OrderDiscountUpdateParams as OrderDiscountUpdateParams, };
+    export { Actions as Actions, type FindOrderDiscountByCodeRequest as FindOrderDiscountByCodeRequest, type ActionFindByCodeParams as ActionFindByCodeParams, };
+}
+//# sourceMappingURL=order-discounts.d.mts.map

package/resources/sales/order-discounts/order-discounts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-discounts.d.mts","sourceRoot":"","sources":["../../../src/resources/sales/order-discounts/order-discounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,KAAK,UAAU;OACf,EAAE,sBAAsB,EAAE,OAAO,EAAE,8BAA8B,EAAE;OACnE,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;IAC7C,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIzE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5F;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,aAAa,CAAC;IAI5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;CAGxE;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,aAAa,EAAE,YAAY,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,aAAa,EAAE,YAAY,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,aAAa,EAAE,YAAY,GAAG,QAAQ,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}