shopify-webhook-schemas 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. package/Readme.md +14 -2
  2. package/dist/src/anonymize-exemplars.d.ts +1 -0
  3. package/dist/src/anonymize-exemplars.js +51 -0
  4. package/dist/src/index.js +2 -2
  5. package/dist/src/scrape.js +501 -182
  6. package/metadatas/2024-07/app_purchases_one_time/update.json +1 -1
  7. package/metadatas/2024-07/app_subscriptions/approaching_capped_amount.json +1 -1
  8. package/metadatas/2024-07/app_subscriptions/update.json +1 -1
  9. package/metadatas/2024-07/bulk_operations/finish.json +2 -2
  10. package/metadatas/2024-07/checkouts/create.json +6 -6
  11. package/metadatas/2024-07/checkouts/update.json +6 -6
  12. package/metadatas/2024-07/draft_orders/create.json +20 -20
  13. package/metadatas/2024-07/draft_orders/update.json +20 -20
  14. package/metadatas/2024-07/orders/edited.json +1 -0
  15. package/metadatas/2024-07/product_listings/add.json +1 -13
  16. package/metadatas/2024-07/product_listings/update.json +1 -13
  17. package/metadatas/2024-07/scheduled_product_listings/add.json +1 -13
  18. package/metadatas/2024-07/scheduled_product_listings/update.json +1 -13
  19. package/metadatas/2024-07/selling_plan_groups/create.json +2 -2
  20. package/metadatas/2024-07/selling_plan_groups/delete.json +2 -2
  21. package/metadatas/2024-07/selling_plan_groups/update.json +2 -2
  22. package/metadatas/2024-07/subscription_billing_attempts/challenged.json +2 -2
  23. package/metadatas/2024-07/subscription_billing_attempts/failure.json +2 -2
  24. package/metadatas/2024-07/subscription_billing_attempts/success.json +2 -2
  25. package/metadatas/2024-07/subscription_billing_cycle_edits/create.json +1 -1
  26. package/metadatas/2024-07/subscription_billing_cycle_edits/delete.json +1 -1
  27. package/metadatas/2024-07/subscription_billing_cycle_edits/update.json +1 -1
  28. package/metadatas/2024-07/subscription_billing_cycles/skip.json +1 -1
  29. package/metadatas/2024-07/subscription_billing_cycles/unskip.json +1 -1
  30. package/metadatas/2024-07/subscription_contracts/activate.json +3 -3
  31. package/metadatas/2024-07/subscription_contracts/cancel.json +3 -3
  32. package/metadatas/2024-07/subscription_contracts/create.json +3 -3
  33. package/metadatas/2024-07/subscription_contracts/expire.json +3 -3
  34. package/metadatas/2024-07/subscription_contracts/fail.json +3 -3
  35. package/metadatas/2024-07/subscription_contracts/pause.json +3 -3
  36. package/metadatas/2024-07/subscription_contracts/update.json +3 -3
  37. package/package.json +9 -1
  38. package/schemas/2023-07/checkouts/create.json +578 -102
  39. package/schemas/2023-07/checkouts/delete.json +26 -4
  40. package/schemas/2023-07/checkouts/update.json +578 -102
  41. package/schemas/2023-07/collection_listings/add.json +9 -2
  42. package/schemas/2023-07/collection_listings/remove.json +7 -0
  43. package/schemas/2023-07/collection_listings/update.json +9 -2
  44. package/schemas/2023-07/company_locations/create.json +8 -2
  45. package/schemas/2023-07/company_locations/delete.json +8 -2
  46. package/schemas/2023-07/company_locations/update.json +8 -2
  47. package/schemas/2023-07/draft_orders/create.json +729 -126
  48. package/schemas/2023-07/draft_orders/update.json +729 -126
  49. package/schemas/2023-07/fulfillments/create.json +149 -30
  50. package/schemas/2023-07/fulfillments/update.json +149 -30
  51. package/schemas/2023-07/order_transactions/create.json +31 -9
  52. package/schemas/2023-07/orders/cancelled.json +966 -48
  53. package/schemas/2023-07/orders/create.json +966 -48
  54. package/schemas/2023-07/orders/fulfilled.json +966 -48
  55. package/schemas/2023-07/orders/paid.json +966 -48
  56. package/schemas/2023-07/orders/partially_fulfilled.json +966 -48
  57. package/schemas/2023-07/orders/updated.json +966 -48
  58. package/schemas/2023-07/products/create.json +191 -17
  59. package/schemas/2023-07/products/update.json +191 -17
  60. package/schemas/2023-10/checkouts/create.json +578 -102
  61. package/schemas/2023-10/checkouts/delete.json +26 -4
  62. package/schemas/2023-10/checkouts/update.json +578 -102
  63. package/schemas/2023-10/collection_listings/add.json +9 -2
  64. package/schemas/2023-10/collection_listings/remove.json +7 -0
  65. package/schemas/2023-10/collection_listings/update.json +9 -2
  66. package/schemas/2023-10/company_locations/create.json +8 -2
  67. package/schemas/2023-10/company_locations/delete.json +8 -2
  68. package/schemas/2023-10/company_locations/update.json +8 -2
  69. package/schemas/2023-10/draft_orders/create.json +729 -126
  70. package/schemas/2023-10/draft_orders/update.json +729 -126
  71. package/schemas/2023-10/fulfillments/create.json +149 -30
  72. package/schemas/2023-10/fulfillments/update.json +149 -30
  73. package/schemas/2023-10/order_transactions/create.json +28 -9
  74. package/schemas/2023-10/orders/cancelled.json +966 -48
  75. package/schemas/2023-10/orders/create.json +966 -48
  76. package/schemas/2023-10/orders/fulfilled.json +966 -48
  77. package/schemas/2023-10/orders/paid.json +966 -48
  78. package/schemas/2023-10/orders/partially_fulfilled.json +966 -48
  79. package/schemas/2023-10/orders/updated.json +966 -48
  80. package/schemas/2023-10/products/create.json +191 -17
  81. package/schemas/2023-10/products/update.json +191 -17
  82. package/schemas/2024-01/checkouts/create.json +585 -100
  83. package/schemas/2024-01/checkouts/delete.json +26 -4
  84. package/schemas/2024-01/checkouts/update.json +585 -100
  85. package/schemas/2024-01/collection_listings/add.json +9 -2
  86. package/schemas/2024-01/collection_listings/remove.json +7 -0
  87. package/schemas/2024-01/collection_listings/update.json +9 -2
  88. package/schemas/2024-01/company_locations/create.json +8 -2
  89. package/schemas/2024-01/company_locations/delete.json +8 -2
  90. package/schemas/2024-01/company_locations/update.json +8 -2
  91. package/schemas/2024-01/draft_orders/create.json +733 -124
  92. package/schemas/2024-01/draft_orders/update.json +733 -124
  93. package/schemas/2024-01/fulfillment_orders/split.json +237 -2
  94. package/schemas/2024-01/fulfillments/create.json +149 -30
  95. package/schemas/2024-01/fulfillments/update.json +149 -30
  96. package/schemas/2024-01/order_transactions/create.json +28 -9
  97. package/schemas/2024-01/orders/cancelled.json +970 -50
  98. package/schemas/2024-01/orders/create.json +970 -50
  99. package/schemas/2024-01/orders/fulfilled.json +970 -50
  100. package/schemas/2024-01/orders/paid.json +970 -50
  101. package/schemas/2024-01/orders/partially_fulfilled.json +970 -50
  102. package/schemas/2024-01/orders/updated.json +970 -50
  103. package/schemas/2024-01/products/create.json +191 -17
  104. package/schemas/2024-01/products/update.json +191 -17
  105. package/schemas/2024-04/checkouts/create.json +585 -100
  106. package/schemas/2024-04/checkouts/delete.json +26 -4
  107. package/schemas/2024-04/checkouts/update.json +585 -100
  108. package/schemas/2024-04/collection_listings/add.json +9 -2
  109. package/schemas/2024-04/collection_listings/remove.json +7 -0
  110. package/schemas/2024-04/collection_listings/update.json +9 -2
  111. package/schemas/2024-04/company_locations/create.json +8 -2
  112. package/schemas/2024-04/company_locations/delete.json +8 -2
  113. package/schemas/2024-04/company_locations/update.json +8 -2
  114. package/schemas/2024-04/draft_orders/create.json +733 -124
  115. package/schemas/2024-04/draft_orders/update.json +733 -124
  116. package/schemas/2024-04/fulfillment_orders/split.json +237 -2
  117. package/schemas/2024-04/fulfillments/create.json +149 -30
  118. package/schemas/2024-04/fulfillments/update.json +149 -30
  119. package/schemas/2024-04/order_transactions/create.json +28 -9
  120. package/schemas/2024-04/orders/cancelled.json +967 -50
  121. package/schemas/2024-04/orders/create.json +967 -50
  122. package/schemas/2024-04/orders/fulfilled.json +967 -50
  123. package/schemas/2024-04/orders/paid.json +967 -50
  124. package/schemas/2024-04/orders/partially_fulfilled.json +967 -50
  125. package/schemas/2024-04/orders/updated.json +967 -50
  126. package/schemas/2024-04/products/create.json +191 -17
  127. package/schemas/2024-04/products/update.json +191 -17
  128. package/schemas/2024-07/checkouts/create.json +585 -100
  129. package/schemas/2024-07/checkouts/delete.json +26 -4
  130. package/schemas/2024-07/checkouts/update.json +585 -100
  131. package/schemas/2024-07/collection_listings/add.json +9 -2
  132. package/schemas/2024-07/collection_listings/remove.json +7 -0
  133. package/schemas/2024-07/collection_listings/update.json +9 -2
  134. package/schemas/2024-07/company_locations/create.json +8 -2
  135. package/schemas/2024-07/company_locations/delete.json +8 -2
  136. package/schemas/2024-07/company_locations/update.json +8 -2
  137. package/schemas/2024-07/draft_orders/create.json +733 -124
  138. package/schemas/2024-07/draft_orders/update.json +733 -124
  139. package/schemas/2024-07/fulfillment_orders/split.json +237 -2
  140. package/schemas/2024-07/fulfillments/create.json +149 -30
  141. package/schemas/2024-07/fulfillments/update.json +149 -30
  142. package/schemas/2024-07/order_transactions/create.json +28 -9
  143. package/schemas/2024-07/orders/cancelled.json +967 -50
  144. package/schemas/2024-07/orders/create.json +967 -50
  145. package/schemas/2024-07/orders/edited.json +5 -0
  146. package/schemas/2024-07/orders/fulfilled.json +967 -50
  147. package/schemas/2024-07/orders/paid.json +967 -50
  148. package/schemas/2024-07/orders/partially_fulfilled.json +967 -50
  149. package/schemas/2024-07/orders/updated.json +967 -50
  150. package/schemas/2024-07/product_listings/add.json +1 -44
  151. package/schemas/2024-07/product_listings/update.json +1 -44
  152. package/schemas/2024-07/products/create.json +191 -17
  153. package/schemas/2024-07/products/update.json +191 -17
  154. package/schemas/2024-07/scheduled_product_listings/add.json +1 -44
  155. package/schemas/2024-07/scheduled_product_listings/update.json +1 -44
