b23-lib 1.7.0 → 1.7.2

package/dist/Classes/Payment.d.ts

@@ -0,0 +1,161 @@
+import BaseModel, { BaseAttributes, BaseData } from './Base.js';
+import { CurrencyCode, ISODateTime } from './Common.js';
+import './Enum.js';
+
+declare enum PaymentStatus {
+    PENDING = "PENDING",
+    AUTHORIZED = "AUTHORIZED",
+    CAPTURED = "CAPTURED",
+    FAILED = "FAILED",
+    REFUNDED = "REFUNDED",
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED"
+}
+declare enum PaymentMode {
+    PAY_LATER = "PAY_LATER",
+    CARD = "CARD",
+    CASH = "CASH",
+    NET_BANKING = "NET_BANKING",
+    WALLET = "WALLET",
+    COD = "COD",
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * Input attributes for creating or updating a PaymentModel.
+ */
+type PaymentAttributes = BaseAttributes & {
+    txnId: string;
+    externalId?: string;
+    orderNumber: string;
+    customerId: string;
+    status: PaymentStatus;
+    subStatus?: string;
+    amount: number;
+    currency: CurrencyCode;
+    paymentMode: PaymentMode;
+    gatewayResponse?: string;
+    gatewayErrorCode?: string;
+    gatewayErrorMessage?: string;
+    amountRefunded?: number;
+    cardLast4?: string;
+    cardBrand?: string;
+    transactionAt: ISODateTime;
+};
+/**
+ * Output data structure for a PaymentModel.
+ * Excludes potentially large or sensitive fields by default.
+ */
+type PaymentData = Omit<PaymentAttributes, 'gatewayResponse' | 'gatewayErrorMessage'> & BaseData;
+/**
+ * Represents a payment transaction, attempt, or record associated with an order.
+ */
+declare class PaymentModel extends BaseModel {
+    protected txnId: string;
+    protected externalId?: string;
+    protected orderNumber: string;
+    protected customerId: string;
+    protected status: PaymentStatus;
+    protected subStatus?: string;
+    protected amount: number;
+    protected currency: CurrencyCode;
+    protected paymentMode: PaymentMode;
+    protected gatewayResponse?: string;
+    protected gatewayErrorCode?: string;
+    protected gatewayErrorMessage?: string;
+    protected amountRefunded: number;
+    protected cardLast4?: string;
+    protected cardBrand?: string;
+    protected transactionAt: ISODateTime;
+    /**
+     * Creates an instance of PaymentModel.
+     * @param data - The initial payment attributes.
+     * @param date - Optional date object for setting creation/modification times (defaults to now).
+     */
+    constructor(data: PaymentAttributes, date?: Date);
+    /**
+     * Gets the primary transaction identifier.
+     * @returns The transaction ID string.
+     */
+    getTxnId(): string;
+    /**
+     * Gets the external identifier, often from a payment gateway.
+     * @returns The external ID string, or undefined if not set.
+     */
+    getExternalId(): string | undefined;
+    /**
+     * Gets the order number associated with this payment.
+     * @returns The order number string.
+     */
+    getOrderNumber(): string;
+    /**
+     * Gets the customer ID associated with this payment.
+     * @returns The customer ID string.
+     */
+    getCustomerId(): string;
+    /**
+     * Gets the current status of the payment (e.g., PENDING, CAPTURED).
+     * @returns The PaymentStatus enum value.
+     */
+    getStatus(): PaymentStatus;
+    /**
+     * Gets the detailed sub-status, often provided by the payment gateway.
+     * @returns The sub-status string, or undefined if not set.
+     */
+    getSubStatus(): string | undefined;
+    /**
+     * Gets the amount of the payment transaction.
+     * @returns The payment amount number.
+     */
+    getAmount(): number;
+    /**
+     * Gets the currency code for the payment amount.
+     * @returns The CurrencyCode enum value.
+     */
+    getCurrency(): CurrencyCode;
+    /**
+     * Gets the mode or method used for the payment (e.g., CARD, COD).
+     * @returns The PaymentMode enum value.
+     */
+    getPaymentMode(): PaymentMode;
+    /**
+     * Gets the raw response data from the payment gateway (potentially large).
+     * @returns The gateway response string, or undefined if not set.
+     */
+    getGatewayResponse(): string | undefined;
+    /**
+     * Gets the error code returned by the payment gateway, if any.
+     * @returns The gateway error code string, or undefined if no error occurred or wasn't recorded.
+     */
+    getGatewayErrorCode(): string | undefined;
+    /**
+     * Gets the error message returned by the payment gateway, if any.
+     * @returns The gateway error message string, or undefined if no error occurred or wasn't recorded.
+     */
+    getGatewayErrorMessage(): string | undefined;
+    /**
+     * Gets the total amount that has been refunded for this transaction.
+     * @returns The refunded amount number (defaults to 0).
+     */
+    getAmountRefunded(): number;
+    /**
+     * Gets the last 4 digits of the card used, if applicable.
+     * @returns The card's last 4 digits string, or undefined.
+     */
+    getCardLast4(): string | undefined;
+    /**
+     * Gets the brand of the card used (e.g., Visa, Mastercard), if applicable.
+     * @returns The card brand string, or undefined.
+     */
+    getCardBrand(): string | undefined;
+    /**
+     * Gets the timestamp when the transaction occurred or was recorded.
+     * @returns The transaction timestamp as an ISO 8601 string.
+     */
+    getTransactionAt(): ISODateTime;
+    /**
+     * Gets a plain data object representing the payment's current state.
+     * @returns PaymentData object suitable for serialization or API responses.
+     */
+    getDetails(): PaymentData;
+}
+
+export { type PaymentAttributes, type PaymentData, PaymentMode, PaymentStatus, PaymentModel as default };

package/dist/Classes/Payment.js

@@ -0,0 +1,2 @@
+'use strict';Object.defineProperty(exports,'__esModule',{value:true});var i=class{customFields;version;createdAt;modifiedAt;modifiedBy;constructor(t,r=new Date){this.customFields={...t.customFields},this.version=t.version??1,this.createdAt=t.createdAt&&!isNaN(Date.parse(t.createdAt))?new Date(t.createdAt).toISOString():r.toISOString(),this.modifiedAt=t.modifiedAt&&!isNaN(Date.parse(t.modifiedAt))?new Date(t.modifiedAt).toISOString():r.toISOString(),this.modifiedBy=t.modifiedBy??"";}getDetails(){return {customFields:this.getAllCustomFields(),version:this.getVersion(),createdAt:this.getCreatedAt(),modifiedAt:this.getModifiedAt(),modifiedBy:this.getModifiedBy()}}getVersion(){return this.version}getCreatedAt(){return this.createdAt}getCreatedAtTime(){return new Date(this.createdAt).getTime()}getModifiedAt(){return this.modifiedAt}getModifiedAtTime(){return new Date(this.modifiedAt).getTime()}getModifiedBy(){return this.modifiedBy}setModifiedBy(t){this.modifiedBy=t;}getCustomField(t){return this.customFields[t]??null}setCustomField(t,r){this.customFields[t]=r;}getAllCustomFields(){return {...this.customFields}}};var u=(s=>(s.PENDING="PENDING",s.AUTHORIZED="AUTHORIZED",s.CAPTURED="CAPTURED",s.FAILED="FAILED",s.REFUNDED="REFUNDED",s.PARTIALLY_REFUNDED="PARTIALLY_REFUNDED",s))(u||{}),a=(e=>(e.PAY_LATER="PAY_LATER",e.CARD="CARD",e.CASH="CASH",e.NET_BANKING="NET_BANKING",e.WALLET="WALLET",e.COD="COD",e.UNKNOWN="UNKNOWN",e))(a||{}),n=class extends i{txnId;externalId;orderNumber;customerId;status;subStatus;amount;currency;paymentMode;gatewayResponse;gatewayErrorCode;gatewayErrorMessage;amountRefunded;cardLast4;cardBrand;transactionAt;constructor(t,r=new Date){super(t,r),this.txnId=t.txnId,this.externalId=t.externalId,this.orderNumber=t.orderNumber,this.customerId=t.customerId,this.status=t.status,this.subStatus=t.subStatus,this.amount=t.amount,this.currency=t.currency,this.paymentMode=t.paymentMode,this.gatewayResponse=t.gatewayResponse,this.gatewayErrorCode=t.gatewayErrorCode,this.gatewayErrorMessage=t.gatewayErrorMessage,this.amountRefunded=t.amountRefunded||0,this.cardLast4=t.cardLast4,this.cardBrand=t.cardBrand,this.transactionAt=t.transactionAt;}getTxnId(){return this.txnId}getExternalId(){return this.externalId}getOrderNumber(){return this.orderNumber}getCustomerId(){return this.customerId}getStatus(){return this.status}getSubStatus(){return this.subStatus}getAmount(){return this.amount}getCurrency(){return this.currency}getPaymentMode(){return this.paymentMode}getGatewayResponse(){return this.gatewayResponse}getGatewayErrorCode(){return this.gatewayErrorCode}getGatewayErrorMessage(){return this.gatewayErrorMessage}getAmountRefunded(){return this.amountRefunded}getCardLast4(){return this.cardLast4}getCardBrand(){return this.cardBrand}getTransactionAt(){return this.transactionAt}getDetails(){return {...super.getDetails(),txnId:this.getTxnId(),externalId:this.getExternalId(),orderNumber:this.getOrderNumber(),customerId:this.getCustomerId(),status:this.getStatus(),subStatus:this.getSubStatus(),amount:this.getAmount(),currency:this.getCurrency(),paymentMode:this.getPaymentMode(),gatewayErrorCode:this.getGatewayErrorCode(),amountRefunded:this.getAmountRefunded(),cardLast4:this.getCardLast4(),cardBrand:this.getCardBrand(),transactionAt:this.getTransactionAt()}}};exports.PaymentMode=a;exports.PaymentStatus=u;exports.default=n;//# sourceMappingURL=Payment.js.map
+//# sourceMappingURL=Payment.js.map

package/dist/Classes/Payment.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Classes/Base.ts","../../src/Classes/Payment.ts"],"names":["BaseModel","data","date","modifiedBy","fieldName","value","PaymentStatus","PaymentMode","PaymentModel"],"mappings":"sEA0BA,IAAqBA,CAAAA,CAArB,KAA+B,CACnB,YACA,CAAA,OAAA,CACA,SACA,CAAA,UAAA,CACA,UAQV,CAAA,WAAA,CAAYC,CAAsBC,CAAAA,CAAAA,CAAa,IAAI,IAAA,CAAQ,CACzD,IAAK,CAAA,YAAA,CAAe,CAAE,GAAGD,CAAK,CAAA,YAAa,CAC3C,CAAA,IAAA,CAAK,OAAUA,CAAAA,CAAAA,CAAK,OAAW,EAAA,CAAA,CAC/B,IAAK,CAAA,SAAA,CAAYA,EAAK,SAAa,EAAA,CAAC,KAAM,CAAA,IAAA,CAAK,KAAMA,CAAAA,CAAAA,CAAK,SAAS,CAAC,CAElE,CAAA,IAAI,IAAKA,CAAAA,CAAAA,CAAK,SAAS,CAAA,CAAE,WAAY,EAAA,CAErCC,CAAK,CAAA,WAAA,EACP,CAAA,IAAA,CAAK,UAAaD,CAAAA,CAAAA,CAAK,UAAc,EAAA,CAAC,KAAM,CAAA,IAAA,CAAK,KAAMA,CAAAA,CAAAA,CAAK,UAAU,CAAC,EACnE,IAAI,IAAA,CAAKA,CAAK,CAAA,UAAU,CAAE,CAAA,WAAA,EAC1BC,CAAAA,CAAAA,CAAK,WAAY,EAAA,CAErB,IAAK,CAAA,UAAA,CAAaD,CAAK,CAAA,UAAA,EAAc,GACvC,CAMA,UAAuB,EAAA,CACrB,OAAO,CACL,YAAc,CAAA,IAAA,CAAK,kBAAmB,EAAA,CACtC,OAAS,CAAA,IAAA,CAAK,UAAW,EAAA,CACzB,SAAW,CAAA,IAAA,CAAK,cAChB,CAAA,UAAA,CAAY,IAAK,CAAA,aAAA,EACjB,CAAA,UAAA,CAAY,IAAK,CAAA,aAAA,EACnB,CACF,CAMA,UAAA,EAAqB,CACnB,OAAO,IAAK,CAAA,OACd,CAMA,YAAA,EAAuB,CACrB,OAAO,IAAK,CAAA,SACd,CAMA,gBAAA,EAA2B,CACzB,OAAO,IAAI,IAAA,CAAK,IAAK,CAAA,SAAS,EAAE,OAAQ,EAC1C,CAOA,aAAA,EAAwB,CACtB,OAAO,IAAK,CAAA,UACd,CAMA,iBAAA,EAA4B,CAC1B,OAAO,IAAI,IAAA,CAAK,KAAK,UAAU,CAAA,CAAE,OAAQ,EAC3C,CAMA,aAAA,EAAwB,CACtB,OAAO,IAAK,CAAA,UACd,CAMA,aAAA,CAAcE,CAA0B,CAAA,CACtC,KAAK,UAAaA,CAAAA,EACpB,CAOA,cAAA,CAAeC,CAAwB,CAAA,CACrC,OAAO,IAAA,CAAK,YAAaA,CAAAA,CAAS,CAAK,EAAA,IACzC,CAQA,cAAA,CAAeA,CAAmBC,CAAAA,CAAAA,CAAkB,CAClD,IAAA,CAAK,YAAaD,CAAAA,CAAS,CAAIC,CAAAA,EACjC,CAMA,kBAAA,EAAmC,CACjC,OAAO,CAAE,GAAG,IAAK,CAAA,YAAa,CAChC,CACF,CAAA,CCpJYC,IAAAA,CAAAA,CAAAA,CAAAA,CAAAA,GACVA,CAAA,CAAA,OAAA,CAAU,SACVA,CAAAA,CAAAA,CAAA,UAAa,CAAA,YAAA,CACbA,CAAA,CAAA,QAAA,CAAW,UACXA,CAAAA,CAAAA,CAAA,MAAS,CAAA,QAAA,CACTA,CAAA,CAAA,QAAA,CAAW,UACXA,CAAAA,CAAAA,CAAA,kBAAqB,CAAA,oBAAA,CANXA,CAAA,CAAA,EAAA,CAAA,EAAA,EAAA,CAAA,CASAC,CACVA,CAAAA,CAAAA,CAAAA,GAAAA,CAAAA,CAAA,SAAY,CAAA,WAAA,CACZA,CAAA,CAAA,IAAA,CAAO,OACPA,CAAA,CAAA,IAAA,CAAO,MACPA,CAAAA,CAAAA,CAAA,WAAc,CAAA,aAAA,CACdA,CAAA,CAAA,MAAA,CAAS,QACTA,CAAAA,CAAAA,CAAA,GAAM,CAAA,KAAA,CACNA,CAAA,CAAA,OAAA,CAAU,SAPAA,CAAAA,CAAAA,CAAAA,EAAAA,CAAAA,EAAA,EAyCSC,CAAAA,CAAAA,CAAAA,CAArB,cAA0CR,CAAU,CACxC,KAAA,CACA,UACA,CAAA,WAAA,CACA,UACA,CAAA,MAAA,CACA,SACA,CAAA,MAAA,CACA,QACA,CAAA,WAAA,CACA,gBACA,gBACA,CAAA,mBAAA,CACA,cACA,CAAA,SAAA,CACA,SACA,CAAA,aAAA,CAOV,WAAYC,CAAAA,CAAAA,CAAyBC,CAAa,CAAA,IAAI,IAAQ,CAAA,CAC5D,KAAMD,CAAAA,CAAAA,CAAMC,CAAI,CAGhB,CAAA,IAAA,CAAK,KAAQD,CAAAA,CAAAA,CAAK,KAClB,CAAA,IAAA,CAAK,UAAaA,CAAAA,CAAAA,CAAK,UACvB,CAAA,IAAA,CAAK,WAAcA,CAAAA,CAAAA,CAAK,WACxB,CAAA,IAAA,CAAK,WAAaA,CAAK,CAAA,UAAA,CACvB,IAAK,CAAA,MAAA,CAASA,CAAK,CAAA,MAAA,CACnB,IAAK,CAAA,SAAA,CAAYA,CAAK,CAAA,SAAA,CACtB,IAAK,CAAA,MAAA,CAASA,CAAK,CAAA,MAAA,CACnB,IAAK,CAAA,QAAA,CAAWA,CAAK,CAAA,QAAA,CACrB,IAAK,CAAA,WAAA,CAAcA,CAAK,CAAA,WAAA,CACxB,IAAK,CAAA,eAAA,CAAkBA,CAAK,CAAA,eAAA,CAC5B,IAAK,CAAA,gBAAA,CAAmBA,CAAK,CAAA,gBAAA,CAC7B,KAAK,mBAAsBA,CAAAA,CAAAA,CAAK,mBAChC,CAAA,IAAA,CAAK,cAAiBA,CAAAA,CAAAA,CAAK,cAAkB,EAAA,CAAA,CAC7C,IAAK,CAAA,SAAA,CAAYA,CAAK,CAAA,SAAA,CACtB,IAAK,CAAA,SAAA,CAAYA,CAAK,CAAA,SAAA,CACtB,IAAK,CAAA,aAAA,CAAgBA,CAAK,CAAA,cAC5B,CAMO,QAAA,EAAmB,CAAE,OAAO,IAAK,CAAA,KAAO,CAMxC,aAAA,EAAoC,CAAE,OAAO,KAAK,UAAY,CAM9D,cAAyB,EAAA,CAAE,OAAO,IAAA,CAAK,WAAa,CAMpD,aAAwB,EAAA,CAAE,OAAO,IAAA,CAAK,UAAY,CAMlD,SAA2B,EAAA,CAAE,OAAO,IAAA,CAAK,MAAQ,CAMjD,YAAmC,EAAA,CAAE,OAAO,IAAA,CAAK,SAAW,CAM5D,SAAoB,EAAA,CAAE,OAAO,IAAA,CAAK,MAAQ,CAM1C,WAAA,EAA4B,CAAE,OAAO,IAAK,CAAA,QAAU,CAMpD,cAAA,EAA8B,CAAE,OAAO,IAAK,CAAA,WAAa,CAMzD,kBAAA,EAAyC,CAAE,OAAO,IAAA,CAAK,eAAiB,CAMxE,mBAA0C,EAAA,CAAE,OAAO,IAAA,CAAK,gBAAkB,CAM1E,sBAA6C,EAAA,CAAE,OAAO,IAAA,CAAK,mBAAqB,CAMhF,iBAAA,EAA4B,CAAE,OAAO,IAAK,CAAA,cAAgB,CAM1D,YAAA,EAAmC,CAAE,OAAO,IAAK,CAAA,SAAW,CAM5D,YAAA,EAAmC,CAAE,OAAO,IAAK,CAAA,SAAW,CAM5D,gBAAA,EAAgC,CAAE,OAAO,IAAK,CAAA,aAAe,CAOpE,UAAA,EAA0B,CAExB,OAAO,CACL,GAFkB,MAAM,UAAW,EAAA,CAGnC,KAAO,CAAA,IAAA,CAAK,QAAS,EAAA,CACrB,UAAY,CAAA,IAAA,CAAK,aAAc,EAAA,CAC/B,WAAa,CAAA,IAAA,CAAK,cAAe,EAAA,CACjC,UAAY,CAAA,IAAA,CAAK,aAAc,EAAA,CAC/B,MAAQ,CAAA,IAAA,CAAK,SAAU,EAAA,CACvB,SAAW,CAAA,IAAA,CAAK,YAAa,EAAA,CAC7B,MAAQ,CAAA,IAAA,CAAK,SAAU,EAAA,CACvB,SAAU,IAAK,CAAA,WAAA,EACf,CAAA,WAAA,CAAa,IAAK,CAAA,cAAA,EAClB,CAAA,gBAAA,CAAkB,IAAK,CAAA,mBAAA,EACvB,CAAA,cAAA,CAAgB,IAAK,CAAA,iBAAA,EACrB,CAAA,SAAA,CAAW,IAAK,CAAA,YAAA,EAChB,CAAA,SAAA,CAAW,IAAK,CAAA,YAAA,EAChB,CAAA,aAAA,CAAe,IAAK,CAAA,gBAAA,EACtB,CACF,CACF","file":"Payment.js","sourcesContent":["import { ISODateTime } from \"./Common\";\r\n\r\nexport interface CustomFields {\r\n  [key: string]: any;\r\n}\r\n\r\nexport type BaseAttributes = {\r\n  customFields?: CustomFields;\r\n  version?: number;\r\n  createdAt?: ISODateTime;\r\n  modifiedAt?: ISODateTime;\r\n  modifiedBy?: string;\r\n};\r\n\r\nexport type BaseData = {\r\n  customFields: CustomFields;\r\n  version: number;\r\n  createdAt: ISODateTime;\r\n  modifiedAt: ISODateTime;\r\n  modifiedBy: string;\r\n};\r\n\r\n/**\r\n * Provides common foundational properties and methods for other data models.\r\n * Handles tracking of custom fields, versioning, and timestamps.\r\n */\r\nexport default class BaseModel {\r\n  protected customFields: CustomFields;\r\n  protected version: number;\r\n  protected createdAt: ISODateTime;\r\n  protected modifiedAt: ISODateTime;\r\n  protected modifiedBy: string;\r\n\r\n  /**\r\n   * Creates an instance of BaseModel.\r\n   * Initializes common properties like timestamps, version, and custom fields.\r\n   * @param data - Optional initial attributes for the base model.\r\n   * @param date - Optional date object to use for default timestamps (defaults to current time).\r\n   */\r\n  constructor(data: BaseAttributes, date: Date = new Date()) {\r\n    this.customFields = { ...data.customFields };\r\n    this.version = data.version ?? 1;\r\n    this.createdAt = data.createdAt && !isNaN(Date.parse(data.createdAt))\r\n      ?\r\n      new Date(data.createdAt).toISOString()\r\n      :\r\n      date.toISOString();\r\n    this.modifiedAt = data.modifiedAt && !isNaN(Date.parse(data.modifiedAt))\r\n      ? new Date(data.modifiedAt).toISOString()\r\n      : date.toISOString();\r\n\r\n    this.modifiedBy = data.modifiedBy ?? '';\r\n  }\r\n\r\n  /**\r\n   * Gets a plain data object representing the base model's current state.\r\n   * @returns BaseData object containing common properties.\r\n   */\r\n  getDetails(): BaseData {\r\n    return {\r\n      customFields: this.getAllCustomFields(), // Use getter to return a copy\r\n      version: this.getVersion(),\r\n      createdAt: this.getCreatedAt(),\r\n      modifiedAt: this.getModifiedAt(),\r\n      modifiedBy: this.getModifiedBy(),\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the current version number of the model instance.\r\n   * @returns The version number.\r\n   */\r\n  getVersion(): number {\r\n    return this.version;\r\n  }\r\n\r\n  /**\r\n   * Gets the creation timestamp as an ISO 8601 string.\r\n   * @returns The creation timestamp string.\r\n   */\r\n  getCreatedAt(): string {\r\n    return this.createdAt;\r\n  }\r\n\r\n  /**\r\n   * Gets the creation timestamp as a Unix epoch time (milliseconds).\r\n   * @returns The creation time in milliseconds since the epoch.\r\n   */\r\n  getCreatedAtTime(): number {\r\n    return new Date(this.createdAt).getTime();\r\n  }\r\n\r\n\r\n  /**\r\n   * Gets the last modification timestamp as an ISO 8601 string.\r\n   * @returns The last modification timestamp string.\r\n   */\r\n  getModifiedAt(): string {\r\n    return this.modifiedAt;\r\n  }\r\n\r\n  /**\r\n   * Gets the last modification timestamp as a Unix epoch time (milliseconds).\r\n   * @returns The last modification time in milliseconds since the epoch.\r\n   */\r\n  getModifiedAtTime(): number {\r\n    return new Date(this.modifiedAt).getTime();\r\n  }\r\n\r\n  /**\r\n   * Gets the identifier of the user or process that last modified the instance.\r\n   * @returns The modifier identifier string.\r\n   */\r\n  getModifiedBy(): string {\r\n    return this.modifiedBy;\r\n  }\r\n\r\n  /**\r\n   * Sets the identifier of the user or process that last modified the instance.\r\n   * @param modifiedBy - The identifier string.\r\n   */\r\n  setModifiedBy(modifiedBy: string): void {\r\n    this.modifiedBy = modifiedBy;\r\n  }\r\n\r\n  /**\r\n   * Retrieves the value of a specific custom field.\r\n   * @param fieldName - The name (key) of the custom field to retrieve.\r\n   * @returns The value of the custom field, or null if the field does not exist.\r\n   */\r\n  getCustomField(fieldName: string): any {\r\n    return this.customFields[fieldName] ?? null;\r\n  }\r\n\r\n  /**\r\n   * Sets the value of a specific custom field.\r\n   * Also updates the modification timestamp and increments the version.\r\n   * @param fieldName - The name (key) of the custom field to set.\r\n   * @param value - The value to assign to the custom field.\r\n   */\r\n  setCustomField(fieldName: string, value: any): void {\r\n    this.customFields[fieldName] = value;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a shallow copy of all custom fields associated with the instance.\r\n   * @returns An object containing all custom fields.\r\n   */\r\n  getAllCustomFields(): CustomFields {\r\n    return { ...this.customFields };\r\n  }\r\n}\r\n","import BaseModel, { BaseAttributes, BaseData } from \"./Base\";\r\nimport { CurrencyCode, ISODateTime } from \"./Common\";\r\n\r\nexport enum PaymentStatus {\r\n  PENDING = \"PENDING\",\r\n  AUTHORIZED = \"AUTHORIZED\",\r\n  CAPTURED = \"CAPTURED\",\r\n  FAILED = \"FAILED\",\r\n  REFUNDED = \"REFUNDED\",\r\n  PARTIALLY_REFUNDED = \"PARTIALLY_REFUNDED\",\r\n}\r\n\r\nexport enum PaymentMode {\r\n  PAY_LATER = \"PAY_LATER\",\r\n  CARD = \"CARD\",\r\n  CASH = \"CASH\",\r\n  NET_BANKING = \"NET_BANKING\",\r\n  WALLET = \"WALLET\",\r\n  COD = \"COD\",\r\n  UNKNOWN = \"UNKNOWN\",\r\n}\r\n\r\n/**\r\n * Input attributes for creating or updating a PaymentModel.\r\n */\r\nexport type PaymentAttributes = BaseAttributes & {\r\n  txnId: string;\r\n  externalId?: string;\r\n  orderNumber: string;\r\n  customerId: string;\r\n  status: PaymentStatus;\r\n  subStatus?: string;\r\n  amount: number;\r\n  currency: CurrencyCode;\r\n  paymentMode: PaymentMode;\r\n  gatewayResponse?: string;\r\n  gatewayErrorCode?: string;\r\n  gatewayErrorMessage?: string;\r\n  amountRefunded?: number;\r\n  cardLast4?: string;\r\n  cardBrand?: string;\r\n  transactionAt: ISODateTime;\r\n};\r\n\r\n/**\r\n * Output data structure for a PaymentModel.\r\n * Excludes potentially large or sensitive fields by default.\r\n */\r\nexport type PaymentData = Omit<PaymentAttributes, 'gatewayResponse' | 'gatewayErrorMessage'> & BaseData\r\n\r\n/**\r\n * Represents a payment transaction, attempt, or record associated with an order.\r\n */\r\nexport default class PaymentModel extends BaseModel {\r\n  protected txnId: string;\r\n  protected externalId?: string;\r\n  protected orderNumber: string;\r\n  protected customerId: string;\r\n  protected status: PaymentStatus;\r\n  protected subStatus?: string;\r\n  protected amount: number;\r\n  protected currency: CurrencyCode;\r\n  protected paymentMode: PaymentMode;\r\n  protected gatewayResponse?: string;\r\n  protected gatewayErrorCode?: string;\r\n  protected gatewayErrorMessage?: string;\r\n  protected amountRefunded: number;\r\n  protected cardLast4?: string;\r\n  protected cardBrand?: string;\r\n  protected transactionAt: ISODateTime;\r\n\r\n  /**\r\n   * Creates an instance of PaymentModel.\r\n   * @param data - The initial payment attributes.\r\n   * @param date - Optional date object for setting creation/modification times (defaults to now).\r\n   */\r\n  constructor(data: PaymentAttributes, date: Date = new Date()) {\r\n    super(data, date); // Pass BaseAttributes to parent\r\n\r\n    // Assign properties\r\n    this.txnId = data.txnId;\r\n    this.externalId = data.externalId;\r\n    this.orderNumber = data.orderNumber;\r\n    this.customerId = data.customerId;\r\n    this.status = data.status;\r\n    this.subStatus = data.subStatus;\r\n    this.amount = data.amount;\r\n    this.currency = data.currency;\r\n    this.paymentMode = data.paymentMode;\r\n    this.gatewayResponse = data.gatewayResponse;\r\n    this.gatewayErrorCode = data.gatewayErrorCode;\r\n    this.gatewayErrorMessage = data.gatewayErrorMessage;\r\n    this.amountRefunded = data.amountRefunded || 0; // Default to 0 if undefined\r\n    this.cardLast4 = data.cardLast4;\r\n    this.cardBrand = data.cardBrand;\r\n    this.transactionAt = data.transactionAt;\r\n  }\r\n\r\n  /**\r\n   * Gets the primary transaction identifier.\r\n   * @returns The transaction ID string.\r\n   */\r\n  public getTxnId(): string { return this.txnId; }\r\n\r\n  /**\r\n   * Gets the external identifier, often from a payment gateway.\r\n   * @returns The external ID string, or undefined if not set.\r\n   */\r\n  public getExternalId(): string | undefined { return this.externalId; }\r\n\r\n  /**\r\n   * Gets the order number associated with this payment.\r\n   * @returns The order number string.\r\n   */\r\n  public getOrderNumber(): string { return this.orderNumber; }\r\n\r\n  /**\r\n   * Gets the customer ID associated with this payment.\r\n   * @returns The customer ID string.\r\n   */\r\n  public getCustomerId(): string { return this.customerId; }\r\n\r\n  /**\r\n   * Gets the current status of the payment (e.g., PENDING, CAPTURED).\r\n   * @returns The PaymentStatus enum value.\r\n   */\r\n  public getStatus(): PaymentStatus { return this.status; }\r\n\r\n  /**\r\n   * Gets the detailed sub-status, often provided by the payment gateway.\r\n   * @returns The sub-status string, or undefined if not set.\r\n   */\r\n  public getSubStatus(): string | undefined { return this.subStatus; }\r\n\r\n  /**\r\n   * Gets the amount of the payment transaction.\r\n   * @returns The payment amount number.\r\n   */\r\n  public getAmount(): number { return this.amount; }\r\n\r\n  /**\r\n   * Gets the currency code for the payment amount.\r\n   * @returns The CurrencyCode enum value.\r\n   */\r\n  public getCurrency(): CurrencyCode { return this.currency; }\r\n\r\n  /**\r\n   * Gets the mode or method used for the payment (e.g., CARD, COD).\r\n   * @returns The PaymentMode enum value.\r\n   */\r\n  public getPaymentMode(): PaymentMode { return this.paymentMode; }\r\n\r\n  /**\r\n   * Gets the raw response data from the payment gateway (potentially large).\r\n   * @returns The gateway response string, or undefined if not set.\r\n   */\r\n  public getGatewayResponse(): string | undefined { return this.gatewayResponse; }\r\n\r\n  /**\r\n   * Gets the error code returned by the payment gateway, if any.\r\n   * @returns The gateway error code string, or undefined if no error occurred or wasn't recorded.\r\n   */\r\n  public getGatewayErrorCode(): string | undefined { return this.gatewayErrorCode; }\r\n\r\n  /**\r\n   * Gets the error message returned by the payment gateway, if any.\r\n   * @returns The gateway error message string, or undefined if no error occurred or wasn't recorded.\r\n   */\r\n  public getGatewayErrorMessage(): string | undefined { return this.gatewayErrorMessage; }\r\n\r\n  /**\r\n   * Gets the total amount that has been refunded for this transaction.\r\n   * @returns The refunded amount number (defaults to 0).\r\n   */\r\n  public getAmountRefunded(): number { return this.amountRefunded; }\r\n\r\n  /**\r\n   * Gets the last 4 digits of the card used, if applicable.\r\n   * @returns The card's last 4 digits string, or undefined.\r\n   */\r\n  public getCardLast4(): string | undefined { return this.cardLast4; }\r\n\r\n  /**\r\n   * Gets the brand of the card used (e.g., Visa, Mastercard), if applicable.\r\n   * @returns The card brand string, or undefined.\r\n   */\r\n  public getCardBrand(): string | undefined { return this.cardBrand; }\r\n\r\n  /**\r\n   * Gets the timestamp when the transaction occurred or was recorded.\r\n   * @returns The transaction timestamp as an ISO 8601 string.\r\n   */\r\n  public getTransactionAt(): ISODateTime { return this.transactionAt; }\r\n\r\n\r\n  /**\r\n   * Gets a plain data object representing the payment's current state.\r\n   * @returns PaymentData object suitable for serialization or API responses.\r\n   */\r\n  getDetails(): PaymentData {\r\n    const baseDetails = super.getDetails();\r\n    return {\r\n      ...baseDetails,\r\n      txnId: this.getTxnId(),\r\n      externalId: this.getExternalId(),\r\n      orderNumber: this.getOrderNumber(),\r\n      customerId: this.getCustomerId(),\r\n      status: this.getStatus(),\r\n      subStatus: this.getSubStatus(),\r\n      amount: this.getAmount(),\r\n      currency: this.getCurrency(),\r\n      paymentMode: this.getPaymentMode(),\r\n      gatewayErrorCode: this.getGatewayErrorCode(),\r\n      amountRefunded: this.getAmountRefunded(),\r\n      cardLast4: this.getCardLast4(),\r\n      cardBrand: this.getCardBrand(),\r\n      transactionAt: this.getTransactionAt(),\r\n    };\r\n  }\r\n}\r\n"]}

