shopify-webhook-schemas 0.1.6 → 0.1.7

package/dist/src/scrape.js

@@ -78,7 +78,7 @@ const getDeterministicObject = (obj) => {
     const stableString = stringify(sortStringArrays(obj));
     return JSON.parse(stableString);
 };
-const inferSchemaFromExamplePayload = (examplePayload, metadata) => {
+const inferSchemaFromExamplePayload = (examplePayload, metadata, version) => {
     const inference = (0, schema_infer_1.inferSchema)(examplePayload);
     // build a copy of the payload and apply overrides based on the webhook name
     for (const [matcher, override] of manualExamples) {
@@ -110,7 +110,7 @@ const inferSchemaFromExamplePayload = (examplePayload, metadata) => {
             }
             else {
                 errors += 1;
-                console.error(`${chalk_1.default.red("schema error")}: null type found in final schema for ${chalk_1.default.blue(metadata.name)} at path ${chalk_1.default.green(fullPath)}`);
+                console.error(`${chalk_1.default.red("schema error")}: null type found in final schema for version ${chalk_1.default.blue(version)} for ${chalk_1.default.blue(metadata.name)} at path ${chalk_1.default.green(fullPath)}`);
             }
         }
     }, () => { }, (0, json_schema_walker_1.getVocabulary)(sortedSchema));
@@ -152,7 +152,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 = inferSchemaFromExamplePayload(webhook.response, webhook);
+            const schema = inferSchemaFromExamplePayload(webhook.response, webhook, version);
             const schemaFile = path_1.default.join(rootDir, "schemas", version, webhook.name + ".json");
             await fs_extra_1.default.mkdir(path_1.default.dirname(schemaFile), { recursive: true });
             await fs_extra_1.default.writeFile(schemaFile, JSON.stringify(schema, null, 2), "utf-8");

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/1017262362",
+      "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/1029266981",
+      "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,7 +10,7 @@
   "related_resource": "RecurringApplicationCharge",
   "response": {
     "app_subscription": {
-      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266982",
+      "admin_graphql_api_id": "gid://shopify/AppSubscription/1029266951",
       "name": "Webhook Test",
       "status": "PENDING",
       "admin_graphql_api_shop_id": "gid://shopify/Shop/548380009",

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

@@ -10,8 +10,8 @@
   "related_resource": "BulkOperation",
   "response": {
     "admin_graphql_api_id": "gid://shopify/BulkOperation/147595010",
-    "completed_at": "2024-10-30T16:01:30-04:00",
-    "created_at": "2024-10-30T16:01:30-04:00",
+    "completed_at": "2024-01-01T07:34:56-05:00",
+    "created_at": "2025-01-30T15:41:03-05:00",
     "error_code": null,
     "status": "completed",
     "type": "query"

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

@@ -14,8 +14,5 @@
   "response": {
     "id": "123456789"
   },
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "write_publications"
-  ]
+  "shop_feature": false
 }

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

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "4dd844f7f10bf1f0dec5dbc39c660702",
-        "destination_location_id": 1015975224,
+        "key": "fd5774a7c08ef6210bc390184a712caa",
+        "destination_location_id": 1015975132,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975223,
+        "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": "4dd844f7f10bf1f0dec5dbc39c660702",
-        "destination_location_id": 1015975224,
+        "key": "fd5774a7c08ef6210bc390184a712caa",
+        "destination_location_id": 1015975132,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975223,
+        "origin_location_id": 1015975131,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,

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

@@ -44,12 +44,12 @@
       {
         "applied_discounts": [],
         "discount_allocations": [],
-        "key": "b20c0c46982e687a8c3a1551fbfd08c3",
-        "destination_location_id": 1015975206,
+        "key": "261145db8f8a3d8ac9e8a66d0cedc6b9",
+        "destination_location_id": 1015975146,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975205,
+        "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": "b20c0c46982e687a8c3a1551fbfd08c3",
-        "destination_location_id": 1015975206,
+        "key": "261145db8f8a3d8ac9e8a66d0cedc6b9",
+        "destination_location_id": 1015975146,
         "fulfillment_service": "manual",
         "gift_card": false,
         "grams": 567,
-        "origin_location_id": 1015975205,
+        "origin_location_id": 1015975145,
         "presentment_title": "IPod Nano - 8GB",
         "presentment_variant_title": "Pink",
         "product_id": 632910392,

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

@@ -20,8 +20,5 @@
     "updated_at": null,
     "collection_id": 408372092144951400
   },
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "write_publications"
-  ]
+  "shop_feature": false
 }

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