package/schemas/2024-04/products/create.json CHANGED
@@ -64,13 +64,23 @@
64
64
  "format": "uri"
65
65
  },
66
66
  "barcode": {
67
- "type": "null"
67
+ "type": [
68
+ "string",
69
+ "null"
70
+ ]
68
71
  },
69
72
  "compare_at_price": {
70
- "type": "string"
73
+ "type": [
74
+ "string",
75
+ "null"
76
+ ]
71
77
  },
72
78
  "created_at": {
73
- "type": "null"
79
+ "type": [
80
+ "string",
81
+ "null"
82
+ ],
83
+ "format": "date-time"
74
84
  },
75
85
  "fulfillment_service": {
76
86
  "type": "string"
@@ -94,7 +104,10 @@
94
104
  "type": "integer"
95
105
  },
96
106
  "sku": {
97
- "type": "string"
107
+ "type": [
108
+ "string",
109
+ "null"
110
+ ]
98
111
  },
99
112
  "taxable": {
100
113
  "type": "boolean"
@@ -103,31 +116,47 @@
103
116
  "type": "string"
104
117
  },
105
118
  "updated_at": {
106
- "type": "null"
119
+ "type": [
120
+ "string",
121
+ "null"
122
+ ],
123
+ "format": "date-time"
107
124
  },