package/dist/Classes/Payment.mjs

@@ -0,0 +1,2 @@
+import {a}from'../chunk-SPLTJRHG.mjs';var u=(r=>(r.PENDING="PENDING",r.AUTHORIZED="AUTHORIZED",r.CAPTURED="CAPTURED",r.FAILED="FAILED",r.REFUNDED="REFUNDED",r.PARTIALLY_REFUNDED="PARTIALLY_REFUNDED",r))(u||{}),i=(e=>(e.PAY_LATER="PAY_LATER",e.CARD="CARD",e.CASH="CASH",e.NET_BANKING="NET_BANKING",e.WALLET="WALLET",e.COD="COD",e.UNKNOWN="UNKNOWN",e))(i||{}),s=class extends a{txnId;externalId;orderNumber;customerId;status;subStatus;amount;currency;paymentMode;gatewayResponse;gatewayErrorCode;gatewayErrorMessage;amountRefunded;cardLast4;cardBrand;transactionAt;constructor(t,a=new Date){super(t,a),this.txnId=t.txnId,this.externalId=t.externalId,this.orderNumber=t.orderNumber,this.customerId=t.customerId,this.status=t.status,this.subStatus=t.subStatus,this.amount=t.amount,this.currency=t.currency,this.paymentMode=t.paymentMode,this.gatewayResponse=t.gatewayResponse,this.gatewayErrorCode=t.gatewayErrorCode,this.gatewayErrorMessage=t.gatewayErrorMessage,this.amountRefunded=t.amountRefunded||0,this.cardLast4=t.cardLast4,this.cardBrand=t.cardBrand,this.transactionAt=t.transactionAt;}getTxnId(){return this.txnId}getExternalId(){return this.externalId}getOrderNumber(){return this.orderNumber}getCustomerId(){return this.customerId}getStatus(){return this.status}getSubStatus(){return this.subStatus}getAmount(){return this.amount}getCurrency(){return this.currency}getPaymentMode(){return this.paymentMode}getGatewayResponse(){return this.gatewayResponse}getGatewayErrorCode(){return this.gatewayErrorCode}getGatewayErrorMessage(){return this.gatewayErrorMessage}getAmountRefunded(){return this.amountRefunded}getCardLast4(){return this.cardLast4}getCardBrand(){return this.cardBrand}getTransactionAt(){return this.transactionAt}getDetails(){return {...super.getDetails(),txnId:this.getTxnId(),externalId:this.getExternalId(),orderNumber:this.getOrderNumber(),customerId:this.getCustomerId(),status:this.getStatus(),subStatus:this.getSubStatus(),amount:this.getAmount(),currency:this.getCurrency(),paymentMode:this.getPaymentMode(),gatewayErrorCode:this.getGatewayErrorCode(),amountRefunded:this.getAmountRefunded(),cardLast4:this.getCardLast4(),cardBrand:this.getCardBrand(),transactionAt:this.getTransactionAt()}}};export{i as PaymentMode,u as PaymentStatus,s as default};//# sourceMappingURL=Payment.mjs.map
+//# sourceMappingURL=Payment.mjs.map

