@cimplify/sdk 0.9.10 → 0.10.1

package/dist/{payment-CTalZM5l.d.mts → payment-CrNyrc-D.d.mts}

@@ -1,30 +1,18 @@
 declare const __money: unique symbol;
-/** Decimal monetary amount as a string (e.g. "29.99"). Branded to prevent mixing with plain strings. */
-type Money = string & {
+type Money = number & {
     readonly [__money]: true;
 };
-/** Create a Money value from a string decimal. */
-declare function money(value: string): Money;
-/** Create a Money value from a number. Converts to a 2-decimal string. */
+declare function money(value: string | number): Money;
 declare function moneyFromNumber(value: number): Money;
-/** Zero money constant. */
 declare const ZERO: Money;
-/** ISO 4217 currency codes supported by the platform */
 type CurrencyCode = "USD" | "EUR" | "GBP" | "JPY" | "CNY" | "CHF" | "CAD" | "AUD" | "GHS" | "NGN" | "KES" | "ZAR" | "XOF" | "XAF" | "EGP" | "TZS" | "UGX" | "RWF" | "ETB" | "ZMW" | "BWP" | "MUR" | "NAD" | "MWK" | "AOA" | "CDF" | "GMD" | "GNF" | "LRD" | "SLL" | "MZN" | "BIF" | "INR" | "BRL" | "MXN" | "KRW" | "TRY" | "THB" | "MYR" | "PHP" | "IDR" | "VND" | "SGD" | "HKD" | "TWD" | "AED" | "SAR" | "ILS";
 declare function isSupportedCurrency(code: string): code is CurrencyCode;
-/** Assert a string as CurrencyCode at API boundaries. */
 declare function currencyCode(value: string): CurrencyCode;
-/**
- * @deprecated Use `CurrencyCode` instead. Kept for backward compatibility.
- */
-type Currency = CurrencyCode;
-/** Pagination parameters */
 interface PaginationParams {
     page?: number;
     limit?: number;
     offset?: number;
 }
-/** Pagination metadata in response */
 interface Pagination {
     total_count: number;
     current_page: number;
@@ -33,7 +21,6 @@ interface Pagination {
     has_more: boolean;
     next_cursor?: string;
 }
-/** Strongly-typed error codes for better DX */
 declare const ErrorCode: {
     readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
     readonly NETWORK_ERROR: "NETWORK_ERROR";
@@ -72,7 +59,6 @@ declare const ErrorCode: {
     readonly INSUFFICIENT_QUANTITY: "INSUFFICIENT_QUANTITY";
 };
 type ErrorCodeType = (typeof ErrorCode)[keyof typeof ErrorCode];
-/** API error structure */
 interface ApiError {
     code: string;
     message: string;
@@ -83,45 +69,19 @@ interface ErrorHint {
     suggestion: string;
 }
 declare const ERROR_HINTS: Record<string, ErrorHint>;
-/**
- * Custom error class for SDK errors with typed error codes.
- *
- * @example
- * ```typescript
- * try {
- *   await client.cart.addItem({ item_id: "prod_123" });
- * } catch (error) {
- *   if (isCimplifyError(error)) {
- *     switch (error.code) {
- *       case ErrorCode.ITEM_UNAVAILABLE:
- *         toast.error("This item is no longer available");
- *         break;
- *       case ErrorCode.VARIANT_OUT_OF_STOCK:
- *         toast.error("Selected option is out of stock");
- *         break;
- *       default:
- *         toast.error(error.message);
- *     }
- *   }
- * }
- * ```
- */
 declare class CimplifyError extends Error {
     code: string;
     retryable: boolean;
     docs_url?: string | undefined;
     suggestion?: string | undefined;
     constructor(code: string, message: string, retryable?: boolean, docs_url?: string | undefined, suggestion?: string | undefined);
-    /** User-friendly message safe to display */
     get userMessage(): string;
 }
-/** Type guard for CimplifyError */
 declare function isCimplifyError(error: unknown): error is CimplifyError;
 declare function getErrorHint(code: string): ErrorHint | undefined;
 declare function enrichError(error: CimplifyError, options?: {
     isTestMode?: boolean;
 }): CimplifyError;
-/** Check if error is retryable */
 declare function isRetryableError(error: unknown): boolean;
 
 type ProductType = "product" | "service" | "digital" | "bundle" | "composite";
@@ -129,7 +89,7 @@ type ProductRenderHint = "food" | "physical" | "general";
 type DisplayMode = "card" | "page";
 type InventoryType = "one_to_one" | "composition" | "none";
 type VariantStrategy = "fetch_all" | "use_axes";
-type DigitalProductType = "download" | "license_key" | "ticket" | "access_grant" | "redemption_code";
+type DigitalProductType = "download" | "license" | "event_ticket" | "access_pass" | "gift_code";
 type DepositType = "none" | "fixed" | "percentage";
 type SalesChannel = "pos" | "online" | "marketplace" | "partners";
 interface Product {
@@ -142,11 +102,15 @@ interface Product {
     image_url?: string;
     default_price: Money;
     type: ProductType;
-    /** Server-derived UI hint for conditional rendering. */
     render_hint?: ProductRenderHint;
     display_mode?: DisplayMode;
     inventory_type: InventoryType;
     variant_strategy: VariantStrategy;
+    inventory_status?: {
+        in_stock: boolean;
+        stock_level?: number;
+        low_stock: boolean;
+    };
     is_active: boolean;
     created_at: string;
     updated_at: string;
@@ -313,7 +277,6 @@ interface VariantLocationAvailability {
     updated_at: string;
     metadata?: Record<string, unknown>;
 }
-/** Input for selecting a variant by axis values */
 interface VariantAxisSelection {
     [axisName: string]: string;
 }
@@ -372,6 +335,7 @@ interface Category {
     name: string;
     slug: string;
     description?: string;
+    product_count?: number;
     created_at: string;
     updated_at: string;
     metadata?: Record<string, unknown>;
@@ -388,6 +352,7 @@ interface Collection {
     tags?: string[];
     image_url?: string;
     channels?: SalesChannel[];
+    product_count?: number;
     created_at: string;
     updated_at: string;
     metadata?: Record<string, unknown>;
@@ -416,6 +381,7 @@ interface Bundle {
     pricing_type: BundlePriceType;
     bundle_price?: Money;
     discount_value?: Money;
+    product_count?: number;
     created_at: string;
     updated_at: string;
     metadata?: Record<string, unknown>;
@@ -460,7 +426,7 @@ interface BundleComponentView {
     product_name: string;
     product_description?: string;
     product_image_url?: string;
-    product_default_price: Money;
+    effective_price: Money;
     quantity: number;
     variant_id?: string;
     allow_variant_choice: boolean;
@@ -570,14 +536,12 @@ interface CompositeComponent {
     created_at: string;
     updated_at: string;
 }
-/** Input for calculating composite price or adding to cart */
 interface ComponentSelectionInput {
     component_id: string;
     quantity: number;
     variant_id?: string;
     add_on_option_id?: string;
 }
-/** Result of composite price calculation */
 interface CompositePriceResult {
     base_price: Money;
     components_total: Money;
@@ -631,53 +595,106 @@ interface ProductTimeProfile {
     updated_at: string;
     metadata?: Record<string, unknown>;
 }
+interface ProductTaxonomy {
+    id: string;
+    code: string;
+    name: string;
+    description?: string;
+    parent_id?: string;
+    level: number;
+    is_active: boolean;
+    created_at: string;
+    updated_at: string;
+}
+interface TaxonomyWithChildren extends ProductTaxonomy {
+    children: ProductTaxonomy[];
+}
+interface ProductAvailabilityNow {
+    is_available: boolean;
+    schedules_today: ProductTimeProfile[];
+}
+type DealBenefitType = "percentage" | "fixed" | "free_item" | "buy_x_get_y_free" | "points";
+interface Deal {
+    id: string;
+    description: string;
+    benefit_type: DealBenefitType;
+    value: Money;
+    min_order_value?: Money;
+    buy_quantity?: number;
+    get_quantity?: number;
+    stackable: boolean;
+    starts_at: string;
+    ends_at: string;
+    product_ids: string[];
+    category_ids: string[];
+    collection_ids: string[];
+}
+interface ProductDealInfo {
+    product_id: string;
+    deal_id: string;
+    deal_name: string;
+    benefit_type: DealBenefitType;
+    value: Money;
+    label: string;
+}
+interface DiscountValidation {
+    is_eligible: boolean;
+    discount_amount?: Money;
+    deal?: Deal;
+    ineligibility_reason?: string;
+}
+interface Tag {
+    id: string;
+    name: string;
+    slug: string;
+    color?: string;
+    icon?: string;
+    description?: string;
+    tag_group?: string;
+    sort_order: number;
+    usage_count: number;
+    created_at: string;
+    updated_at: string;
+}
+interface TagsResponse {
+    items: Tag[];
+    total: number;
+    limit: number;
+    offset: number;
+}
 
 type CartStatus = "active" | "converting" | "converted" | "expired" | "abandoned";
 type CartChannel = "qr" | "taker" | "staff" | "web" | "dashboard";
-type PriceSource = {
-    type: "default_item";
+type PriceSource = "default_item" | "custom" | {
+    location_specific: string;
 } | {
-    type: "location_specific";
-    location_id: string;
+    variant: string;
 } | {
-    type: "variant";
-    variant_id: string;
-} | {
-    type: "composite";
-    composite_id: string;
+    composite: string;
 } | {
-    type: "custom";
+    bundle: string;
 };
-type AdjustmentType = {
-    type: "location_based";
-    location_id: string;
-} | {
-    type: "variant_based";
-    variant_id: string;
+type AdjustmentType = "time_based" | {
+    location_based: string;
 } | {
-    type: "time_based";
+    variant_based: string;
 } | {
-    type: "customer_segment";
-    segment_id: string;
+    customer_segment: string;
 } | {
-    type: "customer_loyalty";
-    tier: string;
+    customer_loyalty: string;
 } | {
-    type: "channel_markup";
-    channel: string;
+    channel_markup: string;
 } | {
-    type: "discount";
-    discount_id: string;
+    discount: string;
 } | {
-    type: "bundle";
-    bundle_id: string;
+    bundle: string;
 } | {
-    type: "manual";
-    reason: string;
+    manual: string;
 } | {
-    type: "time_limited_promotion";
-    promotion_id: string;
-    valid_until: string;
+    time_limited_promotion: {
+        promotion_id: string;
+        valid_until: string;
+    };
 };
 interface PriceAdjustment {
     adjustment_type: AdjustmentType;
@@ -713,7 +730,7 @@ interface ChosenPrice {
     decision_path?: PriceDecisionPath;
     tax_info?: PricePathTaxInfo;
 }
-type BenefitType = "percentage" | "fixed_amount" | "free_item" | "buy_x_get_y";
+type BenefitType = "percentage" | "fixed" | "points" | "free_item" | "buy_x_get_y_free";
 interface AppliedDiscount {
     discount_id: string;
     discount_code?: string;
@@ -721,6 +738,7 @@ interface AppliedDiscount {
     discount_value: Money;
     discount_amount: Money;
     applied_at: string;
+    targeted_item_ids?: string[];
 }
 interface DiscountBreakdown {
     item_discounts: Record<string, AppliedDiscount[]>;
@@ -1053,7 +1071,6 @@ interface CartItemDetails {
     updated_at: string;
     metadata?: Record<string, unknown>;
 }
-/** Enriched cart returned by cart#enriched - matches cart_dto.rs UICart */
 interface UICart {
     id: string;
     business_id: string;
@@ -1073,7 +1090,6 @@ interface UICart {
     pricing: UICartPricing;
     metadata?: Record<string, unknown>;
 }
-/** Envelope returned by cart#enriched query */
 interface UICartResponse {
     cart: UICart;
     cart_count: number;
@@ -1113,12 +1129,48 @@ interface CartSummary {
     currency: CurrencyCode;
 }
 
-type PaymentStatus = "pending" | "processing" | "created" | "pending_confirmation" | "success" | "succeeded" | "failed" | "declined" | "authorized" | "refunded" | "partially_refunded" | "partially_paid" | "paid" | "unpaid" | "requires_action" | "requires_payment_method" | "requires_capture" | "captured" | "cancelled" | "completed" | "voided" | "error" | "unknown";
-type PaymentProvider = "stripe" | "paystack" | "mtn" | "vodafone" | "airtel" | "cellulant" | "offline" | "cash" | "manual";
-type PaymentMethodType = "card" | "mobile_money" | "bank_transfer" | "cash" | "custom";
-/** Authorization types for payment verification (OTP, PIN, etc.) */
-type AuthorizationType = "otp" | "pin" | "phone" | "birthday" | "address";
-/** Payment processing state machine states (for UI) */
+type PaymentStatus = "initialized" | "pending" | "processing" | "authorized" | "captured" | "failed" | "cancelled" | "refunded" | "unknown" | "voided" | "requires_action" | "abandoned" | "reversed" | "disputed" | "refund_pending" | "created" | "pending_confirmation" | "success" | "succeeded" | "declined" | "partially_refunded" | "partially_paid" | "paid" | "unpaid" | "requires_payment_method" | "requires_capture" | "completed" | "error";
+type PaymentProvider = "stripe" | "paystack" | "cellulant" | "mtnmomo" | "offline" | "mtn" | "vodafone" | "airtel" | "cash" | "manual";
+type PaymentMethodType = "card" | "bank_transfer" | "cash" | {
+    mobile_money: {
+        provider: string;
+        phone_number: string;
+    };
+} | {
+    ussd: {
+        provider: string;
+    };
+} | {
+    bank: {
+        bank_code: string;
+        account_number: string;
+        account_name?: string;
+        bank_name?: string;
+    };
+} | {
+    qr: {
+        provider: string;
+    };
+} | {
+    wallet: {
+        provider: string;
+    };
+} | {
+    crypto: {
+        currency: string;
+    };
+} | {
+    custom: string;
+};
+interface AddressAuthorizationData {
+    address: string;
+    city: string;
+    state: string;
+    zip_code: string;
+}
+type AuthorizationType = "otp" | "pin" | "phone" | "birthday" | {
+    address: AddressAuthorizationData;
+};
 type PaymentProcessingState = "initial" | "preparing" | "processing" | "verifying" | "awaiting_authorization" | "success" | "error" | "timeout";
 interface PaymentMethod {
     type: PaymentMethodType;
@@ -1149,7 +1201,6 @@ interface InitializePaymentResult {
     reference: string;
     provider: PaymentProvider;
 }
-/** Normalized payment response from checkout or payment initialization */
 interface PaymentResponse {
     method: string;
     provider: string;
@@ -1168,14 +1219,13 @@ interface PaymentResponse {
     authorization_type?: AuthorizationType;
     provider_payment_id?: string;
 }
-/** Payment status polling response */
 interface PaymentStatusResponse {
     status: PaymentStatus;
     paid: boolean;
-    amount?: Money;
-    currency?: CurrencyCode;
+    amount: Money;
+    currency: string;
     reference?: string;
-    message?: string;
+    message: string;
 }
 interface PaymentErrorDetails {
     code: string;
@@ -1189,4 +1239,4 @@ interface SubmitAuthorizationInput {
     value: string;
 }
 
-export { type BundleComponentData as $, type ApiError as A, type VariantLocationAvailability as B, type CurrencyCode as C, type DisplayMode as D, ErrorCode as E, type VariantAxisSelection as F, type AddOn as G, type AddOnWithOptions as H, type InventoryType as I, type AddOnOption as J, type AddOnOptionPrice as K, type ProductAddOn as L, type Money as M, type Category as N, type CategorySummary as O, type PaginationParams as P, type Collection as Q, type CollectionSummary as R, type SalesChannel as S, type CollectionProduct as T, type BundlePriceType as U, type VariantStrategy as V, type Bundle as W, type BundleSummary as X, type BundleProduct as Y, ZERO as Z, type BundleWithDetails as _, moneyFromNumber as a, type UICartResponse as a$, type BundleComponentInfo as a0, type BundleComponentView as a1, type BundleComponentVariantView as a2, type VariantAxisView as a3, type VariantAxisValueView as a4, type CompositePricingMode as a5, type GroupPricingBehavior as a6, type ComponentSourceType as a7, type Composite as a8, type CompositeWithDetails as a9, type SelectedAddOnOption as aA, type AddOnDetails as aB, type CartAddOn as aC, type VariantDetails as aD, type BundleSelectionInput as aE, type BundleStoredSelection as aF, type BundleSelectionData as aG, type CompositeStoredSelection as aH, type CompositePriceBreakdown as aI, type CompositeSelectionData as aJ, type LineConfiguration as aK, type Cart as aL, type CartItem as aM, type CartTotals as aN, type DisplayCart as aO, type DisplayCartItem as aP, type DisplayAddOn as aQ, type DisplayAddOnOption as aR, type UICartBusiness as aS, type UICartLocation as aT, type UICartCustomer as aU, type UICartPricing as aV, type AddOnOptionDetails as aW, type AddOnGroupDetails as aX, type VariantDetailsDTO as aY, type CartItemDetails as aZ, type UICart as a_, type ComponentGroup as aa, type ComponentGroupWithComponents as ab, type CompositeGroupView as ac, type CompositeComponentView as ad, type CompositeComponent as ae, type ComponentSelectionInput as af, type CompositePriceResult as ag, type ComponentPriceBreakdown as ah, type PriceEntryType as ai, type Price as aj, type LocationProductPrice as ak, type ProductAvailability as al, type ProductTimeProfile as am, type CartStatus as an, type CartChannel as ao, type PriceSource as ap, type AdjustmentType as aq, type PriceAdjustment as ar, type TaxPathComponent as as, type PricePathTaxInfo as at, type PriceDecisionPath as au, type ChosenPrice as av, type BenefitType as aw, type AppliedDiscount as ax, type DiscountBreakdown as ay, type DiscountDetails as az, type Currency as b, type AddToCartInput as b0, type UpdateCartItemInput as b1, type CartSummary as b2, type PaymentStatus as b3, type PaymentProvider as b4, type PaymentMethodType as b5, type AuthorizationType as b6, type PaymentProcessingState as b7, type PaymentMethod as b8, type Payment as b9, type InitializePaymentResult as ba, type PaymentResponse as bb, type PaymentStatusResponse as bc, type PaymentErrorDetails as bd, type SubmitAuthorizationInput as be, currencyCode as c, type Pagination as d, type ErrorCodeType as e, type ErrorHint as f, ERROR_HINTS as g, CimplifyError as h, isSupportedCurrency as i, isCimplifyError as j, getErrorHint as k, enrichError as l, money as m, isRetryableError as n, type ProductType as o, type ProductRenderHint as p, type DigitalProductType as q, type DepositType as r, type Product as s, type ProductWithDetails as t, type ProductVariant as u, type VariantDisplayAttribute as v, type VariantAxis as w, type VariantAxisWithValues as x, type VariantAxisValue as y, type ProductVariantValue as z };
+export { type BundleComponentInfo as $, type ApiError as A, type VariantAxisSelection as B, type CurrencyCode as C, type DisplayMode as D, ErrorCode as E, type AddOn as F, type AddOnWithOptions as G, type AddOnOption as H, type InventoryType as I, type AddOnOptionPrice as J, type ProductAddOn as K, type Category as L, type Money as M, type CategorySummary as N, type Collection as O, type PaginationParams as P, type CollectionSummary as Q, type CollectionProduct as R, type SalesChannel as S, type BundlePriceType as T, type Bundle as U, type VariantStrategy as V, type BundleSummary as W, type BundleProduct as X, type BundleWithDetails as Y, ZERO as Z, type BundleComponentData as _, moneyFromNumber as a, type UICartLocation as a$, type BundleComponentView as a0, type BundleComponentVariantView as a1, type VariantAxisView as a2, type VariantAxisValueView as a3, type CompositePricingMode as a4, type GroupPricingBehavior as a5, type ComponentSourceType as a6, type Composite as a7, type CompositeWithDetails as a8, type ComponentGroup as a9, type TaxPathComponent as aA, type PricePathTaxInfo as aB, type PriceDecisionPath as aC, type ChosenPrice as aD, type BenefitType as aE, type AppliedDiscount as aF, type DiscountBreakdown as aG, type DiscountDetails as aH, type SelectedAddOnOption as aI, type AddOnDetails as aJ, type CartAddOn as aK, type VariantDetails as aL, type BundleSelectionInput as aM, type BundleStoredSelection as aN, type BundleSelectionData as aO, type CompositeStoredSelection as aP, type CompositePriceBreakdown as aQ, type CompositeSelectionData as aR, type LineConfiguration as aS, type Cart as aT, type CartItem as aU, type CartTotals as aV, type DisplayCart as aW, type DisplayCartItem as aX, type DisplayAddOn as aY, type DisplayAddOnOption as aZ, type UICartBusiness as a_, type ComponentGroupWithComponents as aa, type CompositeGroupView as ab, type CompositeComponentView as ac, type CompositeComponent as ad, type ComponentSelectionInput as ae, type CompositePriceResult as af, type ComponentPriceBreakdown as ag, type PriceEntryType as ah, type Price as ai, type LocationProductPrice as aj, type ProductAvailability as ak, type ProductTimeProfile as al, type ProductTaxonomy as am, type TaxonomyWithChildren as an, type ProductAvailabilityNow as ao, type DealBenefitType as ap, type Deal as aq, type ProductDealInfo as ar, type DiscountValidation as as, type Tag as at, type TagsResponse as au, type CartStatus as av, type CartChannel as aw, type PriceSource as ax, type AdjustmentType as ay, type PriceAdjustment as az, type Pagination as b, type UICartCustomer as b0, type UICartPricing as b1, type AddOnOptionDetails as b2, type AddOnGroupDetails as b3, type VariantDetailsDTO as b4, type CartItemDetails as b5, type UICart as b6, type UICartResponse as b7, type AddToCartInput as b8, type UpdateCartItemInput as b9, type CartSummary as ba, type PaymentStatus as bb, type PaymentProvider as bc, type PaymentMethodType as bd, type AddressAuthorizationData as be, type AuthorizationType as bf, type PaymentProcessingState as bg, type PaymentMethod as bh, type Payment as bi, type InitializePaymentResult as bj, type PaymentResponse as bk, type PaymentStatusResponse as bl, type PaymentErrorDetails as bm, type SubmitAuthorizationInput as bn, currencyCode as c, type ErrorCodeType as d, type ErrorHint as e, ERROR_HINTS as f, CimplifyError as g, isCimplifyError as h, isSupportedCurrency as i, getErrorHint as j, enrichError as k, isRetryableError as l, money as m, type ProductType as n, type ProductRenderHint as o, type DigitalProductType as p, type DepositType as q, type Product as r, type ProductWithDetails as s, type ProductVariant as t, type VariantDisplayAttribute as u, type VariantAxis as v, type VariantAxisWithValues as w, type VariantAxisValue as x, type ProductVariantValue as y, type VariantLocationAvailability as z };