108
125
  "option1": {
109
126
  "type": "string"
110
127
  },
111
128
  "option2": {
112
- "type": "null"
129
+ "type": [
130
+ "string",
131
+ "null"
132
+ ]
113
133
  },
114
134
  "option3": {
115
- "type": "null"
135
+ "type": [
136
+ "string",
137
+ "null"
138
+ ]
116
139
  },
117
140
  "grams": {
118
141
  "type": "integer"
119
142
  },
120
143
  "image_id": {
121
- "type": "null"
144
+ "type": [
145
+ "integer",
146
+ "null"
147
+ ]
122
148
  },
123
149
  "weight": {
124
- "type": "integer"
150
+ "type": "number"
125
151
  },
126
152
  "weight_unit": {
127
153
  "type": "string"
128
154
  },
129
155
  "inventory_item_id": {
130
- "type": "null"
156
+ "type": [
157
+ "integer",
158
+ "null"
159
+ ]
131
160
  },
132
161
  "inventory_quantity": {
133
162
  "type": "integer"
@@ -171,18 +200,163 @@
171
200
  },
172
201
  "options": {
173
202
  "type": "array",
174
- "items": false
203
+ "items": {
204
+ "type": "object",
205
+ "properties": {
206
+ "id": {
207
+ "type": "integer"
208
+ },
209
+ "name": {
210
+ "type": "string"
211
+ },
212
+ "position": {
213
+ "type": "integer"
214
+ },
215
+ "product_id": {
216
+ "type": "integer"
217
+ },
218
+ "values": {
219
+ "type": "array",
220
+ "items": {
221
+ "type": "string"
222
+ }
223
+ }
224
+ },
225
+ "required": [
226
+ "id",
227
+ "name",
228
+ "position",
229
+ "product_id",
230
+ "values"
231
+ ]
232
+ }
175
233
  },
