shopify-webhook-schemas 0.1.2 → 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 +11 -5
  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/fulfillment_orders/split.json CHANGED
@@ -41,11 +41,246 @@
41
41
  "type": "object",
42
42
  "properties": {
43
43
  "id": {
44
- "type": "string",
45
- "format": "uri"
44
+ "anyOf": [
45
+ {
46
+ "type": "string",
47
+ "format": "uri"
48
+ },
49
+ {
50
+ "type": "integer"
51
+ },
52
+ {
53
+ "type": "string",
54
+ "format": "uri"
55
+ },
56
+ {
57
+ "type": "string",
58
+ "format": "uri"
59
+ },
60
+ {
61
+ "type": "string",
62
+ "format": "uri"
63
+ },
64
+ {
65
+ "type": "string",
66
+ "format": "uri"
67
+ },
68
+ {
69
+ "type": "string",
70
+ "format": "uri"
71
+ },
72
+ {
73
+ "type": "string",
74
+ "format": "uri"
75
+ }
76
+ ]
46
77
  },
47
78
  "status": {
48
79
  "type": "string"
80
+ },
81
+ "shop_id": {
82
+ "type": "integer"
83
+ },
84
+ "order_id": {
85
+ "type": "integer"
86
+ },
87
+ "assigned_location_id": {
88
+ "type": "integer"
89
+ },
90
+ "request_status": {
91
+ "type": "string"
92
+ },
93
+ "supported_actions": {
94
+ "type": "array",
95
+ "items": {
96
+ "type": "string"
97
+ }
98
+ },
99
+ "destination": {
100
+ "type": "object",
101
+ "properties": {
102
+ "id": {
103
+ "type": "integer"
104
+ },
105
+ "address1": {
106
+ "type": "string"
107
+ },
108
+ "address2": {
109
+ "type": "string"
110
+ },
111
+ "city": {
112
+ "type": "string"
113
+ },
114
+ "company": {
115
+ "type": "null"
116
+ },
117
+ "country": {
118
+ "type": "string"
119
+ },
120
+ "email": {
121
+ "type": "string"
122
+ },
123
+ "first_name": {
124
+ "type": "string"
125
+ },
126
+ "last_name": {
127
+ "type": "string"
128
+ },
129
+ "phone": {
130
+ "type": "null"
131
+ },
132
+ "province": {
133
+ "type": "string"
134
+ },
135
+ "zip": {
136
+ "type": "string",
137
+ "format": "time"
138
+ }
139
+ },
140
+ "required": [
141
+ "id",
142
+ "address1",
143
+ "address2",
144
+ "city",
145
+ "company",
146
+ "country",
147
+ "email",
148
+ "first_name",
149
+ "last_name",
150
+ "phone",
151
+ "province",
152
+ "zip"
153
+ ]
154
+ },
155
+ "line_items": {
156
+ "type": "array",
157
+ "items": {
158
+ "type": "object",
159
+ "properties": {
160
+ "id": {
161
+ "type": "integer"
162
+ },
163
+ "shop_id": {
164
+ "type": "integer"
165
+ },
166
+ "fulfillment_order_id": {
167
+ "type": "integer"
168
+ },
169
+ "quantity": {
170
+ "type": "integer"
171
+ },
172
+ "line_item_id": {
173
+ "type": "integer"
174
+ },
175
+ "inventory_item_id": {
176
+ "type": "integer"
177
+ },
178
+ "fulfillable_quantity": {
179
+ "type": "integer"
180
+ },
181
+ "variant_id": {
182
+ "type": "integer"
183
+ }
184
+ },
185
+ "required": [
186
+ "id",
187
+ "shop_id",
188
+ "fulfillment_order_id",
189
+ "quantity",
190
+ "line_item_id",
191
+ "inventory_item_id",
192
+ "fulfillable_quantity",
193
+ "variant_id"
194
+ ]
195
+ }
196
+ },
197
+ "fulfill_at": {
198
+ "type": "string",
199
+ "format": "date-time"
200
+ },
201
+ "fulfill_by": {
202
+ "type": "null"
203
+ },
204
+ "international_duties": {
205
+ "type": "object",
206
+ "properties": {
207
+ "incoterm": {
208
+ "type": "string"
209
+ }
210
+ },
211
+ "required": [
212
+ "incoterm"
213
+ ]
214
+ },
215
+ "fulfillment_holds": {
216
+ "type": "array",
217
+ "items": false
218
+ },
219
+ "delivery_method": {
220
+ "type": "object",
221
+ "properties": {
222
+ "id": {
223
+ "type": "integer"
224
+ },
225
+ "method_type": {
226
+ "type": "string"
227
+ },
228
+ "min_delivery_date_time": {
229
+ "type": "null"
230
+ },
231
+ "max_delivery_date_time": {
232
+ "type": "null"
233
+ }
234
+ },
235
+ "required": [
236
+ "id",
237
+ "method_type",
238
+ "min_delivery_date_time",
239
+ "max_delivery_date_time"
240
+ ]
241
+ },
242
+ "assigned_location": {
243
+ "type": "object",
244
+ "properties": {
245
+ "address1": {
246
+ "type": "null"
247
+ },
248
+ "address2": {
249
+ "type": "null"
250
+ },
251
+ "city": {
252
+ "type": "null"
253
+ },
254
+ "country_code": {
255
+ "type": "string"
256
+ },
257
+ "location_id": {
258
+ "type": "integer"
259
+ },
260
+ "name": {
261
+ "type": "string"
262
+ },
263
+ "phone": {
264
+ "type": "null"
265
+ },
266
+ "province": {
267
+ "type": "null"
268
+ },
269
+ "zip": {
270
+ "type": "null"
271
+ }
272
+ },
273
+ "required": [
274
+ "address1",
275
+ "address2",
276
+ "city",
277
+ "country_code",
278
+ "location_id",
279
+ "name",
280
+ "phone",
281
+ "province",
282
+ "zip"
283
+ ]
49
284
  }
50
285
  },