package/dist/Classes/Payment.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Classes/Payment.ts"],"names":["PaymentStatus","PaymentMode","PaymentModel","BaseModel","data","date"],"mappings":"sCAGO,IAAKA,CACVA,CAAAA,CAAAA,CAAAA,GAAAA,CAAAA,CAAA,OAAU,CAAA,SAAA,CACVA,EAAA,UAAa,CAAA,YAAA,CACbA,CAAA,CAAA,QAAA,CAAW,WACXA,CAAA,CAAA,MAAA,CAAS,QACTA,CAAAA,CAAAA,CAAA,SAAW,UACXA,CAAAA,CAAAA,CAAA,kBAAqB,CAAA,oBAAA,CANXA,CAAA,CAAA,EAAA,CAAA,EAAA,EAAA,CAAA,CASAC,CACVA,CAAAA,CAAAA,CAAAA,GAAAA,CAAAA,CAAA,UAAY,WACZA,CAAAA,CAAAA,CAAA,IAAO,CAAA,MAAA,CACPA,EAAA,IAAO,CAAA,MAAA,CACPA,CAAA,CAAA,WAAA,CAAc,cACdA,CAAA,CAAA,MAAA,CAAS,QACTA,CAAAA,CAAAA,CAAA,GAAM,CAAA,KAAA,CACNA,CAAA,CAAA,OAAA,CAAU,UAPAA,CAAA,CAAA,EAAA,CAAA,EAAA,EAAA,CAAA,CAyCSC,CAArB,CAAA,cAA0CC,CAAU,CACxC,KAAA,CACA,UACA,CAAA,WAAA,CACA,WACA,MACA,CAAA,SAAA,CACA,MACA,CAAA,QAAA,CACA,WACA,CAAA,eAAA,CACA,gBACA,CAAA,mBAAA,CACA,eACA,SACA,CAAA,SAAA,CACA,aAOV,CAAA,WAAA,CAAYC,EAAyBC,CAAa,CAAA,IAAI,IAAQ,CAAA,CAC5D,MAAMD,CAAMC,CAAAA,CAAI,CAGhB,CAAA,IAAA,CAAK,KAAQD,CAAAA,CAAAA,CAAK,KAClB,CAAA,IAAA,CAAK,WAAaA,CAAK,CAAA,UAAA,CACvB,IAAK,CAAA,WAAA,CAAcA,EAAK,WACxB,CAAA,IAAA,CAAK,UAAaA,CAAAA,CAAAA,CAAK,WACvB,IAAK,CAAA,MAAA,CAASA,CAAK,CAAA,MAAA,CACnB,IAAK,CAAA,SAAA,CAAYA,CAAK,CAAA,SAAA,CACtB,KAAK,MAASA,CAAAA,CAAAA,CAAK,MACnB,CAAA,IAAA,CAAK,SAAWA,CAAK,CAAA,QAAA,CACrB,IAAK,CAAA,WAAA,CAAcA,EAAK,WACxB,CAAA,IAAA,CAAK,eAAkBA,CAAAA,CAAAA,CAAK,eAC5B,CAAA,IAAA,CAAK,gBAAmBA,CAAAA,CAAAA,CAAK,iBAC7B,IAAK,CAAA,mBAAA,CAAsBA,CAAK,CAAA,mBAAA,CAChC,KAAK,cAAiBA,CAAAA,CAAAA,CAAK,cAAkB,EAAA,CAAA,CAC7C,KAAK,SAAYA,CAAAA,CAAAA,CAAK,SACtB,CAAA,IAAA,CAAK,UAAYA,CAAK,CAAA,SAAA,CACtB,IAAK,CAAA,aAAA,CAAgBA,EAAK,cAC5B,CAMO,QAAmB,EAAA,CAAE,OAAO,IAAK,CAAA,KAAO,CAMxC,aAAA,EAAoC,CAAE,OAAO,IAAA,CAAK,UAAY,CAM9D,cAAyB,EAAA,CAAE,OAAO,IAAA,CAAK,WAAa,CAMpD,aAAA,EAAwB,CAAE,OAAO,KAAK,UAAY,CAMlD,SAA2B,EAAA,CAAE,OAAO,IAAK,CAAA,MAAQ,CAMjD,YAAA,EAAmC,CAAE,OAAO,IAAK,CAAA,SAAW,CAM5D,SAAoB,EAAA,CAAE,OAAO,IAAA,CAAK,MAAQ,CAM1C,WAAA,EAA4B,CAAE,OAAO,KAAK,QAAU,CAMpD,cAA8B,EAAA,CAAE,OAAO,IAAA,CAAK,WAAa,CAMzD,oBAAyC,CAAE,OAAO,IAAK,CAAA,eAAiB,CAMxE,mBAA0C,EAAA,CAAE,OAAO,IAAA,CAAK,gBAAkB,CAM1E,sBAAA,EAA6C,CAAE,OAAO,IAAK,CAAA,mBAAqB,CAMhF,iBAAA,EAA4B,CAAE,OAAO,IAAA,CAAK,cAAgB,CAM1D,cAAmC,CAAE,OAAO,IAAK,CAAA,SAAW,CAM5D,YAAmC,EAAA,CAAE,OAAO,IAAA,CAAK,SAAW,CAM5D,gBAAgC,EAAA,CAAE,OAAO,IAAK,CAAA,aAAe,CAOpE,UAAA,EAA0B,CAExB,OAAO,CACL,GAFkB,KAAA,CAAM,YAGxB,CAAA,KAAA,CAAO,IAAK,CAAA,QAAA,EACZ,CAAA,UAAA,CAAY,IAAK,CAAA,aAAA,GACjB,WAAa,CAAA,IAAA,CAAK,cAAe,EAAA,CACjC,WAAY,IAAK,CAAA,aAAA,EACjB,CAAA,MAAA,CAAQ,KAAK,SAAU,EAAA,CACvB,SAAW,CAAA,IAAA,CAAK,YAAa,EAAA,CAC7B,MAAQ,CAAA,IAAA,CAAK,WACb,CAAA,QAAA,CAAU,IAAK,CAAA,WAAA,GACf,WAAa,CAAA,IAAA,CAAK,cAAe,EAAA,CACjC,iBAAkB,IAAK,CAAA,mBAAA,EACvB,CAAA,cAAA,CAAgB,KAAK,iBAAkB,EAAA,CACvC,SAAW,CAAA,IAAA,CAAK,cAChB,CAAA,SAAA,CAAW,IAAK,CAAA,YAAA,GAChB,aAAe,CAAA,IAAA,CAAK,gBAAiB,EACvC,CACF,CACF","file":"Payment.mjs","sourcesContent":["import BaseModel, { BaseAttributes, BaseData } from \"./Base\";\r\nimport { CurrencyCode, ISODateTime } from \"./Common\";\r\n\r\nexport enum PaymentStatus {\r\n  PENDING = \"PENDING\",\r\n  AUTHORIZED = \"AUTHORIZED\",\r\n  CAPTURED = \"CAPTURED\",\r\n  FAILED = \"FAILED\",\r\n  REFUNDED = \"REFUNDED\",\r\n  PARTIALLY_REFUNDED = \"PARTIALLY_REFUNDED\",\r\n}\r\n\r\nexport enum PaymentMode {\r\n  PAY_LATER = \"PAY_LATER\",\r\n  CARD = \"CARD\",\r\n  CASH = \"CASH\",\r\n  NET_BANKING = \"NET_BANKING\",\r\n  WALLET = \"WALLET\",\r\n  COD = \"COD\",\r\n  UNKNOWN = \"UNKNOWN\",\r\n}\r\n\r\n/**\r\n * Input attributes for creating or updating a PaymentModel.\r\n */\r\nexport type PaymentAttributes = BaseAttributes & {\r\n  txnId: string;\r\n  externalId?: string;\r\n  orderNumber: string;\r\n  customerId: string;\r\n  status: PaymentStatus;\r\n  subStatus?: string;\r\n  amount: number;\r\n  currency: CurrencyCode;\r\n  paymentMode: PaymentMode;\r\n  gatewayResponse?: string;\r\n  gatewayErrorCode?: string;\r\n  gatewayErrorMessage?: string;\r\n  amountRefunded?: number;\r\n  cardLast4?: string;\r\n  cardBrand?: string;\r\n  transactionAt: ISODateTime;\r\n};\r\n\r\n/**\r\n * Output data structure for a PaymentModel.\r\n * Excludes potentially large or sensitive fields by default.\r\n */\r\nexport type PaymentData = Omit<PaymentAttributes, 'gatewayResponse' | 'gatewayErrorMessage'> & BaseData\r\n\r\n/**\r\n * Represents a payment transaction, attempt, or record associated with an order.\r\n */\r\nexport default class PaymentModel extends BaseModel {\r\n  protected txnId: string;\r\n  protected externalId?: string;\r\n  protected orderNumber: string;\r\n  protected customerId: string;\r\n  protected status: PaymentStatus;\r\n  protected subStatus?: string;\r\n  protected amount: number;\r\n  protected currency: CurrencyCode;\r\n  protected paymentMode: PaymentMode;\r\n  protected gatewayResponse?: string;\r\n  protected gatewayErrorCode?: string;\r\n  protected gatewayErrorMessage?: string;\r\n  protected amountRefunded: number;\r\n  protected cardLast4?: string;\r\n  protected cardBrand?: string;\r\n  protected transactionAt: ISODateTime;\r\n\r\n  /**\r\n   * Creates an instance of PaymentModel.\r\n   * @param data - The initial payment attributes.\r\n   * @param date - Optional date object for setting creation/modification times (defaults to now).\r\n   */\r\n  constructor(data: PaymentAttributes, date: Date = new Date()) {\r\n    super(data, date); // Pass BaseAttributes to parent\r\n\r\n    // Assign properties\r\n    this.txnId = data.txnId;\r\n    this.externalId = data.externalId;\r\n    this.orderNumber = data.orderNumber;\r\n    this.customerId = data.customerId;\r\n    this.status = data.status;\r\n    this.subStatus = data.subStatus;\r\n    this.amount = data.amount;\r\n    this.currency = data.currency;\r\n    this.paymentMode = data.paymentMode;\r\n    this.gatewayResponse = data.gatewayResponse;\r\n    this.gatewayErrorCode = data.gatewayErrorCode;\r\n    this.gatewayErrorMessage = data.gatewayErrorMessage;\r\n    this.amountRefunded = data.amountRefunded || 0; // Default to 0 if undefined\r\n    this.cardLast4 = data.cardLast4;\r\n    this.cardBrand = data.cardBrand;\r\n    this.transactionAt = data.transactionAt;\r\n  }\r\n\r\n  /**\r\n   * Gets the primary transaction identifier.\r\n   * @returns The transaction ID string.\r\n   */\r\n  public getTxnId(): string { return this.txnId; }\r\n\r\n  /**\r\n   * Gets the external identifier, often from a payment gateway.\r\n   * @returns The external ID string, or undefined if not set.\r\n   */\r\n  public getExternalId(): string | undefined { return this.externalId; }\r\n\r\n  /**\r\n   * Gets the order number associated with this payment.\r\n   * @returns The order number string.\r\n   */\r\n  public getOrderNumber(): string { return this.orderNumber; }\r\n\r\n  /**\r\n   * Gets the customer ID associated with this payment.\r\n   * @returns The customer ID string.\r\n   */\r\n  public getCustomerId(): string { return this.customerId; }\r\n\r\n  /**\r\n   * Gets the current status of the payment (e.g., PENDING, CAPTURED).\r\n   * @returns The PaymentStatus enum value.\r\n   */\r\n  public getStatus(): PaymentStatus { return this.status; }\r\n\r\n  /**\r\n   * Gets the detailed sub-status, often provided by the payment gateway.\r\n   * @returns The sub-status string, or undefined if not set.\r\n   */\r\n  public getSubStatus(): string | undefined { return this.subStatus; }\r\n\r\n  /**\r\n   * Gets the amount of the payment transaction.\r\n   * @returns The payment amount number.\r\n   */\r\n  public getAmount(): number { return this.amount; }\r\n\r\n  /**\r\n   * Gets the currency code for the payment amount.\r\n   * @returns The CurrencyCode enum value.\r\n   */\r\n  public getCurrency(): CurrencyCode { return this.currency; }\r\n\r\n  /**\r\n   * Gets the mode or method used for the payment (e.g., CARD, COD).\r\n   * @returns The PaymentMode enum value.\r\n   */\r\n  public getPaymentMode(): PaymentMode { return this.paymentMode; }\r\n\r\n  /**\r\n   * Gets the raw response data from the payment gateway (potentially large).\r\n   * @returns The gateway response string, or undefined if not set.\r\n   */\r\n  public getGatewayResponse(): string | undefined { return this.gatewayResponse; }\r\n\r\n  /**\r\n   * Gets the error code returned by the payment gateway, if any.\r\n   * @returns The gateway error code string, or undefined if no error occurred or wasn't recorded.\r\n   */\r\n  public getGatewayErrorCode(): string | undefined { return this.gatewayErrorCode; }\r\n\r\n  /**\r\n   * Gets the error message returned by the payment gateway, if any.\r\n   * @returns The gateway error message string, or undefined if no error occurred or wasn't recorded.\r\n   */\r\n  public getGatewayErrorMessage(): string | undefined { return this.gatewayErrorMessage; }\r\n\r\n  /**\r\n   * Gets the total amount that has been refunded for this transaction.\r\n   * @returns The refunded amount number (defaults to 0).\r\n   */\r\n  public getAmountRefunded(): number { return this.amountRefunded; }\r\n\r\n  /**\r\n   * Gets the last 4 digits of the card used, if applicable.\r\n   * @returns The card's last 4 digits string, or undefined.\r\n   */\r\n  public getCardLast4(): string | undefined { return this.cardLast4; }\r\n\r\n  /**\r\n   * Gets the brand of the card used (e.g., Visa, Mastercard), if applicable.\r\n   * @returns The card brand string, or undefined.\r\n   */\r\n  public getCardBrand(): string | undefined { return this.cardBrand; }\r\n\r\n  /**\r\n   * Gets the timestamp when the transaction occurred or was recorded.\r\n   * @returns The transaction timestamp as an ISO 8601 string.\r\n   */\r\n  public getTransactionAt(): ISODateTime { return this.transactionAt; }\r\n\r\n\r\n  /**\r\n   * Gets a plain data object representing the payment's current state.\r\n   * @returns PaymentData object suitable for serialization or API responses.\r\n   */\r\n  getDetails(): PaymentData {\r\n    const baseDetails = super.getDetails();\r\n    return {\r\n      ...baseDetails,\r\n      txnId: this.getTxnId(),\r\n      externalId: this.getExternalId(),\r\n      orderNumber: this.getOrderNumber(),\r\n      customerId: this.getCustomerId(),\r\n      status: this.getStatus(),\r\n      subStatus: this.getSubStatus(),\r\n      amount: this.getAmount(),\r\n      currency: this.getCurrency(),\r\n      paymentMode: this.getPaymentMode(),\r\n      gatewayErrorCode: this.getGatewayErrorCode(),\r\n      amountRefunded: this.getAmountRefunded(),\r\n      cardLast4: this.getCardLast4(),\r\n      cardBrand: this.getCardBrand(),\r\n      transactionAt: this.getTransactionAt(),\r\n    };\r\n  }\r\n}\r\n"]}