@@ -14,8 +14,5 @@
   "response": {
     "id": null
   },
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "write_publications"
-  ]
+  "shop_feature": false
 }

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

@@ -20,8 +20,5 @@
     "updated_at": null,
     "collection_id": 408372092144951400
   },
-  "shop_feature": false,
-  "shopify_approval_scope": [
-    "write_publications"
-  ]
+  "shop_feature": false
 }

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

@@ -19,7 +19,7 @@
       "tag1",
       "tag2"
     ],
-    "occurredAt": "2005-05-05T06: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-05T06:00:00.000Z"
+    "occurredAt": "2005-05-05T07:00:00.000Z"
   },
   "shop_feature": false
 }

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

@@ -0,0 +1,28 @@
+{
+  "available_on": [
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Customers can request their data from a store owner. When this happens, Shopify sends a payload on the customers/data_request topic to the apps that are installed on that store.",
+  "name": "customers/data_request",
+  "privacy_compliance_topic": true,
+  "related_resource": "Customer",
+  "response": {
+    "shop_id": 954889,
+    "shop_domain": "{shop}.myshopify.com",
+    "customer": {
+      "id": 191167,
+      "email": "john@example.com",
+      "phone": "555-625-1199"
+    },
+    "orders_requested": [
+      299938,
+      280263,
+      220458
+    ],
+    "data_request": {
+      "id": 9999
+    }
+  },
+  "shop_feature": false
+}

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

@@ -0,0 +1,25 @@
+{
+  "available_on": [
+    "toml"
+  ],
+  "deprecated": false,
+  "description": "Store owners can request that data is deleted on behalf of a customer. When this happens, Shopify sends a payload on the customers/redact topic to the apps installed on that store.\n\nCustomer redaction occurs either at the end of the grace period after the redaction was requested (today + 10 days), OR the customer's last order date plus the chargeback period of 60 days (last order date + 60 days), whichever occurs later.",
+  "name": "customers/redact",
+  "privacy_compliance_topic": true,
+  "related_resource": "Customer",
+  "response": {
+    "shop_id": 954889,
+    "shop_domain": "{shop}.myshopify.com",
+    "customer": {
+      "id": 191167,
+      "email": "john@example.com",
+      "phone": "555-625-1199"
+    },
+    "orders_to_redact": [
+      299938,
+      280263,
+      220458
+    ]
+  },
+  "shop_feature": false
+}

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-29T14:00:00-04:00",
-    "updated_at": "2016-08-29T14: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-29T14: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-29T18: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-29T18: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-29T14:00:00-04:00",
-    "updated_at": "2016-08-29T14: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/draft_orders/create.json

@@ -25,18 +25,20 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "tax_exempt": false,
     "completed_at": null,
-    "name": "#D110",
+    "name": "#D109",
+    "allow_discount_codes_in_checkout?": false,
+    "b2b?": false,
     "status": "open",
     "line_items": [
       {
-        "id": 2463654,
+        "id": 3501443,
         "variant_id": 49148385,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Red",
         "sku": "IPOD2008RED",
         "vendor": "Apple",
-        "quantity": 6,
+        "quantity": 7,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -48,17 +50,17 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2463654"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/3501443"
       },
       {
-        "id": 2209947,
+        "id": 2686861,
         "variant_id": 457924702,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Black",
         "sku": "IPOD2008BLACK",
         "vendor": "Apple",
-        "quantity": 3,
+        "quantity": 9,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -70,17 +72,17 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2209947"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2686861"
       },
       {
-        "id": 2932350,
+        "id": 3836421,
         "variant_id": 808950810,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Pink",
         "sku": "IPOD2008PINK",
         "vendor": "Apple",
-        "quantity": 6,
+        "quantity": 9,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -92,9 +94,10 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2932350"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/3836421"
       }
     ],
+    "api_client_id": null,
     "shipping_address": {
       "first_name": "Steve",
       "address1": "123 Shipping Street",
@@ -130,11 +133,12 @@
       "province_code": "KY"
     },
     "invoice_url": "https://jsmith.myshopify.com/548380009/invoices/abcd1234abcd1234abcd1234abcd1234",
+    "created_on_api_version_handle": null,
     "applied_discount": {
       "description": "ABC 123",
-      "value": "3.0",
+      "value": "6.0",
       "title": "ABC 123",
-      "amount": "5.00",
+      "amount": "9.00",
       "value_type": "percentage"
     },
     "order_id": null,
@@ -142,30 +146,30 @@
       "title": "ABC 123",
       "custom": true,
       "handle": null,
-      "price": "1.00"
+      "price": "3.00"
     },
     "tax_lines": [
       {
-        "rate": 0.04286715927803485,
+        "rate": 0.020742791096584286,
         "title": "State tax",
-        "price": "4.00"
+        "price": "1.00"
       },
       {
-        "rate": 0.04286715927803485,
+        "rate": 0.020742791096584286,
         "title": "State tax",
-        "price": "1.00"
+        "price": "5.00"
       },
       {
-        "rate": 0.04286715927803485,
+        "rate": 0.020742791096584286,
         "title": "State tax",
         "price": "2.00"
       }
     ],
     "tags": "",
     "note_attributes": [],