51
286
  "required": [
package/schemas/2024-04/fulfillments/create.json CHANGED
@@ -46,19 +46,31 @@
46
46
  "null"
47
47
  ],
48
48
  "properties": {
49
- "first_name": {
49
+ "address1": {
50
50
  "type": "string"
51
51
  },
52
- "address1": {
52
+ "city": {
53
53
  "type": "string"
54
54
  },
55
- "phone": {
55
+ "zip": {
56
56
  "type": "string"
57
57
  },
58
- "city": {
58
+ "address2": {
59
+ "type": [
60
+ "string",
61
+ "null"
62
+ ]
63
+ },
64
+ "country_code": {
59
65
  "type": "string"
60
66
  },
61
- "zip": {
67
+ "province_code": {
68
+ "type": "string"
69
+ },
70
+ "first_name": {
71
+ "type": "string"
72
+ },
73
+ "phone": {
62
74
  "type": "string"
63
75
  },
64
76
  "province": {
@@ -70,9 +82,6 @@
70
82
  "last_name": {
71
83
  "type": "string"
72
84
  },
73
- "address2": {
74
- "type": "null"
75
- },
76
85
  "company": {
77
86
  "type": "string"
78
87
  },
@@ -84,28 +93,13 @@
84
93
  },
85
94
  "name": {
86
95
  "type": "string"
87
- },
88
- "country_code": {
89
- "type": "string"
90
- },
91
- "province_code": {
92
- "type": "string"
93
96
  }
94
97
  },
95
98
  "required": [
96
- "first_name",
97
99
  "address1",
98
- "phone",
99
100
  "city",
100
101
  "zip",
101
- "province",
102
- "country",
103
- "last_name",
104
102
  "address2",
105
- "company",
106
- "latitude",
107
- "longitude",
108
- "name",
109
103
  "country_code",
110
104
  "province_code"
111
105
  ]
@@ -145,13 +139,22 @@
145
139
  "type": "null"
146
140
  },
147
141
  "company": {
148
- "type": "string"
142
+ "type": [
143
+ "string",
144
+ "null"
145
+ ]
149
146
  },
150
147
  "latitude": {
151
- "type": "null"
148
+ "type": [
149
+ "number",
150
+ "null"
151
+ ]
152
152
  },
153
153
  "longitude": {
154
- "type": "null"
154
+ "type": [
155
+ "number",
156
+ "null"
157
+ ]
155
158
  },
156
159
  "name": {
157
160
  "type": "string"
@@ -202,10 +205,16 @@
202
205
  "type": "string"
203
206
  },
204
207
  "variant_title": {
205
- "type": "null"
208
+ "type": [
209
+ "string",
210
+ "null"
211
+ ]
206
212
  },
207
213
  "vendor": {
208
- "type": "null"
214
+ "type": [
215
+ "string",
216
+ "null"
217
+ ]
209
218
  },
210
219
  "fulfillment_service": {
211
220
  "type": "string"
@@ -248,7 +257,10 @@
248
257
  "type": "string"
249
258
  },
250
259
  "fulfillment_status": {
251
- "type": "null"
260
+ "type": [
261
+ "string",
262
+ "null"
263
+ ]
252
264
  },
253
265
  "price_set": {
254
266
  "type": "object",
@@ -396,7 +408,114 @@
396
408
  },
397
409
  "tax_lines": {
398
410
  "type": "array",
399
- "items": false
411
+ "items": {
412
+ "type": "object",
413
+ "properties": {
414
+ "rate": {
415
+ "type": "number"
416
+ },
417
+ "title": {
418
+ "type": "string"
419
+ },
420
+ "channel_liable": {
421
+ "type": "boolean"
422
+ },
423
+ "price": {
424
+ "type": "string"
425
+ },
426
+ "price_set": {
427
+ "type": "object",
428
+ "properties": {
429
+ "presentment_money": {
430
+ "type": "object",
431
+ "properties": {
432
+ "amount": {
433
+ "type": "string"
434
+ },
435
+ "currency_code": {
436
+ "type": "string"
437
+ }
438
+ },
439
+ "required": [
440
+ "amount",
441
+ "currency_code"
442
+ ]
443
+ },
444
+ "shop_money": {
445
+ "type": "object",
446
+ "properties": {
447
+ "amount": {
448
+ "type": "string"
449
+ },
450
+ "currency_code": {
451
+ "type": "string"
452
+ }
453
+ },
454
+ "required": [
455
+ "amount",
456
+ "currency_code"
457
+ ]
458
+ }
459
+ },
460
+ "required": [
461
+ "presentment_money",
462
+ "shop_money"
463
+ ]
464
+ }
465
+ },
466
+ "required": [
467
+ "rate",
468
+ "title",
469
+ "channel_liable",
470
+ "price",
471
+ "price_set"
472
+ ]
473
+ }
474
+ },
475
+ "tax_code": {
476
+ "type": "string"
477
+ },
478
+ "pre_tax_price_set": {
479
+ "type": "object",
480
+ "properties": {
481
+ "presentment_money": {
482
+ "type": "object",
483
+ "properties": {
484
+ "amount": {
485
+ "type": "string"
486
+ },
487
+ "currency_code": {
488
+ "type": "string"
489
+ }
490
+ },
491
+ "required": [
492
+ "amount",
493
+ "currency_code"
494
+ ]
495
+ },
496
+ "shop_money": {
497
+ "type": "object",
498
+ "properties": {
499
+ "currency_code": {
500
+ "type": "string"
501
+ },
502
+ "amount": {
503
+ "type": "string"
504
+ }
505
+ },
506
+ "required": [
507
+ "currency_code",
508
+ "amount"
509
+ ]
510
+ }
511
+ },
512
+ "required": [
513
+ "presentment_money",
514
+ "shop_money"
515
+ ]
516
+ },
517
+ "pre_tax_price": {
518
+ "type": "string"
400
519
  }
401
520
  },
402
521
  "required": [