package/dist/Classes/Price.d.mts

@@ -0,0 +1,70 @@
+import { CountryCode, LocaleCode } from './Common.mjs';
+import './Enum.mjs';
+
+declare class PriceModel {
+    protected price: number;
+    protected country: CountryCode;
+    /**
+     * Creates an instance of PriceModel, storing the currency-correct rounded price.
+     * @param price - The initial price value.
+     * @param country - The country code used for rounding and determining the currency symbol.
+     * @throws {Error} If price is negative or country/currency mapping is missing.
+     */
+    constructor(price: number, country: CountryCode);
+    /**
+     * Gets the country code associated with this price instance.
+     * The country code is used for determining currency and formatting rules.
+     * @returns The CountryCode enum value.
+     */
+    getCountry(): CountryCode;
+    /**
+     * Gets the rounded price value based on standard currency rules.
+     * @returns The numeric price, rounded according to its currency's typical decimal places.
+     */
+    getRoundedPrice(): number;
+    /**
+     * Gets a locale-aware formatted display string for the price.
+     * Uses Intl.NumberFormat for accurate formatting based on locale and currency.
+     * @param locale - The locale code (e.g., 'en-US', 'de-DE', 'en-IN') to use for formatting rules.
+     * @param options - Configuration options for formatting.
+     * @param options.displayAsInteger - If true, the formatted string will show the price rounded to the nearest integer (no decimals). Defaults to false.
+     * @returns The formatted price string according to locale rules.
+     */
+    getFormattedString(locale: LocaleCode, options?: {
+        displayAsInteger?: boolean;
+        currencyDisplay?: 'symbol' | 'narrowSymbol' | 'code' | 'name';
+    }): string;
+    /**
+     * Helper method to determine standard decimal places for a currency.
+     * @param currency - The currency code.
+     * @returns The number of decimal places (0, 2, or 3 based on common rules).
+     */
+    private static getDecimalPlaces;
+    /**
+     * Adds basic thousand separators (commas) to a number string.
+     * Does not handle different locale separators (e.g., periods, spaces).
+     * @param numStr - The number string (potentially with decimals).
+     * @returns The number string with commas added.
+     */
+    private static addThousandSeparators;
+    /**
+     * Rounds a price value according to the standard decimal places
+     * for the currency associated with the given country.
+     *
+     * @param price - The price value to round. Must be a non-negative number.
+     * @param country - The country code to determine the currency and rounding rules.
+     * @returns The rounded price as a number.
+     * @throws {Error} If the country code is not found in the CountryCurrencyMap or price is negative.
+     */
+    static getRoundedPrice(price: number, country: CountryCode): number;
+    /**
+     * Static method to retrieve the currency code associated with a given country code.
+     * Uses the `CountryCurrencyMap` to find the corresponding currency.
+     *
+     * @param country - The country code (e.g., 'IN') for which to find the currency.
+     * @returns The currency code (e.g., 'INR') as a string, or undefined if the mapping doesn't exist.
+     */
+    static getCurrency(country: CountryCode): string;
+}
+
+export { PriceModel as default };