176
234
  "images": {
177
235
  "type": "array",
178
- "items": false
236
+ "items": {
237
+ "type": "object",
238
+ "properties": {
239
+ "height": {
240
+ "type": "integer"
241
+ },
242
+ "id": {
243
+ "type": "integer"
244
+ },
245
+ "src": {
246
+ "type": "string",
247
+ "format": "uri"
248
+ },
249
+ "updated_at": {
250
+ "type": "string",
251
+ "format": "date-time"
252
+ },
253
+ "variant_ids": {
254
+ "type": "array",
255
+ "items": {
256
+ "type": "integer"
257
+ }
258
+ },
259
+ "admin_graphql_api_id": {
260
+ "type": "string",
261
+ "format": "uri"
262
+ },
263
+ "alt": {
264
+ "type": "null"
265
+ },
266
+ "created_at": {
267
+ "type": "string",
268
+ "format": "date-time"
269
+ },
270
+ "product_id": {
271
+ "type": "integer"
272
+ },
273
+ "position": {
274
+ "type": "integer"
275
+ },
276
+ "width": {
277
+ "type": "integer"
278
+ }
279
+ },
280
+ "required": [
281
+ "height",
282
+ "id",
283
+ "src",
284
+ "updated_at",
285
+ "variant_ids",
286
+ "admin_graphql_api_id",
287
+ "alt",
288
+ "created_at",
289
+ "product_id",
290
+ "position",
291
+ "width"
292
+ ]
293
+ }
179
294
  },
