shopify-webhook-schemas 0.2.2 → 0.2.3

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

@@ -1,4 +1,4 @@
-export declare const startVersion = "2024-04";
+export declare const getStartVersion: (date?: Date) => string;
 export type Error = {
     message: string;
     path: string;

package/dist/src/infer-schema.js

@@ -1,14 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.overrides = exports.manualExamples = exports.inferSchemaFromExamplePayload = exports.startVersion = void 0;
+exports.overrides = exports.manualExamples = exports.inferSchemaFromExamplePayload = exports.getStartVersion = void 0;
 const json_schema_walker_1 = require("@cloudflare/json-schema-walker");
 const schema_infer_1 = require("@jsonhero/schema-infer");
 const lodash_1 = require("lodash");
 const safe_stable_stringify_1 = require("safe-stable-stringify");
 const stringify = (0, safe_stable_stringify_1.configure)({ deterministic: true });
-exports.startVersion = "2024-04";
+const getStartVersion = (date = new Date()) => {
+    const year = date.getUTCFullYear();
+    const month = date.getUTCMonth() + 1; // 1-12
+    // Map month to quarter
+    let quarter;
+    if (month <= 3)
+        quarter = 1; // Jan-Mar -> Q1 (01)
+    else if (month <= 6)
+        quarter = 2; // Apr-Jun -> Q2 (04)
+    else if (month <= 9)
+        quarter = 3; // Jul-Sep -> Q3 (07)
+    else
+        quarter = 4; // Oct-Dec -> Q4 (10)
+    // Go back 3 quarters (4 quarters including current)
+    let targetYear = year;
+    let targetQuarter = quarter - 3;
+    // Handle year wraparound
+    while (targetQuarter <= 0) {
+        targetQuarter += 4;
+        targetYear -= 1;
+    }
+    // Map quarter to month string
+    const quarterToMonth = { 1: "01", 2: "04", 3: "07", 4: "10" };
+    return `${targetYear}-${quarterToMonth[targetQuarter]}`;
+};
+exports.getStartVersion = getStartVersion;
 const inferSchemaFromExamplePayload = (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)) {
@@ -23,7 +49,7 @@ const inferSchemaFromExamplePayload = (examplePayload, metadata) => {
         ...inference.toJSONSchema(),
     };
     for (const override of exports.overrides) {
-        if (override.topics.includes(metadata.name) && (!override.versions || override.versions.includes(exports.startVersion))) {
+        if (override.topics.includes(metadata.name) && (!override.versions || override.versions.includes(startVersion))) {
             for (const [key, schemaOverride] of Object.entries(override.schema)) {
                 schema.properties[key] = schemaOverride;
             }

package/dist/src/scrape.js

@@ -76,8 +76,9 @@ const loadExemplars = async () => {
     console.log(`loaded ${files.length} exemplars`);
 };
 const getAllVersions = async () => {
-    const rootPage = await loadRailsData(docsWebhooksPageForVersion(infer_schema_1.startVersion));
-    return (0, lodash_1.uniq)([infer_schema_1.startVersion, ...rootPage.api.selectable_versions]).filter((version) => version != "unstable");
+    const startVersion = (0, infer_schema_1.getStartVersion)();
+    const rootPage = await loadRailsData(docsWebhooksPageForVersion(startVersion));
+    return (0, lodash_1.uniq)([startVersion, ...rootPage.api.selectable_versions]).filter((version) => version != "unstable");
 };
 const main = async () => {
     await loadExemplars();

package/metadatas/2024-04/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/1017262352",
+      "admin_graphql_api_id": "gid://shopify/AppPurchaseOneTime/1017262348",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",

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

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

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

@@ -10,17 +10,14 @@
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266960",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266951",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",
       "created_at": "2021-12-31T19:00:00-05:00",
       "updated_at": "2021-12-31T19:00:00-05:00",
       "currency": "USD",
-      "capped_amount": "20.0",
-      "price": "10.00",
-      "interval": "every_30_days",
-      "plan_handle": "plan-123"
+      "capped_amount": "20.0"
     }
   },
   "shop_feature": false

package/metadatas/2024-04/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-01-30T15:41:03-05:00",
     "error_code": null,
     "status": "completed",
     "type": "query"

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

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "b22a172abde59e26c1ae496968b82f80",
-        "destination_location_id": 1015975144,
+        "key": "fd5774a7c08ef6210bc390184a712caa",
+        "destination_location_id": 1015975132,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975143,
+        "origin_location_id": 1015975131,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -103,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "b22a172abde59e26c1ae496968b82f80",
-        "destination_location_id": 1015975144,
+        "key": "fd5774a7c08ef6210bc390184a712caa",
+        "destination_location_id": 1015975132,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975143,
+        "origin_location_id": 1015975131,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -182,7 +182,6 @@
     "total_tax": "23.88",
     "subtotal_price": "398.00",
     "total_duties": null,
-    "reservation_token": null,
     "billing_address": {
       "first_name": "Bob",
       "address1": "123 Billing Street",
@@ -224,14 +223,25 @@
       "updated_at": null,
       "first_name": "John",
       "last_name": "Smith",
+      "orders_count": 0,
       "state": "disabled",
+      "total_spent": "0.00",
+      "last_order_id": null,
       "note": null,
       "verified_email": true,
       "multipass_identifier": null,
       "tax_exempt": false,
+      "tags": "",
+      "last_order_name": null,
       "currency": "USD",
       "phone": null,
       "tax_exemptions": [],
+      "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/603851970716743426",
       "default_address": {
         "id": null,

package/metadatas/2024-04/checkouts/delete.json

@@ -22,8 +22,7 @@
     "total_tax": "23.88",
     "subtotal_price": "398.00",
     "cart_token": "eeafa272cebfd4b22385bc4b645e762c",
-    "total_duties": null,
-    "reservation_token": null
+    "total_duties": null
   },
   "shop_feature": false
 }

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

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "cb3277c1334fee8f5ddebb2a93a991b2",
-        "destination_location_id": 1015975154,
+        "key": "261145db8f8a3d8ac9e8a66d0cedc6b9",
+        "destination_location_id": 1015975146,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975153,
+        "origin_location_id": 1015975145,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -103,12 +103,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "cb3277c1334fee8f5ddebb2a93a991b2",
-        "destination_location_id": 1015975154,
+        "key": "261145db8f8a3d8ac9e8a66d0cedc6b9",
+        "destination_location_id": 1015975146,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975153,
+        "origin_location_id": 1015975145,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,
@@ -182,7 +182,6 @@
     "total_tax": "23.88",
     "subtotal_price": "398.00",
     "total_duties": null,
-    "reservation_token": null,
     "billing_address": {
       "first_name": "Bob",
       "address1": "123 Billing Street",
@@ -224,14 +223,25 @@
       "updated_at": null,
       "first_name": "John",
       "last_name": "Smith",
+      "orders_count": 0,
       "state": "disabled",
+      "total_spent": "0.00",
+      "last_order_id": null,
       "note": null,
       "verified_email": true,
       "multipass_identifier": null,
       "tax_exempt": false,
+      "tags": "",
+      "last_order_name": null,
       "currency": "USD",
       "phone": null,
       "tax_exemptions": [],
+      "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/603851970716743426",
       "default_address": {
         "id": null,

package/metadatas/2024-04/company_contact_roles/assign.json

@@ -48,14 +48,6 @@
         "CA_BC_CONTRACTOR_EXEMPTION",
         "CA_BC_RESELLER_EXEMPTION"
       ],
-      "tax_settings": {
-        "tax_registration_id": "1214214141",
-        "tax_exempt": null,
-        "tax_exemptions": [
-          "CA_BC_CONTRACTOR_EXEMPTION",
-          "CA_BC_RESELLER_EXEMPTION"
-        ]
-      },
       "company": {
         "name": "Example Company",
         "note": "This is an example company",

package/metadatas/2024-04/company_contact_roles/revoke.json

@@ -48,14 +48,6 @@
         "CA_BC_CONTRACTOR_EXEMPTION",
         "CA_BC_RESELLER_EXEMPTION"
       ],
-      "tax_settings": {
-        "tax_registration_id": "1214214141",
-        "tax_exempt": null,
-        "tax_exemptions": [
-          "CA_BC_CONTRACTOR_EXEMPTION",
-          "CA_BC_RESELLER_EXEMPTION"
-        ]
-      },
       "company": {
         "name": "Example Company",
         "note": "This is an example company",

package/metadatas/2024-04/company_locations/create.json

@@ -29,14 +29,6 @@
       "CA_BC_CONTRACTOR_EXEMPTION",
       "CA_BC_RESELLER_EXEMPTION"
     ],
-    "tax_settings": {
-      "tax_registration_id": "1214214141",
-      "tax_exempt": null,
-      "tax_exemptions": [
-        "CA_BC_CONTRACTOR_EXEMPTION",
-        "CA_BC_RESELLER_EXEMPTION"
-      ]
-    },
     "company": {
       "name": "Example Company",
       "note": "This is an example company",

package/metadatas/2024-04/company_locations/delete.json

@@ -26,14 +26,6 @@
       "CA_BC_CONTRACTOR_EXEMPTION",
       "CA_BC_RESELLER_EXEMPTION"
     ],
-    "tax_settings": {
-      "tax_registration_id": "1214214141",
-      "tax_exempt": null,
-      "tax_exemptions": [
-        "CA_BC_CONTRACTOR_EXEMPTION",
-        "CA_BC_RESELLER_EXEMPTION"
-      ]
-    },
     "company": {
       "name": "Example Company",
       "note": "This is an example company",

package/metadatas/2024-04/company_locations/update.json

@@ -29,14 +29,6 @@
       "CA_BC_CONTRACTOR_EXEMPTION",
       "CA_BC_RESELLER_EXEMPTION"
     ],
-    "tax_settings": {
-      "tax_registration_id": "1214214141",
-      "tax_exempt": null,
-      "tax_exemptions": [
-        "CA_BC_CONTRACTOR_EXEMPTION",
-        "CA_BC_RESELLER_EXEMPTION"
-      ]
-    },
     "company": {
       "name": "Example Company",
       "note": "This is an example company",

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

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

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

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

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

@@ -21,15 +21,22 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
     "last_name": "Biller",
+    "orders_count": 1,
     "state": "disabled",
+    "total_spent": "100.00",
+    "last_order_id": 820982911946154500,
     "note": "This customer loves ice cream",
     "verified_email": true,
     "multipass_identifier": null,
     "tax_exempt": false,
+    "tags": "",
+    "last_order_name": "#9999",
     "currency": "USD",
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
       "id": 12321,

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

@@ -16,6 +16,8 @@
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084"
   },
   "shop_feature": false

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

@@ -21,15 +21,22 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
     "last_name": "Biller",
+    "orders_count": 1,
     "state": "disabled",
+    "total_spent": "100.00",
+    "last_order_id": 820982911946154500,
     "note": "This customer loves ice cream",
     "verified_email": true,
     "multipass_identifier": null,
     "tax_exempt": false,
+    "tags": "",
+    "last_order_name": "#9999",
     "currency": "USD",
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
       "id": 12321,

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

@@ -21,15 +21,22 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
     "last_name": "Biller",
+    "orders_count": 1,
     "state": "disabled",
+    "total_spent": "100.00",
+    "last_order_id": 820982911946154500,
     "note": "This customer loves ice cream",
     "verified_email": true,
     "multipass_identifier": null,
     "tax_exempt": false,
+    "tags": "",
+    "last_order_name": "#9999",
     "currency": "USD",
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
       "id": 12321,

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

@@ -21,15 +21,22 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "first_name": "Bob",
     "last_name": "Biller",
+    "orders_count": 1,
     "state": "disabled",
+    "total_spent": "100.00",
+    "last_order_id": 820982911946154500,
     "note": "This customer loves ice cream",
     "verified_email": true,
     "multipass_identifier": null,
     "tax_exempt": false,
+    "tags": "",
+    "last_order_name": "#9999",
     "currency": "USD",
     "phone": null,
     "addresses": [],
     "tax_exemptions": [],
+    "email_marketing_consent": null,
+    "sms_marketing_consent": null,
     "admin_graphql_api_id": "gid://shopify/Customer/706405506930370084",
     "default_address": {
       "id": 12321,

package/metadatas/2024-04/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-29T15:00:00-04:00",
+    "updated_at": "2016-08-29T15:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/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-29T15:00:00-04:00"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/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-29T19:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/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-29T19:00:00.000Z"
   },
   "shop_feature": false
 }

package/metadatas/2024-04/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-29T15:00:00-04:00",
+    "updated_at": "2016-08-29T15:00:00-04:00"
   },
   "shop_feature": false
 }