-    "total_price": "437.00",
-    "subtotal_price": "464.00",
-    "total_tax": "485.00",
+    "total_price": "427.00",
+    "subtotal_price": "494.00",
+    "total_tax": "459.00",
     "payment_terms": {
       "id": 706405506930370000,
       "payment_terms_name": "Net 7",
@@ -184,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": "437.00",
+          "amount": "427.00",
           "currency": "USD",
-          "total_price": "437.00",
+          "total_price": "427.00",
           "total_price_currency": "USD",
-          "balance_due": "437.00",
+          "balance_due": "427.00",
           "balance_due_currency": "USD",
-          "total_balance": "437.00",
+          "total_balance": "427.00",
           "total_balance_currency": "USD",
-          "outstanding_balance": "437.00",
+          "outstanding_balance": "427.00",
           "outstanding_balance_currency": "USD"
         }
       ],

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

@@ -25,18 +25,20 @@
     "updated_at": "2021-12-31T19:00:00-05:00",
     "tax_exempt": false,
     "completed_at": null,
-    "name": "#D130",
+    "name": "#D148",
+    "allow_discount_codes_in_checkout?": false,
+    "b2b?": false,
     "status": "open",
     "line_items": [
       {
-        "id": 4215981,
+        "id": 4842269,
         "variant_id": 49148385,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Red",
         "sku": "IPOD2008RED",
         "vendor": "Apple",
-        "quantity": 10,
+        "quantity": 7,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -48,17 +50,17 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/4215981"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/4842269"
       },
       {
-        "id": 4858493,
+        "id": 2504001,
         "variant_id": 457924702,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Black",
         "sku": "IPOD2008BLACK",
         "vendor": "Apple",
-        "quantity": 7,
+        "quantity": 2,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -70,17 +72,17 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/4858493"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/2504001"
       },
       {
-        "id": 907316,
+        "id": 55389,
         "variant_id": 808950810,
         "product_id": 632910392,
         "title": "IPod Nano - 8GB",
         "variant_title": "Pink",
         "sku": "IPOD2008PINK",
         "vendor": "Apple",
-        "quantity": 10,
+        "quantity": 2,
         "requires_shipping": true,
         "taxable": true,
         "gift_card": false,
@@ -92,9 +94,10 @@
         "properties": [],
         "custom": false,
         "price": "199.00",
-        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/907316"
+        "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/55389"
       }
     ],