180
295
  "image": {
181
- "type": [
182
- "string",
183
- "null"
184
- ],
185
- "format": "uri"
296
+ "anyOf": [
297
+ {
298
+ "type": "string",
299
+ "format": "uri"
300
+ },
301
+ {
302
+ "type": "object",
303
+ "properties": {
304
+ "height": {
305
+ "type": "integer"
306
+ },
307
+ "position": {
308
+ "type": "integer"
309
+ },
310
+ "updated_at": {
311
+ "type": "string",
312
+ "format": "date-time"
313
+ },
314
+ "variant_ids": {
315
+ "type": "array",
316
+ "items": {
317
+ "type": "integer"
318
+ }
319
+ },
320
+ "admin_graphql_api_id": {
321
+ "type": "string",
322
+ "format": "uri"
323
+ },
324
+ "created_at": {
325
+ "type": "string",
326
+ "format": "date-time"
327
+ },
328
+ "product_id": {
329
+ "type": "integer"
330
+ },
331
+ "alt": {
332
+ "type": "null"
333
+ },
334
+ "src": {
335
+ "type": "string",
336
+ "format": "uri"
337
+ },
338
+ "width": {
339
+ "type": "integer"
340
+ },
341
+ "id": {
342
+ "type": "integer"
343
+ }
344
+ },
345
+ "required": [
346
+ "height",
347
+ "position",
348
+ "updated_at",
349
+ "variant_ids",
350
+ "admin_graphql_api_id",
351
+ "created_at",
352
+ "product_id",
353
+ "alt",
354
+ "src",
355
+ "width",
356
+ "id"
357
+ ]
358
+ }
359
+ ]
186
360
  },
187
361
  "variant_gids": {
188
362
  "type": "array",
package/schemas/2024-04/products/update.json CHANGED
@@ -64,13 +64,23 @@
64
64
  "format": "uri"
65
65
  },
66
66
  "barcode": {
67
- "type": "null"
67
+ "type": [
68
+ "string",
69
+ "null"
70
+ ]
68
71
  },
69
72
  "compare_at_price": {
70
- "type": "string"
73
+ "type": [
74
+ "string",
75
+ "null"
76
+ ]
71
77
  },
72
78
  "created_at": {
73
- "type": "null"
79
+ "type": [
80
+ "string",
81
+ "null"
82
+ ],
83
+ "format": "date-time"
74
84
  },
75
85
  "fulfillment_service": {
76
86
  "type": "string"
@@ -94,7 +104,10 @@
94
104
  "type": "integer"
95
105
  },
96
106
  "sku": {
97
- "type": "string"
107
+ "type": [
108
+ "string",
109
+ "null"
110
+ ]
98
111
  },
99
112
  "taxable": {
100
113
  "type": "boolean"
@@ -103,31 +116,47 @@
103
116
  "type": "string"
104
117
  },
105
118
  "updated_at": {
106
- "type": "null"
119
+ "type": [
120
+ "string",
121
+ "null"
122
+ ],
123
+ "format": "date-time"
107
124
  },
108
125
  "option1": {
109
126
  "type": "string"
110
127
  },
111
128
  "option2": {
112
- "type": "null"
129
+ "type": [
130
+ "string",
131
+ "null"
132
+ ]
113
133
  },
114
134
  "option3": {
115
- "type": "null"
135
+ "type": [
136
+ "string",
137
+ "null"
138
+ ]
116
139
  },
117
140
  "grams": {
118
141
  "type": "integer"
119
142
  },
120
143
  "image_id": {
121
- "type": "null"
144
+ "type": [
145
+ "integer",
146
+ "null"
147
+ ]
122
148
  },
123
149
  "weight": {
124
- "type": "integer"
150
+ "type": "number"
125
151
  },
126
152
  "weight_unit": {
127
153
  "type": "string"
128
154
  },
129
155
  "inventory_item_id": {
130
- "type": "null"
156
+ "type": [
157
+ "integer",
158
+ "null"
159
+ ]
131
160
  },
132
161
  "inventory_quantity": {
133
162
  "type": "integer"
@@ -171,18 +200,163 @@
171
200
  },
