@xpayeg/sdk 3.0.0 → 3.1.0

package/.types/index.d.cts

@@ -510,59 +510,6 @@ interface PendingDiscountResponseDto {
   end?: string;
 }
 type CheckoutDiscountResponseDto = DiscountResponseDto | PendingDiscountResponseDto;
-/**
- * Generated by orval 🍺
- * Do not edit manually.
- * XPay Checkout API
- * API for the XPay checkout flow — client endpoints and SSR
- * OpenAPI spec version: 1.0
- */
-/**
- * Currency code (ISO 4217)
- * @nullable
- */
-type CheckoutSessionResponseDtoCurrency = (typeof CheckoutSessionResponseDtoCurrency)[keyof typeof CheckoutSessionResponseDtoCurrency] | null;
-declare const CheckoutSessionResponseDtoCurrency: {
-  readonly EGP: "EGP";
-  readonly USD: "USD";
-  readonly EUR: "EUR";
-  readonly GBP: "GBP";
-  readonly SAR: "SAR";
-  readonly AED: "AED";
-  readonly QAR: "QAR";
-  readonly KWD: "KWD";
-  readonly JOD: "JOD";
-  readonly OMR: "OMR";
-  readonly BHD: "BHD";
-  readonly LYD: "LYD";
-  readonly AUD: "AUD";
-  readonly CAD: "CAD";
-  readonly CNY: "CNY";
-};
-/**
- * Generated by orval 🍺
- * Do not edit manually.
- * XPay Checkout API
- * API for the XPay checkout flow — client endpoints and SSR
- * OpenAPI spec version: 1.0
- */
-/**
- * Whether the money has arrived. `paid` means fulfil; `unpaid` on a `complete` session means the customer still has to pay a reference. Never fulfil on `status` alone.
- */
-type CheckoutSessionResponseDtoPaymentStatus = (typeof CheckoutSessionResponseDtoPaymentStatus)[keyof typeof CheckoutSessionResponseDtoPaymentStatus];
-declare const CheckoutSessionResponseDtoPaymentStatus: {
-  readonly paid: "paid";
-  readonly unpaid: "unpaid";
-  readonly no_payment_required: "no_payment_required";
-};
-interface FeesResponseDto {
-  paymentMethodType: string;
-  feeAmount: number;
-  feePercentage: number;
-  vatAmount?: number;
-  totalAmount: number;
-  cardInfo?: CardInfoResponseDto;
-}
 /**
  * Generated by orval 🍺
  * Do not edit manually.
@@ -574,8 +521,8 @@ interface FeesResponseDto {
  * Currency of this line's amount fields
  * @nullable
  */