+    "api_client_id": null,
     "shipping_address": {
       "first_name": "Steve",
       "address1": "123 Shipping Street",
@@ -130,11 +133,12 @@
       "province_code": "KY"
     },
     "invoice_url": "https://jsmith.myshopify.com/548380009/invoices/abcd1234abcd1234abcd1234abcd1234",
+    "created_on_api_version_handle": null,
     "applied_discount": {
       "description": "ABC 123",
-      "value": "9.0",
+      "value": "4.0",
       "title": "ABC 123",
-      "amount": "2.00",
+      "amount": "10.00",
       "value_type": "percentage"
     },
     "order_id": null,
@@ -142,30 +146,30 @@
       "title": "ABC 123",
       "custom": true,
       "handle": null,
-      "price": "4.00"
+      "price": "2.00"
     },
     "tax_lines": [
       {
-        "rate": 0.04954898138784494,
+        "rate": 0.04401059067287736,
         "title": "State tax",
-        "price": "1.00"
+        "price": "2.00"
       },
       {
-        "rate": 0.04954898138784494,
+        "rate": 0.04401059067287736,
         "title": "State tax",
-        "price": "2.00"
+        "price": "4.00"
       },
       {
-        "rate": 0.04954898138784494,
+        "rate": 0.04401059067287736,
         "title": "State tax",
-        "price": "3.00"
+        "price": "4.00"
       }
     ],
     "tags": "",
     "note_attributes": [],
-    "total_price": "442.00",
-    "subtotal_price": "412.00",
-    "total_tax": "429.00",
+    "total_price": "425.00",
+    "subtotal_price": "442.00",
+    "total_tax": "424.00",
     "payment_terms": {
       "id": 706405506930370000,
       "payment_terms_name": "Net 7",
@@ -184,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": "442.00",
+          "amount": "425.00",
           "currency": "USD",
-          "total_price": "442.00",
+          "total_price": "425.00",
           "total_price_currency": "USD",
-          "balance_due": "442.00",
+          "balance_due": "425.00",
           "balance_due_currency": "USD",
-          "total_balance": "442.00",
+          "total_balance": "425.00",
           "total_balance_currency": "USD",
-          "outstanding_balance": "442.00",
+          "outstanding_balance": "425.00",
           "outstanding_balance_currency": "USD"
         }
       ],

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

@@ -23,6 +23,8 @@
     "harmonized_system_code": null,
     "tracked": true,
     "country_harmonized_system_codes": [],
+    "weight_value": 0,
+    "weight_unit": "lb",
     "admin_graphql_api_id": "gid://shopify/InventoryItem/271878346596884015"
   },
   "shop_feature": false

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

@@ -23,6 +23,8 @@
     "harmonized_system_code": null,
     "tracked": true,
     "country_harmonized_system_codes": [],
+    "weight_value": 0,
+    "weight_unit": "lb",
     "admin_graphql_api_id": "gid://shopify/InventoryItem/271878346596884015"
   },
   "shop_feature": false

package/metadatas/2024-04/orders/cancelled.json

@@ -86,7 +86,7 @@
     "email": "jon@example.com",
     "estimated_taxes": false,
     "financial_status": "voided",
-    "fulfillment_status": "pending",
+    "fulfillment_status": null,
     "landing_site": null,
     "landing_site_ref": null,
     "location_id": null,