@aimee.shop/sdk 0.0.1

package/dist/services/core/discounts.client.d.ts

@@ -0,0 +1,197 @@
+import type { HttpClientTransport as HttpClient } from '../../core/http-client.js';
+import { BaseResourceClient } from './base-resource.js';
+/**
+ * Discount type enum values (camelCase to match backend naming convention)
+ */
+export type DiscountType = 'percent' | 'fixedAmount' | 'freeShipping' | 'buyXGetY';
+/**
+ * Configuration for Buy X Get Y (BOGO) discount type
+ */
+export interface BogoConfig {
+    /** Number of items customer must buy to qualify */
+    buyQuantity: number;
+    /** Number of items customer receives at discount */
+    getQuantity: number;
+    /** Discount percentage for the "get" items (100 = free, 50 = half off) */
+    getDiscountPercent: number;
+}
+export interface Discount {
+    id: string;
+    tenantId: string;
+    storeId: string;
+    code: string;
+    name: string;
+    description?: string;
+    discountType: DiscountType;
+    discountValue: number;
+    currency?: string;
+    minimumOrderAmount?: number;
+    minimumOrderQuantity?: number;
+    usageLimit?: number;
+    usageLimitPerCustomer?: number;
+    usageCount: number;
+    applicableProducts?: string[];
+    applicableCategories?: string[];
+    applicableVariants?: string[];
+    requiredCustomerTags?: string[];
+    excludedCustomerTags?: string[];
+    startsAt?: string;
+    endsAt?: string;
+    isActive: boolean;
+    isAutoApplied?: boolean;
+    canCombineWithOthers?: boolean;
+    priority?: number;
+    metadata?: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface DiscountCondition {
+    type: 'product' | 'category' | 'customer' | 'minimumQuantity';
+    operator: 'in' | 'notIn' | 'equals' | 'greaterThan';
+    value: string | string[] | number;
+}
+export interface CreateDiscountDto {
+    code: string;
+    name: string;
+    description?: string;
+    discountType: DiscountType;
+    /** Discount value (percentage, fixed amount). Not required for freeShipping or buyXGetY. */
+    discountValue?: number;
+    currency?: string;
+    minimumOrderAmount?: number;
+    minimumOrderQuantity?: number;
+    usageLimit?: number;
+    usageLimitPerCustomer?: number;
+    applicableProducts?: string[];
+    applicableCategories?: string[];
+    applicableVariants?: string[];
+    requiredCustomerTags?: string[];
+    excludedCustomerTags?: string[];
+    startsAt?: string;
+    endsAt?: string;
+    isActive?: boolean;
+    isAutoApplied?: boolean;
+    canCombineWithOthers?: boolean;
+    priority?: number;
+    metadata?: Record<string, unknown>;
+    /** Configuration for Buy X Get Y discounts. Required when discountType is buyXGetY. */
+    bogoConfig?: BogoConfig;
+}
+export interface UpdateDiscountDto {
+    name?: string;
+    description?: string;
+    discountType?: DiscountType;
+    discountValue?: number;
+    currency?: string;
+    minimumOrderAmount?: number;
+    minimumOrderQuantity?: number;
+    usageLimit?: number;
+    usageLimitPerCustomer?: number;
+    applicableProducts?: string[];
+    applicableCategories?: string[];
+    applicableVariants?: string[];
+    requiredCustomerTags?: string[];
+    excludedCustomerTags?: string[];
+    startsAt?: string;
+    endsAt?: string;
+    isActive?: boolean;
+    isAutoApplied?: boolean;
+    canCombineWithOthers?: boolean;
+    priority?: number;
+    metadata?: Record<string, unknown>;
+    bogoConfig?: BogoConfig;
+}
+export interface DiscountFilters extends Record<string, unknown> {
+    isActive?: boolean;
+    discountType?: DiscountType;
+    code?: string;
+}
+export interface DiscountValidation {
+    isValid: boolean;
+    discount?: Discount;
+    error?: string;
+    discountAmount?: number;
+}
+export type DiscountCodeGenerationType = 'random' | 'prefix' | 'custom';
+/** Body for `POST /v1/discounts/bulk-generate` (core-api `BulkGenerateDiscountDto`). */
+export interface BulkGenerateDiscountDto {
+    baseDiscount: Omit<CreateDiscountDto, 'code'>;
+    count: number;
+    generationType: DiscountCodeGenerationType;
+    prefix?: string;
+    codeLength?: number;
+    pattern?: string;
+}
+/** Response from `POST /v1/discounts/bulk-generate`. */
+export interface BulkGenerateDiscountResult {
+    count: number;
+    codes: string[];
+    baseDiscountId: string;
+}
+/**
+ * Discount codes (`/v1/discounts`).
+ *
+ * `list()` `page` is 0-based (server default `page=0`). Most other SDK list
+ * helpers document 1-indexed pages.
+ */
+export declare class DiscountsClient extends BaseResourceClient<Discount, CreateDiscountDto, UpdateDiscountDto, DiscountFilters> {
+    constructor(httpClient: HttpClient, baseUrl: string);
+    /**
+     * Get discount by code
+     */
+    getByCode(code: string): Promise<Discount>;
+    /**
+     * Validate a discount code for a cart
+     */
+    validate(code: string, cartId: string): Promise<DiscountValidation>;
+    /**
+     * Calculate discount amount for a cart
+     */
+    calculate(code: string, cartTotal: number, items?: {
+        productId: string;
+        quantity: number;
+        price: number;
+    }[]): Promise<{
+        discountAmount: number;
+        newTotal: number;
+    }>;
+    /**
+     * Activate a discount
+     */
+    activate(discountId: string): Promise<Discount>;
+    /**
+     * Deactivate a discount
+     */
+    deactivate(discountId: string): Promise<Discount>;
+    /**
+     * Get discount usage statistics
+     */
+    getUsageStats(discountId: string): Promise<{
+        totalUsage: number;
+        totalDiscountAmount: number;
+        uniqueCustomers: number;
+    }>;
+    /**
+     * Generate unique discount codes in bulk (`POST /v1/discounts/bulk-generate`).
+     *
+     * Body matches core-api `BulkGenerateDiscountDto`. Returns
+     * `{ count, codes, baseDiscountId }`, not the created discount rows.
+     *
+     * @example
+     * ```typescript
+     * const { count, codes, baseDiscountId } = await sdk.discounts.generateCodes({
+     *   baseDiscount: {
+     *     name: 'SoClean single-use',
+     *     discountType: 'percent',
+     *     discountValue: 10,
+     *     usageLimit: 1,
+     *   },
+     *   count: 5,
+     *   generationType: 'prefix',
+     *   prefix: 'SOCLEAN',
+     * });
+     * ```
+     */
+    generateCodes(payload: BulkGenerateDiscountDto): Promise<BulkGenerateDiscountResult>;
+}
+//# sourceMappingURL=discounts.client.d.ts.map

package/dist/services/core/discounts.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discounts.client.d.ts","sourceRoot":"","sources":["../../../../../src/services/core/discounts.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,IAAI,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACnF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAIxD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,aAAa,GAAG,cAAc,GAAG,UAAU,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,WAAW,EAAE,MAAM,CAAC;IACpB,0EAA0E;IAC1E,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,iBAAiB,CAAC;IAC9D,QAAQ,EAAE,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAC;IACpD,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,YAAY,CAAC;IAC3B,4FAA4F;IAC5F,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,uFAAuF;IACvF,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,eAAgB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC9D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,0BAA0B,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAExE,wFAAwF;AACxF,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,0BAA0B,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,wDAAwD;AACxD,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;CACxB;AAID;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,kBAAkB,CACrD,QAAQ,EACR,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,CAChB;gBACa,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM;IAInD;;OAEG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhD;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAOzE;;OAEG;IACG,SAAS,CACb,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,GAC/D,OAAO,CAAC;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAQxD;;OAEG;IACG,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIrD;;OAEG;IACG,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIvD;;OAEG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAC/C,UAAU,EAAE,MAAM,CAAC;QACnB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;IAIF;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,aAAa,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAG3F"}

package/dist/services/core/discounts.client.js

@@ -0,0 +1,81 @@
+import { BaseResourceClient } from './base-resource.js';
+// ==================== Client ====================
+/**
+ * Discount codes (`/v1/discounts`).
+ *
+ * `list()` `page` is 0-based (server default `page=0`). Most other SDK list
+ * helpers document 1-indexed pages.
+ */
+export class DiscountsClient extends BaseResourceClient {
+    constructor(httpClient, baseUrl) {
+        super({ httpClient, baseUrl, resourcePath: 'discounts' });
+    }
+    /**
+     * Get discount by code
+     */
+    async getByCode(code) {
+        return this.http.get(`${this.endpoint}/code/${code}`);
+    }
+    /**
+     * Validate a discount code for a cart
+     */
+    async validate(code, cartId) {
+        return this.http.post(`${this.endpoint}/validate`, {
+            code,
+            cartId,
+        });
+    }
+    /**
+     * Calculate discount amount for a cart
+     */
+    async calculate(code, cartTotal, items) {
+        return this.http.post(`${this.endpoint}/calculate`, {
+            code,
+            cartTotal,
+            items,
+        });
+    }
+    /**
+     * Activate a discount
+     */
+    async activate(discountId) {
+        return this.http.post(`${this.endpoint}/${discountId}/activate`, {});
+    }
+    /**
+     * Deactivate a discount
+     */
+    async deactivate(discountId) {
+        return this.http.post(`${this.endpoint}/${discountId}/deactivate`, {});
+    }
+    /**
+     * Get discount usage statistics
+     */
+    async getUsageStats(discountId) {
+        return this.http.get(`${this.endpoint}/${discountId}/stats`);
+    }
+    /**
+     * Generate unique discount codes in bulk (`POST /v1/discounts/bulk-generate`).
+     *
+     * Body matches core-api `BulkGenerateDiscountDto`. Returns
+     * `{ count, codes, baseDiscountId }`, not the created discount rows.
+     *
+     * @example
+     * ```typescript
+     * const { count, codes, baseDiscountId } = await sdk.discounts.generateCodes({
+     *   baseDiscount: {
+     *     name: 'SoClean single-use',
+     *     discountType: 'percent',
+     *     discountValue: 10,
+     *     usageLimit: 1,
+     *   },
+     *   count: 5,
+     *   generationType: 'prefix',
+     *   prefix: 'SOCLEAN',
+     * });
+     * ```
+     */
+    async generateCodes(payload) {
+        return this.http.post(`${this.endpoint}/bulk-generate`, payload);
+    }
+}
+//# sourceMappingURL=discounts.client.js.map

package/dist/services/core/discounts.client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discounts.client.js","sourceRoot":"","sources":["../../../../../src/services/core/discounts.client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AA+IxD,mDAAmD;AAEnD;;;;;GAKG;AACH,MAAM,OAAO,eAAgB,SAAQ,kBAKpC;IACC,YAAY,UAAsB,EAAE,OAAe;QACjD,KAAK,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,IAAY;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAW,GAAG,IAAI,CAAC,QAAQ,SAAS,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,MAAc;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,GAAG,IAAI,CAAC,QAAQ,WAAW,EAAE;YACrE,IAAI;YACJ,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,IAAY,EACZ,SAAiB,EACjB,KAAgE;QAEhE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,YAAY,EAAE;YAClD,IAAI;YACJ,SAAS;YACT,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAW,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,WAAW,EAAE,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,UAAkB;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAW,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,aAAa,EAAE,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,UAAkB;QAKpC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,UAAU,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,aAAa,CAAC,OAAgC;QAClD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAA6B,GAAG,IAAI,CAAC,QAAQ,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC/F,CAAC;CACF"}

package/dist/services/core/exports/exports.client.d.ts

@@ -0,0 +1,55 @@
+import type { HttpClientTransport as HttpClient } from '../../../core/http-client.js';
+import type { CreateExportDto, CreateExportOptions, CreateExportResponse, ExportDownloadUrl, ExportJob, ExportJobListQuery, ExportJobListResponse } from './types.js';
+/**
+ * Admin CSV export jobs (`POST /v1/exports` is always async).
+ *
+ * Server / `sk_` (or admin JWT) only: `{entity}:export` (`orders:export`,
+ * `products:export`, `customers:export`, `inventory:export`,
+ * `discounts:export`, `reviews:export`). Store-scoped entities send
+ * `x-store-id` via `setStore` / `withStore`. Publishable (`pk_`) keys 403.
+ * Not available on `@aimee.shop/sdk/storefront`.
+ *
+ * @example
+ * ```typescript
+ * sdk.setStore(storeId);
+ * const { jobId, status } = await sdk.exports.create(
+ *   {
+ *     entity: 'orders',
+ *     filters: { status: 'PAID' },
+ *     columnSet: 'summary',
+ *     includes: ['items', 'notes'],
+ *   },
+ *   { idempotencyKey: crypto.randomUUID() },
+ * );
+ * const job = await sdk.exports.get(jobId);
+ * if (job.status === 'completed') {
+ *   const { downloadUrl } = await sdk.exports.getDownloadUrl(jobId);
+ * }
+ * ```
+ */
+export declare class ExportsClient {
+    private readonly http;
+    private readonly endpoint;
+    constructor(http: HttpClient, baseUrl: string);
+    /**
+     * Create an async CSV export job (202). Requires a client-generated Idempotency-Key.
+     */
+    create(body: CreateExportDto, options: CreateExportOptions): Promise<CreateExportResponse>;
+    /**
+     * List export jobs the caller may see (`{entity}:export`).
+     */
+    list(query?: ExportJobListQuery): Promise<ExportJobListResponse>;
+    /**
+     * Get job status and progress by id.
+     */
+    get(jobId: string): Promise<ExportJob>;
+    /**
+     * Mint a 1h presigned download URL. 404 if the job is not completed or the object expired.
+     */
+    getDownloadUrl(jobId: string): Promise<ExportDownloadUrl>;
+    /**
+     * Cancel a pending or running job (202).
+     */
+    cancel(jobId: string): Promise<CreateExportResponse>;
+}
+//# sourceMappingURL=exports.client.d.ts.map

package/dist/services/core/exports/exports.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.client.d.ts","sourceRoot":"","sources":["../../../../../../src/services/core/exports/exports.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,IAAI,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAEtF,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAIpB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,aAAa;IAItB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAHvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;gBAGf,IAAI,EAAE,UAAU,EACjC,OAAO,EAAE,MAAM;IAKjB;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAWhG;;OAEG;IACG,IAAI,CAAC,KAAK,GAAE,kBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAO1E;;OAEG;IACG,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAI5C;;OAEG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAM/D;;OAEG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAM3D"}

package/dist/services/core/exports/exports.client.js

@@ -0,0 +1,80 @@
+import { ConfigurationError } from '../../../core/errors/index.js';
+const IDEMPOTENCY_KEY_HEADER = 'Idempotency-Key';
+/**
+ * Admin CSV export jobs (`POST /v1/exports` is always async).
+ *
+ * Server / `sk_` (or admin JWT) only: `{entity}:export` (`orders:export`,
+ * `products:export`, `customers:export`, `inventory:export`,
+ * `discounts:export`, `reviews:export`). Store-scoped entities send
+ * `x-store-id` via `setStore` / `withStore`. Publishable (`pk_`) keys 403.
+ * Not available on `@aimee.shop/sdk/storefront`.
+ *
+ * @example
+ * ```typescript
+ * sdk.setStore(storeId);
+ * const { jobId, status } = await sdk.exports.create(
+ *   {
+ *     entity: 'orders',
+ *     filters: { status: 'PAID' },
+ *     columnSet: 'summary',
+ *     includes: ['items', 'notes'],
+ *   },
+ *   { idempotencyKey: crypto.randomUUID() },
+ * );
+ * const job = await sdk.exports.get(jobId);
+ * if (job.status === 'completed') {
+ *   const { downloadUrl } = await sdk.exports.getDownloadUrl(jobId);
+ * }
+ * ```
+ */
+export class ExportsClient {
+    http;
+    endpoint;
+    constructor(http, baseUrl) {
+        this.http = http;
+        this.endpoint = `${baseUrl}/v1/exports`;
+    }
+    /**
+     * Create an async CSV export job (202). Requires a client-generated Idempotency-Key.
+     */
+    async create(body, options) {
+        if (!options.idempotencyKey || options.idempotencyKey.trim() === '') {
+            throw new ConfigurationError('create requires a non-empty idempotencyKey');
+        }
+        return this.http.post(this.endpoint, body, {
+            headers: {
+                [IDEMPOTENCY_KEY_HEADER]: options.idempotencyKey,
+            },
+        });
+    }
+    /**
+     * List export jobs the caller may see (`{entity}:export`).
+     */
+    async list(query = {}) {
+        const params = {};
+        if (query.page !== undefined)
+            params.page = String(query.page);
+        if (query.limit !== undefined)
+            params.limit = String(query.limit);
+        return this.http.get(this.endpoint, { params });
+    }
+    /**
+     * Get job status and progress by id.
+     */
+    async get(jobId) {
+        return this.http.get(`${this.endpoint}/${encodeURIComponent(jobId)}`);
+    }
+    /**
+     * Mint a 1h presigned download URL. 404 if the job is not completed or the object expired.
+     */
+    async getDownloadUrl(jobId) {
+        return this.http.get(`${this.endpoint}/${encodeURIComponent(jobId)}/download`);
+    }
+    /**
+     * Cancel a pending or running job (202).
+     */
+    async cancel(jobId) {
+        return this.http.post(`${this.endpoint}/${encodeURIComponent(jobId)}/cancel`, {});
+    }
+}
+//# sourceMappingURL=exports.client.js.map

package/dist/services/core/exports/exports.client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.client.js","sourceRoot":"","sources":["../../../../../../src/services/core/exports/exports.client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAWnE,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,aAAa;IAIL;IAHF,QAAQ,CAAS;IAElC,YACmB,IAAgB,EACjC,OAAe;QADE,SAAI,GAAJ,IAAI,CAAY;QAGjC,IAAI,CAAC,QAAQ,GAAG,GAAG,OAAO,aAAa,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,IAAqB,EAAE,OAA4B;QAC9D,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACpE,MAAM,IAAI,kBAAkB,CAAC,4CAA4C,CAAC,CAAC;QAC7E,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAuB,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE;YAC/D,OAAO,EAAE;gBACP,CAAC,sBAAsB,CAAC,EAAE,OAAO,CAAC,cAAc;aACjD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,QAA4B,EAAE;QACvC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAwB,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,KAAa;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAY,GAAG,IAAI,CAAC,QAAQ,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,KAAa;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAClB,GAAG,IAAI,CAAC,QAAQ,IAAI,kBAAkB,CAAC,KAAK,CAAC,WAAW,CACzD,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,KAAa;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CACnB,GAAG,IAAI,CAAC,QAAQ,IAAI,kBAAkB,CAAC,KAAK,CAAC,SAAS,EACtD,EAAE,CACH,CAAC;IACJ,CAAC;CACF"}

package/dist/services/core/exports/index.d.ts

@@ -0,0 +1,4 @@
+export { ExportsClient } from './exports.client.js';
+export type { ExportEntity, OrderExportInclude, ExportColumnSet, ExportJobStatus, ExportSort, CreateExportDto, CreateExportOptions, CreateExportResponse, ExportJob, ExportJobListQuery, ExportJobListResponse, ExportDownloadUrl, } from './types.js';
+export { EXPORT_ENTITIES, ORDER_EXPORT_INCLUDES, EXPORT_COLUMN_SETS, EXPORT_JOB_STATUSES, } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/services/core/exports/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/services/core/exports/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,YAAY,EACV,YAAY,EACZ,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,UAAU,EACV,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,SAAS,EACT,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,YAAY,CAAC"}

package/dist/services/core/exports/index.js

@@ -0,0 +1,3 @@
+export { ExportsClient } from './exports.client.js';
+export { EXPORT_ENTITIES, ORDER_EXPORT_INCLUDES, EXPORT_COLUMN_SETS, EXPORT_JOB_STATUSES, } from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/services/core/exports/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/services/core/exports/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAepD,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,YAAY,CAAC"}

package/dist/services/core/exports/types.d.ts

@@ -0,0 +1,68 @@
+export declare const EXPORT_ENTITIES: readonly ["orders", "products", "customers", "inventory", "discounts", "reviews"];
+export type ExportEntity = (typeof EXPORT_ENTITIES)[number];
+export declare const ORDER_EXPORT_INCLUDES: readonly ["items", "fulfillments", "payments", "refunds", "discounts", "notes"];
+export type OrderExportInclude = (typeof ORDER_EXPORT_INCLUDES)[number];
+export declare const EXPORT_COLUMN_SETS: readonly ["summary", "detail"];
+export type ExportColumnSet = (typeof EXPORT_COLUMN_SETS)[number];
+export declare const EXPORT_JOB_STATUSES: readonly ["pending", "running", "completed", "failed", "cancelled"];
+export type ExportJobStatus = (typeof EXPORT_JOB_STATUSES)[number];
+export interface ExportSort {
+    field: string;
+    order: 'asc' | 'desc';
+}
+/** Body for POST /v1/exports. Unknown filter keys are 400 on the API. */
+export interface CreateExportDto {
+    entity: ExportEntity;
+    /** Defaults to `summary` on the API when omitted. */
+    columnSet?: ExportColumnSet;
+    filters: Record<string, unknown>;
+    sort?: ExportSort;
+    /** Selected row ids (max 10_000). Overrides filters on the API. */
+    ids?: string[];
+    /**
+     * Optional expansions. Unknown keys ignored by the API (max 16).
+     * Orders: {@link ORDER_EXPORT_INCLUDES}.
+     */
+    includes?: string[];
+}
+export interface CreateExportOptions {
+    /** Required client-generated key sent as Idempotency-Key. */
+    idempotencyKey: string;
+}
+export interface CreateExportResponse {
+    jobId: string;
+    status: ExportJobStatus;
+}
+export interface ExportJob {
+    id: string;
+    status: ExportJobStatus;
+    entity: ExportEntity;
+    columnSet: ExportColumnSet;
+    totalRows: number;
+    processedRows: number;
+    bytesWritten: number;
+    fileCount: number;
+    errorMessage: string | null;
+    filename: string | null;
+    createdAt: string;
+    startedAt: string | null;
+    completedAt: string | null;
+    expiresAt: string | null;
+}
+export interface ExportJobListQuery {
+    page?: number;
+    limit?: number;
+}
+export interface ExportJobListResponse {
+    data: ExportJob[];
+    total: number;
+}
+export interface ExportDownloadUrl {
+    downloadUrl: string;
+    expiresAt: string;
+    filename: string;
+    contentType: string;
+    byteSize: number;
+    fileCount: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/services/core/exports/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../src/services/core/exports/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,mFAOlB,CAAC;AACX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5D,eAAO,MAAM,qBAAqB,iFAOxB,CAAC;AACX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAExE,eAAO,MAAM,kBAAkB,gCAAiC,CAAC;AACjE,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,eAAO,MAAM,mBAAmB,qEAMtB,CAAC;AACX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEnE,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;CACvB;AAED,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,YAAY,CAAC;IACrB,qDAAqD;IACrD,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,6DAA6D;IAC7D,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,eAAe,CAAC;IACxB,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,eAAe,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/services/core/exports/types.js

@@ -0,0 +1,25 @@
+export const EXPORT_ENTITIES = [
+    'orders',
+    'products',
+    'customers',
+    'inventory',
+    'discounts',
+    'reviews',
+];
+export const ORDER_EXPORT_INCLUDES = [
+    'items',
+    'fulfillments',
+    'payments',
+    'refunds',
+    'discounts',
+    'notes',
+];
+export const EXPORT_COLUMN_SETS = ['summary', 'detail'];
+export const EXPORT_JOB_STATUSES = [
+    'pending',
+    'running',
+    'completed',
+    'failed',
+    'cancelled',
+];
+//# sourceMappingURL=types.js.map

package/dist/services/core/exports/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../src/services/core/exports/types.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,QAAQ;IACR,UAAU;IACV,WAAW;IACX,WAAW;IACX,WAAW;IACX,SAAS;CACD,CAAC;AAGX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,OAAO;IACP,cAAc;IACd,UAAU;IACV,SAAS;IACT,WAAW;IACX,OAAO;CACC,CAAC;AAGX,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAU,CAAC;AAGjE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,SAAS;IACT,SAAS;IACT,WAAW;IACX,QAAQ;IACR,WAAW;CACH,CAAC"}