@shopify/ui-extensions 2022.10.5 → 2023.4.0

package/build/ts/surfaces/checkout/api/standard/standard.d.ts

@@ -1,7 +1,5 @@
 import type { StatefulRemoteSubscribable } from '@remote-ui/async-subscription';
-import type { StandardApi as BaseStandardApi } from '../../../../api';
-import type { ExtensionPoint as AnyExtensionPoint } from '../../extension-points';
-import type { CurrencyCode, CountryCode, Timezone } from '../shared';
+import type { CurrencyCode, CountryCode, Timezone, GraphQLError, StorefrontApiVersion, ValidationError, SellingPlan, Attribute } from '../shared';
 /**
  * A key-value storage object for extension points.
  *
@@ -34,27 +32,33 @@ export interface Storage {
     delete(key: string): Promise<void>;
 }
 /**
- * The high-level capabilities an extension is allowed to have access to.
+ * The capabilities an extension has access to.
  *
- * * `network_access` allows an extension to make network calls via fetch() and
- *    is requested by a partner
+ * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.
  *
- * * `block_progress` allows an extension to block a buyer's progress through
- *    checkout and may be granted by a merchant in differing checkout contexts
+ * * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.
+ *
+ * * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.
  */
-export type Capability = 'network_access' | 'block_progress';
+export type Capability = 'api_access' | 'network_access' | 'block_progress';
 /**
  * Meta information about an extension point.
  */
