@epcc-sdk/sdks-shopper 0.6.0 → 0.7.0

package/dist/client/types.gen.d.cts

@@ -4515,7 +4515,7 @@ type CustomerCheckout = {
          * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
          */
         external_ref?: string;
-        customer?: {
+        customer: {
             /**
              * The ID of the customer.
              */
@@ -4556,7 +4556,7 @@ type AccountCheckout = {
              */
             member_id?: string;
         };
-        contact?: {
+        contact: {
             /**
              * The name of the account member.
              */
@@ -5339,6 +5339,8 @@ type CartsResponse = {
             tax?: FormattedPriceData;
             discount?: FormattedPriceData;
             without_discount?: FormattedPriceData;
+            shipping?: FormattedPriceData;
+            shipping_discount?: FormattedPriceData;
             discounts?: {
                 [key: string]: {
                     amount?: number;
@@ -5354,12 +5356,33 @@ type CartsResponse = {
  * Cart Items Response
  */
 type CartItemsResponse = {
-    data?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
+    data?: Array<CartItemObject | CustomItemCartObject | SubscriptionItemCartObject | PromotionItemCartObject>;
 };
 /**
  * Cart Item Object
  */
 type CartItemObject = CartItemObjectData & CartItemResponse;
+/**
+ * Custom Item Cart Object
+ */
+type CustomItemCartObject = CartItemResponse & {
+    type: "custom_item";
+    quantity: number;
+};
+/**
+ * Subscription Item Cart Object
+ */
+type SubscriptionItemCartObject = CartItemResponse & {
+    type: "subscription_item";
+    quantity: number;
+};
+/**
+ * Promotion Item Cart Object
+ */
+type PromotionItemCartObject = CartItemResponse & {
+    type: "promotion_item";
+    quantity: number;
+};
 /**
  * Data.StripeConnectPayment
  */
@@ -5409,28 +5432,6 @@ type CartIncludedPromotion = {
      */
     end: string;
 };
-/**
- * Subscription Item Cart Object
- */
-type SubscriptionItemCartObject = SubscriptionItemObjectData & CartItemResponse;
-/**
- * Promotion Item Cart Object
- */
-type PromotionItemCartObject = PromotionItemObjectData & CartItemResponse & {
-    /**
-     * The unique identifier of the promotion item.
-     */
-    id?: string;
-};
-/**
- * Custom Item Cart Object
- */
-type CustomItemCartObject = CustomItemObjectData & CartItemResponse & {
-    /**
-     * The unique identifier of the custom item.
-     */
-    id?: string;
-};
 /**
  * Included is an array of resources that are included in the response.
  */
@@ -5996,6 +5997,10 @@ type ProrationPolicyAttributes = {
      */
     rounding: "up" | "down" | "nearest";
     external_ref?: ExternalRef;
+    /**
+     * Set to `true` to allow an automatic gateway refund when a proration would otherwise be rejected for netting negative.
+     */
+    allow_negative_proration_refund?: boolean;
 };
 type ProrationPolicyUpdateAttributes = {
     external_ref?: ExternalRefUpdate;
@@ -6007,6 +6012,10 @@ type ProrationPolicyUpdateAttributes = {
      * Whether to round up or down
      */
     rounding?: "up" | "down" | "nearest";
+    /**
+     * Set to `true` to allow an automatic gateway refund when a proration would otherwise be rejected for netting negative.
+     */
+    allow_negative_proration_refund?: boolean;
 };
 type ProrationPolicyMeta = {
     owner: OwnerMeta;
@@ -6050,11 +6059,11 @@ type PricingOptionAttributes = {
      */
     end_behavior: "close" | "roll";
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can pause a subscription, but currently has no effect — subscription pausing is only available to merchandizers, regardless of this value.
+     * The subscriber can pause a subscription.
      */
     can_pause: boolean;
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can resume a paused subscription, but currently has no effect — subscription resuming is only available to merchandizers, regardless of this value.
+     * The subscriber can resume a paused subscription.
      */
     can_resume: boolean;
     /**
@@ -6097,11 +6106,11 @@ type PricingOptionUpdateAttributes = {
      */
     end_behavior?: "close" | "roll";
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can pause a subscription, but currently has no effect — subscription pausing is only available to merchandizers, regardless of this value.
+     * The subscriber can pause a subscription.
      */
     can_pause?: boolean;
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can resume a paused subscription, but currently has no effect — subscription resuming is only available to merchandizers, regardless of this value.
+     * The subscriber can resume a paused subscription.
      */
     can_resume?: boolean;
     /**
@@ -6447,6 +6456,18 @@ type SubscriptionMeta = {
      * A history of price updates that have been applied to this subscription.
      */
     price_update_history?: Array<SubscriptionPriceUpdateHistoryEntry>;
+    /**
+     * The ID of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_id?: string;
+    /**
+     * The amount of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_amount?: number;
+    /**
+     * Who or what most recently paused this subscription, while it remains paused. Absent when the subscription has never been paused, or is not currently paused (cleared on resume). Only visible to merchandizer/store or organization-scoped callers.
+     */
+    paused_by?: "subscriber" | "merchandizer" | "dunning";
 };
 type SubscriptionTimestamps = SubscriptionsTimestamps & {
     /**
@@ -6562,12 +6583,28 @@ type ProrationPreviewAttributes = {
      * Whether submitting this prospective change would actually result in a proration.
      */
     would_prorate: boolean;
+    /**
+     * Whether this change would result in a Proration Refund - a real refund issued against the
+     * subscription's previous invoice payment because the unused-time credit exceeds the new pricing
+     * option's cost. Set alongside `would_prorate: true` for this case; omitted otherwise.
+     *
+     */
+    would_refund?: boolean | null;
+    /**
+     * The amount that would be refunded as a Proration Refund, as a whole number of the currency's
+     * smallest subdivision. Set only when `would_refund` is `true`.
+     *
+     */
+    refund_amount?: number | null;
     /**
      * Why a previewed change would not result in a proration if actually submitted. Returned alongside
-     * `would_prorate: false`; this is not an error response.
+     * `would_prorate: false`; this is not an error response. `negative_amount` is retained for backward
+     * compatibility but is no longer returned - a negative-net change now either proceeds with a
+     * Proration Refund (`would_refund: true`), is rejected as `refund_not_possible`, or is rejected as
+     * `refund_disallowed_by_policy` when the applicable proration policy does not allow refunds.
      *
      */
-    rejection_reason: "negative_amount" | "no_change";
+    rejection_reason: "negative_amount" | "no_change" | "refund_not_possible" | "refund_disallowed_by_policy";
     /**
      * The value as a whole number of the currency's smallest subdivision.
      */
@@ -11422,6 +11459,8 @@ type CartsResponseWritable = {
             tax?: FormattedPriceData;
             discount?: FormattedPriceData;
             without_discount?: FormattedPriceData;
+            shipping?: FormattedPriceData;
+            shipping_discount?: FormattedPriceData;
             discounts?: {
                 [key: string]: {
                     amount?: number;
@@ -11437,33 +11476,32 @@ type CartsResponseWritable = {
  * Cart Items Response
  */
 type CartItemsResponseWritable = {
-    data?: Array<CartItemObjectWritable | CustomItemObject | SubscriptionItemObjectWritable | PromotionItemObject>;
+    data?: Array<CartItemObjectWritable | CustomItemCartObjectWritable | SubscriptionItemCartObjectWritable | PromotionItemCartObjectWritable>;
 };
 /**
  * Cart Item Object
  */
 type CartItemObjectWritable = CartItemObjectData & CartItemResponseWritable;
 /**
- * Subscription Item Cart Object
+ * Custom Item Cart Object
  */
-type SubscriptionItemCartObjectWritable = SubscriptionItemObjectData & CartItemResponseWritable;
+type CustomItemCartObjectWritable = CartItemResponseWritable & {
+    type: "custom_item";
+    quantity: number;
+};
 /**
- * Promotion Item Cart Object
+ * Subscription Item Cart Object
  */
-type PromotionItemCartObjectWritable = PromotionItemObjectData & CartItemResponseWritable & {
-    /**
-     * The unique identifier of the promotion item.
-     */
-    id?: string;
+type SubscriptionItemCartObjectWritable = CartItemResponseWritable & {
+    type: "subscription_item";
+    quantity: number;
 };
 /**
- * Custom Item Cart Object
+ * Promotion Item Cart Object
  */
-type CustomItemCartObjectWritable = CustomItemObjectData & CartItemResponseWritable & {
-    /**
-     * The unique identifier of the custom item.
-     */
-    id?: string;
+type PromotionItemCartObjectWritable = CartItemResponseWritable & {
+    type: "promotion_item";
+    quantity: number;
 };
 /**
  * Included is an array of resources that are included in the response.
@@ -11700,6 +11738,18 @@ type SubscriptionMetaWritable = {
      * A history of price updates that have been applied to this subscription.
      */
     price_update_history?: Array<SubscriptionPriceUpdateHistoryEntry>;
+    /**
+     * The ID of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_id?: string;
+    /**
+     * The amount of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_amount?: number;
+    /**
+     * Who or what most recently paused this subscription, while it remains paused. Absent when the subscription has never been paused, or is not currently paused (cleared on resume). Only visible to merchandizer/store or organization-scoped callers.
+     */
+    paused_by?: "subscriber" | "merchandizer" | "dunning";
 };
 type SubscriptionAttributesWritable = {
     external_ref?: ExternalRef;

package/dist/client/types.gen.d.ts

@@ -4515,7 +4515,7 @@ type CustomerCheckout = {
          * An optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.
          */
         external_ref?: string;
-        customer?: {
+        customer: {
             /**
              * The ID of the customer.
              */
@@ -4556,7 +4556,7 @@ type AccountCheckout = {
              */
             member_id?: string;
         };
-        contact?: {
+        contact: {
             /**
              * The name of the account member.
              */
@@ -5339,6 +5339,8 @@ type CartsResponse = {
             tax?: FormattedPriceData;
             discount?: FormattedPriceData;
             without_discount?: FormattedPriceData;
+            shipping?: FormattedPriceData;
+            shipping_discount?: FormattedPriceData;
             discounts?: {
                 [key: string]: {
                     amount?: number;
@@ -5354,12 +5356,33 @@ type CartsResponse = {
  * Cart Items Response
  */
 type CartItemsResponse = {
-    data?: Array<CartItemObject | CustomItemObject | SubscriptionItemObject | PromotionItemObject>;
+    data?: Array<CartItemObject | CustomItemCartObject | SubscriptionItemCartObject | PromotionItemCartObject>;
 };
 /**
  * Cart Item Object
  */
 type CartItemObject = CartItemObjectData & CartItemResponse;
+/**
+ * Custom Item Cart Object
+ */
+type CustomItemCartObject = CartItemResponse & {
+    type: "custom_item";
+    quantity: number;
+};
+/**
+ * Subscription Item Cart Object
+ */
+type SubscriptionItemCartObject = CartItemResponse & {
+    type: "subscription_item";
+    quantity: number;
+};
+/**
+ * Promotion Item Cart Object
+ */
+type PromotionItemCartObject = CartItemResponse & {
+    type: "promotion_item";
+    quantity: number;
+};
 /**
  * Data.StripeConnectPayment
  */
@@ -5409,28 +5432,6 @@ type CartIncludedPromotion = {
      */
     end: string;
 };
-/**
- * Subscription Item Cart Object
- */
-type SubscriptionItemCartObject = SubscriptionItemObjectData & CartItemResponse;
-/**
- * Promotion Item Cart Object
- */
-type PromotionItemCartObject = PromotionItemObjectData & CartItemResponse & {
-    /**
-     * The unique identifier of the promotion item.
-     */
-    id?: string;
-};
-/**
- * Custom Item Cart Object
- */
-type CustomItemCartObject = CustomItemObjectData & CartItemResponse & {
-    /**
-     * The unique identifier of the custom item.
-     */
-    id?: string;
-};
 /**
  * Included is an array of resources that are included in the response.
  */
@@ -5996,6 +5997,10 @@ type ProrationPolicyAttributes = {
      */
     rounding: "up" | "down" | "nearest";
     external_ref?: ExternalRef;
+    /**
+     * Set to `true` to allow an automatic gateway refund when a proration would otherwise be rejected for netting negative.
+     */
+    allow_negative_proration_refund?: boolean;
 };
 type ProrationPolicyUpdateAttributes = {
     external_ref?: ExternalRefUpdate;
@@ -6007,6 +6012,10 @@ type ProrationPolicyUpdateAttributes = {
      * Whether to round up or down
      */
     rounding?: "up" | "down" | "nearest";
+    /**
+     * Set to `true` to allow an automatic gateway refund when a proration would otherwise be rejected for netting negative.
+     */
+    allow_negative_proration_refund?: boolean;
 };
 type ProrationPolicyMeta = {
     owner: OwnerMeta;
@@ -6050,11 +6059,11 @@ type PricingOptionAttributes = {
      */
     end_behavior: "close" | "roll";
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can pause a subscription, but currently has no effect — subscription pausing is only available to merchandizers, regardless of this value.
+     * The subscriber can pause a subscription.
      */
     can_pause: boolean;
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can resume a paused subscription, but currently has no effect — subscription resuming is only available to merchandizers, regardless of this value.
+     * The subscriber can resume a paused subscription.
      */
     can_resume: boolean;
     /**
@@ -6097,11 +6106,11 @@ type PricingOptionUpdateAttributes = {
      */
     end_behavior?: "close" | "roll";
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can pause a subscription, but currently has no effect — subscription pausing is only available to merchandizers, regardless of this value.
+     * The subscriber can pause a subscription.
      */
     can_pause?: boolean;
     /**
-     * Reserved for a future release. Intended to control whether a subscriber can resume a paused subscription, but currently has no effect — subscription resuming is only available to merchandizers, regardless of this value.
+     * The subscriber can resume a paused subscription.
      */
     can_resume?: boolean;
     /**
@@ -6447,6 +6456,18 @@ type SubscriptionMeta = {
      * A history of price updates that have been applied to this subscription.
      */
     price_update_history?: Array<SubscriptionPriceUpdateHistoryEntry>;
+    /**
+     * The ID of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_id?: string;
+    /**
+     * The amount of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_amount?: number;
+    /**
+     * Who or what most recently paused this subscription, while it remains paused. Absent when the subscription has never been paused, or is not currently paused (cleared on resume). Only visible to merchandizer/store or organization-scoped callers.
+     */
+    paused_by?: "subscriber" | "merchandizer" | "dunning";
 };
 type SubscriptionTimestamps = SubscriptionsTimestamps & {
     /**
@@ -6562,12 +6583,28 @@ type ProrationPreviewAttributes = {
      * Whether submitting this prospective change would actually result in a proration.
      */
     would_prorate: boolean;
+    /**
+     * Whether this change would result in a Proration Refund - a real refund issued against the
+     * subscription's previous invoice payment because the unused-time credit exceeds the new pricing
+     * option's cost. Set alongside `would_prorate: true` for this case; omitted otherwise.
+     *
+     */
+    would_refund?: boolean | null;
+    /**
+     * The amount that would be refunded as a Proration Refund, as a whole number of the currency's
+     * smallest subdivision. Set only when `would_refund` is `true`.
+     *
+     */
+    refund_amount?: number | null;
     /**
      * Why a previewed change would not result in a proration if actually submitted. Returned alongside
-     * `would_prorate: false`; this is not an error response.
+     * `would_prorate: false`; this is not an error response. `negative_amount` is retained for backward
+     * compatibility but is no longer returned - a negative-net change now either proceeds with a
+     * Proration Refund (`would_refund: true`), is rejected as `refund_not_possible`, or is rejected as
+     * `refund_disallowed_by_policy` when the applicable proration policy does not allow refunds.
      *
      */
-    rejection_reason: "negative_amount" | "no_change";
+    rejection_reason: "negative_amount" | "no_change" | "refund_not_possible" | "refund_disallowed_by_policy";
     /**
      * The value as a whole number of the currency's smallest subdivision.
      */
@@ -11422,6 +11459,8 @@ type CartsResponseWritable = {
             tax?: FormattedPriceData;
             discount?: FormattedPriceData;
             without_discount?: FormattedPriceData;
+            shipping?: FormattedPriceData;
+            shipping_discount?: FormattedPriceData;
             discounts?: {
                 [key: string]: {
                     amount?: number;
@@ -11437,33 +11476,32 @@ type CartsResponseWritable = {
  * Cart Items Response
  */
 type CartItemsResponseWritable = {
-    data?: Array<CartItemObjectWritable | CustomItemObject | SubscriptionItemObjectWritable | PromotionItemObject>;
+    data?: Array<CartItemObjectWritable | CustomItemCartObjectWritable | SubscriptionItemCartObjectWritable | PromotionItemCartObjectWritable>;
 };
 /**
  * Cart Item Object
  */
 type CartItemObjectWritable = CartItemObjectData & CartItemResponseWritable;
 /**
- * Subscription Item Cart Object
+ * Custom Item Cart Object
  */
-type SubscriptionItemCartObjectWritable = SubscriptionItemObjectData & CartItemResponseWritable;
+type CustomItemCartObjectWritable = CartItemResponseWritable & {
+    type: "custom_item";
+    quantity: number;
+};
 /**
- * Promotion Item Cart Object
+ * Subscription Item Cart Object
  */
-type PromotionItemCartObjectWritable = PromotionItemObjectData & CartItemResponseWritable & {
-    /**
-     * The unique identifier of the promotion item.
-     */
-    id?: string;
+type SubscriptionItemCartObjectWritable = CartItemResponseWritable & {
+    type: "subscription_item";
+    quantity: number;
 };
 /**
- * Custom Item Cart Object
+ * Promotion Item Cart Object
  */
-type CustomItemCartObjectWritable = CustomItemObjectData & CartItemResponseWritable & {
-    /**
-     * The unique identifier of the custom item.
-     */
-    id?: string;
+type PromotionItemCartObjectWritable = CartItemResponseWritable & {
+    type: "promotion_item";
+    quantity: number;
 };
 /**
  * Included is an array of resources that are included in the response.
@@ -11700,6 +11738,18 @@ type SubscriptionMetaWritable = {
      * A history of price updates that have been applied to this subscription.
      */
     price_update_history?: Array<SubscriptionPriceUpdateHistoryEntry>;
+    /**
+     * The ID of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_id?: string;
+    /**
+     * The amount of the most recent Proration Refund issued for this subscription, if any.
+     */
+    last_refund_amount?: number;
+    /**
+     * Who or what most recently paused this subscription, while it remains paused. Absent when the subscription has never been paused, or is not currently paused (cleared on resume). Only visible to merchandizer/store or organization-scoped callers.
+     */
+    paused_by?: "subscriber" | "merchandizer" | "dunning";
 };
 type SubscriptionAttributesWritable = {
     external_ref?: ExternalRef;