package/dist/Classes/Price.d.ts

@@ -0,0 +1,70 @@
+import { CountryCode, LocaleCode } from './Common.js';
+import './Enum.js';
+
+declare class PriceModel {
+    protected price: number;
+    protected country: CountryCode;
+    /**
+     * Creates an instance of PriceModel, storing the currency-correct rounded price.
+     * @param price - The initial price value.
+     * @param country - The country code used for rounding and determining the currency symbol.
+     * @throws {Error} If price is negative or country/currency mapping is missing.
+     */
+    constructor(price: number, country: CountryCode);
+    /**
+     * Gets the country code associated with this price instance.
+     * The country code is used for determining currency and formatting rules.
+     * @returns The CountryCode enum value.
+     */
+    getCountry(): CountryCode;
+    /**
+     * Gets the rounded price value based on standard currency rules.
+     * @returns The numeric price, rounded according to its currency's typical decimal places.
+     */
+    getRoundedPrice(): number;
+    /**
+     * Gets a locale-aware formatted display string for the price.
+     * Uses Intl.NumberFormat for accurate formatting based on locale and currency.
+     * @param locale - The locale code (e.g., 'en-US', 'de-DE', 'en-IN') to use for formatting rules.
+     * @param options - Configuration options for formatting.
+     * @param options.displayAsInteger - If true, the formatted string will show the price rounded to the nearest integer (no decimals). Defaults to false.
+     * @returns The formatted price string according to locale rules.
+     */
+    getFormattedString(locale: LocaleCode, options?: {
+        displayAsInteger?: boolean;
+        currencyDisplay?: 'symbol' | 'narrowSymbol' | 'code' | 'name';
+    }): string;
+    /**
+     * Helper method to determine standard decimal places for a currency.
+     * @param currency - The currency code.
+     * @returns The number of decimal places (0, 2, or 3 based on common rules).
+     */
+    private static getDecimalPlaces;
+    /**
+     * Adds basic thousand separators (commas) to a number string.
+     * Does not handle different locale separators (e.g., periods, spaces).
+     * @param numStr - The number string (potentially with decimals).
+     * @returns The number string with commas added.
+     */
+    private static addThousandSeparators;
+    /**
+     * Rounds a price value according to the standard decimal places
+     * for the currency associated with the given country.
+     *
+     * @param price - The price value to round. Must be a non-negative number.
+     * @param country - The country code to determine the currency and rounding rules.
+     * @returns The rounded price as a number.
+     * @throws {Error} If the country code is not found in the CountryCurrencyMap or price is negative.
+     */
+    static getRoundedPrice(price: number, country: CountryCode): number;
+    /**
+     * Static method to retrieve the currency code associated with a given country code.
+     * Uses the `CountryCurrencyMap` to find the corresponding currency.
+     *
+     * @param country - The country code (e.g., 'IN') for which to find the currency.
+     * @returns The currency code (e.g., 'INR') as a string, or undefined if the mapping doesn't exist.
+     */
+    static getCurrency(country: CountryCode): string;
+}
+
+export { PriceModel as default };

