@wix/auto_sdk_events_orders 1.0.72 → 1.0.73

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -80,6 +80,11 @@ interface Order {
80
80
  * @readonly
81
81
  */
82
82
  updated?: Date | null;
83
+ /**
84
+ * Gift card payments, including voided payments.
85
+ * @maxSize 10
86
+ */
87
+ giftCardPaymentDetails?: GiftCardPaymentDetails[];
83
88
  /** Whether marketing consent was given. */
84
89
  marketingConsent?: boolean | null;
85
90
  }
@@ -644,30 +649,15 @@ declare enum Action {
644
649
  /** @enumType */
645
650
  type ActionWithLiterals = Action | 'ARCHIVE' | 'UNARCHIVE' | 'CONFIRM' | 'CAPTURE' | 'VOID';
646
651
  interface GiftCardPaymentDetails {
647
- /**
648
- * Gift card payment ID.
649
- * @format GUID
650
- */
651
- giftCardPaymentId?: string | null;
652
- /**
653
- * ID of the app that created the gift card.
654
- * @format GUID
655
- */
656
- appId?: string | null;
657
- /** Whether the gift card payment is voided. */
652
+ /** Whether the payment was reversed and no longer contributes to the order. */
658
653
  voided?: boolean | null;
659
- /** Amount */
654
+ /** Gift card payment amount, or projected amount for invoice previews. */
660
655
  amount?: Money;
661
656
  /**
662
- * Obfuscated gift card code.
657
+ * Masked gift card code for display.
663
658
  * @maxLength 30
664
659
  */
665
660
  obfuscatedCode?: string | null;
666
- /**
667
- * Gift card code.
668
- * @maxLength 30
669
- */
670
- code?: string | null;
671
661
  }
672
662
  interface BalanceSummary {
673
663
  /** Amount left to pay. */
@@ -1883,6 +1873,11 @@ interface GetInvoiceRequest {
1883
1873
  withDiscount?: DiscountRequest;
1884
1874
  /** Optional benefit granted by the pricing plan to be applied on the returned invoice. */
1885
1875
  paidPlanBenefit?: PaidPlanBenefit;
1876
+ /**
1877
+ * Gift card code to preview without redeeming it.
1878
+ * @maxLength 30
1879
+ */
1880
+ giftCardCode?: string | null;
1886
1881
  }
1887
1882
  interface DiscountRequest {
1888
1883
  /**
@@ -1916,6 +1911,13 @@ interface GetInvoiceResponse {
1916
1911
  reservationOccupied?: boolean;
1917
1912
  /** Ticket reservations. */
1918
1913
  reservations?: TicketReservation[];
1914
+ /**
1915
+ * Projected gift card payments.
1916
+ * @maxSize 10
1917
+ */
1918
+ giftCardPaymentDetails?: GiftCardPaymentDetails[];
1919
+ /** Gift card errors, if relevant. */
1920
+ giftCardErrors?: GiftCardErrors;
1919
1921
  }
1920
1922
  interface DiscountErrors {
1921
1923
  /** Error. */
@@ -1932,7 +1934,11 @@ interface GiftCardErrors {
1932
1934
  error?: GiftCardErrorsError[];
1933
1935
  }
1934
1936
  interface GiftCardErrorsError {
1935
- /** @maxLength 100 */
1937
+ /**
1938
+ * Error code, such as EVENTS_GIFT_CARD_NOT_FOUND, EVENTS_GIFT_CARD_EXPIRED,
1939
+ * EVENTS_GIFT_CARD_DISABLED, or EVENTS_GIFT_CARD_INSUFFICIENT_FUNDS.
1940
+ * @maxLength 100
1941
+ */
1936
1942
  code?: string;
1937
1943
  }
1938
1944
  interface CheckoutRequest {
@@ -1962,6 +1968,11 @@ interface CheckoutRequest {
1962
1968
  paidPlanBenefit?: PaidPlanBenefit;
1963
1969
  /** Options controlling the checkout process. */
1964
1970
  options?: CheckoutOptions;
1971
+ /**
1972
+ * Gift card code to redeem toward the order.
1973
+ * @maxLength 30
1974
+ */
1975
+ giftCardCode?: string | null;
1965
1976
  /** Whether marketing consent was given. */
1966
1977
  marketingConsent?: boolean | null;
1967
1978
  }
@@ -2096,6 +2107,12 @@ interface UpdateCheckoutRequest {
2096
2107
  discount?: DiscountRequest;
2097
2108
  /** Benefit granted by the pricing plan. */
2098
2109
  paidPlanBenefit?: PaidPlanBenefit;
2110
+ /**
2111
+ * Gift card code to apply. Resend it on each update to keep the card applied.
2112
+ * Omitting it reverses the payment when the update recalculates the invoice.
2113
+ * @maxLength 30
2114
+ */
2115
+ giftCardCode?: string | null;
2099
2116
  }
2100
2117
  interface UpdateCheckoutResponse {
2101
2118
  /** Updated order. */