-export interface ExtensionInstance {
+export interface Extension {
     /**
      * The published version of the running extension point.
      *
-     * For unpublished extensions, the value is `null`.
+     * For unpublished extensions, the value is `undefined`.
      *
      * @example 3.0.10
      */
     version?: string;
+    /**
+     * The API version that was set in the extension config file.
+     *
+     * @example '2023-01', '2022-10'
+     */
+    apiVersion: ApiVersion;
     /**
      * The URL to the script that started the extension point.
      */
@@ -73,14 +77,13 @@ export interface ExtensionInstance {
     rendered: StatefulRemoteSubscribable<boolean>;
     /**
      * The allowed capabilities of the extension, defined
-     * in your `shopify.ui.extension.toml` file .
+     * in your [shopify.ui.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file.
      *
-     * `network_access`:
-     * You must [request access](https://shopify.dev/api/checkout-extensions/checkout/configuration#complete-a-request-for-network-access)
-     * to make network calls.
+     * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.
      *
-     * `block_progress`:
-     * Merchants control whether your extension [can block checkout progress](https://shopify.dev/api/checkout-extensions/checkout/configuration#block-progress)
+     * * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.
+     *
+     * * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.
      */
     capabilities: StatefulRemoteSubscribable<Capability[]>;
     /**
@@ -96,94 +99,6 @@ export interface Editor {
      */
     type: 'checkout';
 }
-/**
- * Removes a note
- */
-export interface NoteRemoveChange {
-    /**
-     * The type of the `NoteRemoveChange` API.
-     */
-    type: 'removeNote';
-}
-/**
- * An Update to a note on the order.
- * for example, the buyer could request detailed packaging instructions in an order note
- */
-export interface NoteUpdateChange {
-    /**
-     * The type of the `NoteUpdateChange` API.
-     */
-    type: 'updateNote';
-    /**
-     * The new value of the note.
-     */
-    note: string;
-}
-export type NoteChange = NoteRemoveChange | NoteUpdateChange;
-export interface NoteChangeResultSuccess {
-    /**
-     * The type of the `NoteChangeResultSuccess` API.
-     */
-    type: 'success';
-}
-export interface NoteChangeResultError {
-    /**
-     * The type of the `NoteChangeResultError` API.
-     */
-    type: 'error';
-    /**
-     * A message that explains the error. This message is useful for debugging.
-     * It is **not** localized, and therefore should not be presented directly
-     * to the buyer.
-     */
-    message: string;
-}
-export type NoteChangeResult = NoteChangeResultSuccess | NoteChangeResultError;
-/**
- * Updates an attribute on the order. If an attribute with the
- * provided key does not already exist, it gets created.
- */
-export interface AttributeUpdateChange {
-    /**
-     * The type of the `AttributeUpdateChange` API.
-     */
-    type: 'updateAttribute';
-    /**
-     * Key of the attribute to add or update
-     */
-    key: string;
-    /**
-     * Value for the attribute to add or update
-     */
-    value: string;
-}
-export type AttributeChange = AttributeUpdateChange;
-/**
- * The returned result of a successful update to an attribute.
- */
-export interface AttributeChangeResultSuccess {
-    /**
-     * The type of the `AttributeChangeResultSuccess` API.
-     */
-    type: 'success';
-}
-/**
- * The returned result of an unsuccessful update to an attribute
- * with a message detailing the type of error that occurred.
- */
-export interface AttributeChangeResultError {
-    /**
-     * The type of the `AttributeChangeResultError` API.
-     */
-    type: 'error';
-    /**
-     * A message that explains the error. This message is useful for debugging.
-     * It is **not** localized, and therefore should not be presented directly
-     * to the buyer.
-     */
-    message: string;
-}
-export type AttributeChangeResult = AttributeChangeResultSuccess | AttributeChangeResultError;
 /**
  * Metadata associated with the checkout.
  */
@@ -206,61 +121,6 @@ export interface Metafield {
     /** The metafield’s information type. */
     valueType: 'integer' | 'string' | 'json_string';
 }
-/** Removes a metafield. */
-export interface MetafieldRemoveChange {
-    /**
-     * The type of the `MetafieldRemoveChange` API.
-     */
-    type: 'removeMetafield';
-    /**
-     * The name of the metafield to remove.
-     */
-    key: string;
-    /**
-     * The namespace of the metafield to remove.
-     */
-    namespace: string;
-}
-/**
- * Updates a metafield. If a metafield with the
- * provided key and namespace does not already exist, it gets created.
- */
-export interface MetafieldUpdateChange {
-    /**
-     * The type of the `MetafieldUpdateChange` API.
-     */
-    type: 'updateMetafield';
-    /** The name of the metafield to update. */
-    key: string;
-    /** The namespace of the metafield to add. */
-    namespace: string;
-    /** The new information to store in the metafield. */
-    value: string | number;
-    /**
-     * The metafield’s information type.
-     */
-    valueType: 'integer' | 'string' | 'json_string';
-}
-export type MetafieldChange = MetafieldRemoveChange | MetafieldUpdateChange;
-export interface MetafieldChangeResultSuccess {
-    /**
-     * The type of the `MetafieldChangeResultSuccess` API.
-     */
-    type: 'success';
-}
-export interface MetafieldChangeResultError {
-    /**
-     * The type of the `MetafieldChangeResultError` API.
-     */
-    type: 'error';
-    /**
-     * A message that explains the error. This message is useful for debugging.
-     * It is **not** localized, and therefore should not be presented directly
-     * to the buyer.
-     */
-    message: string;
-}
-export type MetafieldChangeResult = MetafieldChangeResultSuccess | MetafieldChangeResultError;
 /**
  * Represents a custom metadata attached to a resource.
  */
@@ -278,7 +138,11 @@ export interface AppMetafield {
  * The metafield owner.
  */
 export interface AppMetafieldEntryTarget {
-    /** The type of the metafield owner. */
+    /**
+     * The type of the metafield owner.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`.
+     */
     type: 'customer' | 'product' | 'shop' | 'variant';
     /** The numeric owner ID that is associated with the metafield. */
     id: string;
@@ -287,25 +151,25 @@ export interface AppMetafieldEntryTarget {
  * A metafield associated with the shop or a resource on the checkout.
  */
 export interface AppMetafieldEntry {
-    /** The target that is associated to the metadata. */
+    /**
+     * The target that is associated to the metadata.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`.
+     */
     target: AppMetafieldEntryTarget;
     /** The metadata information. */
     metafield: AppMetafield;
 }
-export type Version = 'unstable';
+export type ApiVersion = '2022-10' | '2023-01' | '2023-04' | 'unstable';
+export type Version = string;
 /**
- * This defines the i18n.translate() signature.
+ * This returns a translated string matching a key in a locale file.
+ *
+ * @example translate("banner.title")
  */
-export interface I18nTranslate {
-    /**
-     * This returns a translated string matching a key in a locale file.
-     *
-     * @example translate("banner.title")
-     */
-    <ReplacementType = string>(key: string, options?: {
-        [placeholderKey: string]: ReplacementType | string | number;
-    }): ReplacementType extends string | number ? string : (string | ReplacementType)[];
-}
+export type I18nTranslate<ReplacementType = string> = (key: string, options?: {
+    [placeholderKey: string]: ReplacementType | string | number;
+}) => ReplacementType extends string | number ? string : (string | ReplacementType)[];
 export interface I18n {
     /**
      * Returns a localized number.
@@ -372,6 +236,23 @@ export interface Currency {
      */
     isoCode: CurrencyCode;
 }
+export interface Country {
+    /**
+     * The ISO-3166-1 code for this country.
+     * @see https://www.iso.org/iso-3166-country-codes.html
+     */
+    isoCode: CountryCode;
+}
+export interface Market {
+    /**
+     * A globally-unique identifier for a market.
+     */
+    id: string;
+    /**
+     * The human-readable, shop-scoped identifier for the market.
+     */
+    handle: string;
+}
 export interface Localization {
     /**
      * The currency that the buyer sees for money amounts in the checkout.
@@ -397,81 +278,127 @@ export interface Localization {
      * extension (that is, the one matching your .default.json file).
      */
     extensionLanguage: StatefulRemoteSubscribable<Language>;
+    /**
+     * The country context of the checkout. This value carries over from the
+     * context of the cart, where it was used to contextualize the storefront
+     * experience. It will update if the buyer changes the country of their
+     * shipping address. The value is undefined if unknown.
+     */
+    country: StatefulRemoteSubscribable<Country | undefined>;
+    /**
+     * The [market](https://shopify.dev/docs/apps/markets) context of the
+     * checkout. This value carries over from the context of the cart, where it
+     * was used to contextualize the storefront experience. It will update if the
+     * buyer changes the country of their shipping address. The value is undefined
+     * if unknown.
+     */
+    market: StatefulRemoteSubscribable<Market | undefined>;
 }
 /**
- * The following APIs are provided to all extension points.
+ * Provides details on the buyer's progression through the checkout.
  */
-export interface StandardApi<ExtensionPoint extends AnyExtensionPoint> extends BaseStandardApi {
+export interface BuyerJourney {
     /**
-     * The renderer version being used for the extension.
+     * Installs a function for intercepting and preventing progress on checkout.
      *
-     * @example 'unstable'
+     * This returns a promise that resolves to a teardown function. Calling the
+     * teardown function will remove the interceptor.
+     *
+     * To block checkout progress, you must set the [block_progress](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress)
+     * capability in your extension's configuration.
      */
-    version: Version;
+    intercept(interceptor: Interceptor): Promise<() => void>;
     /**
-     * Provides details on buyer progression through the steps of the checkout.
-     */
-    buyerJourney: {
-        /**
-         * A function for intercepting and preventing progress on checkout. You can block
-         * checkout progress by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState}`.
-         * If you do, then you're expected to also update some part of your UI to reflect the reason why progress
-         * was blocked.
-         *
-         * To block checkout progress, you must set the [block_progress](https://shopify.dev/api/checkout-extensions/checkout/configuration#block-progress) capability in your extension's configuration.
-         */
-        intercept(interceptor: Interceptor): Promise<() => void>;
-    };
+     * This subscribable value will be true if the buyer completed submitting their order.
+     *
+     * For example, when viewing the order status page after submitting payment, the buyer will have completed their order.
+     */
+    completed: StatefulRemoteSubscribable<boolean>;
+}
+export interface StandardApi<ExtensionPoint extends import('../../extension-points').ExtensionPoint> {
     /**
-     * The identifier of the running extension point.
-     * @example 'Checkout::PostPurchase::Render'
+     * Methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.
      */
-    extensionPoint: ExtensionPoint;
+    analytics: Analytics;
     /**
-     * Meta information about the extension.
+     * Gift Cards that have been applied to the checkout.
      */
-    extension: ExtensionInstance;
+    appliedGiftCards: StatefulRemoteSubscribable<AppliedGiftCard[]>;
     /**
-     * Key-value storage for the extension point.
+     * The metafields requested in the
+     * [`shopify.ui.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)
+     * file. These metafields are updated when there's a change in the merchandise items
+     * being purchased by the customer.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
-    storage: Storage;
+    appMetafields: StatefulRemoteSubscribable<AppMetafieldEntry[]>;
     /**
-     * The proposed buyer shipping address. During the information step, the address
-     * updates when the field is committed (on change) rather than every keystroke.
-     * An address value is only present if delivery is required. Otherwise, the
-     * subscribable value is undefined.
+     * Custom attributes left by the customer to the merchant, either in their cart or during checkout.
      */
-    shippingAddress?: StatefulRemoteSubscribable<MailingAddress | undefined>;
+    attributes: StatefulRemoteSubscribable<Attribute[] | undefined>;
+    /**
+     * All available payment options.
+     */
+    availablePaymentOptions: StatefulRemoteSubscribable<PaymentOption[]>;
     /**
      * Information about the buyer that is interacting with the checkout.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     buyerIdentity?: BuyerIdentity;
-    /** Shop where the checkout is taking place. */
-    shop: Shop;
+    /**
+     * Provides details on the buyer's progression through the checkout.
+     *
+     * See [buyer journey](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#example-buyer-journey)
+     * examples for more information.
+     */
+    buyerJourney: BuyerJourney;
     /**
      * Details on the costs the buyer will pay for this checkout.
      */
     cost: CartCost;
     /**
-     * A note left by the customer to the merchant, either in their cart or during checkout.
+     * A list of delivery groups containing information about the delivery of the items the customer intends to purchase.
      */
-    note: StatefulRemoteSubscribable<string | undefined>;
+    deliveryGroups: StatefulRemoteSubscribable<DeliveryGroup[]>;
     /**
-     * Performs an update on the note attached to the cart and checkout. If
-     * successful, this mutation results in an update to the value retrieved
-     * through the `note` property.
+     * A list of discount codes currently applied to the checkout.
      */
-    applyNoteChange(change: NoteChange): Promise<NoteChangeResult>;
+    discountCodes: StatefulRemoteSubscribable<CartDiscountCode[]>;
     /**
-     * Custom attributes left by the customer to the merchant, either in their cart or during checkout.
+     * Discounts that have been applied to the entire cart.
      */
-    attributes: StatefulRemoteSubscribable<Attribute[] | undefined>;
+    discountAllocations: StatefulRemoteSubscribable<CartDiscountAllocation[]>;
     /**
-     * Performs an update on an attribute attached to the cart and checkout. If
-     * successful, this mutation results in an update to the value retrieved
-     * through the `attributes` property.
+     * Meta information about the extension.
      */
-    applyAttributeChange(change: AttributeChange): Promise<AttributeChangeResult>;
+    extension: Extension;
+    /**
+     * The identifier of the running extension point.
+     * @example 'Checkout::PostPurchase::Render'
+     */
+    extensionPoint: ExtensionPoint;
+    /**
+     * Utilities for translating content and formatting values according to the current
+     * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-localization)
+     * of the checkout.
+     *
+     * See [localization examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#example-localization)
+     * for more information.
+     */
+    i18n: I18n;
+    /**
+     * A list of lines containing information about the items the customer intends to purchase.
+     */
+    lines: StatefulRemoteSubscribable<CartLine[]>;
+    /**
+     * Details about the location, language, and currency of the buyer. For utilities to easily
+     * format and translate content based on these details, you can use the
+     * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-i18n)
+     * object instead.
+     */
+    localization: Localization;
     /**
      * The metafields that apply to the current checkout. The actual resource
      * on which these metafields exist depends on the source of the checkout:
@@ -492,93 +419,124 @@ export interface StandardApi<ExtensionPoint extends AnyExtensionPoint> extends B
      */
     metafields: StatefulRemoteSubscribable<Metafield[]>;
     /**
-     * Performs an update on a piece of metadata attached to the checkout. If
-     * successful, this mutation results in an update to the value retrieved
-     * through the `metafields` property.
-     */
-    applyMetafieldChange(change: MetafieldChange): Promise<MetafieldChangeResult>;
-    /**
-     * A list of lines containing information about the items the customer intends to purchase.
+     * A note left by the customer to the merchant, either in their cart or during checkout.
      */
-    lines: StatefulRemoteSubscribable<CartLine[]>;
+    note: StatefulRemoteSubscribable<string | undefined>;
     /**
      * A list of the line items displayed in the checkout. These may be the same as lines, or may be a subset.
      */
     presentmentLines: StatefulRemoteSubscribable<PresentmentCartLine[]>;
     /**
-     * Performs an update on the merchandise line items. It resolves when the new
-     * line items have been negotiated and results in an update to the value
-     * retrieved through the `lines` property.
+     * Used to query the Storefront GraphQL API with a prefetched token.
+     *
+     * See [storefront api access examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#example-storefront-api-access) for more information.
      */
-    applyCartLinesChange(change: CartLineChange): Promise<CartLineChangeResult>;
+    query: <Data = unknown, Variables = {
+        [key: string]: unknown;
+    }>(query: string, options?: {
+        variables?: Variables;
+        version?: StorefrontApiVersion;
+    }) => Promise<{
+        data?: Data;
+        errors?: GraphQLError[];
+    }>;
     /**
-     * A list of discount codes currently applied to the checkout.
+     * Payment options selected by the buyer.
      */
-    discountCodes: StatefulRemoteSubscribable<CartDiscountCode[]>;
+    selectedPaymentOptions: StatefulRemoteSubscribable<SelectedPaymentOption[]>;
     /**
-     * Discounts that have been applied to the entire cart.
+     * Provides access to session tokens, which can be used to verify token claims on your app's server.
+     *
+     * See [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#example-session-token) for more information.
      */
-    discountAllocations: StatefulRemoteSubscribable<CartDiscountAllocation[]>;
+    sessionToken: SessionToken;
     /**
-     * Performs an update on the discount codes.
-     * It resolves when the new discount codes have been negotiated and results in an update
-     * to the value retrieved through the `discountCodes` property.
+     * The settings matching the settings definition written in the
+     * [`shopify.ui.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file.
+     *
+     *  See [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#example-settings) for more information.
+     *
+     * > Note: When an extension is being installed in the editor, the settings will be empty until
+     * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.
      */
-    applyDiscountCodeChange(change: DiscountCodeChange): Promise<DiscountCodeChangeResult>;
+    settings: StatefulRemoteSubscribable<ExtensionSettings>;
     /**
-     * The metafields requested in the `shopify.ui.extension.toml` file. These metafields are
-     * updated when there's a change in the merchandise items being purchased by the customer.
+     * The proposed buyer shipping address. During the information step, the address
+     * updates when the field is committed (on change) rather than every keystroke.
+     * An address value is only present if delivery is required. Otherwise, the
+     * subscribable value is undefined.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
-    appMetafields: StatefulRemoteSubscribable<AppMetafieldEntry[]>;
+    shippingAddress?: StatefulRemoteSubscribable<MailingAddress | undefined>;
+    /** Shop where the checkout is taking place. */
+    shop: Shop;
     /**
-     * Details about the location, language, and currency of the buyer. For utilities to easily
-     * format and translate content based on these details, you can use the `i18n` object instead.
+     * Key-value storage for the extension point.
      */
-    localization: Localization;
+    storage: Storage;
     /**
-     * Utilities for translating content and formatting values according to the current `localization`
-     * of the checkout.
+     * Methods to interact with the extension's UI.
      */
-    i18n: I18n;
+    ui: Ui;
     /**
-     * The settings matching the settings definition written in the `shopify.ui.extension.toml` file.
+     * The renderer version being used for the extension.
      *
-     * **Note:** When an extension is being installed in the editor, the settings will be empty until
-     * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.
+     * @example 'unstable'
      */
-    settings: StatefulRemoteSubscribable<ExtensionSettings>;
+    version: Version;
+}
+export interface Ui {
+    overlay: {
+        close(overlayId: string): void;
+    };
+}
+export interface SessionToken {
     /**
-     * Exposes a `analytics.publish` method to publish analytics events.
+     * Requests a session token that hasn't expired. You should call this method every
+     * time you need to make a request to your backend in order to get a valid token.
+     * This method will return cached tokens when possible, so you don’t need to worry
+     * about storing these tokens yourself.
      */
-    analytics: Analytics;
+    get(): Promise<string>;
 }
 export interface BuyerIdentity {
     /**
-     * The customer account from the buyer. This value will update when there's a
-     * change in the account. The value is undefined if the buyer isn’t a known customer
-     * for this shop.
+     * The buyer's customer account. The value is undefined if the buyer isn’t a
+     * known customer for this shop or if they haven't logged in yet.
      *
-     * Protected resource: Requires approval to access protected customer data.
-     * More info - https://shopify.dev/apps/store/data-protection/protected-customer-data
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     customer: StatefulRemoteSubscribable<Customer | undefined>;
     /**
-     * The email address of the buyer that is interacting with the cart. This value will update when there's a
-     * change in the checkout formulary. The value is undefined if no permission given.
+     * The email address of the buyer that is interacting with the cart.
+     * The value is `undefined` if the app does not have access to customer data.
      *
-     * Protected resource: Requires approval to access protected customer data (Level 2).
-     * More info - https://shopify.dev/apps/store/data-protection/protected-customer-data
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     email: StatefulRemoteSubscribable<string | undefined>;
     /**
-     * The phone number of the buyer that is interacting with the cart. This value will update when there's a
-     * change in the checkout formulary. The value is undefined if no permission given.
+     * The phone number of the buyer that is interacting with the cart.
+     * The value is `undefined` if the app does not have access to customer data.
      *
-     * Protected resource: Requires approval to access protected customer data (Level 2).
-     * More info - https://shopify.dev/apps/store/data-protection/protected-customer-data
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     phone: StatefulRemoteSubscribable<string | undefined>;
 }
+export interface AppliedGiftCard {
+    /**
+     * The last four characters of the applied gift card's code.
+     */
+    lastCharacters: string;
+    /**
+     * The amount of the applied gift card that will be used when the checkout is completed.
+     */
+    amountUsed: Money;
+    /**
+     * The current balance of the applied gift card prior to checkout completion.
+     */
+    balance: Money;
+}
 export interface Shop {
     /**
      * The shop ID.
@@ -601,56 +559,89 @@ export interface Shop {
 export interface MailingAddress {
     /**
      * The buyer's full name.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'John Doe'
      */
     name?: string;
     /**
      * The buyer's first name.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'John'
      */
     firstName?: string;
     /**
      * The buyer's last name.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'Doe'
      */
     lastName?: string;
     /**
      * The buyer's company name.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'Shopify'
      */
     company?: string;
     /**
      * The first line of the buyer's address, including street name and number.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example '151 O'Connor Street'
      */
     address1?: string;
     /**
      * The second line of the buyer's address, like apartment number, suite, etc.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'Ground floor'
      */
     address2?: string;
     /**
      * The buyer's city.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'Ottawa'
      */
     city?: string;
     /**
      * The buyer's postal or ZIP code.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'K2P 2L8'
      */
     zip?: string;
     /**
      * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'CA' for Canada.
      */
     countryCode?: CountryCode;
     /**
      * The buyer's zone code, such as state, province, prefecture, or region.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'ON' for Ontario.
      */
     provinceCode?: string;
     /**
      * The buyer's phone number.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example '+1 613 111 2222'.
      */
     phone?: string;
@@ -692,22 +683,44 @@ export interface CartLine {
      * Discounts applied to the cart line.
      */
     discountAllocations: CartDiscountAllocation[];
-    /** @private */
-    __lineComponents: CartLineComponentType[];
+    /**
+     * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array.
+     */
+    lineComponents: CartLineComponentType[];
 }
-/** @private */
 type CartLineComponentType = CartBundleLineComponent;
-/** @private */
 export interface CartBundleLineComponent {
+    type: 'bundle';
+    /**
+     * A unique identifier for the bundle line component.
+     *
+     * This ID is not stable. If an operation updates the line items in any way, all IDs could change.
+     *
+     * @example 'gid://shopify/CartLineComponent/123'
+     */
     id: string;
+    /**
+     * The merchandise of this bundle line component.
+     */
     merchandise: Merchandise;
+    /**
+     * The quantity of merchandise being purchased.
+     */
     quantity: number;
+    /**
+     * The cost attributed to this bundle line component.
+     */
     cost: CartLineCost;
+    /**
+     * Additional custom attributes for the bundle line component.
+     *
+     * @example [{key: 'engraving', value: 'hello world'}]
+     */
     attributes: Attribute[];
 }
 export interface CartLineCost {
     /**
-     * The total amount the buyer can expect to pay that is directly attributable to a single
+     * The total amount after reductions the buyer can expect to pay that is directly attributable to a single
      * cart line.
      */
     totalAmount: Money;
@@ -758,6 +771,14 @@ export interface ProductVariant extends BaseMerchandise {
      * The product object that the product variant belongs to.
      */
     product: Product;
+    /**
+     * Whether or not the product requires shipping.
+     */
+    requiresShipping: boolean;
+    /**
+     * The selling plan associated with the merchandise.
+     */
+    sellingPlan?: SellingPlan;
 }
 export interface Product {
     /**
@@ -783,16 +804,6 @@ export interface ImageDetails {
      */
     altText?: string;
 }
-export interface Attribute {
-    /**
-     * The key for the attribute.
-     */
-    key: string;
-    /**
-     * The value for the attribute.
-     */
-    value: string;
-}
 export interface SelectedOption {
     /**
      * The name of the merchandise option.
@@ -841,83 +852,46 @@ export interface PresentmentCartLineCost {
      */
     totalAmount: Money;
 }
-export interface CartLineChangeResultSuccess {
-    /**
-     * Indicates that the line item was changed successfully.
-     */
-    type: 'success';
-}
-export interface CartLineChangeResultError {
-    /**
-     * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error.
-     */
-    type: 'error';
-    /**
-     * A message that explains the error. This message is useful for debugging.
-     * It is **not** localized, and therefore should not be presented directly
-     * to the buyer.
-     */
-    message: string;
-}
-export type CartLineChangeResult = CartLineChangeResultSuccess | CartLineChangeResultError;
-export type CartLineChange = CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange;
-export interface CartLineAddChange {
-    /**
-     * An identifier for changes that add line items.
-     */
-    type: 'addCartLine';
-    /**
-     * The merchandise ID being added.
-     * @example 'gid://shopify/ProductVariant/123'
-     */
-    merchandiseId: string;
-    /**
-     * The quantity of the merchandise being added.
-     */
-    quantity: number;
-    /**
-     * The attributes associated with the line item.
-     */
-    attributes?: Attribute[];
-}
-export interface CartLineRemoveChange {
-    /**
-     * An identifier for changes that remove line items.
-     */
-    type: 'removeCartLine';
-    /**
-     * Line Item ID.
-     * @example 'gid://shopify/CartLine/123'
-     */
-    id: string;
+/**
+ * A payment option presented to the buyer.
+ */
+export interface PaymentOption {
     /**
-     * The quantity being removed for this line item.
+     * The type of the payment option.
+     *
+     * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions.
+     *
+     * | Type  | Description  |
+     * |---|---|
+     * | `creditCard`  |  A vaulted or manually entered credit card.  |
+     * | `deferred`  |  A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time.  |
+     * | `local`  |  A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market  |
+     * | `manualPayment`  |  A manual payment option such as an in-person retail transaction.  |
+     * | `offsite`  |  A payment processed outside of Shopify's checkout, excluding integrated wallets.  |
+     * | `other`  |  Another type of payment not defined here.  |
+     * | `paymentOnDelivery`  |  A payment that will be collected on delivery.  |
+     * | `redeemable`  |  A redeemable payment option such as a gift card or store credit.  |
+     * | `wallet`  |  An integrated wallet such as PayPal, Google Pay, Apple Pay, etc.  |
+     * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. |
+     */
+    type: 'creditCard' | 'deferred' | 'local' | 'manualPayment' | 'offsite' | 'other' | 'paymentOnDelivery' | 'redeemable' | 'wallet' | 'customOnsite';
+    /**
+     * The unique handle for the payment option.
+     *
+     * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop.
      */
-    quantity: number;
+    handle: string;
 }
-export interface CartLineUpdateChange {
-    /**
-     * An identifier for changes that update line items.
-     */
-    type: 'updateCartLine';
-    /**
-     * Line Item ID.
-     * @example 'gid://shopify/CartLine/123'
-     */
-    id: string;
-    /**
-     * The new merchandise ID for the line item.
-     * @example 'gid://shopify/ProductVariant/123'
-     */
-    merchandiseId?: string;
-    /**
-     * The new quantity for the line item.
-     */
-    quantity?: number;
+/**
+ * A payment option selected by the buyer.
+ */
+export interface SelectedPaymentOption {
     /**
-     * The new attributes for the line item.
+     * The unique handle referencing `PaymentOption.handle`.
+     *
+     * See [availablePaymentOptions](https://shopify.dev/docs/api/checkout-ui-extensions/unstable/apis/standardapi#properties-propertydetail-availablepaymentoptions).
      */
-    attributes?: Attribute[];
+    handle: string;
 }
 export interface CartDiscountCode {
     /**
@@ -962,46 +936,6 @@ export interface CartCustomDiscountAllocation extends CartDiscountAllocationBase
      */
     type: 'custom';
 }
-export type DiscountCodeChange = DiscountCodeAddChange | DiscountCodeRemoveChange;
-export type DiscountCodeChangeResult = DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError;
-export interface DiscountCodeAddChange {
-    /**
-     * The type of the `DiscountCodeChange` API.
-     */
-    type: 'addDiscountCode';
-    /**
-     * The code for the discount
-     */
-    code: string;
-}
-export interface DiscountCodeRemoveChange {
-    /**
-     * The type of the `DiscountCodeChange` API.
-     */
-    type: 'removeDiscountCode';
-    /**
-     * The code for the discount
-     */
-    code: string;
-}
-export interface DiscountCodeChangeResultSuccess {
-    /**
-     * Indicates that the discount code change was applied successfully.
-     */
-    type: 'success';
-}
-export interface DiscountCodeChangeResultError {
-    /**
-     * Indicates that the discount code change failed.
-     */
-    type: 'error';
-    /**
-     * A message that explains the error. This message is useful for debugging.
-     * It is **not** localized, and therefore should not be presented directly
-     * to the buyer.
-     */
-    message: string;
-}
 type InterceptorResult = InterceptorResultAllow | InterceptorResultBlock;
 interface InterceptorResultAllow {
     /**
@@ -1042,13 +976,17 @@ interface InterceptorRequestBlock {
      * own internal debugging and metrics.
      */
     reason: string;
+    /**
+     * Used to pass errors to the checkout UI, outside your extension's UI boundaries.
+     */
+    errors?: ValidationError[];
     /**
      * This callback is called when all interceptors finish. We recommend
      * setting errors or reasons for blocking at this stage, so that all the errors in
      * the UI show up at once.
      * @param result InterceptorResult with behavior as either 'allow' or 'block'
      */
-    perform(result: InterceptorResult): void | Promise<void>;
+    perform?(result: InterceptorResult): void | Promise<void>;
 }
 export interface InterceptorProps {
     /**
@@ -1057,52 +995,92 @@ export interface InterceptorProps {
      */
     canBlockProgress: boolean;
 }
-export interface Interceptor {
-    /**
-     * A function for intercepting and preventing navigation on checkout. You can block
-     * navigation by returning an object with `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState}`.
-     * If you do, then you're expected to also update some part of your UI to reflect the reason why navigation
-     * was blocked.
-     */
-    (interceptorProps: InterceptorProps): InterceptorRequest | Promise<InterceptorRequest>;
-}
+/**
+ * A function for intercepting and preventing navigation on checkout. You can block
+ * navigation by returning an object with
+ * `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`.
+ * If you do, then you're expected to also update some part of your UI to reflect the reason why navigation
+ * was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension.
+ */
+export type Interceptor = (interceptorProps: InterceptorProps) => InterceptorRequest | Promise<InterceptorRequest>;
 /**
  * Information about a customer who has previously purchased from this shop.
+ *
+ * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
  */
 export interface Customer {
     /**
      * Customer ID.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
      * @example 'gid://shopify/Customer/123'
      */
     id: string;
     /**
      * The email of the customer.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     email?: string;
     /**
      * The phone number of the customer.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     phone?: string;
     /**
      * The full name of the customer.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     fullName?: string;
     /**
      * The first name of the customer.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     firstName?: string;
     /**
      * The last name of the customer.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     lastName?: string;
     /**
      * The image associated with the customer.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     image: ImageDetails;
     /**
      * Defines if the customer accepts marketing activities.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
      */
     acceptsMarketing: boolean;
+    /**
+     * The Store Credit Accounts owned by the customer and usable during the checkout process.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
+     * @private
+     */
+    storeCreditAccounts: StoreCreditAccount[];
+}
+/**
+ * Information about a Store Credit Account.
+ */
+export interface StoreCreditAccount {
+    /**
+     * A globally-unique identifier.
+     * @example 'gid://shopify/StoreCreditAccount/1'
+     */
+    id: string;
+    /**
+     * The current balance of the Store Credit Account.
+     */
+    balance: Money;
 }
 /**
  * The merchant-defined setting values for the extension.
@@ -1110,13 +1088,191 @@ export interface Customer {
 export interface ExtensionSettings {
     [key: string]: string | number | boolean | undefined;
 }
-/**
- * Publish method to emit analytics events to Web Pixels.
- */
 export interface Analytics {
+    /**
+     * Publish method to emit analytics events to [Web Pixels](https://shopify.dev/docs/apps/marketing).
+     */
     publish(name: string, data: {
         [key: string]: unknown;
     }): Promise<boolean>;
 }
+/**
+ * Represents the delivery information and options available for one or
+ * more cart lines.
+ */
+export interface DeliveryGroup {
+    /**
+     * The cart line references associated to the delivery group.
+     */
+    targetedCartLines: CartLineReference[];
+    /**
+     * The delivery options available for the delivery group.
+     */
+    deliveryOptions: DeliveryOption[];
+    /**
+     * The selected delivery option for the delivery group.
+     */
+    selectedDeliveryOption?: DeliveryOptionReference;
+    /**
+     * The type of the delivery group.
+     */
+    groupType: DeliveryGroupType;
+    /**
+     * Whether delivery is required for the delivery group.
+     */
+    deliveryRequired: boolean;
+}
+/**
+ * The possible types of a delivery group.
+ */
+export type DeliveryGroupType = 'oneTimePurchase' | 'subscription';
+/**
+ * Represents a reference to a cart line.
+ */
+export interface CartLineReference {
+    /**
+     * The unique identifier of the referenced cart line.
+     */
+    id: string;
+}
+/**
+ * Represents a reference to a delivery option.
+ */
+export interface DeliveryOptionReference {
+    /**
+     * The unique identifier of the referenced delivery option.
+     */
+    handle: string;
+}
+/**
+ * Represents a base interface for a single delivery option.
+ */
+export interface DeliveryOption {
+    /**
+     * The unique identifier of the delivery option.
+     */
+    handle: string;
+    /**
+     * The title of the delivery option.
+     */
+    title?: string;
+    /**
+     * The description of the delivery option.
+     */
+    description?: string;
+}
+/**
+ * Represents a delivery option that is a shipping option.
+ */
+export interface ShippingOption extends DeliveryOption {
+    /**
+     * The type of this delivery option.
+     */
+    type: 'shipping' | 'local';
+    /**
+     * Information about the carrier.
+     */
+    carrier: ShippingOptionCarrier;
+    /**
+     * The cost of the delivery.
+     */
+    cost: Money;
+    /**
+     * The cost of the delivery including discounts.
+     */
+    costAfterDiscounts: Money;
+    /**
+     * Information about the estimated delivery time.
+     */
+    deliveryEstimate: DeliveryEstimate;
+}
+export interface DeliveryEstimate {
+    /**
+     * The estimated time in transit for the delivery in seconds.
+     */
+    timeInTransit?: NumberRange;
+}
+export interface ShippingOptionCarrier {
+    /**
+     * The name of the carrier.
+     */
+    name?: string;
+}
+export interface PickupPointOption extends DeliveryOption {
+    /**
+     * The type of this delivery option.
+     */
+    type: 'pickupPoint';
+    /**
+     * Information about the carrier that ships to the pickup point.
+     */
+    carrier: PickupPointCarrier;
+    /**
+     * The cost to ship to this pickup point.
+     */
+    cost: Money;
+    /**
+     * The cost to ship to this pickup point including discounts.
+     */
+    costAfterDiscounts: Money;
+    /**
+     * The location details of the pickup point.
+     */
+    location: PickupPointLocation;
+}
+export interface PickupLocationOption extends DeliveryOption {
+    /**
+     * The type of this delivery option.
+     */
+    type: 'pickup';
+    /**
+     * The location details of the pickup location.
+     */
+    location: PickupLocation;
+}
+interface PickupLocation {
+    /**
+     * The name of the pickup location.
+     */
+    name?: string;
+    /**
+     * The address of the pickup location.
+     */
+    address: MailingAddress;
+}
+interface PickupPointLocation {
+    /**
+     * The name of the pickup point.
+     */
+    name?: string;
+    /**
+     * The unique identifier of the pickup point.
+     */
+    handle: string;
+    /**
+     * The address of the pickup point.
+     */
+    address: MailingAddress;
+}
+interface PickupPointCarrier {
+    /**
+     * The code identifying the carrier.
+     */
+    code?: string;
+    /**
+     * The name of the carrier.
+     */
+    name?: string;
+}
+export interface NumberRange {
+    /**
+     * The lower bound of the number range.
+     */
+    lower?: number;
+    /**
+     * The upper bound of the number range.
+     */
+    upper?: number;
+}
 export {};
 //# sourceMappingURL=standard.d.ts.map