package/dist/Classes/Price.js

@@ -0,0 +1,2 @@
+'use strict';var i={IN:"INR"},s={INR:"\u20B9"};var a=class c{price;country;constructor(r,e){if(this.country=e,r<0)throw new Error("InvalidPrice: Price cannot be negative.");this.price=r;}getCountry(){return this.country}getRoundedPrice(){return c.getRoundedPrice(this.price,this.country)}getFormattedString(r,e={}){let o=e.displayAsInteger??!1,t=i[this.country];if(t===void 0)throw new Error("Currency mapping not found for CountryCode");let n=this.price,u=o?0:c.getDecimalPlaces(t),d={style:"currency",currency:t,signDisplay:"never",currencyDisplay:e.currencyDisplay,minimumFractionDigits:u,maximumFractionDigits:u};o&&(n=Math.round(n));try{return new Intl.NumberFormat(r,d).format(n)}catch(l){return console.error(`Error formatting price for locale "${r}" and currency "${t}":`,l),`${s[t]??t} ${c.addThousandSeparators(n.toFixed(u))}`}}static getDecimalPlaces(r){switch(r){case"INR":default:return 2}}static addThousandSeparators(r){let e=r.split("."),o=e[0],t=e.length>1?"."+e[1]:"";return o.replace(/\B(?=(\d{3})+(?!\d))/g,",")+t}static getRoundedPrice(r,e){if(r<0)throw new Error("Price cannot be negative for rounding.");let o=i[e];if(o===void 0)throw new Error(`Currency mapping not found for CountryCode: ${e}`);let t=c.getDecimalPlaces(o),n=Math.pow(10,t);return Math.round(r*n)/n}static getCurrency(r){return i[r]}};a.getRoundedPrice(-1,"IN");module.exports=a;//# sourceMappingURL=Price.js.map
+//# sourceMappingURL=Price.js.map

