Update web pixel schema (#113)

Author: kiftio

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 3.0.3 - August 9, 2024
+
+- Upgrades Swift and Android dependencies to `3.0.4`
+- Updates Web Pixel schema
+
 ## 3.0.2 - August 6, 2024
 
 - Upgrades Swift and Android dependencies to `3.0.3`
@@ -80,7 +85,7 @@ ShopifyCheckoutSheetKit.setConfig({
 ## 1.0.5 - March 5, 2024
 
 - Updates the underlying swift SDK from `1.0.1` to `1.0.2` to include
-  https://github.com/Shopify/checkout-sheet-kit-swift/pull/143
+  <https://github.com/Shopify/checkout-sheet-kit-swift/pull/143>
 
 ## 1.0.4 - March 4, 2024
 

README.md

@@ -336,7 +336,7 @@ behavior can be customized via the `colorScheme` property:
 
 | Name        | Default | Description                                                                                      |
 | ----------- | ------- | ------------------------------------------------------------------------------------------------ |
-| `automatic` | ✔       | Alternates between an idiomatic light and dark theme - depending on the users device preference. |
+| `automatic` | ✔      | Alternates between an idiomatic light and dark theme - depending on the users device preference. |
 | `light`     |         | Force the idomatic light theme.                                                                  |
 | `dark`      |         | Force the idomatic dark theme.                                                                   |
 | `web`       |         | Force your storefront web theme, as rendered by a mobile browser.                                |
@@ -723,6 +723,7 @@ Replace the details in the `sample/.env.example` file and rename it to
 # Storefront Details
 STOREFRONT_DOMAIN="YOUR_STORE.myshopify.com"
 STOREFRONT_ACCESS_TOKEN="YOUR_PUBLIC_STOREFRONT_ACCESS_TOKEN"
+STOREFRONT_VERSION="2024-04"
 ```
 
 #### Start the sample app

modules/@shopify/checkout-sheet-kit/RNShopifyCheckoutSheetKit.podspec

@@ -20,7 +20,7 @@ Pod::Spec.new do |s|
   s.source_files = "ios/*.{h,m,mm,swift}"
 
 	s.dependency "React-Core"
-	s.dependency "ShopifyCheckoutSheetKit", "~> 3.0.3"
+	s.dependency "ShopifyCheckoutSheetKit", "~> 3.0.4"
 
   if fabric_enabled
 		install_modules_dependencies(s)

modules/@shopify/checkout-sheet-kit/android/gradle.properties

@@ -5,4 +5,4 @@ ndkVersion=23.1.7779620
 buildToolsVersion = "33.0.0"
 
 # Version of Shopify Checkout SDK to use with React Native
-SHOPIFY_CHECKOUT_SDK_VERSION=3.0.3
+SHOPIFY_CHECKOUT_SDK_VERSION=3.0.4

modules/@shopify/checkout-sheet-kit/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shopify/checkout-sheet-kit",
   "license": "MIT",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "main": "lib/commonjs/index.js",
   "types": "src/index.ts",
   "source": "src/index.ts",

modules/@shopify/checkout-sheet-kit/src/pixels.d.ts

@@ -273,19 +273,29 @@ interface Checkout {
   attributes?: Attribute[];
   /* The billing address to where the order will be charged. */
   billingAddress?: MailingAddress;
+  /* Indicates whether the customer has consented to be sent marketing material via email. */
+  buyerAcceptsEmailMarketing?: boolean;
+  /*Indicates whether the customer has consented to be sent marketing material via SMS. */
+  buyerAcceptsSmsMarketing?: boolean;
   /**
    * The three-letter code that represents the currency, for example, USD.
    * Supported codes include standard ISO 4217 codes, legacy codes, and non-
    * standard codes.
    */
   currencyCode?: string;
+  /* Represents the selected delivery options for a checkout. */
+  delivery?: Delivery;
   /* A list of discount applications. */
   discountApplications?: DiscountApplication[];
+  /* The total amount of the discounts applied to the price of the checkout. */
+  discountsAmount?: MoneyV2;
   /* The email attached to this checkout. */
   email?: string;
   /* A list of line item objects, each one containing information about an item */
   /* in the checkout. */
   lineItems?: CheckoutLineItem[];
+  /* Information about the active localized experience. */
+  localization?: Localization;
   /* The resulting order from a paid checkout. */
   order?: Order;
   /* A unique phone number for the customer. Formatted using E.164 standard. For */
@@ -296,6 +306,8 @@ interface Checkout {
   /* Once a shipping rate is selected by the customer it is transitioned to a */
   /* `shipping_line` object. */
   shippingLine?: ShippingRate;
+  /* The phone number provided by the buyer after opting in to SMS marketing. */
+  smsMarketingPhone?: string;
   /* The price at checkout before duties, shipping, and taxes. */
   subtotalPrice?: MoneyV2;
   /* A unique identifier for a particular checkout. */
@@ -319,34 +331,58 @@ interface Attribute {
   value?: string;
 }
 
-/* A mailing address for customers and shipping. */
-interface MailingAddress {
-  /* The first line of the address. This is usually the street address or a P.O. */
-  /* Box number. */
-  address1?: string;
-  /* The second line of the address. This is usually an apartment, suite, or */
-  /* unit number. */
-  address2?: string;
-  /* The name of the city, district, village, or town. */
-  city?: string;
-  /* The name of the country. */
-  country?: string;
-  /* The two-letter code that represents the country, for example, US. */
-  /* The country codes generally follows ISO 3166-1 alpha-2 guidelines. */
-  countryCode?: string;
-  /* The customer’s first name. */
-  firstName?: string;
-  /* The customer’s last name. */
-  lastName?: string;
-  /* The phone number for this mailing address as entered by the customer. */
-  phone?: string;
-  /* The region of the address, such as the province, state, or district. */
-  province?: string;
-  /* The two-letter code for the region. */
-  /* For example, ON. */
-  provinceCode?: string;
-  /* The ZIP or postal code of the address. */
-  zip?: string;
+/* A single line item in the checkout, grouped by variant and attributes. */
+interface CheckoutLineItem {
+  /* The discounts that have been applied to the checkout line item by a */
+  /* discount application. */
+  discountAllocations?: DiscountAllocation[];
+  /* The combined price of all of the items in the line item after line-level discounts have been applied. */
+  finalLinePrice?: MoneyV2;
+  /* A globally unique identifier. */
+  id?: string;
+  /** The properties of the line item. A shop may add, or enable customers to add custom information to a line item.
+   * Line item properties consist of a key and value pair.
+   */
+  properties?: Property[];
+  /* The quantity of the line item. */
+  quantity?: number;
+  /* The title of the line item. Defaults to the product's title. */
+  sellingPlanAllocation?: SellingPlanAllocation;
+  title?: string;
+  /* Product variant of the line item. */
+  variant?: ProductVariant;
+}
+
+interface Country {
+  /* The ISO-3166-1 code for this country, for example, "US". */
+  isoCode?: string;
+}
+
+interface Delivery {
+  selectedDeliveryOptions?: DeliveryOption[];
+}
+
+interface DeliveryOption {
+  /* The delivery option that the customer has selected. */
+  cost?: MoneyV2;
+  /* The cost of the delivery option after discounts have been applied. */
+  costAfterDiscounts?: MoneyV2;
+  /* The description of the delivery option. */
+  description?: string;
+  /* The unique identifier of the delivery option. */
+  handle?: string;
+  /* The title of the delivery option. */
+  title?: string;
+  /* he type of delivery option, e.g. pickup, pickupPoint, shipping, local. */
+  type?: string;
+}
+
+/* The discount that has been applied to the checkout line item. */
+interface DiscountAllocation {
+  /* The monetary value with currency allocated to the discount. */
+  amount?: MoneyV2;
+  /* The information about the intent of the discount. */
+  discountApplication?: DiscountApplication;
 }
 
 /* The information about the intent of the discount. */
@@ -389,41 +425,55 @@ interface DiscountApplication {
   value?: Value;
 }
 
-/* A value given to a customer when a discount is applied to an order. The */
-/* application of a discount with this value gives the customer the specified */
-/* percentage off a specified item. */
-interface Value {
-  /* The decimal money amount. */
-  amount?: number;
-  /* The three-letter code that represents the currency, for example, USD. */
-  /* Supported codes include standard ISO 4217 codes, legacy codes, and non- */
-  /* standard codes. */
-  currencyCode?: string;
-  /* The percentage value of the object. */
-  percentage?: number;
+interface Language {
+  /* The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code, for example, "en-US". */
+  isoCode?: string;
 }
 
-/* A single line item in the checkout, grouped by variant and attributes. */
-interface CheckoutLineItem {
-  /* The discounts that have been applied to the checkout line item by a */
-  /* discount application. */
-  discountAllocations?: DiscountAllocation[];
-  /* A globally unique identifier. */
-  id?: string;
-  /* The quantity of the line item. */
-  quantity?: number;
-  /* The title of the line item. Defaults to the product's title. */
-  title?: string;
-  /* Product variant of the line item. */
-  variant?: ProductVariant;
+interface Localization {
+  /* The country of the active localized experience. */
+  country?: Country;
+  /* The language of the active localized experience. */
+  language?: Language;
+  /* The market including the country of the active localized experience. */
+  market?: Market;
 }
 
-/* The discount that has been applied to the checkout line item. */
-interface DiscountAllocation {
-  /* The monetary value with currency allocated to the discount. */
-  amount?: MoneyV2;
-  /* The information about the intent of the discount. */
-  discountApplication?: DiscountApplication;
+/* A mailing address for customers and shipping. */
+interface MailingAddress {
+  /* The first line of the address. This is usually the street address or a P.O. */
+  /* Box number. */
+  address1?: string;
+  /* The second line of the address. This is usually an apartment, suite, or */
+  /* unit number. */
+  address2?: string;
+  /* The name of the city, district, village, or town. */
+  city?: string;
+  /* The name of the country. */
+  country?: string;
+  /* The two-letter code that represents the country, for example, US. */
+  /* The country codes generally follows ISO 3166-1 alpha-2 guidelines. */
+  countryCode?: string;
+  /* The customer’s first name. */
+  firstName?: string;
+  /* The customer’s last name. */
+  lastName?: string;
+  /* The phone number for this mailing address as entered by the customer. */
+  phone?: string;
+  /* The region of the address, such as the province, state, or district. */
+  province?: string;
+  /* The two-letter code for the region. */
+  /* For example, ON. */
+  provinceCode?: string;
+  /* The ZIP or postal code of the address. */
+  zip?: string;
+}
+
+interface Market {
+  /* A human-readable, shop-scoped identifier. */
+  handle?: string;
+  /* A globally unique identifier. */
+  id?: string;
 }
 
 /**
@@ -434,6 +484,45 @@ interface DiscountAllocation {
 interface Order {
   /* The ID of the order. */
   id?: string;
+  /* The customer that placed the order. */
+  customer?: OrderCustomer;
+}
+
+interface OrderCustomer {
+  /* The ID of the customer. */
+  id?: string;
+}
+
+/**
+ * A value given to a customer when a discount is applied to an order. The
+ * application of a discount with this value gives the customer the specified
+ * percentage off a specified item.
+ */
+interface PricingPercentageValue {
+  /* The percentage value of the object. */
+  percentage?: number;
+}
+
+interface Property {
+  /* The key for the property. */
+  key?: string;
+  /* The value for the property. */
+  value?: string;
+}
+
+interface SellingPlan {
+  /* A globally unique identifier. */
+  id?: string;
+  /* The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'. */
+  name?: string;
+}
+
+interface SellingPlanAllocation {
+  /**
+   * A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be
+   * '6 weeks of prepaid granola, delivered weekly'.
+   */
+  sellingPlan?: SellingPlan;
 }
 
 /* A shipping rate to be applied to a checkout. */
@@ -448,14 +537,40 @@ interface Transaction {
   amount?: MoneyV2;
   /* The name of the payment provider used for the transaction. */
   gateway?: string;
+  /* The payment method used for the transaction. */
+  paymentMethod?: TransactionPaymentMethod;
 }
 
-/**
- * A value given to a customer when a discount is applied to an order. The
- * application of a discount with this value gives the customer the specified
- * percentage off a specified item.
- */
-interface PricingPercentageValue {
+interface TransactionPaymentMethod {
+  /* The name of the payment method used for the transaction. This may further specify the payment method used. */
+  name?: string;
+  /**
+   * The type of payment method used for the transaction.
+   *
+   * - creditCard: A vaulted or manually entered credit card.
+   * - redeemable: A redeemable payment method, such as a gift card or store credit.
+   * - deferred: A deferred payment, such as invoicing the buyer and collecting payment later.
+   * - local: A local payment method specific to the current region or market.
+   * - manualPayment: A manual payment method, such as an in-person retail transaction.
+   * - paymentOnDelivery: A payment that will be collected on delivery.
+   * - wallet: An integrated wallet, such as PayPal, Google Pay, Apple Pay, etc.
+   * - offsite: A payment processed outside of Shopify's checkout, excluding integrated wallets.
+   * - customOnSite: A custom payment method that is processed through a checkout extension with a payments app.
+   * - other: Another type of payment not defined here.
+   */
+  type?: string;
+}
+
+/* A value given to a customer when a discount is applied to an order. The */
+/* application of a discount with this value gives the customer the specified */
+/* percentage off a specified item. */
+interface Value {
+  /* The decimal money amount. */
+  amount?: number;
+  /* The three-letter code that represents the currency, for example, USD. */
+  /* Supported codes include standard ISO 4217 codes, legacy codes, and non- */
+  /* standard codes. */
+  currencyCode?: string;
   /* The percentage value of the object. */
   percentage?: number;
 }

sample/android/gradle.properties

@@ -41,4 +41,4 @@ newArchEnabled=false
 hermesEnabled=true
 
 # Note: only used here for testing
-SHOPIFY_CHECKOUT_SDK_VERSION=3.0.3
+SHOPIFY_CHECKOUT_SDK_VERSION=3.0.4