-type LineItemDtoCurrency = (typeof LineItemDtoCurrency)[keyof typeof LineItemDtoCurrency] | null;
-declare const LineItemDtoCurrency: {
+type CheckoutLineItemDtoCurrency = (typeof CheckoutLineItemDtoCurrency)[keyof typeof CheckoutLineItemDtoCurrency] | null;
+declare const CheckoutLineItemDtoCurrency: {
   readonly EGP: "EGP";
   readonly USD: "USD";
   readonly EUR: "EUR";
@@ -632,6 +579,23 @@ interface LineItemPresentmentDetailsDto {
   /** Presentment currency matching the session */
   currency: LineItemPresentmentDetailsDtoCurrency;
 }
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type PriceAvailability = (typeof PriceAvailability)[keyof typeof PriceAvailability];
+declare const PriceAvailability: {
+  readonly available: "available";
+  readonly archived: "archived";
+  readonly scheduled: "scheduled";
+  readonly expired: "expired";
+  readonly sold_out: "sold_out";
+  readonly oversold: "oversold";
+  readonly recurring_unsupported: "recurring_unsupported";
+};
 /**
  * Generated by orval 🍺
  * Do not edit manually.
@@ -769,7 +733,7 @@ interface PriceDto {
   expirationDate?: string | null;
   product: ProductDto;
 }
-interface LineItemDto {
+interface CheckoutLineItemDto {
   /** Line item ID */
   id: string;
   /** Quantity; zero represents an optional item */
@@ -788,10 +752,65 @@ interface LineItemDto {
    * Currency of this line's amount fields
    * @nullable
    */
-  currency?: LineItemDtoCurrency;
+  currency?: CheckoutLineItemDtoCurrency;
   /** Line item description */
   description?: string;
   presentmentDetails?: LineItemPresentmentDetailsDto;
+  /** Server-calculated availability for this quantity (one unit for optional items). Never derive this from the device clock. */
+  availability: PriceAvailability;
+}
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Currency code (ISO 4217)
+ * @nullable
+ */
+type CheckoutSessionResponseDtoCurrency = (typeof CheckoutSessionResponseDtoCurrency)[keyof typeof CheckoutSessionResponseDtoCurrency] | null;
+declare const CheckoutSessionResponseDtoCurrency: {
+  readonly EGP: "EGP";
+  readonly USD: "USD";
+  readonly EUR: "EUR";
+  readonly GBP: "GBP";
+  readonly SAR: "SAR";
+  readonly AED: "AED";
+  readonly QAR: "QAR";
+  readonly KWD: "KWD";
+  readonly JOD: "JOD";
+  readonly OMR: "OMR";
+  readonly BHD: "BHD";
+  readonly LYD: "LYD";
+  readonly AUD: "AUD";
+  readonly CAD: "CAD";
+  readonly CNY: "CNY";
+};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Whether the money has arrived. `paid` means fulfil; `unpaid` on a `complete` session means the customer still has to pay a reference. Never fulfil on `status` alone.
+ */
+type CheckoutSessionResponseDtoPaymentStatus = (typeof CheckoutSessionResponseDtoPaymentStatus)[keyof typeof CheckoutSessionResponseDtoPaymentStatus];
+declare const CheckoutSessionResponseDtoPaymentStatus: {
+  readonly paid: "paid";
+  readonly unpaid: "unpaid";
+  readonly no_payment_required: "no_payment_required";
+};
+interface FeesResponseDto {
+  paymentMethodType: string;
+  feeAmount: number;
+  feePercentage: number;
+  vatAmount?: number;
+  totalAmount: number;
+  cardInfo?: CardInfoResponseDto;
 }
 /**
  * Generated by orval 🍺
@@ -997,7 +1016,7 @@ type CheckoutSession = {
    */
   presentmentDetails?: SessionPresentmentDetailsDto | undefined;
   /** Line items in the session */
-  lineItems?: LineItemDto[] | undefined;
+  lineItems?: CheckoutLineItemDto[] | undefined;
   /** Totals breakdown (subtotal, tax, shipping, etc.) */
   totalDetails?: TotalDetailsResponseDto | undefined;
   /** Fee breakdown (when feesPassThrough is enabled) */
@@ -1006,7 +1025,7 @@ type CheckoutSession = {
   discounts?: CheckoutDiscountResponseDto[] | undefined;
 };
 /** Line item in a checkout session */
-type CheckoutLineItem = LineItemDto;
+type CheckoutLineItem = CheckoutLineItemDto;
 /** Totals breakdown (subtotal, tax, shipping, discount amounts) */
 type CheckoutTotalDetails = TotalDetailsResponseDto;
 /** Fee breakdown for pass-through fees */

package/.types/index.d.mts

@@ -510,59 +510,6 @@ interface PendingDiscountResponseDto {
   end?: string;
 }
 type CheckoutDiscountResponseDto = DiscountResponseDto | PendingDiscountResponseDto;
-/**
- * Generated by orval 🍺
- * Do not edit manually.
- * XPay Checkout API
- * API for the XPay checkout flow — client endpoints and SSR
- * OpenAPI spec version: 1.0
- */
-/**
- * Currency code (ISO 4217)
- * @nullable
- */
-type CheckoutSessionResponseDtoCurrency = (typeof CheckoutSessionResponseDtoCurrency)[keyof typeof CheckoutSessionResponseDtoCurrency] | null;
-declare const CheckoutSessionResponseDtoCurrency: {
-  readonly EGP: "EGP";
-  readonly USD: "USD";
-  readonly EUR: "EUR";
-  readonly GBP: "GBP";
-  readonly SAR: "SAR";
-  readonly AED: "AED";
-  readonly QAR: "QAR";
-  readonly KWD: "KWD";
-  readonly JOD: "JOD";
-  readonly OMR: "OMR";
-  readonly BHD: "BHD";
-  readonly LYD: "LYD";
-  readonly AUD: "AUD";
-  readonly CAD: "CAD";
-  readonly CNY: "CNY";
-};
-/**
- * Generated by orval 🍺
- * Do not edit manually.
- * XPay Checkout API
- * API for the XPay checkout flow — client endpoints and SSR
- * OpenAPI spec version: 1.0
- */
-/**
- * Whether the money has arrived. `paid` means fulfil; `unpaid` on a `complete` session means the customer still has to pay a reference. Never fulfil on `status` alone.
- */
-type CheckoutSessionResponseDtoPaymentStatus = (typeof CheckoutSessionResponseDtoPaymentStatus)[keyof typeof CheckoutSessionResponseDtoPaymentStatus];
-declare const CheckoutSessionResponseDtoPaymentStatus: {
-  readonly paid: "paid";
-  readonly unpaid: "unpaid";
-  readonly no_payment_required: "no_payment_required";
-};
-interface FeesResponseDto {
-  paymentMethodType: string;
-  feeAmount: number;
-  feePercentage: number;
-  vatAmount?: number;
-  totalAmount: number;
-  cardInfo?: CardInfoResponseDto;
-}
 /**
  * Generated by orval 🍺
  * Do not edit manually.
@@ -574,8 +521,8 @@ interface FeesResponseDto {
  * Currency of this line's amount fields
  * @nullable
  */
-type LineItemDtoCurrency = (typeof LineItemDtoCurrency)[keyof typeof LineItemDtoCurrency] | null;
-declare const LineItemDtoCurrency: {
+type CheckoutLineItemDtoCurrency = (typeof CheckoutLineItemDtoCurrency)[keyof typeof CheckoutLineItemDtoCurrency] | null;
+declare const CheckoutLineItemDtoCurrency: {
   readonly EGP: "EGP";
   readonly USD: "USD";
   readonly EUR: "EUR";
@@ -632,6 +579,23 @@ interface LineItemPresentmentDetailsDto {
   /** Presentment currency matching the session */
   currency: LineItemPresentmentDetailsDtoCurrency;
 }
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type PriceAvailability = (typeof PriceAvailability)[keyof typeof PriceAvailability];
+declare const PriceAvailability: {
+  readonly available: "available";
+  readonly archived: "archived";
+  readonly scheduled: "scheduled";
+  readonly expired: "expired";
+  readonly sold_out: "sold_out";
+  readonly oversold: "oversold";
+  readonly recurring_unsupported: "recurring_unsupported";
+};
 /**
  * Generated by orval 🍺
  * Do not edit manually.
@@ -769,7 +733,7 @@ interface PriceDto {
   expirationDate?: string | null;
   product: ProductDto;
 }
-interface LineItemDto {
+interface CheckoutLineItemDto {
   /** Line item ID */
   id: string;
   /** Quantity; zero represents an optional item */
@@ -788,10 +752,65 @@ interface LineItemDto {
    * Currency of this line's amount fields
    * @nullable
    */
-  currency?: LineItemDtoCurrency;
+  currency?: CheckoutLineItemDtoCurrency;
   /** Line item description */
   description?: string;
   presentmentDetails?: LineItemPresentmentDetailsDto;
+  /** Server-calculated availability for this quantity (one unit for optional items). Never derive this from the device clock. */
+  availability: PriceAvailability;
+}
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Currency code (ISO 4217)
+ * @nullable
+ */
+type CheckoutSessionResponseDtoCurrency = (typeof CheckoutSessionResponseDtoCurrency)[keyof typeof CheckoutSessionResponseDtoCurrency] | null;
+declare const CheckoutSessionResponseDtoCurrency: {
+  readonly EGP: "EGP";
+  readonly USD: "USD";
+  readonly EUR: "EUR";
+  readonly GBP: "GBP";
+  readonly SAR: "SAR";
+  readonly AED: "AED";
+  readonly QAR: "QAR";
+  readonly KWD: "KWD";
+  readonly JOD: "JOD";
+  readonly OMR: "OMR";
+  readonly BHD: "BHD";
+  readonly LYD: "LYD";
+  readonly AUD: "AUD";
+  readonly CAD: "CAD";
+  readonly CNY: "CNY";
+};
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Whether the money has arrived. `paid` means fulfil; `unpaid` on a `complete` session means the customer still has to pay a reference. Never fulfil on `status` alone.
+ */
+type CheckoutSessionResponseDtoPaymentStatus = (typeof CheckoutSessionResponseDtoPaymentStatus)[keyof typeof CheckoutSessionResponseDtoPaymentStatus];
+declare const CheckoutSessionResponseDtoPaymentStatus: {
+  readonly paid: "paid";
+  readonly unpaid: "unpaid";
+  readonly no_payment_required: "no_payment_required";
+};
+interface FeesResponseDto {
+  paymentMethodType: string;
+  feeAmount: number;
+  feePercentage: number;
+  vatAmount?: number;
+  totalAmount: number;
+  cardInfo?: CardInfoResponseDto;
 }
 /**
  * Generated by orval 🍺
@@ -997,7 +1016,7 @@ type CheckoutSession = {
    */
   presentmentDetails?: SessionPresentmentDetailsDto | undefined;
   /** Line items in the session */
-  lineItems?: LineItemDto[] | undefined;
+  lineItems?: CheckoutLineItemDto[] | undefined;
   /** Totals breakdown (subtotal, tax, shipping, etc.) */
   totalDetails?: TotalDetailsResponseDto | undefined;
   /** Fee breakdown (when feesPassThrough is enabled) */
@@ -1006,7 +1025,7 @@ type CheckoutSession = {
   discounts?: CheckoutDiscountResponseDto[] | undefined;
 };
 /** Line item in a checkout session */
-type CheckoutLineItem = LineItemDto;
+type CheckoutLineItem = CheckoutLineItemDto;
 /** Totals breakdown (subtotal, tax, shipping, discount amounts) */
 type CheckoutTotalDetails = TotalDetailsResponseDto;
 /** Fee breakdown for pass-through fees */

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @xpayeg/sdk
 
+## 3.1.0
+
+### Minor Changes
+
+- [#600](https://github.com/xpayeg/xpay/pull/600) [`9f4d949`](https://github.com/xpayeg/xpay/commit/9f4d949ff5f51b0c739521155fa392340bb3067e) Thanks [@Elmosh](https://github.com/Elmosh)! - Add availability status to checkout line-item types.
+
 ## 3.0.0
 
 ### Major Changes

package/README.md

@@ -126,7 +126,7 @@ const checkout = await xpay.initCheckout({
 | `merchantName`   | `string`                  | `"My Store"`                        | Merchant display name                         |
 | `livemode`       | `boolean`                 | `false`                             | Whether live or test mode                     |
 | `paymentMethods` | `PaymentMethodInfo[]`     | `[{ type, displayName, category }]` | Available payment methods                     |
-| `lineItems`      | `LineItemDto[]`           |                                     | Line items with prices and quantities         |
+| `lineItems`      | `CheckoutLineItem[]`      |                                     | Line items with prices and quantities         |
 | `totalDetails`   | `TotalDetailsResponseDto` |                                     | Breakdown of fees, discounts, VAT             |
 | `discounts`      | `DiscountResponseDto[]`   |                                     | Applied discounts                             |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpayeg/sdk",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "XPay JavaScript SDK — loader and TypeScript types for embedding XPay payments",
   "license": "MIT",
   "type": "module",