package/dist/Classes/Price.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Classes/Enum.ts","../../src/Classes/Price.ts"],"names":["CountryCurrencyMap","CurrencySymbolMap","PriceModel","_PriceModel","price","country","locale","options","displayAsInteger","currency","valueToFormat","fractionDigits","formattingOptions","error","numStr","parts","integerPart","decimalPart","decimalPlaces","multiplier"],"mappings":"aAkBO,IAAMA,CAAqB,CAAA,CAClB,EAAwB,CAAA,KACxC,CAEaC,CAAAA,CAAAA,CAAoB,CAC9B,GAAA,CAAiC,QACpC,CAAA,CCrBqBC,IAAAA,CAAAA,CAArB,MAAqBC,CAAW,CACpB,KAAA,CACA,OAQV,CAAA,WAAA,CAAYC,CAAeC,CAAAA,CAAAA,CAAsB,CAG/C,GAFA,IAAK,CAAA,OAAA,CAAUA,CAEZD,CAAAA,CAAAA,CAAQ,CACT,CAAA,MAAM,IAAI,KAAA,CAAM,yCAAyC,CAAA,CAG3D,IAAK,CAAA,KAAA,CAAQA,EACf,CAOO,UAA0B,EAAA,CAC/B,OAAO,IAAA,CAAK,OACd,CAMO,eAA0B,EAAA,CAC/B,OAAOD,CAAAA,CAAW,eAAgB,CAAA,IAAA,CAAK,KAAO,CAAA,IAAA,CAAK,OAAO,CAC5D,CAUO,kBAAA,CAAmBG,CAAoBC,CAAAA,CAAAA,CAAyG,EAAC,CAAW,CACjK,IAAMC,EAAmBD,CAAQ,CAAA,gBAAA,EAAoB,CAC/CE,CAAAA,CAAAA,CAAAA,CAAqCT,CAAmB,CAAA,IAAA,CAAK,OAAO,CAAA,CAE1E,GAAIS,CAAAA,GAAa,KACf,CAAA,CAAA,MAAM,IAAI,KAAA,CAAM,4CAA4C,CAAA,CAG9D,IAAIC,CAAAA,CAAgB,IAAK,CAAA,KAAA,CACnBC,CAAiBH,CAAAA,CAAAA,CAAmB,CAAIL,CAAAA,CAAAA,CAAW,gBAAiBM,CAAAA,CAAQ,CAE9EG,CAAAA,CAAAA,CAA8C,CAC9C,KAAA,CAAO,UACP,CAAA,QAAA,CAAUH,CACV,CAAA,WAAA,CAAa,OACb,CAAA,eAAA,CAAiBF,CAAQ,CAAA,eAAA,CACzB,qBAAuBI,CAAAA,CAAAA,CACvB,qBAAuBA,CAAAA,CAC3B,CAEIH,CAAAA,CAAAA,GACAE,CAAgB,CAAA,IAAA,CAAK,KAAMA,CAAAA,CAAa,CAG5C,CAAA,CAAA,GAAI,CACA,OAAO,IAAI,IAAA,CAAK,YAAaJ,CAAAA,CAAAA,CAAQM,CAAiB,CAAA,CAAE,MAAOF,CAAAA,CAAa,CAChF,CAAA,MAASG,CAAO,CAAA,CACZ,eAAQ,KAAM,CAAA,CAAA,mCAAA,EAAsCP,CAAM,CAAA,gBAAA,EAAmBG,CAAQ,CAAA,EAAA,CAAA,CAAMI,CAAK,CAAA,CAEzF,CAAGZ,EAAAA,CAAAA,CAAkBQ,CAAQ,CAAA,EAAKA,CAAQ,CAAA,CAAA,EAAIN,CAAW,CAAA,qBAAA,CAAsBO,CAAc,CAAA,OAAA,CAAQC,CAAc,CAAC,CAAC,CAAA,CAChI,CACF,CAOA,OAAe,gBAAA,CAAiBF,CAAgC,CAAA,CAC9D,OAAQA,CAAAA,EACN,IAAK,KACL,CAAA,QACE,OAAO,CACX,CACF,CAQA,OAAe,qBAAA,CAAsBK,CAAwB,CAAA,CAC3D,IAAMC,CAAAA,CAAQD,CAAO,CAAA,KAAA,CAAM,GAAG,CAAA,CACxBE,CAAcD,CAAAA,CAAAA,CAAM,CAAC,CAAA,CACrBE,CAAcF,CAAAA,CAAAA,CAAM,MAAS,CAAA,CAAA,CAAI,GAAMA,CAAAA,CAAAA,CAAM,CAAC,CAAA,CAAI,EAGxD,CAAA,OADyBC,CAAY,CAAA,OAAA,CAAQ,wBAAyB,GAAG,CAAA,CAC/CC,CAC5B,CAWA,OAAO,eAAA,CAAgBb,CAAeC,CAAAA,CAAAA,CAA8B,CAClE,GAAID,CAAQ,CAAA,CAAA,CACV,MAAM,IAAI,KAAM,CAAA,wCAAwC,CAG1D,CAAA,IAAMK,CAAqCT,CAAAA,CAAAA,CAAmBK,CAAO,CAAA,CACrE,GAAII,CAAAA,GAAa,KACf,CAAA,CAAA,MAAM,IAAI,KAAA,CAAM,CAA+CJ,4CAAAA,EAAAA,CAAO,CAAE,CAAA,CAAA,CAG1E,IAAMa,CAAAA,CAAgBf,CAAW,CAAA,gBAAA,CAAiBM,CAAQ,CAAA,CACpDU,CAAa,CAAA,IAAA,CAAK,GAAI,CAAA,EAAA,CAAID,CAAa,CAAA,CAG7C,OAFqB,IAAA,CAAK,KAAMd,CAAAA,CAAAA,CAAQe,CAAU,CAAA,CAAIA,CAGxD,CASA,OAAO,WAAA,CAAYd,CAA8B,CAAA,CAC/C,OAAOL,CAAAA,CAAmBK,CAAO,CACnC,CAEF,EAEAH,CAAW,CAAA,eAAA,CAAgB,GAAI,IAAI,CAAA","file":"Price.js","sourcesContent":["/**\r\n * Represents the countries where the application operates or products are available.\r\n */\r\nexport enum OperationalCountry {\r\n  /** India */ IN = 'IN',\r\n}\r\n  \r\nexport enum OperationalCountryCurrency {\r\n  /** India */ INR = 'INR',\r\n}\r\n\r\nexport enum OperationalLocale {\r\n  /** India */ 'en-IN' = 'en-IN',\r\n}\r\n\r\n/**\r\n * Defines the supported ISO 4217 currency codes as an enumeration.\r\n */\r\nexport const CountryCurrencyMap = {\r\n  /** India */ [OperationalCountry.IN]: OperationalCountryCurrency.INR,\r\n};\r\n\r\nexport const CurrencySymbolMap = {\r\n  [OperationalCountryCurrency.INR]: '₹',\r\n}\r\n\r\n/**\r\n * Defines standard gender categories for product targeting.\r\n */\r\nexport enum GenderCategory {\r\n  MALE = 'Male',\r\n  FEMALE = 'Female',\r\n  UNISEX = 'Unisex',\r\n  KIDS = 'Kids',\r\n  BOY = 'Boy',\r\n  GIRL = 'Girl',\r\n}","import { CountryCode, CurrencyCode, LocaleCode } from \"./Common\"; // Assuming these are in Common.ts\r\nimport { CountryCurrencyMap, CurrencySymbolMap } from \"./Enum\"; // Ensure these maps exist\r\n\r\nexport default class PriceModel {\r\n  protected price: number;\r\n  protected country: CountryCode;\r\n\r\n  /**\r\n   * Creates an instance of PriceModel, storing the currency-correct rounded price.\r\n   * @param price - The initial price value.\r\n   * @param country - The country code used for rounding and determining the currency symbol.\r\n   * @throws {Error} If price is negative or country/currency mapping is missing.\r\n   */\r\n  constructor(price: number, country: CountryCode) {\r\n    this.country = country;\r\n\r\n    if(price < 0) {\r\n      throw new Error(\"InvalidPrice: Price cannot be negative.\");\r\n    }\r\n\r\n    this.price = price\r\n  }\r\n\r\n  /**\r\n   * Gets the country code associated with this price instance.\r\n   * The country code is used for determining currency and formatting rules.\r\n   * @returns The CountryCode enum value.\r\n   */\r\n  public getCountry(): CountryCode {\r\n    return this.country;\r\n  }\r\n\r\n  /**\r\n   * Gets the rounded price value based on standard currency rules.\r\n   * @returns The numeric price, rounded according to its currency's typical decimal places.\r\n   */\r\n  public getRoundedPrice(): number {\r\n    return PriceModel.getRoundedPrice(this.price, this.country);\r\n  }\r\n\r\n  /**\r\n   * Gets a locale-aware formatted display string for the price.\r\n   * Uses Intl.NumberFormat for accurate formatting based on locale and currency.\r\n   * @param locale - The locale code (e.g., 'en-US', 'de-DE', 'en-IN') to use for formatting rules.\r\n   * @param options - Configuration options for formatting.\r\n   * @param options.displayAsInteger - If true, the formatted string will show the price rounded to the nearest integer (no decimals). Defaults to false.\r\n   * @returns The formatted price string according to locale rules.\r\n   */\r\n  public getFormattedString(locale: LocaleCode, options: { displayAsInteger?: boolean, currencyDisplay?: 'symbol' | 'narrowSymbol' | 'code' | 'name' } = {}): string {\r\n    const displayAsInteger = options.displayAsInteger ?? false;\r\n    const currency: CurrencyCode | undefined = CountryCurrencyMap[this.country];\r\n\r\n    if (currency === undefined) {\r\n      throw new Error('Currency mapping not found for CountryCode');\r\n    }\r\n\r\n    let valueToFormat = this.price;\r\n    const fractionDigits = displayAsInteger ? 0 : PriceModel.getDecimalPlaces(currency);\r\n\r\n    let formattingOptions: Intl.NumberFormatOptions = {\r\n        style: 'currency',\r\n        currency: currency,\r\n        signDisplay: 'never',\r\n        currencyDisplay: options.currencyDisplay,\r\n        minimumFractionDigits: fractionDigits,\r\n        maximumFractionDigits: fractionDigits,\r\n    };\r\n\r\n    if (displayAsInteger) {\r\n        valueToFormat = Math.round(valueToFormat);\r\n    }\r\n\r\n    try {\r\n        return new Intl.NumberFormat(locale, formattingOptions).format(valueToFormat);\r\n    } catch (error) {\r\n        console.error(`Error formatting price for locale \"${locale}\" and currency \"${currency}\":`, error);\r\n        // Basic fallback without symbol if Intl fails completely\r\n        return `${CurrencySymbolMap[currency] ?? currency} ${PriceModel.addThousandSeparators(valueToFormat.toFixed(fractionDigits))}`;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Helper method to determine standard decimal places for a currency.\r\n   * @param currency - The currency code.\r\n   * @returns The number of decimal places (0, 2, or 3 based on common rules).\r\n   */\r\n  private static getDecimalPlaces(currency: CurrencyCode): number {\r\n    switch (currency) {\r\n      case 'INR':\r\n      default:\r\n        return 2;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adds basic thousand separators (commas) to a number string.\r\n   * Does not handle different locale separators (e.g., periods, spaces).\r\n   * @param numStr - The number string (potentially with decimals).\r\n   * @returns The number string with commas added.\r\n   */\r\n  private static addThousandSeparators(numStr: string): string {\r\n    const parts = numStr.split('.');\r\n    const integerPart = parts[0];\r\n    const decimalPart = parts.length > 1 ? '.' + parts[1] : '';\r\n\r\n    const formattedInteger = integerPart.replace(/\\B(?=(\\d{3})+(?!\\d))/g, ',');\r\n    return formattedInteger + decimalPart;\r\n  }\r\n\r\n  /**\r\n   * Rounds a price value according to the standard decimal places\r\n   * for the currency associated with the given country.\r\n   *\r\n   * @param price - The price value to round. Must be a non-negative number.\r\n   * @param country - The country code to determine the currency and rounding rules.\r\n   * @returns The rounded price as a number.\r\n   * @throws {Error} If the country code is not found in the CountryCurrencyMap or price is negative.\r\n   */\r\n  static getRoundedPrice(price: number, country: CountryCode): number {\r\n    if (price < 0) {\r\n      throw new Error(\"Price cannot be negative for rounding.\");\r\n    }\r\n\r\n    const currency: CurrencyCode | undefined = CountryCurrencyMap[country];\r\n    if (currency === undefined) {\r\n      throw new Error(`Currency mapping not found for CountryCode: ${country}`);\r\n    }\r\n\r\n    const decimalPlaces = PriceModel.getDecimalPlaces(currency);\r\n    const multiplier = Math.pow(10, decimalPlaces);\r\n    const roundedValue = Math.round(price * multiplier) / multiplier;\r\n\r\n    return roundedValue;\r\n  }\r\n\r\n  /**\r\n   * Static method to retrieve the currency code associated with a given country code.\r\n   * Uses the `CountryCurrencyMap` to find the corresponding currency.\r\n   *\r\n   * @param country - The country code (e.g., 'IN') for which to find the currency.\r\n   * @returns The currency code (e.g., 'INR') as a string, or undefined if the mapping doesn't exist.\r\n   */\r\n  static getCurrency(country: CountryCode): string {\r\n    return CountryCurrencyMap[country];\r\n  }\r\n\r\n}\r\n\r\nPriceModel.getRoundedPrice(-1, 'IN')"]}

