ce-storefront 0.0.1

package/src/models/components/cardpayment.ts

@@ -0,0 +1,234 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+import * as z from "zod";
+
+export const TransactionType = {
+    Payment: "payment",
+    Refund: "refund",
+} as const;
+export type TransactionType = ClosedEnum<typeof TransactionType>;
+
+export const CardPaymentPaymentStatus = {
+    Pending: "pending",
+    Success: "success",
+    Failed: "failed",
+    PartiallyPaid: "partially_paid",
+    RefundInitiated: "refund_initiated",
+} as const;
+export type CardPaymentPaymentStatus = ClosedEnum<typeof CardPaymentPaymentStatus>;
+
+export const PaymentMethod = {
+    CreditCard: "Credit Card",
+    DebitCard: "Debit Card",
+    Netbanking: "Netbanking",
+    Upi: "UPI",
+    Wallet: "Wallet",
+    LoyaltyPoint: "Loyalty Point",
+    Imps: "IMPS",
+    Neft: "NEFT",
+    Rtgs: "RTGS",
+} as const;
+export type PaymentMethod = ClosedEnum<typeof PaymentMethod>;
+
+export const CardType = {
+    Visa: "Visa",
+    MasterCard: "Master Card",
+    Rupay: "Rupay",
+} as const;
+export type CardType = ClosedEnum<typeof CardType>;
+
+/**
+ * Payments using credit card, debit card
+ */
+export type CardPayment = {
+    transactionType?: TransactionType | undefined;
+    requestNumber?: string | undefined;
+    amount?: number | undefined;
+    paymentStatus?: CardPaymentPaymentStatus | undefined;
+    paymentDate?: Date | undefined;
+    paymentReferenceNumber?: string | null | undefined;
+    paymentMethod?: PaymentMethod | undefined;
+    iconUrl?: string | undefined;
+    /**
+     * masked card number
+     *
+     * @remarks
+     * e.g. ************1111
+     */
+    cardNumber?: string | undefined;
+    cardType?: CardType | undefined;
+};
+
+/** @internal */
+export const TransactionType$inboundSchema: z.ZodNativeEnum<typeof TransactionType> =
+    z.nativeEnum(TransactionType);
+
+/** @internal */
+export const TransactionType$outboundSchema: z.ZodNativeEnum<typeof TransactionType> =
+    TransactionType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TransactionType$ {
+    /** @deprecated use `TransactionType$inboundSchema` instead. */
+    export const inboundSchema = TransactionType$inboundSchema;
+    /** @deprecated use `TransactionType$outboundSchema` instead. */
+    export const outboundSchema = TransactionType$outboundSchema;
+}
+
+/** @internal */
+export const CardPaymentPaymentStatus$inboundSchema: z.ZodNativeEnum<
+    typeof CardPaymentPaymentStatus
+> = z.nativeEnum(CardPaymentPaymentStatus);
+
+/** @internal */
+export const CardPaymentPaymentStatus$outboundSchema: z.ZodNativeEnum<
+    typeof CardPaymentPaymentStatus
+> = CardPaymentPaymentStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CardPaymentPaymentStatus$ {
+    /** @deprecated use `CardPaymentPaymentStatus$inboundSchema` instead. */
+    export const inboundSchema = CardPaymentPaymentStatus$inboundSchema;
+    /** @deprecated use `CardPaymentPaymentStatus$outboundSchema` instead. */
+    export const outboundSchema = CardPaymentPaymentStatus$outboundSchema;
+}
+
+/** @internal */
+export const PaymentMethod$inboundSchema: z.ZodNativeEnum<typeof PaymentMethod> =
+    z.nativeEnum(PaymentMethod);
+
+/** @internal */
+export const PaymentMethod$outboundSchema: z.ZodNativeEnum<typeof PaymentMethod> =
+    PaymentMethod$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentMethod$ {
+    /** @deprecated use `PaymentMethod$inboundSchema` instead. */
+    export const inboundSchema = PaymentMethod$inboundSchema;
+    /** @deprecated use `PaymentMethod$outboundSchema` instead. */
+    export const outboundSchema = PaymentMethod$outboundSchema;
+}
+
+/** @internal */
+export const CardType$inboundSchema: z.ZodNativeEnum<typeof CardType> = z.nativeEnum(CardType);
+
+/** @internal */
+export const CardType$outboundSchema: z.ZodNativeEnum<typeof CardType> = CardType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CardType$ {
+    /** @deprecated use `CardType$inboundSchema` instead. */
+    export const inboundSchema = CardType$inboundSchema;
+    /** @deprecated use `CardType$outboundSchema` instead. */
+    export const outboundSchema = CardType$outboundSchema;
+}
+
+/** @internal */
+export const CardPayment$inboundSchema: z.ZodType<CardPayment, z.ZodTypeDef, unknown> = z
+    .object({
+        transaction_type: TransactionType$inboundSchema.optional(),
+        request_number: z.string().optional(),
+        amount: z.number().optional(),
+        payment_status: CardPaymentPaymentStatus$inboundSchema.optional(),
+        payment_date: z
+            .string()
+            .datetime({ offset: true })
+            .transform((v) => new Date(v))
+            .optional(),
+        payment_reference_number: z.nullable(z.string()).optional(),
+        payment_method: PaymentMethod$inboundSchema.optional(),
+        icon_url: z.string().optional(),
+        card_number: z.string().optional(),
+        card_type: CardType$inboundSchema.optional(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            transaction_type: "transactionType",
+            request_number: "requestNumber",
+            payment_status: "paymentStatus",
+            payment_date: "paymentDate",
+            payment_reference_number: "paymentReferenceNumber",
+            payment_method: "paymentMethod",
+            icon_url: "iconUrl",
+            card_number: "cardNumber",
+            card_type: "cardType",
+        });
+    });
+
+/** @internal */
+export type CardPayment$Outbound = {
+    transaction_type?: string | undefined;
+    request_number?: string | undefined;
+    amount?: number | undefined;
+    payment_status?: string | undefined;
+    payment_date?: string | undefined;
+    payment_reference_number?: string | null | undefined;
+    payment_method?: string | undefined;
+    icon_url?: string | undefined;
+    card_number?: string | undefined;
+    card_type?: string | undefined;
+};
+
+/** @internal */
+export const CardPayment$outboundSchema: z.ZodType<
+    CardPayment$Outbound,
+    z.ZodTypeDef,
+    CardPayment
+> = z
+    .object({
+        transactionType: TransactionType$outboundSchema.optional(),
+        requestNumber: z.string().optional(),
+        amount: z.number().optional(),
+        paymentStatus: CardPaymentPaymentStatus$outboundSchema.optional(),
+        paymentDate: z
+            .date()
+            .transform((v) => v.toISOString())
+            .optional(),
+        paymentReferenceNumber: z.nullable(z.string()).optional(),
+        paymentMethod: PaymentMethod$outboundSchema.optional(),
+        iconUrl: z.string().optional(),
+        cardNumber: z.string().optional(),
+        cardType: CardType$outboundSchema.optional(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            transactionType: "transaction_type",
+            requestNumber: "request_number",
+            paymentStatus: "payment_status",
+            paymentDate: "payment_date",
+            paymentReferenceNumber: "payment_reference_number",
+            paymentMethod: "payment_method",
+            iconUrl: "icon_url",
+            cardNumber: "card_number",
+            cardType: "card_type",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CardPayment$ {
+    /** @deprecated use `CardPayment$inboundSchema` instead. */
+    export const inboundSchema = CardPayment$inboundSchema;
+    /** @deprecated use `CardPayment$outboundSchema` instead. */
+    export const outboundSchema = CardPayment$outboundSchema;
+    /** @deprecated use `CardPayment$Outbound` instead. */
+    export type Outbound = CardPayment$Outbound;
+}

package/src/models/components/cart.ts

@@ -0,0 +1,356 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+    CartItem,
+    CartItem$inboundSchema,
+    CartItem$Outbound,
+    CartItem$outboundSchema,
+} from "./cartitem.js";
+import {
+    Currency,
+    Currency$inboundSchema,
+    Currency$Outbound,
+    Currency$outboundSchema,
+} from "./currency.js";
+import {
+    CustomerAddress,
+    CustomerAddress$inboundSchema,
+    CustomerAddress$Outbound,
+    CustomerAddress$outboundSchema,
+} from "./customeraddress.js";
+import * as z from "zod";
+
+export type CartMetadata = {};
+
+/**
+ * This cart model is structured to capture a wide range of details, facilitating accurate representation and management of user shopping carts in an e-commerce platform.
+ */
+export type Cart = {
+    /**
+     * Unique identifier for the cart.
+     */
+    id?: string | undefined;
+    /**
+     * Indicates whether the cart is currently active or inactive.
+     */
+    active?: boolean | undefined;
+    /**
+     * Email of the customer associated with the cart.
+     */
+    customerEmail?: string | null | undefined;
+    /**
+     * Phone number of the customer.
+     */
+    customerPhone?: string | null | undefined;
+    /**
+     * customer note for shipping or product customization.
+     */
+    customerNote?: string | null | undefined;
+    /**
+     * Indicates if a promotion is applied or not.
+     */
+    isPromotionApplied?: boolean | undefined;
+    /**
+     * Discount amount due to promotions(If Applied).
+     */
+    promotionDiscountAmount?: number | undefined;
+    /**
+     * Indicates if a coupon is applied or not.
+     */
+    isCouponApplied?: boolean | undefined;
+    /**
+     * Code of the applied coupon.
+     */
+    couponCode?: string | null | undefined;
+    /**
+     * Discount amount due to the coupon.
+     */
+    couponDiscountAmount?: number | undefined;
+    /**
+     * Indicates if items in the cart are on subscription.
+     */
+    onSubscription?: boolean | undefined;
+    /**
+     * Subtotal amount for items in the cart.
+     */
+    subtotal?: number | undefined;
+    /**
+     * Total tax amount for items.
+     */
+    itemTotalTax?: number | undefined;
+    /**
+     * Subtotal including tax.
+     */
+    subtotalIncludingTax?: number | undefined;
+    /**
+     * Shipping cost.
+     */
+    shippingAmount?: number | undefined;
+    /**
+     * Total tax amount for shipping.
+     */
+    shippingTotalTax?: number | undefined;
+    /**
+     * Shipping cost including tax.
+     */
+    shippingAmountIncludingTax?: number | undefined;
+    /**
+     * Total tax amount for the entire cart.
+     */
+    totalTax?: number | undefined;
+    /**
+     * Grand total amount for the cart.
+     */
+    grandTotal?: number | undefined;
+    /**
+     * Amount of credit balance used.
+     */
+    creditBalanceUsed?: number | undefined;
+    /**
+     * Amount to be paid by the customer.
+     */
+    toBePaid?: number | undefined;
+    /**
+     * Number of loyalty points redeemed.
+     */
+    loyaltyPointRedeemed?: number | undefined;
+    /**
+     * Number of loyalty points earned.
+     */
+    loyaltyPointEarned?: number | undefined;
+    /**
+     * Number of items in the cart.
+     */
+    cartItemsCount?: number | undefined;
+    /**
+     * List containing detailed information about each item in the cart.
+     */
+    cartItems?: Array<CartItem> | undefined;
+    billingAddress?: CustomerAddress | null | undefined;
+    shippingAddress?: CustomerAddress | null | undefined;
+    currency?: Currency | undefined;
+    /**
+     * Additional metadata associated with the cart. The example includes an empty object in the list.
+     */
+    metadata?: Array<CartMetadata> | undefined;
+    /**
+     * the expiration timestamp of the shopping cart. .
+     *
+     * @remarks
+     *
+     */
+    expiresAt?: Date | undefined;
+};
+
+/** @internal */
+export const CartMetadata$inboundSchema: z.ZodType<CartMetadata, z.ZodTypeDef, unknown> = z.object(
+    {}
+);
+
+/** @internal */
+export type CartMetadata$Outbound = {};
+
+/** @internal */
+export const CartMetadata$outboundSchema: z.ZodType<
+    CartMetadata$Outbound,
+    z.ZodTypeDef,
+    CartMetadata
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CartMetadata$ {
+    /** @deprecated use `CartMetadata$inboundSchema` instead. */
+    export const inboundSchema = CartMetadata$inboundSchema;
+    /** @deprecated use `CartMetadata$outboundSchema` instead. */
+    export const outboundSchema = CartMetadata$outboundSchema;
+    /** @deprecated use `CartMetadata$Outbound` instead. */
+    export type Outbound = CartMetadata$Outbound;
+}
+
+/** @internal */
+export const Cart$inboundSchema: z.ZodType<Cart, z.ZodTypeDef, unknown> = z
+    .object({
+        id: z.string().optional(),
+        active: z.boolean().optional(),
+        customer_email: z.nullable(z.string()).optional(),
+        customer_phone: z.nullable(z.string()).optional(),
+        customer_note: z.nullable(z.string()).optional(),
+        is_promotion_applied: z.boolean().optional(),
+        promotion_discount_amount: z.number().optional(),
+        is_coupon_applied: z.boolean().optional(),
+        coupon_code: z.nullable(z.string()).optional(),
+        coupon_discount_amount: z.number().optional(),
+        on_subscription: z.boolean().optional(),
+        subtotal: z.number().optional(),
+        item_total_tax: z.number().optional(),
+        subtotal_including_tax: z.number().optional(),
+        shipping_amount: z.number().optional(),
+        shipping_total_tax: z.number().optional(),
+        shipping_amount_including_tax: z.number().optional(),
+        total_tax: z.number().optional(),
+        grand_total: z.number().optional(),
+        credit_balance_used: z.number().optional(),
+        to_be_paid: z.number().optional(),
+        loyalty_point_redeemed: z.number().int().optional(),
+        loyalty_point_earned: z.number().int().optional(),
+        cart_items_count: z.number().int().optional(),
+        cart_items: z.array(CartItem$inboundSchema).optional(),
+        billing_address: z.nullable(CustomerAddress$inboundSchema).optional(),
+        shipping_address: z.nullable(CustomerAddress$inboundSchema).optional(),
+        currency: Currency$inboundSchema.optional(),
+        metadata: z.array(z.lazy(() => CartMetadata$inboundSchema)).optional(),
+        expires_at: z
+            .string()
+            .datetime({ offset: true })
+            .transform((v) => new Date(v))
+            .optional(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            customer_email: "customerEmail",
+            customer_phone: "customerPhone",
+            customer_note: "customerNote",
+            is_promotion_applied: "isPromotionApplied",
+            promotion_discount_amount: "promotionDiscountAmount",
+            is_coupon_applied: "isCouponApplied",
+            coupon_code: "couponCode",
+            coupon_discount_amount: "couponDiscountAmount",
+            on_subscription: "onSubscription",
+            item_total_tax: "itemTotalTax",
+            subtotal_including_tax: "subtotalIncludingTax",
+            shipping_amount: "shippingAmount",
+            shipping_total_tax: "shippingTotalTax",
+            shipping_amount_including_tax: "shippingAmountIncludingTax",
+            total_tax: "totalTax",
+            grand_total: "grandTotal",
+            credit_balance_used: "creditBalanceUsed",
+            to_be_paid: "toBePaid",
+            loyalty_point_redeemed: "loyaltyPointRedeemed",
+            loyalty_point_earned: "loyaltyPointEarned",
+            cart_items_count: "cartItemsCount",
+            cart_items: "cartItems",
+            billing_address: "billingAddress",
+            shipping_address: "shippingAddress",
+            expires_at: "expiresAt",
+        });
+    });
+
+/** @internal */
+export type Cart$Outbound = {
+    id?: string | undefined;
+    active?: boolean | undefined;
+    customer_email?: string | null | undefined;
+    customer_phone?: string | null | undefined;
+    customer_note?: string | null | undefined;
+    is_promotion_applied?: boolean | undefined;
+    promotion_discount_amount?: number | undefined;
+    is_coupon_applied?: boolean | undefined;
+    coupon_code?: string | null | undefined;
+    coupon_discount_amount?: number | undefined;
+    on_subscription?: boolean | undefined;
+    subtotal?: number | undefined;
+    item_total_tax?: number | undefined;
+    subtotal_including_tax?: number | undefined;
+    shipping_amount?: number | undefined;
+    shipping_total_tax?: number | undefined;
+    shipping_amount_including_tax?: number | undefined;
+    total_tax?: number | undefined;
+    grand_total?: number | undefined;
+    credit_balance_used?: number | undefined;
+    to_be_paid?: number | undefined;
+    loyalty_point_redeemed?: number | undefined;
+    loyalty_point_earned?: number | undefined;
+    cart_items_count?: number | undefined;
+    cart_items?: Array<CartItem$Outbound> | undefined;
+    billing_address?: CustomerAddress$Outbound | null | undefined;
+    shipping_address?: CustomerAddress$Outbound | null | undefined;
+    currency?: Currency$Outbound | undefined;
+    metadata?: Array<CartMetadata$Outbound> | undefined;
+    expires_at?: string | undefined;
+};
+
+/** @internal */
+export const Cart$outboundSchema: z.ZodType<Cart$Outbound, z.ZodTypeDef, Cart> = z
+    .object({
+        id: z.string().optional(),
+        active: z.boolean().optional(),
+        customerEmail: z.nullable(z.string()).optional(),
+        customerPhone: z.nullable(z.string()).optional(),
+        customerNote: z.nullable(z.string()).optional(),
+        isPromotionApplied: z.boolean().optional(),
+        promotionDiscountAmount: z.number().optional(),
+        isCouponApplied: z.boolean().optional(),
+        couponCode: z.nullable(z.string()).optional(),
+        couponDiscountAmount: z.number().optional(),
+        onSubscription: z.boolean().optional(),
+        subtotal: z.number().optional(),
+        itemTotalTax: z.number().optional(),
+        subtotalIncludingTax: z.number().optional(),
+        shippingAmount: z.number().optional(),
+        shippingTotalTax: z.number().optional(),
+        shippingAmountIncludingTax: z.number().optional(),
+        totalTax: z.number().optional(),
+        grandTotal: z.number().optional(),
+        creditBalanceUsed: z.number().optional(),
+        toBePaid: z.number().optional(),
+        loyaltyPointRedeemed: z.number().int().optional(),
+        loyaltyPointEarned: z.number().int().optional(),
+        cartItemsCount: z.number().int().optional(),
+        cartItems: z.array(CartItem$outboundSchema).optional(),
+        billingAddress: z.nullable(CustomerAddress$outboundSchema).optional(),
+        shippingAddress: z.nullable(CustomerAddress$outboundSchema).optional(),
+        currency: Currency$outboundSchema.optional(),
+        metadata: z.array(z.lazy(() => CartMetadata$outboundSchema)).optional(),
+        expiresAt: z
+            .date()
+            .transform((v) => v.toISOString())
+            .optional(),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            customerEmail: "customer_email",
+            customerPhone: "customer_phone",
+            customerNote: "customer_note",
+            isPromotionApplied: "is_promotion_applied",
+            promotionDiscountAmount: "promotion_discount_amount",
+            isCouponApplied: "is_coupon_applied",
+            couponCode: "coupon_code",
+            couponDiscountAmount: "coupon_discount_amount",
+            onSubscription: "on_subscription",
+            itemTotalTax: "item_total_tax",
+            subtotalIncludingTax: "subtotal_including_tax",
+            shippingAmount: "shipping_amount",
+            shippingTotalTax: "shipping_total_tax",
+            shippingAmountIncludingTax: "shipping_amount_including_tax",
+            totalTax: "total_tax",
+            grandTotal: "grand_total",
+            creditBalanceUsed: "credit_balance_used",
+            toBePaid: "to_be_paid",
+            loyaltyPointRedeemed: "loyalty_point_redeemed",
+            loyaltyPointEarned: "loyalty_point_earned",
+            cartItemsCount: "cart_items_count",
+            cartItems: "cart_items",
+            billingAddress: "billing_address",
+            shippingAddress: "shipping_address",
+            expiresAt: "expires_at",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Cart$ {
+    /** @deprecated use `Cart$inboundSchema` instead. */
+    export const inboundSchema = Cart$inboundSchema;
+    /** @deprecated use `Cart$outboundSchema` instead. */
+    export const outboundSchema = Cart$outboundSchema;
+    /** @deprecated use `Cart$Outbound` instead. */
+    export type Outbound = Cart$Outbound;
+}