172
201
  "options": {
173
202
  "type": "array",
174
- "items": false
203
+ "items": {
204
+ "type": "object",
205
+ "properties": {
206
+ "id": {
207
+ "type": "integer"
208
+ },
209
+ "name": {
210
+ "type": "string"
211
+ },
212
+ "position": {
213
+ "type": "integer"
214
+ },
215
+ "product_id": {
216
+ "type": "integer"
217
+ },
218
+ "values": {
219
+ "type": "array",
220
+ "items": {
221
+ "type": "string"
222
+ }
223
+ }
224
+ },
225
+ "required": [
226
+ "id",
227
+ "name",
228
+ "position",
229
+ "product_id",
230
+ "values"
231
+ ]
232
+ }
175
233
  },
176
234
  "images": {
177
235
  "type": "array",
178
- "items": false
236
+ "items": {
237
+ "type": "object",
238
+ "properties": {
239
+ "height": {
240
+ "type": "integer"
241
+ },
242
+ "id": {
243
+ "type": "integer"
244
+ },
245
+ "src": {
246
+ "type": "string",
247
+ "format": "uri"
248
+ },
249
+ "updated_at": {
250
+ "type": "string",
251
+ "format": "date-time"
252
+ },
253
+ "variant_ids": {
254
+ "type": "array",
255
+ "items": {
256
+ "type": "integer"
257
+ }
258
+ },
259
+ "admin_graphql_api_id": {
260
+ "type": "string",
261
+ "format": "uri"
262
+ },
263
+ "alt": {
264
+ "type": "null"
265
+ },
266
+ "created_at": {
267
+ "type": "string",
268
+ "format": "date-time"
269
+ },
270
+ "product_id": {
271
+ "type": "integer"
272
+ },
273
+ "position": {
274
+ "type": "integer"
275
+ },
276
+ "width": {
277
+ "type": "integer"
278
+ }
279
+ },
280
+ "required": [
281
+ "height",
282
+ "id",
283
+ "src",
284
+ "updated_at",
285
+ "variant_ids",
286
+ "admin_graphql_api_id",
287
+ "alt",
288
+ "created_at",
289
+ "product_id",
290
+ "position",
291
+ "width"
292
+ ]
293
+ }
179
294
  },
180
295
  "image": {
181
- "type": [
182
- "string",
183
- "null"
184
- ],
185
- "format": "uri"
296
+ "anyOf": [
297
+ {
298
+ "type": "string",
299
+ "format": "uri"
300
+ },
301
+ {
302
+ "type": "object",
303
+ "properties": {
304
+ "height": {
305
+ "type": "integer"
306
+ },
307
+ "position": {
308
+ "type": "integer"
309
+ },
310
+ "updated_at": {
311
+ "type": "string",
312
+ "format": "date-time"
313
+ },
314
+ "variant_ids": {
315
+ "type": "array",
316
+ "items": {
317
+ "type": "integer"
318
+ }
319
+ },
320
+ "admin_graphql_api_id": {
321
+ "type": "string",
322
+ "format": "uri"
323
+ },
324
+ "created_at": {
325
+ "type": "string",
326
+ "format": "date-time"
327
+ },
328
+ "product_id": {
329
+ "type": "integer"
330
+ },
331
+ "alt": {
332
+ "type": "null"
333
+ },
334
+ "src": {
335
+ "type": "string",
336
+ "format": "uri"
337
+ },
338
+ "width": {
339
+ "type": "integer"
340
+ },
341
+ "id": {
342
+ "type": "integer"
343
+ }
344
+ },
345
+ "required": [
346
+ "height",
347
+ "position",
348
+ "updated_at",
349
+ "variant_ids",
350
+ "admin_graphql_api_id",
351
+ "created_at",
352
+ "product_id",
353
+ "alt",
354
+ "src",
355
+ "width",
356
+ "id"
357
+ ]
358
+ }
359
+ ]
186
360
  },
187
361
  "variant_gids": {
188
362
  "type": "array",