@epcc-sdk/sdks-shopper 0.0.2 → 0.0.3

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

@@ -1766,6 +1766,7 @@ export type CartsRequest = {
      * The cart name provided by the shopper. A cart name must contain 1 to 255 characters. You cannot use whitespace characters, but special characters are permitted. For more information, see the [Safe Characters](/guides/Getting-Started/safe-characters) section.
      */
     name?: string;
+    contact?: CartContact;
     /**
      * This optional parameter sets a reference date for the cart. If this parameter is set, it allows the cart to act as one that might occur on that specified date. For example, such future carts might acquire future-enabled discounts, allowing users to test and validate future interactions with carts. The snapshot_date must be in the format 2026-02-21T15:07:25Z. By default, this parameter is left empty.
      */
@@ -1776,6 +1777,12 @@ export type CartsRequest = {
      */
     payment_intent_id?: string;
 };
+export type CartContact = {
+    /**
+     * The email address attached to a cart.
+     */
+    email?: string;
+};
 export type DiscountSettings = {
     /**
      * This parameter enables custom discounts for a cart. When set to true, Elastic Path promotions will not be applied to the new carts. Default is set from cart discount settings for the store. See [Cart Settings](/docs/api/settings/put-v-2-settings-cart).
@@ -1823,6 +1830,7 @@ export type CartResponse = {
      * A description of the cart.
      */
     description?: string;
+    contact?: CartContact;
     discount_settings?: DiscountSettings;
     /**
      * Stripe-assigned unique identifier for the linked Payment Intent
@@ -1872,7 +1880,7 @@ export type CartResponse = {
         };
     };
 };
-export type CartItemsObjectRequest = CartItemObject | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject;
+export type CartItemsObjectRequest = CartItemObject | SubscriptionItemObject | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject;
 export type CartItemObject = {
     data?: CartItemObjectData & CartItemResponse;
 };
@@ -1913,11 +1921,45 @@ export type CartItemObjectData = {
         selected_options?: {
             [key: string]: unknown;
         };
+        /**
+         * Array of component products for the selected options.
+         */
+        component_products?: Array<unknown>;
     };
     /**
      * Identifier for a created Cart Shipping Group
      */
     shipping_group_id?: string;
+    /**
+     * The slug of a stock location.
+     */
+    location?: string;
+};
+export type SubscriptionItemObject = {
+    data?: SubscriptionItemObjectData & CartItemResponse;
+};
+export type SubscriptionItemObjectData = {
+    /**
+     * The type of object being returned.
+     */
+    type: "subscription_item";
+    /**
+     * The number of items added to the cart.
+     */
+    quantity: number;
+    /**
+     * Specifies the ID of the subscription offering you want to add to cart.
+     */
+    id: string;
+    /**
+     * Specifies how the subscription offering should be configured.
+     */
+    subscription_configuration: {
+        /**
+         * The ID of the plan within the offering to use for the subscription.
+         */
+        plan: string;
+    };
 };
 export type CartMergeObjectRequest = {
     data?: Array<CartMergeObject>;
@@ -2066,6 +2108,10 @@ export type CartItemResponse = {
      * The unique ID of the product.
      */
     readonly product_id?: string;
+    /**
+     * The unique ID of the subscription offering for subscription items.
+     */
+    readonly subscription_offering_id?: string;
     /**
      * The name of this item
      */
@@ -2322,11 +2368,15 @@ export type OrdersAnonymizeData = {
     order_ids?: Array<string>;
 };
 export type OrdersUpdateRequest = {
-    data?: OrdersAddressData | OrdersCancelData | OrdersFulfulledData;
+    data?: OrdersAddressData | OrdersCancelData | OrdersFulfilledData;
 };
 export type OrdersAddressData = {
     /**
-     * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and does 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.
+     * Specifies a user-managed, optional field used as an alternative to the existing order_id. If provided, the order-number will be sent to Authorize.net instead of the order_id, and will appear as the invoice number in Authorize.net transactions.
+     */
+    order_number?: string;
+    /**
+     * Represents 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;
     shipping_address: {
@@ -2390,11 +2440,11 @@ export type OrdersCancelData = {
      */
     type: string;
     /**
-     * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and does 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.
+     * Represents 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;
 };
-export type OrdersFulfulledData = {
+export type OrdersFulfilledData = {
     /**
      * The shipping status of the order. You can only update the shipping status to `fulfilled`.
      */
@@ -2404,7 +2454,7 @@ export type OrdersFulfulledData = {
      */
     type: string;
     /**
-     * Represents an optional external ID reference for an order. It can contain alphanumeric characters, special characters, and spaces, and does 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.
+     * Represents 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;
 };
@@ -2554,7 +2604,7 @@ export type DataPayPalExpressCheckoutPayment = DataBasePayments & {
         soft_descriptor?: string;
         application_context?: {
             /**
-             * The label that overrides the business name in the PayPal account on the payPal site.
+             * The label that overrides the business name in the PayPal account on the PayPal site.
              */
             brand_name?: string;
             /**
@@ -2786,6 +2836,10 @@ export type OrderItemResponse = {
      * The unique identifier for this order item.
      */
     readonly product_id?: string;
+    /**
+     * The unique identifier for the subscription offering for this order item.
+     */
+    readonly subscription_offering_id?: string;
     /**
      * The name of this order item.
      */
@@ -2845,6 +2899,14 @@ export type OrderResponse = {
      * Specifies the type of object being returned. You must use `order`.
      */
     type?: string;
+    /**
+     * Specifies a user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
+     */
+    order_number?: string;
+    /**
+     * 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;
     /**
      * Specifies the unique identifier of the order.
      */
@@ -2882,6 +2944,14 @@ export type OrderMeta = {
 };
 export type CustomerCheckout = {
     data?: {
+        /**
+         * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
+         */
+        order_number?: string;
+        /**
+         * 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?: {
             /**
              * The ID of the customer.
@@ -2894,6 +2964,14 @@ export type CustomerCheckout = {
 };
 export type AccountCheckout = {
     data?: {
+        /**
+         * A user-managed, optional field used as an alternative to the existing `order_id`. If provided, the order-number will be sent to Authorize.net instead of the `order_id`, and will appear as the invoice number in Authorize.net transactions.
+         */
+        order_number?: string;
+        /**
+         * 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;
         account?: {
             /**
              * The account ID.
@@ -2919,18 +2997,6 @@ export type AccountCheckout = {
     };
 };
 export type BillingAddress = {
-    /**
-     * Company name of the billing recipient.
-     */
-    company_name?: string;
-    /**
-     * Specifies the country of the billing address.
-     */
-    country: string;
-    /**
-     * Specifies the county of the billing address.
-     */
-    county?: string;
     /**
      * First name of the billing recipient.
      */
@@ -2939,6 +3005,10 @@ export type BillingAddress = {
      * Last name of the billing recipient.
      */
     last_name: string;
+    /**
+     * Company name of the billing recipient.
+     */
+    company_name: string;
     /**
      * First line of the billing address.
      */
@@ -2946,13 +3016,25 @@ export type BillingAddress = {
     /**
      * Second line of the billing address.
      */
-    line_2?: string;
+    line_2: string;
+    /**
+     * City of the billing address.
+     */
+    city: string;
     /**
      * Postcode of the billing address.
      */
     postcode: string;
     /**
-     * Specifies state, province, or region of the billing address.
+     * County of the billing address.
+     */
+    county: string;
+    /**
+     * Country of the billing address.
+     */
+    country: string;
+    /**
+     * State, province, or region of the billing address.
      */
     region: string;
 };
@@ -2967,18 +3049,6 @@ export type Contact = {
     name?: string;
 };
 export type ShippingAddress = {
-    /**
-     * Company of the shipping recipient.
-     */
-    company_name?: string;
-    /**
-     * Specifies the country of the shipping address.
-     */
-    country: string;
-    /**
-     * Specifies the county of the shipping address.
-     */
-    county?: string;
     /**
      * First name of the shipping recipient.
      */
@@ -2987,6 +3057,14 @@ export type ShippingAddress = {
      * Last name of the shipping recipient.
      */
     last_name: string;
+    /**
+     * Phone number of the shipping recipient.
+     */
+    phone_number: string;
+    /**
+     * Company of the shipping recipient.
+     */
+    company_name: string;
     /**
      * First line of the shipping address.
      */
@@ -2994,15 +3072,31 @@ export type ShippingAddress = {
     /**
      * Second line of the shipping address.
      */
-    line_2?: string;
+    line_2: string;
+    /**
+     * City of the shipping address.
+     */
+    city: string;
     /**
      * Post code of the shipping address.
      */
     postcode: string;
     /**
-     * Specifies the state, province, or region of the shipping address.
+     * County of the shipping address.
+     */
+    county: string;
+    /**
+     * Country of the shipping address.
+     */
+    country: string;
+    /**
+     * State, province, or region of the shipping address.
      */
     region: string;
+    /**
+     * Delivery instructions.
+     */
+    instructions: string;
 };
 export type ResponseMetaCarts = {
     page?: ResponsePaginationPage;
@@ -5567,6 +5661,19 @@ export type AddCustomDiscountToCartItemData = {
     query?: never;
     url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts";
 };
+export type AddCustomDiscountToCartItemErrors = {
+    /**
+     * Unauthorized
+     */
+    401: ResponseError;
+};
+export type AddCustomDiscountToCartItemError = AddCustomDiscountToCartItemErrors[keyof AddCustomDiscountToCartItemErrors];
+export type AddCustomDiscountToCartItemResponses = {
+    200: ResponseData & {
+        data?: CartsCustomDiscountsResponse;
+    };
+};
+export type AddCustomDiscountToCartItemResponse = AddCustomDiscountToCartItemResponses[keyof AddCustomDiscountToCartItemResponses];
 export type DeleteCustomDiscountFromCartItemData = {
     body?: never;
     path: {
@@ -5621,6 +5728,19 @@ export type UpdateCustomDiscountForCartItemData = {
     query?: never;
     url: "/v2/carts/{cartID}/items/{cartitemID}/custom-discounts/{customdiscountID}";
 };
+export type UpdateCustomDiscountForCartItemErrors = {
+    /**
+     * Unauthorized
+     */
+    401: ResponseError;
+};
+export type UpdateCustomDiscountForCartItemError = UpdateCustomDiscountForCartItemErrors[keyof UpdateCustomDiscountForCartItemErrors];
+export type UpdateCustomDiscountForCartItemResponses = {
+    200: ResponseData & {
+        data?: CartsCustomDiscountsResponse;
+    };
+};
+export type UpdateCustomDiscountForCartItemResponse = UpdateCustomDiscountForCartItemResponses[keyof UpdateCustomDiscountForCartItemResponses];
 export type CreateCartPaymentIntentData = {
     body?: ElasticPathPaymentsPoweredByStripePayment;
     path: {
@@ -5785,7 +5905,7 @@ export type GetOrderItemsResponses = {
 };
 export type GetOrderItemsResponse = GetOrderItemsResponses[keyof GetOrderItemsResponses];
 export type AnonymizeOrdersData = {
-    body?: OrdersAnonymizeRequest;
+    body?: OrdersAnonymizeRequest & unknown;
     path?: never;
     query?: never;
     url: "/v2/orders/anonymize";
@@ -5810,7 +5930,7 @@ export type AnonymizeOrdersResponses = {
     };
 };
 export type AnonymizeOrdersResponse = AnonymizeOrdersResponses[keyof AnonymizeOrdersResponses];
-export type AuthorizeSetupData = {
+export type PaymentSetupData = {
     body?: PaymentsRequest;
     path: {
         /**
@@ -5821,14 +5941,14 @@ export type AuthorizeSetupData = {
     query?: never;
     url: "/v2/orders/{orderID}/payments";
 };
-export type AuthorizeSetupErrors = {
+export type PaymentSetupErrors = {
     /**
      * Unauthorized
      */
     401: ResponseError;
 };
-export type AuthorizeSetupError = AuthorizeSetupErrors[keyof AuthorizeSetupErrors];
-export type AuthorizeSetupResponses = {
+export type PaymentSetupError = PaymentSetupErrors[keyof PaymentSetupErrors];
+export type PaymentSetupResponses = {
     /**
      * OK
      */
@@ -5836,8 +5956,8 @@ export type AuthorizeSetupResponses = {
         data?: TransactionResponse;
     };
 };
-export type AuthorizeSetupResponse = AuthorizeSetupResponses[keyof AuthorizeSetupResponses];
-export type ConfirmSetupData = {
+export type PaymentSetupResponse = PaymentSetupResponses[keyof PaymentSetupResponses];
+export type ConfirmPaymentData = {
     body?: OrdersTransactionsConfirmRequest;
     path: {
         /**
@@ -5852,19 +5972,19 @@ export type ConfirmSetupData = {
     query?: never;
     url: "/v2/orders/{orderID}/transactions/{transactionID}/confirm";
 };
-export type ConfirmSetupErrors = {
+export type ConfirmPaymentErrors = {
     /**
      * Unauthorized
      */
     401: ResponseError;
 };
-export type ConfirmSetupError = ConfirmSetupErrors[keyof ConfirmSetupErrors];
-export type ConfirmSetupResponses = {
+export type ConfirmPaymentError = ConfirmPaymentErrors[keyof ConfirmPaymentErrors];
+export type ConfirmPaymentResponses = {
     200: ResponseData & {
         data?: TransactionResponse;
     };
 };
-export type ConfirmSetupResponse = ConfirmSetupResponses[keyof ConfirmSetupResponses];
+export type ConfirmPaymentResponse = ConfirmPaymentResponses[keyof ConfirmPaymentResponses];
 export type CaptureATransactionData = {
     body?: OrdersTransactionsCaptureRequest;
     path: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epcc-sdk/sdks-shopper",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "",
   "main": "dist/index.js",
   "exports": {