package/dist/Classes/Price.mjs

@@ -0,0 +1,2 @@
+export{a as default}from'../chunk-763MN5XV.mjs';import'../chunk-65X54TKF.mjs';//# sourceMappingURL=Price.mjs.map
+//# sourceMappingURL=Price.mjs.map

package/dist/Classes/Price.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"Price.mjs"}

package/dist/Classes/Product.d.mts

@@ -0,0 +1,209 @@
+import BaseModel, { BaseAttributes } from './Base.mjs';
+import { LocalizedString, BasePriceList, PriceTierList, Color, LocaleCode, CountryCode } from './Common.mjs';
+import { GenderCategory } from './Enum.mjs';
+import ImageInfoModel, { ImageInfoData } from './ImageInfo.mjs';
+
+type ProductVariantIdentifier = {
+    key: string;
+    variantId: string;
+};
+type ProductHashKey = {
+    id: string;
+    variantId: string;
+};
+type ProductAttributes = BaseAttributes & {
+    id: string;
+    key: string;
+    variantId: string;
+    name: LocalizedString;
+    description: LocalizedString;
+    slug: LocalizedString;
+    brand: string;
+    basePrices: BasePriceList;
+    priceTiers: PriceTierList;
+    attributes: {
+        color: Color;
+        sizes: string[];
+    };
+    primaryImage: ImageInfoData;
+    additionalImages?: ImageInfoData[];
+    isActive: boolean;
+    targetGender: GenderCategory;
+    categories: string[];
+    specifications: {
+        [locale: string]: {
+            [key: string]: string | string[];
+        };
+    };
+    searchTags?: string[];
+};
+type ProductData = Required<ProductAttributes>;
+type ProductSpecification = {
+    [key: string]: string | string[];
+};
+type LocalizedProductSpecification = {
+    en: ProductSpecification;
+} & {
+    [locale in LocaleCode]?: ProductSpecification;
+};
+declare class ProductModel extends BaseModel {
+    protected id: string;
+    protected key: string;
+    protected variantId: string;
+    protected name: LocalizedString;
+    protected description: LocalizedString;
+    protected slug: LocalizedString;
+    protected brand: string;
+    protected basePrices: BasePriceList;
+    protected priceTiers: PriceTierList;
+    protected attributes: {
+        color: Color;
+        sizes: string[];
+    };
+    protected primaryImage: ImageInfoModel;
+    protected additionalImages: ImageInfoModel[];
+    protected isActive: boolean;
+    protected targetGender: GenderCategory;
+    protected categories: string[];
+    protected specifications: LocalizedProductSpecification;
+    protected searchTags: string[];
+    static productKeyRegex: RegExp;
+    static variantIdRegex: RegExp;
+    /**
+     * Creates an instance of ProductModel.
+     * Initializes properties based on the provided data, creating copies where necessary.
+     * @param data - The initial product attributes.
+     * @param date - Optional date for setting creation/modification times (defaults to now).
+    */
+    constructor(data: ProductAttributes, date?: Date);
+    /**
+     * Gets the base Product ID.
+     * @returns Product ID.
+    */
+    getId(): string;
+    /**
+     * Gets the user-friendly product key.
+     * @returns Product Key.
+     */
+    getKey(): string;
+    /**
+     * Gets the specific Variant ID.
+     * @returns Variant ID.
+     */
+    getVariantId(): string;
+    /**
+     * Gets the full localized product name object.
+     * @returns A copy of the LocalizedString object for the name.
+     */
+    getName(): LocalizedString;
+    /**
+     * Gets the product name for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The name string for the specified locale.
+     */
+    getName(locale: LocaleCode): string;
+    /**
+     * Gets the full localized product description object.
+     * @returns A copy of the LocalizedString object for the description.
+     */
+    getDescription(): LocalizedString;
+    /**
+     * Gets the product description for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The description string for the specified locale.
+     */
+    getDescription(locale: LocaleCode): string;
+    /**
+     * Gets the full localized product slug object.
+     * @returns A copy of the LocalizedString object for the slug.
+     */
+    getSlug(): LocalizedString;
+    /**
+     * Gets the product slug for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The slug string for the specified locale.
+     */
+    getSlug(locale: LocaleCode): string;
+    /**
+     * Gets the brand associated with the product.
+     * @returns The brand name string.
+     */
+    getBrand(): string;
+    /**
+     * Gets the list of base prices. Returns copies of the price objects.
+     * Optionally filters by country.
+     * @param country - Optional country code to filter prices for.
+     * @returns A list of base prices (or an empty list if none match).
+     */
+    getBasePrices(country?: CountryCode): BasePriceList;
+    /**
+     * Gets the list of quantity-based price tiers. Returns copies of the tier objects.
+     * Optionally filters by country.
+     * @param country - Optional country code to filter tiers for.
+     * @returns A list of price tiers (or an empty list if none match or none exist).
+     */
+    getPriceTiers(country?: CountryCode): PriceTierList;
+    /**
+     * Gets the variant-specific attributes (color, sizes). Returns copies.
+     * @returns Product Attributes.
+     */
+    getAttributes(): {
+        color: Color;
+        sizes: string[];
+    };
+    /**
+     * Gets details of product's primary image.
+     * @returns The ImageInfoModel instance for the primary image.
+     */
+    getPrimaryImage(): ImageInfoModel;
+    /**
+     * Gets the list of additional product images.
+     * @returns An array of ImageInfoModel instances.
+     */
+    getAdditionalImages(): ImageInfoModel[];
+    /**
+     * Checks if the product variant is active.
+     * @returns True if the product is active, false otherwise.
+     */
+    getIsActive(): boolean;
+    /**
+     * Gets the target gender category for the product.
+     * @returns The GenderCategory enum value.
+     */
+    getTargetGender(): GenderCategory;
+    /**
+     * Gets the list of categories the product belongs to. Returns a copy.
+     * @returns An array of category.
+     */
+    getCategories(): string[];
+    /**
+     * Gets the full localized product specifications object.
+     * @returns Product Specifications
+     */
+    getSpecifications(): LocalizedProductSpecification;
+    /**
+     * Gets the product specifications for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The ProductSpecification object for the specified locale, or undefined if not found.
+     */
+    getSpecifications(locale: LocaleCode): ProductSpecification | undefined;
+    /**
+     * Gets the list of search tags. Returns a copy.
+     * @returns An array of search tags.
+     */
+    getSearchTags(): string[];
+    /**
+     *
+     * @returns ProductData
+     */
+    getDetails(): ProductData;
+    /**
+     * Calculates the maximum potential discount percentage for a given country
+     * based on the lowest price tier compared to the base price.
+     * @param country - The country code to calculate the discount for.
+     * @returns The maximum discount percentage (0-100), or 0 if calculation is not possible.
+     */
+    getMaxDiscountPercent(country: CountryCode): number;
+}
+
+export { type LocalizedProductSpecification, type ProductAttributes, type ProductData, type ProductHashKey, type ProductSpecification, type ProductVariantIdentifier, ProductModel as default };