shopify-webhook-schemas 0.2.3 → 0.2.5

package/dist/src/infer-schema.d.ts

@@ -3,7 +3,7 @@ export type Error = {
     message: string;
     path: string;
 };
-export declare const inferSchemaFromExamplePayload: (examplePayload: Record<string, any>, metadata: {
+export declare const inferSchemaFromExamplePayload: (version: string, examplePayload: Record<string, any>, metadata: {
     name: string;
 }) => {
     schema: any;
@@ -14,5 +14,6 @@ export declare const manualExamples: [RegExp, Record<string, any>][];
 export declare const overrides: {
     topics: string[];
     schema: any;
+    required?: string[];
     versions?: string[];
 }[];

package/dist/src/infer-schema.js

@@ -32,9 +32,8 @@ const getStartVersion = (date = new Date()) => {
     return `${targetYear}-${quarterToMonth[targetQuarter]}`;
 };
 exports.getStartVersion = getStartVersion;
-const inferSchemaFromExamplePayload = (examplePayload, metadata) => {
+const inferSchemaFromExamplePayload = (version, examplePayload, metadata) => {
     const inference = (0, schema_infer_1.inferSchema)(examplePayload);
-    const startVersion = (0, exports.getStartVersion)();
     // build a copy of the payload and apply overrides based on the webhook name
     for (const [matcher, override] of exports.manualExamples) {
         if (matcher.test(metadata.name)) {
@@ -49,10 +48,14 @@ const inferSchemaFromExamplePayload = (examplePayload, metadata) => {
         ...inference.toJSONSchema(),
     };
     for (const override of exports.overrides) {
-        if (override.topics.includes(metadata.name) && (!override.versions || override.versions.includes(startVersion))) {
+        if (override.topics.includes(metadata.name) && (!override.versions || override.versions.includes(version))) {
             for (const [key, schemaOverride] of Object.entries(override.schema)) {
+                schema.properties ?? (schema.properties = {});
                 schema.properties[key] = schemaOverride;
             }
+            if (override.required) {
+                schema.required = override.required;
+            }
         }
     }
     const sortedSchema = getDeterministicObject(schema);
@@ -740,4 +743,33 @@ exports.overrides = [
             },
         },
     },
+    {
+        topics: ["inventory_levels/connect", "inventory_levels/update"],
+        schema: {
+            admin_graphql_api_id: {
+                format: "uri",
+                type: "string",
+            },
+            available: {
+                type: ["integer", "null"],
+            },
+            inventory_item_id: {
+                type: "integer",
+            },
+            location_id: {
+                type: "integer",
+            },
+            updated_at: {
+                format: "date-time",
+                type: "string",
+            },
+        },
+        required: ["admin_graphql_api_id", "available", "inventory_item_id", "location_id", "updated_at"],
+    },
+    {
+        topics: ["shipping_addresses/create", "shipping_addresses/update"],
+        schema: {
+            ...shippingAddress.properties,
+        },
+    },
 ];

package/dist/src/scrape.js

@@ -105,7 +105,7 @@ const main = async () => {
             const metadataFile = path_1.default.join(rootDir, "metadatas", version, webhook.name + ".json");
             await fs_extra_1.default.mkdir(path_1.default.dirname(metadataFile), { recursive: true });
             await fs_extra_1.default.writeFile(metadataFile, JSON.stringify(webhook, null, 2), "utf-8");
-            const { schema, warnings: warningCount, errors: errorMessages } = (0, infer_schema_1.inferSchemaFromExamplePayload)(webhook.response, webhook);
+            const { schema, warnings: warningCount, errors: errorMessages } = (0, infer_schema_1.inferSchemaFromExamplePayload)(version, webhook.response, webhook);
             warnings += warningCount;
             for (const error of errorMessages) {
                 console.error(`${chalk_1.default.red("schema error")}: ${error.message} for version ${chalk_1.default.blue(version)} for ${chalk_1.default.blue(webhook.name)} at path ${chalk_1.default.green(error.path)}`);

package/metadatas/2024-10/app/scopes_update.json

@@ -10,6 +10,7 @@
   "related_resource": "Shop",
   "response": {
     "id": 1,
+    "shop_id": "gid://shopify/Shop/548380009",
     "previous": [
       "read_products"
     ],

package/metadatas/2024-10/app_purchases_one_time/update.json

@@ -9,7 +9,7 @@
   "related_resource": "ApplicationCharge",
   "response": {
     "app_purchase_one_time": {
-      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262353",
+      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262354",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",

package/metadatas/2024-10/app_subscriptions/approaching_capped_amount.json

@@ -9,7 +9,7 @@
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266949",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266960",
       "name": "Webhook Test",
       "balance_used": 0,
       "capped_amount": "20.0",

package/metadatas/2024-10/app_subscriptions/update.json

@@ -10,7 +10,7 @@
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266948",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266962",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",

package/metadatas/2024-10/bulk_operations/finish.json

@@ -11,7 +11,7 @@
   "response": {
     "admin_graphql_api_id": "gid://shopify/BulkOperation/147595010",
     "completed_at": "2024-01-01T07:34:56-05:00",
-    "created_at": "2025-06-13T11:19:23-04:00",
+    "created_at": "2025-07-01T14:03:22-04:00",
     "error_code": null,
     "status": "completed",
     "type": "query"

package/metadatas/2024-10/checkouts/create.json

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "4788bcebfdae50ed3756b05241d17fdd",
-        "destination_location_id": 1015975126,
+        "key": "fdc2f3d43cec601dbe9d1a7b86152329",
+        "destination_location_id": 1015975130,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975125,
+        "origin_location_id": 1015975129,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -103,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "4788bcebfdae50ed3756b05241d17fdd",
-        "destination_location_id": 1015975126,
+        "key": "fdc2f3d43cec601dbe9d1a7b86152329",
+        "destination_location_id": 1015975130,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975125,
+        "origin_location_id": 1015975129,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -219,7 +219,7 @@
     },
     "customer": {
       "id": 603851970716743400,
-      "email": "john@example.com",
+      "email": null,
       "created_at": null,
       "updated_at": null,
       "first_name": "John",
@@ -247,8 +247,8 @@
       "default_address": {
         "id": null,
         "customer_id": 603851970716743400,
-        "first_name": null,
-        "last_name": null,
+        "first_name": "John",
+        "last_name": "Smith",
         "company": null,
         "address1": "123 Elm St.",
         "address2": null,
@@ -257,7 +257,7 @@
         "country": "Canada",
         "zip": "K2H7A8",
         "phone": "123-123-1234",
-        "name": "",
+        "name": "John Smith",
         "province_code": "ON",
         "country_code": "CA",
         "country_name": "Canada",

package/metadatas/2024-10/checkouts/update.json

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "fd5774a7c08ef6210bc390184a712caa",
-        "destination_location_id": 1015975132,
+        "key": "bff422fa7717dc622afd0a63413f6269",
+        "destination_location_id": 1015975140,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975131,
+        "origin_location_id": 1015975139,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -103,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "fd5774a7c08ef6210bc390184a712caa",
-        "destination_location_id": 1015975132,
+        "key": "bff422fa7717dc622afd0a63413f6269",
+        "destination_location_id": 1015975140,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975131,
+        "origin_location_id": 1015975139,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -219,7 +219,7 @@
     },
     "customer": {
       "id": 603851970716743400,
-      "email": "john@example.com",
+      "email": null,
       "created_at": null,
       "updated_at": null,
       "first_name": "John",
@@ -247,8 +247,8 @@
       "default_address": {
         "id": null,
         "customer_id": 603851970716743400,
-        "first_name": null,
-        "last_name": null,
+        "first_name": "John",
+        "last_name": "Smith",
         "company": null,
         "address1": "123 Elm St.",
         "address2": null,
@@ -257,7 +257,7 @@
         "country": "Canada",
         "zip": "K2H7A8",
         "phone": "123-123-1234",
-        "name": "",
+        "name": "John Smith",
         "province_code": "ON",
         "country_code": "CA",
         "country_name": "Canada",

package/metadatas/2024-10/customer.tags_added.json

@@ -19,7 +19,7 @@
       "tag1",
       "tag2"
     ],
-    "occurredAt": "2005-05-05T04:00:00.000Z"
+    "occurredAt": "2005-05-05T05:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-10/customer.tags_removed.json

@@ -19,7 +19,7 @@
       "tag1",
       "tag2"
     ],
-    "occurredAt": "2005-05-05T04:00:00.000Z"
+    "occurredAt": "2005-05-05T05:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-10/customers/create.json

@@ -16,7 +16,7 @@
   "related_resource": "Customer",
   "response": {
     "id": 706405506930370000,
-    "email": "bob@biller.com",
+    "email": null,
     "created_at": "2021-12-31T19:00:00-05:00",
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
@@ -35,7 +35,11 @@
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
+    "email_marketing_consent": {
+      "state": "not_subscribed",
+      "opt_in_level": null,
+      "consent_updated_at": null
+    },
     "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
@@ -55,7 +59,7 @@
       "province_code": "ON",
       "country_code": "CA",
       "country_name": "CA",
-      "default": false
+      "default": true
     }
   },
   "shop_feature": false

package/metadatas/2024-10/customers/delete.json

@@ -16,7 +16,11 @@
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
+    "email_marketing_consent": {
+      "state": "not_subscribed",
+      "opt_in_level": null,
+      "consent_updated_at": null
+    },
     "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
   },

package/metadatas/2024-10/customers/disable.json

@@ -16,7 +16,7 @@
   "related_resource": "Customer",
   "response": {
     "id": 706405506930370000,
-    "email": "bob@biller.com",
+    "email": null,
     "created_at": "2021-12-31T19:00:00-05:00",
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
@@ -35,7 +35,11 @@
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
+    "email_marketing_consent": {
+      "state": "not_subscribed",
+      "opt_in_level": null,
+      "consent_updated_at": null
+    },
     "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
@@ -55,7 +59,7 @@
       "province_code": "ON",
       "country_code": "CA",
       "country_name": "CA",
-      "default": false
+      "default": true
     }
   },
   "shop_feature": false

package/metadatas/2024-10/customers/enable.json

@@ -16,7 +16,7 @@
   "related_resource": "Customer",
   "response": {
     "id": 706405506930370000,
-    "email": "bob@biller.com",
+    "email": null,
     "created_at": "2021-12-31T19:00:00-05:00",
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
@@ -35,7 +35,11 @@
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
+    "email_marketing_consent": {
+      "state": "not_subscribed",
+      "opt_in_level": null,
+      "consent_updated_at": null
+    },
     "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
@@ -55,7 +59,7 @@
       "province_code": "ON",
       "country_code": "CA",
       "country_name": "CA",
-      "default": false
+      "default": true
     }
   },
   "shop_feature": false

package/metadatas/2024-10/customers/update.json

@@ -16,7 +16,7 @@
   "related_resource": "Customer",
   "response": {
     "id": 706405506930370000,
-    "email": "bob@biller.com",
+    "email": null,
     "created_at": "2021-12-31T19:00:00-05:00",
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
@@ -35,7 +35,11 @@
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
-    "email_marketing_consent": null,
+    "email_marketing_consent": {
+      "state": "not_subscribed",
+      "opt_in_level": null,
+      "consent_updated_at": null
+    },
     "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
@@ -55,7 +59,7 @@
       "province_code": "ON",
       "country_code": "CA",
       "country_name": "CA",
-      "default": false
+      "default": true
     }
   },
   "shop_feature": false

package/metadatas/2024-10/customers_email_marketing_consent/update.json

@@ -16,7 +16,7 @@
   "related_resource": "Customer",
   "response": {
     "customer_id": 706405506930370000,
-    "email_address": null,
+    "email_address": "bob@biller.com",
     "email_marketing_consent": {
       "state": null,
       "opt_in_level": null,

package/metadatas/2024-10/discounts/create.json

@@ -15,8 +15,8 @@
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
     "title": "Automatic free shipping",
     "status": "ACTIVE",
-    "created_at": "2016-08-29T12:00:00-04:00",
-    "updated_at": "2016-08-29T12:00:00-04:00"
+    "created_at": "2016-08-29T13:00:00-04:00",
+    "updated_at": "2016-08-29T13:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-10/discounts/delete.json

@@ -13,7 +13,7 @@
   "related_resource": "PriceRule",
   "response": {
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
-    "deleted_at": "2018-08-29T12:00:00-04:00"
+    "deleted_at": "2018-08-29T13:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-10/discounts/redeemcode_added.json

@@ -17,7 +17,7 @@
       "id": "gid://shopify/DiscountRedeemCode/1",
       "code": "code1"
     },
-    "updated_at": "2018-08-29T16:00:00.000Z"
+    "updated_at": "2018-08-29T17:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-10/discounts/redeemcode_removed.json

@@ -17,7 +17,7 @@
       "id": "gid://shopify/DiscountRedeemCode/1",
       "code": "code1"
     },
-    "updated_at": "2018-08-29T16:00:00.000Z"
+    "updated_at": "2018-08-29T17:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-10/discounts/update.json

@@ -15,8 +15,8 @@
     "admin_graphql_api_id": "gid://shopify/DiscountAutomaticNode/1",
     "title": "Automatic free shipping updated",
     "status": "ACTIVE",
-    "created_at": "2016-08-29T12:00:00-04:00",
-    "updated_at": "2016-08-29T12:00:00-04:00"
+    "created_at": "2016-08-29T13:00:00-04:00",
+    "updated_at": "2016-08-29T13:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-10/draft_orders/create.json

@@ -25,20 +25,20 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "tax_exempt": false,
     "completed_at": null,
-    "name": "#D150",
+    "name": "#D131",
     "allow_discount_codes_in_checkout?": false,
     "b2b?": false,
     "status": "open",
     "line_items": [
       {
-        "id": 4200896,
+        "id": 4299028,
         "variant_id": 49148385,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Red",
         "sku": "IPOD2008RED",
         "vendor": "Apple",
-        "quantity": 2,
+        "quantity": 4,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -50,17 +50,17 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/4200896"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/4299028"
       },
       {
-        "id": 2808882,
+        "id": 208003,
         "variant_id": 457924702,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Black",
         "sku": "IPOD2008BLACK",
         "vendor": "Apple",
-        "quantity": 5,
+        "quantity": 10,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -72,17 +72,17 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2808882"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/208003"
       },
       {
-        "id": 964856,
+        "id": 3435618,
         "variant_id": 808950810,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Pink",
         "sku": "IPOD2008PINK",
         "vendor": "Apple",
-        "quantity": 9,
+        "quantity": 1,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -94,7 +94,7 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/964856"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/3435618"
       }
     ],
     "api_client_id": null,
@@ -136,9 +136,9 @@
     "created_on_api_version_handle": null,
     "applied_discount": {
       "description": "ABC 123",
-      "value": "2.0",
+      "value": "3.0",
       "title": "ABC 123",
-      "amount": "10.00",
+      "amount": "4.00",
       "value_type": "percentage"
     },
     "order_id": null,
@@ -146,30 +146,30 @@
       "title": "ABC 123",
       "custom": true,
       "handle": null,
-      "price": "3.00"
+      "price": "9.00"
     },
     "tax_lines": [
       {
-        "rate": 0.024013790673784504,
+        "rate": 0.030741493752353827,
         "title": "State tax",
-        "price": "4.00"
+        "price": "1.00"
       },
       {
-        "rate": 0.024013790673784504,
+        "rate": 0.030741493752353827,
         "title": "State tax",
-        "price": "2.00"
+        "price": "1.00"
       },
       {
-        "rate": 0.024013790673784504,
+        "rate": 0.030741493752353827,
         "title": "State tax",
-        "price": "3.00"
+        "price": "5.00"
       }
     ],
     "tags": "",
     "note_attributes": [],
-    "total_price": "416.00",
-    "subtotal_price": "420.00",
-    "total_tax": "482.00",
+    "total_price": "439.00",
+    "subtotal_price": "418.00",
+    "total_tax": "449.00",
     "payment_terms": {
       "id": 706405506930370000,
       "payment_terms_name": "Net 7",
@@ -188,15 +188,15 @@
           "issued_at": "2021-01-01T00:00:00-05:00",
           "due_at": "2021-01-02T00:00:00-05:00",
           "completed_at": "2021-01-02T00:00:00-05:00",
-          "amount": "416.00",
+          "amount": "439.00",
           "currency": "USD",
-          "total_price": "416.00",
+          "total_price": "439.00",
           "total_price_currency": "USD",
-          "balance_due": "416.00",
+          "balance_due": "439.00",
           "balance_due_currency": "USD",
-          "total_balance": "416.00",
+          "total_balance": "439.00",
           "total_balance_currency": "USD",
-          "outstanding_balance": "416.00",
+          "outstanding_balance": "439.00",
           "outstanding_balance_currency": "USD"
         }
       ],
@@ -205,7 +205,7 @@
     "admin_graphql_api_id": "gid://shopify/DraftOrder/890612572568261625",
     "customer": {
       "id": 706405506930370000,
-      "email": "john@doe.ca",
+      "email": null,
       "created_at": null,
       "updated_at": null,
       "first_name": "John",
@@ -233,8 +233,8 @@
       "default_address": {
         "id": null,
         "customer_id": 706405506930370000,
-        "first_name": null,
-        "last_name": null,
+        "first_name": "John",
+        "last_name": "Smith",
         "company": null,
         "address1": "123 Elm St.",
         "address2": null,
@@ -243,7 +243,7 @@
         "country": "Canada",
         "zip": "K2H7A8",
         "phone": "123-123-1234",
-        "name": "",
+        "name": "John Smith",
         "province_code": "ON",
         "country_code": "CA",
         "country_name": "Canada",