@paynow-gg/typescript-sdk 1.0.61 → 2.0.1

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 (140) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +44 -5
  3. package/dist/cjs/generated/management/client.d.ts +895 -0
  4. package/dist/cjs/generated/management/client.d.ts.map +1 -0
  5. package/dist/cjs/generated/management/client.js +1568 -0
  6. package/dist/cjs/generated/management/client.js.map +1 -0
  7. package/dist/cjs/generated/management/types.d.ts +7566 -0
  8. package/dist/cjs/generated/management/types.d.ts.map +1 -0
  9. package/dist/cjs/generated/management/types.js +4 -0
  10. package/dist/cjs/generated/management/types.js.map +1 -0
  11. package/dist/cjs/generated/storefront/client.d.ts +229 -0
  12. package/dist/cjs/generated/storefront/client.d.ts.map +1 -0
  13. package/dist/cjs/generated/storefront/client.js +357 -0
  14. package/dist/cjs/generated/storefront/client.js.map +1 -0
  15. package/dist/cjs/generated/storefront/types.d.ts +3076 -0
  16. package/dist/cjs/generated/storefront/types.d.ts.map +1 -0
  17. package/dist/cjs/generated/storefront/types.js +4 -0
  18. package/dist/cjs/generated/storefront/types.js.map +1 -0
  19. package/dist/cjs/generated/webhooks/types.d.ts +3113 -0
  20. package/dist/cjs/generated/webhooks/types.d.ts.map +1 -0
  21. package/dist/cjs/generated/webhooks/types.js +4 -0
  22. package/dist/cjs/generated/webhooks/types.js.map +1 -0
  23. package/dist/cjs/index.d.ts +9 -0
  24. package/dist/cjs/index.d.ts.map +1 -0
  25. package/dist/cjs/index.js +16 -0
  26. package/dist/cjs/index.js.map +1 -0
  27. package/dist/cjs/management.d.ts +3 -0
  28. package/dist/cjs/management.d.ts.map +1 -0
  29. package/dist/cjs/management.js +22 -0
  30. package/dist/cjs/management.js.map +1 -0
  31. package/dist/cjs/package.json +3 -0
  32. package/dist/cjs/runtime/errors.d.ts +18 -0
  33. package/dist/cjs/runtime/errors.d.ts.map +1 -0
  34. package/dist/cjs/runtime/errors.js +41 -0
  35. package/dist/cjs/runtime/errors.js.map +1 -0
  36. package/dist/cjs/runtime/http.d.ts +20 -0
  37. package/dist/cjs/runtime/http.d.ts.map +1 -0
  38. package/dist/cjs/runtime/http.js +121 -0
  39. package/dist/cjs/runtime/http.js.map +1 -0
  40. package/dist/cjs/runtime/options.d.ts +12 -0
  41. package/dist/cjs/runtime/options.d.ts.map +1 -0
  42. package/dist/{types.js → cjs/runtime/options.js} +1 -1
  43. package/dist/cjs/runtime/options.js.map +1 -0
  44. package/dist/cjs/storefront.d.ts +3 -0
  45. package/dist/cjs/storefront.d.ts.map +1 -0
  46. package/dist/cjs/storefront.js +22 -0
  47. package/dist/cjs/storefront.js.map +1 -0
  48. package/dist/cjs/webhooks.d.ts +2 -0
  49. package/dist/cjs/webhooks.d.ts.map +1 -0
  50. package/dist/cjs/webhooks.js +18 -0
  51. package/dist/cjs/webhooks.js.map +1 -0
  52. package/dist/esm/generated/management/client.d.ts +895 -0
  53. package/dist/esm/generated/management/client.d.ts.map +1 -0
  54. package/dist/esm/generated/management/client.js +1531 -0
  55. package/dist/esm/generated/management/client.js.map +1 -0
  56. package/dist/esm/generated/management/types.d.ts +7566 -0
  57. package/dist/esm/generated/management/types.d.ts.map +1 -0
  58. package/dist/esm/generated/management/types.js +3 -0
  59. package/dist/esm/generated/management/types.js.map +1 -0
  60. package/dist/esm/generated/storefront/client.d.ts +229 -0
  61. package/dist/esm/generated/storefront/client.d.ts.map +1 -0
  62. package/dist/esm/generated/storefront/client.js +340 -0
  63. package/dist/esm/generated/storefront/client.js.map +1 -0
  64. package/dist/esm/generated/storefront/types.d.ts +3076 -0
  65. package/dist/esm/generated/storefront/types.d.ts.map +1 -0
  66. package/dist/esm/generated/storefront/types.js +3 -0
  67. package/dist/esm/generated/storefront/types.js.map +1 -0
  68. package/dist/esm/generated/webhooks/types.d.ts +3113 -0
  69. package/dist/esm/generated/webhooks/types.d.ts.map +1 -0
  70. package/dist/esm/generated/webhooks/types.js +3 -0
  71. package/dist/esm/generated/webhooks/types.js.map +1 -0
  72. package/dist/esm/index.d.ts +9 -0
  73. package/dist/esm/index.d.ts.map +1 -0
  74. package/dist/esm/index.js +5 -0
  75. package/dist/esm/index.js.map +1 -0
  76. package/dist/esm/management.d.ts +3 -0
  77. package/dist/esm/management.d.ts.map +1 -0
  78. package/dist/esm/management.js +3 -0
  79. package/dist/esm/management.js.map +1 -0
  80. package/dist/esm/package.json +3 -0
  81. package/dist/esm/runtime/errors.d.ts +18 -0
  82. package/dist/esm/runtime/errors.d.ts.map +1 -0
  83. package/dist/esm/runtime/errors.js +36 -0
  84. package/dist/esm/runtime/errors.js.map +1 -0
  85. package/dist/esm/runtime/http.d.ts +20 -0
  86. package/dist/esm/runtime/http.d.ts.map +1 -0
  87. package/dist/esm/runtime/http.js +117 -0
  88. package/dist/esm/runtime/http.js.map +1 -0
  89. package/dist/esm/runtime/options.d.ts +12 -0
  90. package/dist/esm/runtime/options.d.ts.map +1 -0
  91. package/dist/esm/runtime/options.js +2 -0
  92. package/dist/esm/runtime/options.js.map +1 -0
  93. package/dist/esm/storefront.d.ts +3 -0
  94. package/dist/esm/storefront.d.ts.map +1 -0
  95. package/dist/esm/storefront.js +3 -0
  96. package/dist/esm/storefront.js.map +1 -0
  97. package/dist/esm/webhooks.d.ts +2 -0
  98. package/dist/esm/webhooks.d.ts.map +1 -0
  99. package/dist/esm/webhooks.js +2 -0
  100. package/dist/esm/webhooks.js.map +1 -0
  101. package/package.json +74 -15
  102. package/dist/client.d.ts +0 -73
  103. package/dist/client.d.ts.map +0 -1
  104. package/dist/client.js +0 -55
  105. package/dist/client.js.map +0 -1
  106. package/dist/errors.d.ts +0 -7
  107. package/dist/errors.d.ts.map +0 -1
  108. package/dist/errors.js +0 -14
  109. package/dist/errors.js.map +0 -1
  110. package/dist/generate.d.ts +0 -2
  111. package/dist/generate.d.ts.map +0 -1
  112. package/dist/generate.js +0 -102
  113. package/dist/generate.js.map +0 -1
  114. package/dist/generated/management.d.ts +0 -12767
  115. package/dist/generated/management.d.ts.map +0 -1
  116. package/dist/generated/management.js +0 -638
  117. package/dist/generated/management.js.map +0 -1
  118. package/dist/generated/storefront.d.ts +0 -3464
  119. package/dist/generated/storefront.d.ts.map +0 -1
  120. package/dist/generated/storefront.js +0 -90
  121. package/dist/generated/storefront.js.map +0 -1
  122. package/dist/generated/webhooks.d.ts +0 -3659
  123. package/dist/generated/webhooks.d.ts.map +0 -1
  124. package/dist/generated/webhooks.js +0 -5
  125. package/dist/generated/webhooks.js.map +0 -1
  126. package/dist/index.d.ts +0 -12
  127. package/dist/index.d.ts.map +0 -1
  128. package/dist/index.js +0 -10
  129. package/dist/index.js.map +0 -1
  130. package/dist/management.d.ts +0 -7
  131. package/dist/management.d.ts.map +0 -1
  132. package/dist/management.js +0 -12
  133. package/dist/management.js.map +0 -1
  134. package/dist/storefront.d.ts +0 -7
  135. package/dist/storefront.d.ts.map +0 -1
  136. package/dist/storefront.js +0 -13
  137. package/dist/storefront.js.map +0 -1
  138. package/dist/types.d.ts +0 -12
  139. package/dist/types.d.ts.map +0 -1
  140. package/dist/types.js.map +0 -1
@@ -1,3659 +0,0 @@
1
- export type paths = Record<string, never>;
2
- export interface webhooks {
3
- ON_CHARGEBACK: {
4
- parameters: {
5
- query?: never;
6
- header?: never;
7
- path?: never;
8
- cookie?: never;
9
- };
10
- get?: never;
11
- put?: never;
12
- /**
13
- * Triggered when a chargeback is created
14
- * @description Webhook for ON_CHARGEBACK
15
- */
16
- post: {
17
- parameters: {
18
- query?: never;
19
- header?: never;
20
- path?: never;
21
- cookie?: never;
22
- };
23
- requestBody: {
24
- content: {
25
- "application/json": {
26
- /**
27
- * @description The type of webhook event
28
- * @example ON_CHARGEBACK
29
- */
30
- event_type: components["schemas"]["WebhookEventType"];
31
- /**
32
- * Format: flake-id
33
- * @description The ID of the Webhook Event
34
- * @example 411486491630370816
35
- */
36
- event_id: string;
37
- body: {
38
- /**
39
- * Format: flake-id
40
- * @description The Flake ID of the Payment associated with the Payment
41
- * @example 411486491630370816
42
- */
43
- id: string;
44
- /**
45
- * Format: flake-id
46
- * @description The Flake ID of the Store associated with the Payment
47
- * @example 411486491630370816
48
- */
49
- store_id: string;
50
- /**
51
- * Format: flake-id
52
- * @description The Flake ID of the Order associated with Payment
53
- * @example 411486491630370816
54
- */
55
- order_id: string;
56
- customer?: components["schemas"]["CustomerDTO"] | null;
57
- /**
58
- * @description The Payment Gateway of the Payment
59
- * @example stripe
60
- */
61
- gateway: string;
62
- /**
63
- * @description The ISO-4217 Currency Code of the Payment
64
- * @example USD
65
- */
66
- currency: string;
67
- /**
68
- * @description Indicates if the payment was Tax Inclusive
69
- * @example true
70
- */
71
- tax_inclusive: boolean;
72
- /**
73
- * @description The payment amount, represented in cents
74
- * @example 7500
75
- */
76
- amount: number;
77
- /**
78
- * @description The gateway fee amount, represented in cents
79
- * @example 200
80
- */
81
- gateway_fee_amount: number;
82
- /**
83
- * @description The tax amount, represented in cents
84
- * @example 1200
85
- */
86
- tax_amount: number;
87
- /**
88
- * @description The platform fee amount, represented in cents
89
- * @example 375
90
- */
91
- platform_fee_amount: number;
92
- /**
93
- * @description The net amount recieved by the associated store, represented in cents
94
- * @example 5925
95
- */
96
- store_net_amount: number;
97
- /** @description The status of the payment */
98
- status: string;
99
- /** @description The chargeback outcome */
100
- chargeback_status: string;
101
- /**
102
- * Format: date-time
103
- * @description Indicated when a chargeback was opened for the payment
104
- * @example 2024-01-25T14:45:00Z
105
- */
106
- chargeback_at: string;
107
- };
108
- };
109
- };
110
- };
111
- responses: {
112
- /** @description Webhook processed successfully */
113
- 200: {
114
- headers: {
115
- [name: string]: unknown;
116
- };
117
- content?: never;
118
- };
119
- /** @description Bad request */
120
- 400: {
121
- headers: {
122
- [name: string]: unknown;
123
- };
124
- content?: never;
125
- };
126
- /** @description Internal server error */
127
- 500: {
128
- headers: {
129
- [name: string]: unknown;
130
- };
131
- content?: never;
132
- };
133
- };
134
- };
135
- delete?: never;
136
- options?: never;
137
- head?: never;
138
- patch?: never;
139
- trace?: never;
140
- };
141
- ON_CHARGEBACK_CLOSED: {
142
- parameters: {
143
- query?: never;
144
- header?: never;
145
- path?: never;
146
- cookie?: never;
147
- };
148
- get?: never;
149
- put?: never;
150
- /**
151
- * Triggered when a chargeback is resolved
152
- * @description Webhook for ON_CHARGEBACK_CLOSED
153
- */
154
- post: {
155
- parameters: {
156
- query?: never;
157
- header?: never;
158
- path?: never;
159
- cookie?: never;
160
- };
161
- requestBody: {
162
- content: {
163
- "application/json": {
164
- /**
165
- * @description The type of webhook event
166
- * @example ON_CHARGEBACK_CLOSED
167
- */
168
- event_type: components["schemas"]["WebhookEventType"];
169
- /**
170
- * Format: flake-id
171
- * @description The ID of the Webhook Event
172
- * @example 411486491630370816
173
- */
174
- event_id: string;
175
- body: {
176
- /**
177
- * Format: flake-id
178
- * @description The Flake ID of the Payment associated with the Payment
179
- * @example 411486491630370816
180
- */
181
- id: string;
182
- /**
183
- * Format: flake-id
184
- * @description The Flake ID of the Store associated with the Payment
185
- * @example 411486491630370816
186
- */
187
- store_id: string;
188
- /**
189
- * Format: flake-id
190
- * @description The Flake ID of the Order associated with Payment
191
- * @example 411486491630370816
192
- */
193
- order_id: string;
194
- customer?: components["schemas"]["CustomerDTO"] | null;
195
- /**
196
- * @description The Payment Gateway of the Payment
197
- * @example stripe
198
- */
199
- gateway: string;
200
- /**
201
- * @description The ISO-4217 Currency Code of the Payment
202
- * @example USD
203
- */
204
- currency: string;
205
- /**
206
- * @description Indicates if the payment was Tax Inclusive
207
- * @example true
208
- */
209
- tax_inclusive: boolean;
210
- /**
211
- * @description The payment amount, represented in cents
212
- * @example 7500
213
- */
214
- amount: number;
215
- /**
216
- * @description The gateway fee amount, represented in cents
217
- * @example 200
218
- */
219
- gateway_fee_amount: number;
220
- /**
221
- * @description The tax amount, represented in cents
222
- * @example 1200
223
- */
224
- tax_amount: number;
225
- /**
226
- * @description The platform fee amount, represented in cents
227
- * @example 375
228
- */
229
- platform_fee_amount: number;
230
- /**
231
- * @description The net amount recieved by the associated store, represented in cents
232
- * @example 5925
233
- */
234
- store_net_amount: number;
235
- /** @description The status of the payment */
236
- status: string;
237
- /** @description The chargeback outcome */
238
- chargeback_status: string;
239
- /**
240
- * Format: date-time
241
- * @description Indicated when a chargeback was opened for the payment
242
- * @example 2024-01-25T14:45:00Z
243
- */
244
- chargeback_at: string;
245
- };
246
- };
247
- };
248
- };
249
- responses: {
250
- /** @description Webhook processed successfully */
251
- 200: {
252
- headers: {
253
- [name: string]: unknown;
254
- };
255
- content?: never;
256
- };
257
- /** @description Bad request */
258
- 400: {
259
- headers: {
260
- [name: string]: unknown;
261
- };
262
- content?: never;
263
- };
264
- /** @description Internal server error */
265
- 500: {
266
- headers: {
267
- [name: string]: unknown;
268
- };
269
- content?: never;
270
- };
271
- };
272
- };
273
- delete?: never;
274
- options?: never;
275
- head?: never;
276
- patch?: never;
277
- trace?: never;
278
- };
279
- ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT: {
280
- parameters: {
281
- query?: never;
282
- header?: never;
283
- path?: never;
284
- cookie?: never;
285
- };
286
- get?: never;
287
- put?: never;
288
- /**
289
- * Triggered when a Discord account is successfully linked to a checkout.
290
- * @description Webhook for ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
291
- */
292
- post: {
293
- parameters: {
294
- query?: never;
295
- header?: never;
296
- path?: never;
297
- cookie?: never;
298
- };
299
- requestBody: {
300
- content: {
301
- "application/json": {
302
- /**
303
- * @description The type of webhook event
304
- * @example ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
305
- */
306
- event_type: components["schemas"]["WebhookEventType"];
307
- /**
308
- * Format: flake-id
309
- * @description The ID of the Webhook Event
310
- * @example 411486491630370816
311
- */
312
- event_id: string;
313
- body: {
314
- /**
315
- * Format: flake-id
316
- * @description The Flake ID of the Store associated with the Checkout
317
- * @example 411486491630370816
318
- */
319
- store_id: string;
320
- /**
321
- * Format: flake-id
322
- * @description The Flake ID of the Customer associated with the Checkout
323
- * @example 411486491630370816
324
- */
325
- customer_id: string;
326
- customer: components["schemas"]["CustomerDTO"];
327
- /**
328
- * Format: flake-id
329
- * @description The Flake ID of the Checkout
330
- * @example 411486491630370816
331
- */
332
- checkout_id: string;
333
- /**
334
- * Format: flake-id
335
- * @description The Flake ID of the Checkout Line
336
- * @example 411486491630370816
337
- */
338
- checkout_line_id: string;
339
- /**
340
- * Format: flake-id
341
- * @description The Flake ID of the Order associated with the Checkout
342
- * @example 411486491630370816
343
- */
344
- order_id: string;
345
- order: components["schemas"]["OrderDTO"];
346
- /**
347
- * @description The Discord User ID of the linked account
348
- * @example 123456789012345678
349
- */
350
- discord_user_id: string;
351
- /**
352
- * @description The Discord username of the linked account
353
- * @example john_doe
354
- */
355
- discord_user_name: string;
356
- /**
357
- * @description The Discord avatar hash of the linked account
358
- * @example a1b2c3d4e5f6g7h8i9j0
359
- */
360
- discord_user_avatar_hash: string;
361
- /**
362
- * Format: flake-id
363
- * @description The Flake ID of the Product associated with the Checkout
364
- * @example 411486491630370816
365
- */
366
- product_id: string;
367
- /**
368
- * Format: flake-id
369
- * @description The Flake ID of the Product Version associated with the Checkout
370
- * @example 411486491630370816
371
- */
372
- product_version_id: string;
373
- product: components["schemas"]["ProductDTO"];
374
- /**
375
- * Format: date-time
376
- * @description Indicates when the Discord account link was enqueued
377
- * @example 2024-01-15T10:30:00Z
378
- */
379
- enqueued_at?: null | string;
380
- };
381
- };
382
- };
383
- };
384
- responses: {
385
- /** @description Webhook processed successfully */
386
- 200: {
387
- headers: {
388
- [name: string]: unknown;
389
- };
390
- content?: never;
391
- };
392
- /** @description Bad request */
393
- 400: {
394
- headers: {
395
- [name: string]: unknown;
396
- };
397
- content?: never;
398
- };
399
- /** @description Internal server error */
400
- 500: {
401
- headers: {
402
- [name: string]: unknown;
403
- };
404
- content?: never;
405
- };
406
- };
407
- };
408
- delete?: never;
409
- options?: never;
410
- head?: never;
411
- patch?: never;
412
- trace?: never;
413
- };
414
- ON_DELIVERY_ITEM_ADDED: {
415
- parameters: {
416
- query?: never;
417
- header?: never;
418
- path?: never;
419
- cookie?: never;
420
- };
421
- get?: never;
422
- put?: never;
423
- /**
424
- * Triggered when a delivery item is added to the customers inventory
425
- * @description Webhook for ON_DELIVERY_ITEM_ADDED
426
- */
427
- post: {
428
- parameters: {
429
- query?: never;
430
- header?: never;
431
- path?: never;
432
- cookie?: never;
433
- };
434
- requestBody: {
435
- content: {
436
- "application/json": {
437
- /**
438
- * @description The type of webhook event
439
- * @example ON_DELIVERY_ITEM_ADDED
440
- */
441
- event_type: components["schemas"]["WebhookEventType"];
442
- /**
443
- * Format: flake-id
444
- * @description The ID of the Webhook Event
445
- * @example 411486491630370816
446
- */
447
- event_id: string;
448
- body: {
449
- /**
450
- * Format: flake-id
451
- * @description The Flake ID of the Delivery Item
452
- * @example 411486491630370816
453
- */
454
- id: string;
455
- /**
456
- * Format: flake-id
457
- * @description The Flake ID of the Store associated with the Delivery Item
458
- * @example 411486491630370816
459
- */
460
- store_id: string;
461
- customer?: components["schemas"]["CustomerDTO"] | null;
462
- /**
463
- * Format: flake-id
464
- * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
465
- * @example 411486491630370816
466
- */
467
- order_customer_id?: null | string;
468
- /**
469
- * Format: flake-id
470
- * @description The Flake ID of the Checkout associated with the Delivery Item
471
- * @example 411486491630370816
472
- */
473
- checkout_id?: null | string;
474
- /**
475
- * Format: flake-id
476
- * @description The Flake ID of the Order ID associated with the Delivery Item
477
- * @example 411486491630370816
478
- */
479
- order_id?: null | string;
480
- /**
481
- * Format: flake-id
482
- * @description The Flake Id of the Order Line ID associated with the Delivery Item
483
- * @example 411486491630370816
484
- */
485
- order_line_id?: null | string;
486
- /**
487
- * Format: flake-id
488
- * @description The Flake ID of the Subscription associated with the Delivery Item
489
- * @example 411486491630370816
490
- */
491
- subscription_id?: null | string;
492
- /**
493
- * Format: flake-id
494
- * @description The Flake ID of the Game Server the Delivery Item is associated with
495
- * @example 411486491630370816
496
- */
497
- execute_on_gameserver_id?: null | string;
498
- execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
499
- /**
500
- * Format: flake-id
501
- * @description The associated Product ID of the Delivery Item
502
- * @example 411486491630370816
503
- */
504
- product_id: string;
505
- /**
506
- * Format: flake-id
507
- * @description The associated Product Version ID of the Delivery Item
508
- * @example 411486491630370816
509
- */
510
- product_version_id: string;
511
- product: components["schemas"]["ProductDTO"];
512
- /**
513
- * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
514
- * @example usable
515
- */
516
- state: string;
517
- /**
518
- * Format: date-time
519
- * @description Indicates when the Delivery Item was added to the customers inventory
520
- * @example 2024-01-10T08:00:00Z
521
- */
522
- added_at: string;
523
- /**
524
- * Format: date-time
525
- * @description Indicates when the Delivery Item become active
526
- * @example 2024-01-10T09:00:00Z
527
- */
528
- active_at?: null | string;
529
- /**
530
- * Format: date-time
531
- * @description Indicates when the Delivery Item expires
532
- * @example 2024-12-31T23:59:59Z
533
- */
534
- expires_at?: null | string;
535
- /**
536
- * Format: date-time
537
- * @description Indicates when the Delivery Item was removed from the customers inventory
538
- * @example 2024-02-01T10:00:00Z
539
- */
540
- removed_at?: null | string;
541
- /**
542
- * Format: date-time
543
- * @description Indicates when the Delivery Item was revoked from the customers inventory
544
- * @example 2024-02-05T14:30:00Z
545
- */
546
- revoked_at?: null | string;
547
- /** @description Indicates the reason the delivery item was revoked from the customers inventory */
548
- revoke_reason?: null | string;
549
- };
550
- };
551
- };
552
- };
553
- responses: {
554
- /** @description Webhook processed successfully */
555
- 200: {
556
- headers: {
557
- [name: string]: unknown;
558
- };
559
- content?: never;
560
- };
561
- /** @description Bad request */
562
- 400: {
563
- headers: {
564
- [name: string]: unknown;
565
- };
566
- content?: never;
567
- };
568
- /** @description Internal server error */
569
- 500: {
570
- headers: {
571
- [name: string]: unknown;
572
- };
573
- content?: never;
574
- };
575
- };
576
- };
577
- delete?: never;
578
- options?: never;
579
- head?: never;
580
- patch?: never;
581
- trace?: never;
582
- };
583
- ON_DELIVERY_ITEM_ACTIVATED: {
584
- parameters: {
585
- query?: never;
586
- header?: never;
587
- path?: never;
588
- cookie?: never;
589
- };
590
- get?: never;
591
- put?: never;
592
- /**
593
- * Triggered when a delivery item in the customers inventory activates
594
- * @description Webhook for ON_DELIVERY_ITEM_ACTIVATED
595
- */
596
- post: {
597
- parameters: {
598
- query?: never;
599
- header?: never;
600
- path?: never;
601
- cookie?: never;
602
- };
603
- requestBody: {
604
- content: {
605
- "application/json": {
606
- /**
607
- * @description The type of webhook event
608
- * @example ON_DELIVERY_ITEM_ACTIVATED
609
- */
610
- event_type: components["schemas"]["WebhookEventType"];
611
- /**
612
- * Format: flake-id
613
- * @description The ID of the Webhook Event
614
- * @example 411486491630370816
615
- */
616
- event_id: string;
617
- body: {
618
- /**
619
- * Format: flake-id
620
- * @description The Flake ID of the Delivery Item
621
- * @example 411486491630370816
622
- */
623
- id: string;
624
- /**
625
- * Format: flake-id
626
- * @description The Flake ID of the Store associated with the Delivery Item
627
- * @example 411486491630370816
628
- */
629
- store_id: string;
630
- customer?: components["schemas"]["CustomerDTO"] | null;
631
- /**
632
- * Format: flake-id
633
- * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
634
- * @example 411486491630370816
635
- */
636
- order_customer_id?: null | string;
637
- /**
638
- * Format: flake-id
639
- * @description The Flake ID of the Checkout associated with the Delivery Item
640
- * @example 411486491630370816
641
- */
642
- checkout_id?: null | string;
643
- /**
644
- * Format: flake-id
645
- * @description The Flake ID of the Order ID associated with the Delivery Item
646
- * @example 411486491630370816
647
- */
648
- order_id?: null | string;
649
- /**
650
- * Format: flake-id
651
- * @description The Flake Id of the Order Line ID associated with the Delivery Item
652
- * @example 411486491630370816
653
- */
654
- order_line_id?: null | string;
655
- /**
656
- * Format: flake-id
657
- * @description The Flake ID of the Subscription associated with the Delivery Item
658
- * @example 411486491630370816
659
- */
660
- subscription_id?: null | string;
661
- /**
662
- * Format: flake-id
663
- * @description The Flake ID of the Game Server the Delivery Item is associated with
664
- * @example 411486491630370816
665
- */
666
- execute_on_gameserver_id?: null | string;
667
- execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
668
- /**
669
- * Format: flake-id
670
- * @description The associated Product ID of the Delivery Item
671
- * @example 411486491630370816
672
- */
673
- product_id: string;
674
- /**
675
- * Format: flake-id
676
- * @description The associated Product Version ID of the Delivery Item
677
- * @example 411486491630370816
678
- */
679
- product_version_id: string;
680
- product: components["schemas"]["ProductDTO"];
681
- /**
682
- * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
683
- * @example usable
684
- */
685
- state: string;
686
- /**
687
- * Format: date-time
688
- * @description Indicates when the Delivery Item was added to the customers inventory
689
- * @example 2024-01-10T08:00:00Z
690
- */
691
- added_at: string;
692
- /**
693
- * Format: date-time
694
- * @description Indicates when the Delivery Item become active
695
- * @example 2024-01-10T09:00:00Z
696
- */
697
- active_at?: null | string;
698
- /**
699
- * Format: date-time
700
- * @description Indicates when the Delivery Item expires
701
- * @example 2024-12-31T23:59:59Z
702
- */
703
- expires_at?: null | string;
704
- /**
705
- * Format: date-time
706
- * @description Indicates when the Delivery Item was removed from the customers inventory
707
- * @example 2024-02-01T10:00:00Z
708
- */
709
- removed_at?: null | string;
710
- /**
711
- * Format: date-time
712
- * @description Indicates when the Delivery Item was revoked from the customers inventory
713
- * @example 2024-02-05T14:30:00Z
714
- */
715
- revoked_at?: null | string;
716
- /** @description Indicates the reason the delivery item was revoked from the customers inventory */
717
- revoke_reason?: null | string;
718
- };
719
- };
720
- };
721
- };
722
- responses: {
723
- /** @description Webhook processed successfully */
724
- 200: {
725
- headers: {
726
- [name: string]: unknown;
727
- };
728
- content?: never;
729
- };
730
- /** @description Bad request */
731
- 400: {
732
- headers: {
733
- [name: string]: unknown;
734
- };
735
- content?: never;
736
- };
737
- /** @description Internal server error */
738
- 500: {
739
- headers: {
740
- [name: string]: unknown;
741
- };
742
- content?: never;
743
- };
744
- };
745
- };
746
- delete?: never;
747
- options?: never;
748
- head?: never;
749
- patch?: never;
750
- trace?: never;
751
- };
752
- ON_DELIVERY_ITEM_USED: {
753
- parameters: {
754
- query?: never;
755
- header?: never;
756
- path?: never;
757
- cookie?: never;
758
- };
759
- get?: never;
760
- put?: never;
761
- /**
762
- * Triggered when a delivery item in the customers inventory becomes used
763
- * @deprecated
764
- * @description Webhook for ON_DELIVERY_ITEM_USED
765
- */
766
- post: {
767
- parameters: {
768
- query?: never;
769
- header?: never;
770
- path?: never;
771
- cookie?: never;
772
- };
773
- requestBody: {
774
- content: {
775
- "application/json": {
776
- /**
777
- * @description The type of webhook event
778
- * @example ON_DELIVERY_ITEM_USED
779
- */
780
- event_type: components["schemas"]["WebhookEventType"];
781
- /**
782
- * Format: flake-id
783
- * @description The ID of the Webhook Event
784
- * @example 411486491630370816
785
- */
786
- event_id: string;
787
- body: {
788
- /**
789
- * Format: flake-id
790
- * @description The Flake ID of the Delivery Item
791
- * @example 411486491630370816
792
- */
793
- id: string;
794
- /**
795
- * Format: flake-id
796
- * @description The Flake ID of the Store associated with the Delivery Item
797
- * @example 411486491630370816
798
- */
799
- store_id: string;
800
- customer?: components["schemas"]["CustomerDTO"] | null;
801
- /**
802
- * Format: flake-id
803
- * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
804
- * @example 411486491630370816
805
- */
806
- order_customer_id?: null | string;
807
- /**
808
- * Format: flake-id
809
- * @description The Flake ID of the Checkout associated with the Delivery Item
810
- * @example 411486491630370816
811
- */
812
- checkout_id?: null | string;
813
- /**
814
- * Format: flake-id
815
- * @description The Flake ID of the Order ID associated with the Delivery Item
816
- * @example 411486491630370816
817
- */
818
- order_id?: null | string;
819
- /**
820
- * Format: flake-id
821
- * @description The Flake Id of the Order Line ID associated with the Delivery Item
822
- * @example 411486491630370816
823
- */
824
- order_line_id?: null | string;
825
- /**
826
- * Format: flake-id
827
- * @description The Flake ID of the Subscription associated with the Delivery Item
828
- * @example 411486491630370816
829
- */
830
- subscription_id?: null | string;
831
- /**
832
- * Format: flake-id
833
- * @description The Flake ID of the Game Server the Delivery Item is associated with
834
- * @example 411486491630370816
835
- */
836
- execute_on_gameserver_id?: null | string;
837
- execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
838
- /**
839
- * Format: flake-id
840
- * @description The associated Product ID of the Delivery Item
841
- * @example 411486491630370816
842
- */
843
- product_id: string;
844
- /**
845
- * Format: flake-id
846
- * @description The associated Product Version ID of the Delivery Item
847
- * @example 411486491630370816
848
- */
849
- product_version_id: string;
850
- product: components["schemas"]["ProductDTO"];
851
- /**
852
- * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
853
- * @example usable
854
- */
855
- state: string;
856
- /**
857
- * Format: date-time
858
- * @description Indicates when the Delivery Item was added to the customers inventory
859
- * @example 2024-01-10T08:00:00Z
860
- */
861
- added_at: string;
862
- /**
863
- * Format: date-time
864
- * @description Indicates when the Delivery Item become active
865
- * @example 2024-01-10T09:00:00Z
866
- */
867
- active_at?: null | string;
868
- /**
869
- * Format: date-time
870
- * @description Indicates when the Delivery Item expires
871
- * @example 2024-12-31T23:59:59Z
872
- */
873
- expires_at?: null | string;
874
- /**
875
- * Format: date-time
876
- * @description Indicates when the Delivery Item was removed from the customers inventory
877
- * @example 2024-02-01T10:00:00Z
878
- */
879
- removed_at?: null | string;
880
- /**
881
- * Format: date-time
882
- * @description Indicates when the Delivery Item was revoked from the customers inventory
883
- * @example 2024-02-05T14:30:00Z
884
- */
885
- revoked_at?: null | string;
886
- /** @description Indicates the reason the delivery item was revoked from the customers inventory */
887
- revoke_reason?: null | string;
888
- };
889
- };
890
- };
891
- };
892
- responses: {
893
- /** @description Webhook processed successfully */
894
- 200: {
895
- headers: {
896
- [name: string]: unknown;
897
- };
898
- content?: never;
899
- };
900
- /** @description Bad request */
901
- 400: {
902
- headers: {
903
- [name: string]: unknown;
904
- };
905
- content?: never;
906
- };
907
- /** @description Internal server error */
908
- 500: {
909
- headers: {
910
- [name: string]: unknown;
911
- };
912
- content?: never;
913
- };
914
- };
915
- };
916
- delete?: never;
917
- options?: never;
918
- head?: never;
919
- patch?: never;
920
- trace?: never;
921
- };
922
- ON_DELIVERY_ITEM_RENEWED: {
923
- parameters: {
924
- query?: never;
925
- header?: never;
926
- path?: never;
927
- cookie?: never;
928
- };
929
- get?: never;
930
- put?: never;
931
- /**
932
- * Triggered when a delivery item in the customers inventory is renewed
933
- * @description Webhook for ON_DELIVERY_ITEM_RENEWED
934
- */
935
- post: {
936
- parameters: {
937
- query?: never;
938
- header?: never;
939
- path?: never;
940
- cookie?: never;
941
- };
942
- requestBody: {
943
- content: {
944
- "application/json": {
945
- /**
946
- * @description The type of webhook event
947
- * @example ON_DELIVERY_ITEM_RENEWED
948
- */
949
- event_type: components["schemas"]["WebhookEventType"];
950
- /**
951
- * Format: flake-id
952
- * @description The ID of the Webhook Event
953
- * @example 411486491630370816
954
- */
955
- event_id: string;
956
- body: {
957
- /**
958
- * Format: flake-id
959
- * @description The Flake ID of the Delivery Item
960
- * @example 411486491630370816
961
- */
962
- id: string;
963
- /**
964
- * Format: flake-id
965
- * @description The Flake ID of the Store associated with the Delivery Item
966
- * @example 411486491630370816
967
- */
968
- store_id: string;
969
- customer?: components["schemas"]["CustomerDTO"] | null;
970
- /**
971
- * Format: flake-id
972
- * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
973
- * @example 411486491630370816
974
- */
975
- order_customer_id?: null | string;
976
- /**
977
- * Format: flake-id
978
- * @description The Flake ID of the Checkout associated with the Delivery Item
979
- * @example 411486491630370816
980
- */
981
- checkout_id?: null | string;
982
- /**
983
- * Format: flake-id
984
- * @description The Flake ID of the Order ID associated with the Delivery Item
985
- * @example 411486491630370816
986
- */
987
- order_id?: null | string;
988
- /**
989
- * Format: flake-id
990
- * @description The Flake Id of the Order Line ID associated with the Delivery Item
991
- * @example 411486491630370816
992
- */
993
- order_line_id?: null | string;
994
- /**
995
- * Format: flake-id
996
- * @description The Flake ID of the Subscription associated with the Delivery Item
997
- * @example 411486491630370816
998
- */
999
- subscription_id?: null | string;
1000
- /**
1001
- * Format: flake-id
1002
- * @description The Flake ID of the Game Server the Delivery Item is associated with
1003
- * @example 411486491630370816
1004
- */
1005
- execute_on_gameserver_id?: null | string;
1006
- execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
1007
- /**
1008
- * Format: flake-id
1009
- * @description The associated Product ID of the Delivery Item
1010
- * @example 411486491630370816
1011
- */
1012
- product_id: string;
1013
- /**
1014
- * Format: flake-id
1015
- * @description The associated Product Version ID of the Delivery Item
1016
- * @example 411486491630370816
1017
- */
1018
- product_version_id: string;
1019
- product: components["schemas"]["ProductDTO"];
1020
- /**
1021
- * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
1022
- * @example usable
1023
- */
1024
- state: string;
1025
- /**
1026
- * Format: date-time
1027
- * @description Indicates when the Delivery Item was added to the customers inventory
1028
- * @example 2024-01-10T08:00:00Z
1029
- */
1030
- added_at: string;
1031
- /**
1032
- * Format: date-time
1033
- * @description Indicates when the Delivery Item become active
1034
- * @example 2024-01-10T09:00:00Z
1035
- */
1036
- active_at?: null | string;
1037
- /**
1038
- * Format: date-time
1039
- * @description Indicates when the Delivery Item expires
1040
- * @example 2024-12-31T23:59:59Z
1041
- */
1042
- expires_at?: null | string;
1043
- /**
1044
- * Format: date-time
1045
- * @description Indicates when the Delivery Item was removed from the customers inventory
1046
- * @example 2024-02-01T10:00:00Z
1047
- */
1048
- removed_at?: null | string;
1049
- /**
1050
- * Format: date-time
1051
- * @description Indicates when the Delivery Item was revoked from the customers inventory
1052
- * @example 2024-02-05T14:30:00Z
1053
- */
1054
- revoked_at?: null | string;
1055
- /** @description Indicates the reason the delivery item was revoked from the customers inventory */
1056
- revoke_reason?: null | string;
1057
- };
1058
- };
1059
- };
1060
- };
1061
- responses: {
1062
- /** @description Webhook processed successfully */
1063
- 200: {
1064
- headers: {
1065
- [name: string]: unknown;
1066
- };
1067
- content?: never;
1068
- };
1069
- /** @description Bad request */
1070
- 400: {
1071
- headers: {
1072
- [name: string]: unknown;
1073
- };
1074
- content?: never;
1075
- };
1076
- /** @description Internal server error */
1077
- 500: {
1078
- headers: {
1079
- [name: string]: unknown;
1080
- };
1081
- content?: never;
1082
- };
1083
- };
1084
- };
1085
- delete?: never;
1086
- options?: never;
1087
- head?: never;
1088
- patch?: never;
1089
- trace?: never;
1090
- };
1091
- ON_DELIVERY_ITEM_EXPIRED: {
1092
- parameters: {
1093
- query?: never;
1094
- header?: never;
1095
- path?: never;
1096
- cookie?: never;
1097
- };
1098
- get?: never;
1099
- put?: never;
1100
- /**
1101
- * Triggered when a delivery item in the customers inventory expires
1102
- * @description Webhook for ON_DELIVERY_ITEM_EXPIRED
1103
- */
1104
- post: {
1105
- parameters: {
1106
- query?: never;
1107
- header?: never;
1108
- path?: never;
1109
- cookie?: never;
1110
- };
1111
- requestBody: {
1112
- content: {
1113
- "application/json": {
1114
- /**
1115
- * @description The type of webhook event
1116
- * @example ON_DELIVERY_ITEM_EXPIRED
1117
- */
1118
- event_type: components["schemas"]["WebhookEventType"];
1119
- /**
1120
- * Format: flake-id
1121
- * @description The ID of the Webhook Event
1122
- * @example 411486491630370816
1123
- */
1124
- event_id: string;
1125
- body: {
1126
- /**
1127
- * Format: flake-id
1128
- * @description The Flake ID of the Delivery Item
1129
- * @example 411486491630370816
1130
- */
1131
- id: string;
1132
- /**
1133
- * Format: flake-id
1134
- * @description The Flake ID of the Store associated with the Delivery Item
1135
- * @example 411486491630370816
1136
- */
1137
- store_id: string;
1138
- customer?: components["schemas"]["CustomerDTO"] | null;
1139
- /**
1140
- * Format: flake-id
1141
- * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
1142
- * @example 411486491630370816
1143
- */
1144
- order_customer_id?: null | string;
1145
- /**
1146
- * Format: flake-id
1147
- * @description The Flake ID of the Checkout associated with the Delivery Item
1148
- * @example 411486491630370816
1149
- */
1150
- checkout_id?: null | string;
1151
- /**
1152
- * Format: flake-id
1153
- * @description The Flake ID of the Order ID associated with the Delivery Item
1154
- * @example 411486491630370816
1155
- */
1156
- order_id?: null | string;
1157
- /**
1158
- * Format: flake-id
1159
- * @description The Flake Id of the Order Line ID associated with the Delivery Item
1160
- * @example 411486491630370816
1161
- */
1162
- order_line_id?: null | string;
1163
- /**
1164
- * Format: flake-id
1165
- * @description The Flake ID of the Subscription associated with the Delivery Item
1166
- * @example 411486491630370816
1167
- */
1168
- subscription_id?: null | string;
1169
- /**
1170
- * Format: flake-id
1171
- * @description The Flake ID of the Game Server the Delivery Item is associated with
1172
- * @example 411486491630370816
1173
- */
1174
- execute_on_gameserver_id?: null | string;
1175
- execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
1176
- /**
1177
- * Format: flake-id
1178
- * @description The associated Product ID of the Delivery Item
1179
- * @example 411486491630370816
1180
- */
1181
- product_id: string;
1182
- /**
1183
- * Format: flake-id
1184
- * @description The associated Product Version ID of the Delivery Item
1185
- * @example 411486491630370816
1186
- */
1187
- product_version_id: string;
1188
- product: components["schemas"]["ProductDTO"];
1189
- /**
1190
- * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
1191
- * @example usable
1192
- */
1193
- state: string;
1194
- /**
1195
- * Format: date-time
1196
- * @description Indicates when the Delivery Item was added to the customers inventory
1197
- * @example 2024-01-10T08:00:00Z
1198
- */
1199
- added_at: string;
1200
- /**
1201
- * Format: date-time
1202
- * @description Indicates when the Delivery Item become active
1203
- * @example 2024-01-10T09:00:00Z
1204
- */
1205
- active_at?: null | string;
1206
- /**
1207
- * Format: date-time
1208
- * @description Indicates when the Delivery Item expires
1209
- * @example 2024-12-31T23:59:59Z
1210
- */
1211
- expires_at?: null | string;
1212
- /**
1213
- * Format: date-time
1214
- * @description Indicates when the Delivery Item was removed from the customers inventory
1215
- * @example 2024-02-01T10:00:00Z
1216
- */
1217
- removed_at?: null | string;
1218
- /**
1219
- * Format: date-time
1220
- * @description Indicates when the Delivery Item was revoked from the customers inventory
1221
- * @example 2024-02-05T14:30:00Z
1222
- */
1223
- revoked_at?: null | string;
1224
- /** @description Indicates the reason the delivery item was revoked from the customers inventory */
1225
- revoke_reason?: null | string;
1226
- };
1227
- };
1228
- };
1229
- };
1230
- responses: {
1231
- /** @description Webhook processed successfully */
1232
- 200: {
1233
- headers: {
1234
- [name: string]: unknown;
1235
- };
1236
- content?: never;
1237
- };
1238
- /** @description Bad request */
1239
- 400: {
1240
- headers: {
1241
- [name: string]: unknown;
1242
- };
1243
- content?: never;
1244
- };
1245
- /** @description Internal server error */
1246
- 500: {
1247
- headers: {
1248
- [name: string]: unknown;
1249
- };
1250
- content?: never;
1251
- };
1252
- };
1253
- };
1254
- delete?: never;
1255
- options?: never;
1256
- head?: never;
1257
- patch?: never;
1258
- trace?: never;
1259
- };
1260
- ON_DELIVERY_ITEM_REVOKED: {
1261
- parameters: {
1262
- query?: never;
1263
- header?: never;
1264
- path?: never;
1265
- cookie?: never;
1266
- };
1267
- get?: never;
1268
- put?: never;
1269
- /**
1270
- * Triggered when a delivery item is revoked from the customers inventory
1271
- * @description Webhook for ON_DELIVERY_ITEM_REVOKED
1272
- */
1273
- post: {
1274
- parameters: {
1275
- query?: never;
1276
- header?: never;
1277
- path?: never;
1278
- cookie?: never;
1279
- };
1280
- requestBody: {
1281
- content: {
1282
- "application/json": {
1283
- /**
1284
- * @description The type of webhook event
1285
- * @example ON_DELIVERY_ITEM_REVOKED
1286
- */
1287
- event_type: components["schemas"]["WebhookEventType"];
1288
- /**
1289
- * Format: flake-id
1290
- * @description The ID of the Webhook Event
1291
- * @example 411486491630370816
1292
- */
1293
- event_id: string;
1294
- body: {
1295
- /**
1296
- * Format: flake-id
1297
- * @description The Flake ID of the Delivery Item
1298
- * @example 411486491630370816
1299
- */
1300
- id: string;
1301
- /**
1302
- * Format: flake-id
1303
- * @description The Flake ID of the Store associated with the Delivery Item
1304
- * @example 411486491630370816
1305
- */
1306
- store_id: string;
1307
- customer?: components["schemas"]["CustomerDTO"] | null;
1308
- /**
1309
- * Format: flake-id
1310
- * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
1311
- * @example 411486491630370816
1312
- */
1313
- order_customer_id?: null | string;
1314
- /**
1315
- * Format: flake-id
1316
- * @description The Flake ID of the Checkout associated with the Delivery Item
1317
- * @example 411486491630370816
1318
- */
1319
- checkout_id?: null | string;
1320
- /**
1321
- * Format: flake-id
1322
- * @description The Flake ID of the Order ID associated with the Delivery Item
1323
- * @example 411486491630370816
1324
- */
1325
- order_id?: null | string;
1326
- /**
1327
- * Format: flake-id
1328
- * @description The Flake Id of the Order Line ID associated with the Delivery Item
1329
- * @example 411486491630370816
1330
- */
1331
- order_line_id?: null | string;
1332
- /**
1333
- * Format: flake-id
1334
- * @description The Flake ID of the Subscription associated with the Delivery Item
1335
- * @example 411486491630370816
1336
- */
1337
- subscription_id?: null | string;
1338
- /**
1339
- * Format: flake-id
1340
- * @description The Flake ID of the Game Server the Delivery Item is associated with
1341
- * @example 411486491630370816
1342
- */
1343
- execute_on_gameserver_id?: null | string;
1344
- execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
1345
- /**
1346
- * Format: flake-id
1347
- * @description The associated Product ID of the Delivery Item
1348
- * @example 411486491630370816
1349
- */
1350
- product_id: string;
1351
- /**
1352
- * Format: flake-id
1353
- * @description The associated Product Version ID of the Delivery Item
1354
- * @example 411486491630370816
1355
- */
1356
- product_version_id: string;
1357
- product: components["schemas"]["ProductDTO"];
1358
- /**
1359
- * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
1360
- * @example usable
1361
- */
1362
- state: string;
1363
- /**
1364
- * Format: date-time
1365
- * @description Indicates when the Delivery Item was added to the customers inventory
1366
- * @example 2024-01-10T08:00:00Z
1367
- */
1368
- added_at: string;
1369
- /**
1370
- * Format: date-time
1371
- * @description Indicates when the Delivery Item become active
1372
- * @example 2024-01-10T09:00:00Z
1373
- */
1374
- active_at?: null | string;
1375
- /**
1376
- * Format: date-time
1377
- * @description Indicates when the Delivery Item expires
1378
- * @example 2024-12-31T23:59:59Z
1379
- */
1380
- expires_at?: null | string;
1381
- /**
1382
- * Format: date-time
1383
- * @description Indicates when the Delivery Item was removed from the customers inventory
1384
- * @example 2024-02-01T10:00:00Z
1385
- */
1386
- removed_at?: null | string;
1387
- /**
1388
- * Format: date-time
1389
- * @description Indicates when the Delivery Item was revoked from the customers inventory
1390
- * @example 2024-02-05T14:30:00Z
1391
- */
1392
- revoked_at?: null | string;
1393
- /** @description Indicates the reason the delivery item was revoked from the customers inventory */
1394
- revoke_reason?: null | string;
1395
- };
1396
- };
1397
- };
1398
- };
1399
- responses: {
1400
- /** @description Webhook processed successfully */
1401
- 200: {
1402
- headers: {
1403
- [name: string]: unknown;
1404
- };
1405
- content?: never;
1406
- };
1407
- /** @description Bad request */
1408
- 400: {
1409
- headers: {
1410
- [name: string]: unknown;
1411
- };
1412
- content?: never;
1413
- };
1414
- /** @description Internal server error */
1415
- 500: {
1416
- headers: {
1417
- [name: string]: unknown;
1418
- };
1419
- content?: never;
1420
- };
1421
- };
1422
- };
1423
- delete?: never;
1424
- options?: never;
1425
- head?: never;
1426
- patch?: never;
1427
- trace?: never;
1428
- };
1429
- ON_ORDER_COMPLETED: {
1430
- parameters: {
1431
- query?: never;
1432
- header?: never;
1433
- path?: never;
1434
- cookie?: never;
1435
- };
1436
- get?: never;
1437
- put?: never;
1438
- /**
1439
- * Triggered when an order is completed
1440
- * @description Webhook for ON_ORDER_COMPLETED
1441
- */
1442
- post: {
1443
- parameters: {
1444
- query?: never;
1445
- header?: never;
1446
- path?: never;
1447
- cookie?: never;
1448
- };
1449
- requestBody: {
1450
- content: {
1451
- "application/json": {
1452
- /**
1453
- * @description The type of webhook event
1454
- * @example ON_ORDER_COMPLETED
1455
- */
1456
- event_type: components["schemas"]["WebhookEventType"];
1457
- /**
1458
- * Format: flake-id
1459
- * @description The ID of the Webhook Event
1460
- * @example 411486491630370816
1461
- */
1462
- event_id: string;
1463
- body: {
1464
- /**
1465
- * Format: flake-id
1466
- * @description The Flake ID of the Order
1467
- * @example 411486491630370816
1468
- */
1469
- id: string;
1470
- /**
1471
- * Format: flake-id
1472
- * @description The Flake ID of the store associated with the order
1473
- * @example 411486491630370816
1474
- */
1475
- store_id: string;
1476
- customer: components["schemas"]["CustomerDTO"];
1477
- /**
1478
- * Format: flake-id
1479
- * @description The Flake ID of the Checkout associated with the order
1480
- * @example 411486491630370816
1481
- */
1482
- checkout_id: string;
1483
- checkout: components["schemas"]["CheckoutDTO"];
1484
- /**
1485
- * Format: flake-id
1486
- * @description The Flake ID of the Subscription associated with the order
1487
- * @example 411486491630370816
1488
- */
1489
- subscription_id?: null | string;
1490
- /** @description Applied coupons to this order */
1491
- applied_coupons: components["schemas"]["OrderCouponUsageDTO"][];
1492
- /** @description Applied gift cards to this order */
1493
- applied_giftcards: components["schemas"]["OrderGiftCardUsageDTO"][];
1494
- /**
1495
- * Format: flake-id
1496
- * @description The Flake ID of the Coupon associated with the order
1497
- * @example 411486491630370816
1498
- */
1499
- coupon_id: string;
1500
- /**
1501
- * @description The type of the order
1502
- * @example one_time
1503
- */
1504
- type: string;
1505
- /**
1506
- * @description The ISO-4217 Currency Code of the order
1507
- * @example USD
1508
- */
1509
- currency: string;
1510
- /**
1511
- * @description Indicates if the order value was inclusive of tax
1512
- * @example true
1513
- */
1514
- tax_inclusive: boolean;
1515
- /**
1516
- * @description The tax amount, represented as cents
1517
- * @example 1500
1518
- */
1519
- tax_amount: number;
1520
- /**
1521
- * @description The discount amount, represented as cents
1522
- * @example 500
1523
- */
1524
- discount_amount: number;
1525
- /**
1526
- * @description The subtotal amount, represented as cents
1527
- * @example 10000
1528
- */
1529
- subtotal_amount: number;
1530
- /**
1531
- * @description The total amount, represented as cents
1532
- * @example 11000
1533
- */
1534
- total_amount: number;
1535
- /**
1536
- * Format: date-time
1537
- * @description Indicates when the order was created
1538
- * @example 2024-01-15T10:30:00Z
1539
- */
1540
- created_at: string;
1541
- /**
1542
- * Format: date-time
1543
- * @description Indicates when the order was completed
1544
- * @example 2024-01-15T10:35:00Z
1545
- */
1546
- completed_at: string;
1547
- /**
1548
- * @description The billing name of the customer associated with the order
1549
- * @example John Doe
1550
- */
1551
- billing_name: string;
1552
- /**
1553
- * @description The billing email address of the customer associated with the order
1554
- * @example john@doe.com
1555
- */
1556
- billing_email: string;
1557
- /**
1558
- * @description The ISO-3316 Country Code of the customer associated with the order
1559
- * @example US
1560
- */
1561
- billing_address_country: string;
1562
- /**
1563
- * @description The IPv4 or IPv6 Address of the associated customer when creating the order
1564
- * @example 127.0.0.1/24
1565
- */
1566
- customer_ip: string;
1567
- /**
1568
- * @description The total amount of giftcard usage associated with the order, represented in cents
1569
- * @example 0
1570
- */
1571
- giftcard_usage_amount: number;
1572
- /** @description The order lines associated with the order */
1573
- lines: components["schemas"]["OrderLineDTO"][];
1574
- /**
1575
- * @description A comma-seperated string of the names of the product associated with the order
1576
- * @example Product A, Product B
1577
- */
1578
- product_names: string;
1579
- /**
1580
- * @description A comma-seperated string of the tags of the products associated with the order
1581
- * @example ranks, perks
1582
- */
1583
- product_tags: string;
1584
- /**
1585
- * @description A comma-seperated string of the gameservers of the product associated with the order
1586
- * @example game server one, game server two
1587
- */
1588
- product_gameservers: string;
1589
- /**
1590
- * @description The status of the Order. Possbile options: created, completed, canceled
1591
- * @example created
1592
- */
1593
- status: string;
1594
- };
1595
- };
1596
- };
1597
- };
1598
- responses: {
1599
- /** @description Webhook processed successfully */
1600
- 200: {
1601
- headers: {
1602
- [name: string]: unknown;
1603
- };
1604
- content?: never;
1605
- };
1606
- /** @description Bad request */
1607
- 400: {
1608
- headers: {
1609
- [name: string]: unknown;
1610
- };
1611
- content?: never;
1612
- };
1613
- /** @description Internal server error */
1614
- 500: {
1615
- headers: {
1616
- [name: string]: unknown;
1617
- };
1618
- content?: never;
1619
- };
1620
- };
1621
- };
1622
- delete?: never;
1623
- options?: never;
1624
- head?: never;
1625
- patch?: never;
1626
- trace?: never;
1627
- };
1628
- ON_REFUND: {
1629
- parameters: {
1630
- query?: never;
1631
- header?: never;
1632
- path?: never;
1633
- cookie?: never;
1634
- };
1635
- get?: never;
1636
- put?: never;
1637
- /**
1638
- * Triggered when a refund is completed
1639
- * @description Webhook for ON_REFUND
1640
- */
1641
- post: {
1642
- parameters: {
1643
- query?: never;
1644
- header?: never;
1645
- path?: never;
1646
- cookie?: never;
1647
- };
1648
- requestBody: {
1649
- content: {
1650
- "application/json": {
1651
- /**
1652
- * @description The type of webhook event
1653
- * @example ON_REFUND
1654
- */
1655
- event_type: components["schemas"]["WebhookEventType"];
1656
- /**
1657
- * Format: flake-id
1658
- * @description The ID of the Webhook Event
1659
- * @example 411486491630370816
1660
- */
1661
- event_id: string;
1662
- body: {
1663
- /**
1664
- * Format: flake-id
1665
- * @description The Flake ID of the Refund
1666
- * @example 411486491630370816
1667
- */
1668
- id: string;
1669
- /**
1670
- * Format: flake-id
1671
- * @description The Flake ID of the store associated with the Refund
1672
- * @example 411486491630370816
1673
- */
1674
- store_id: string;
1675
- /**
1676
- * Format: flake-id
1677
- * @description The Flake ID of Order associated with the refund
1678
- * @example 411486491630370816
1679
- */
1680
- order_id: string;
1681
- customer?: components["schemas"]["CustomerDTO"] | null;
1682
- /**
1683
- * Format: flake-id
1684
- * @description The Flake ID of the Payment associated with the refund
1685
- * @example 411486491630370816
1686
- */
1687
- payment_id: string;
1688
- /** @description The Payment Gateway associated with the refund */
1689
- gateway: string;
1690
- /**
1691
- * @description The ISO-4217 Currency Code of the Payment
1692
- * @example USD
1693
- */
1694
- currency: string;
1695
- /**
1696
- * @description Indicates if taxes were inclusive in the associated payment
1697
- * @example false
1698
- */
1699
- tax_inclusive: boolean;
1700
- /**
1701
- * @description The initial payment amount, represented in cents
1702
- * @example 5000
1703
- */
1704
- amount: number;
1705
- /**
1706
- * @description The initial gateway fee amount, represented in cents
1707
- * @example 150
1708
- */
1709
- gateway_fee_amount: number;
1710
- /**
1711
- * @description The initial tax amount, represented in cents
1712
- * @example 800
1713
- */
1714
- tax_amount: number;
1715
- /**
1716
- * @description The initial platform fee amount, represented in cents
1717
- * @example 250
1718
- */
1719
- platform_fee_amount: number;
1720
- /**
1721
- * @description The initial store net amount, represented in cents
1722
- * @example 3800
1723
- */
1724
- store_net_amount: number;
1725
- /**
1726
- * @description The amount refunded to the store, represented in cents
1727
- * @example 5000
1728
- */
1729
- store_refund_amount: number;
1730
- /**
1731
- * Format: date-time
1732
- * @description Indicates when the refund was created
1733
- * @example 2024-01-20T12:00:00Z
1734
- */
1735
- created_at: string;
1736
- /**
1737
- * Format: date-time
1738
- * @description Indicates when the refund was approved
1739
- * @example 2024-01-20T12:30:00Z
1740
- */
1741
- approved_at: string;
1742
- /**
1743
- * Format: date-time
1744
- * @description Indicates when the refund was pending
1745
- * @example 2024-01-20T12:15:00Z
1746
- */
1747
- pending_at: string;
1748
- /**
1749
- * Format: date-time
1750
- * @description Indicates when the refund was completed
1751
- * @example 2024-01-20T13:00:00Z
1752
- */
1753
- completed_at: string;
1754
- /**
1755
- * @description The email address of the intial payment customer
1756
- * @example john@doe.com
1757
- */
1758
- billing_email: string;
1759
- /**
1760
- * @description The status of the refund. Possible options: created, approved, processing, completed, canceled, failed
1761
- * @example created
1762
- */
1763
- status: string;
1764
- };
1765
- };
1766
- };
1767
- };
1768
- responses: {
1769
- /** @description Webhook processed successfully */
1770
- 200: {
1771
- headers: {
1772
- [name: string]: unknown;
1773
- };
1774
- content?: never;
1775
- };
1776
- /** @description Bad request */
1777
- 400: {
1778
- headers: {
1779
- [name: string]: unknown;
1780
- };
1781
- content?: never;
1782
- };
1783
- /** @description Internal server error */
1784
- 500: {
1785
- headers: {
1786
- [name: string]: unknown;
1787
- };
1788
- content?: never;
1789
- };
1790
- };
1791
- };
1792
- delete?: never;
1793
- options?: never;
1794
- head?: never;
1795
- patch?: never;
1796
- trace?: never;
1797
- };
1798
- ON_SUBSCRIPTION_ACTIVATED: {
1799
- parameters: {
1800
- query?: never;
1801
- header?: never;
1802
- path?: never;
1803
- cookie?: never;
1804
- };
1805
- get?: never;
1806
- put?: never;
1807
- /**
1808
- * Triggered when a subscription is activated
1809
- * @description Webhook for ON_SUBSCRIPTION_ACTIVATED
1810
- */
1811
- post: {
1812
- parameters: {
1813
- query?: never;
1814
- header?: never;
1815
- path?: never;
1816
- cookie?: never;
1817
- };
1818
- requestBody: {
1819
- content: {
1820
- "application/json": {
1821
- /**
1822
- * @description The type of webhook event
1823
- * @example ON_SUBSCRIPTION_ACTIVATED
1824
- */
1825
- event_type: components["schemas"]["WebhookEventType"];
1826
- /**
1827
- * Format: flake-id
1828
- * @description The ID of the Webhook Event
1829
- * @example 411486491630370816
1830
- */
1831
- event_id: string;
1832
- body: {
1833
- /**
1834
- * Format: flake-id
1835
- * @description The Flake ID of the Subscription
1836
- * @example 411486491630370816
1837
- */
1838
- id: string;
1839
- /**
1840
- * Format: flake-id
1841
- * @description The Flake ID of the Store associated with the Subscription
1842
- * @example 411486491630370816
1843
- */
1844
- store_id: string;
1845
- /**
1846
- * Format: flake-id
1847
- * @description The Flake ID of the Customer associated with the Subscription
1848
- * @example 411486491630370816
1849
- */
1850
- customer_id: string;
1851
- customer: components["schemas"]["CustomerDTO"];
1852
- checkout: components["schemas"]["CheckoutDTO"];
1853
- /**
1854
- * @description The current billing cycle number
1855
- * @example 1
1856
- */
1857
- billing_cycle_sequence: number;
1858
- /**
1859
- * @description The billing email address of the customer associated with the Subscription
1860
- * @example john@doe.com
1861
- */
1862
- billing_email: string;
1863
- /**
1864
- * @description The subtotal amount of the Subscription represented in cents
1865
- * @example 9999
1866
- */
1867
- subtotal_amount: number;
1868
- /**
1869
- * @description The tax amount of the Subscription represented in cents
1870
- * @example 1500
1871
- */
1872
- tax_amount: number;
1873
- /**
1874
- * @description The discount amount applied to the Subscription represented in cents
1875
- * @example 1000
1876
- */
1877
- discount_amount: number;
1878
- /**
1879
- * @description The total amount of the Subscription represented in cents
1880
- * @example 10499
1881
- */
1882
- total_amount: number;
1883
- /**
1884
- * @description The currency code of the Subscription
1885
- * @example USD
1886
- */
1887
- currency: string;
1888
- /**
1889
- * @description The interval value of the billing cycle
1890
- * @example 1
1891
- */
1892
- interval_value: number;
1893
- /**
1894
- * @description The interval scale of the billing cycle
1895
- * @example month
1896
- */
1897
- interval_scale: string;
1898
- /**
1899
- * Format: flake-id
1900
- * @description The Flake ID of the Product associated with the Subscription
1901
- * @example 411486491630370816
1902
- */
1903
- product_id: string;
1904
- /**
1905
- * Format: flake-id
1906
- * @description The Flake ID of the Product Version associated with the Subscription
1907
- * @example 411486491630370816
1908
- */
1909
- product_version_id: string;
1910
- /**
1911
- * @description The name of the Product associated with the Subscription
1912
- * @example Example Product
1913
- */
1914
- product_name: string;
1915
- /**
1916
- * @description The image URL of the Product associated with the Subscription
1917
- * @example https://example.com/image.jpg
1918
- */
1919
- product_image_url?: null | string;
1920
- product: components["schemas"]["ProductDTO"];
1921
- /**
1922
- * @description The ISO-3166 Country Code of the customer associated with the Subscription
1923
- * @example US
1924
- */
1925
- billing_country: string;
1926
- /**
1927
- * @description The initial subtotal amount of the Subscription represented in cents
1928
- * @example 9999
1929
- */
1930
- initial_subtotal_amount: number;
1931
- /**
1932
- * @description The initial tax amount of the Subscription represented in cents
1933
- * @example 1500
1934
- */
1935
- initial_tax_amount: number;
1936
- /**
1937
- * @description The initial discount amount applied to the Subscription represented in cents
1938
- * @example 2000
1939
- */
1940
- initial_discount_amount: number;
1941
- /**
1942
- * @description The initial gift card usage amount applied to the Subscription represented in cents
1943
- * @example 0
1944
- */
1945
- initial_giftcard_usage_amount: number;
1946
- /**
1947
- * @description The initial total amount of the Subscription represented in cents
1948
- * @example 9499
1949
- */
1950
- initial_total_amount: number;
1951
- /**
1952
- * @description The IP address of the Customer
1953
- * @example 127.0.0.1/24
1954
- */
1955
- customer_ip: string;
1956
- /**
1957
- * Format: date-time
1958
- * @description The start date of the current billing period
1959
- * @example 2024-02-01T00:00:00Z
1960
- */
1961
- current_period_start?: null | string;
1962
- /**
1963
- * Format: date-time
1964
- * @description The end date of the current billing period
1965
- * @example 2024-03-01T00:00:00Z
1966
- */
1967
- current_period_end?: null | string;
1968
- /**
1969
- * Format: date-time
1970
- * @description The date and time when the Subscription was created
1971
- * @example 2024-02-01T10:15:00Z
1972
- */
1973
- created_at?: null | string;
1974
- /**
1975
- * Format: date-time
1976
- * @description Indicates when the subscription was active
1977
- * @example 2024-02-01T10:20:00Z
1978
- */
1979
- active_at?: null | string;
1980
- /**
1981
- * Format: flake-id
1982
- * @description The Flake ID of the Checkout associated with the Subscription
1983
- * @example 411486491630370816
1984
- */
1985
- checkout_id: string;
1986
- /**
1987
- * Format: flake-id
1988
- * @description The Flake ID of the Checkout Line associated with the Subscription
1989
- * @example 411486491630370816
1990
- */
1991
- checkout_line_id: string;
1992
- /**
1993
- * @description The current status of the Subscription. Possible options: created, active, canceled
1994
- * @example created
1995
- */
1996
- status: string;
1997
- /** @description The lines of the Subscription */
1998
- lines: components["schemas"]["SubscriptionLineDTO"][];
1999
- };
2000
- };
2001
- };
2002
- };
2003
- responses: {
2004
- /** @description Webhook processed successfully */
2005
- 200: {
2006
- headers: {
2007
- [name: string]: unknown;
2008
- };
2009
- content?: never;
2010
- };
2011
- /** @description Bad request */
2012
- 400: {
2013
- headers: {
2014
- [name: string]: unknown;
2015
- };
2016
- content?: never;
2017
- };
2018
- /** @description Internal server error */
2019
- 500: {
2020
- headers: {
2021
- [name: string]: unknown;
2022
- };
2023
- content?: never;
2024
- };
2025
- };
2026
- };
2027
- delete?: never;
2028
- options?: never;
2029
- head?: never;
2030
- patch?: never;
2031
- trace?: never;
2032
- };
2033
- ON_SUBSCRIPTION_CANCELED: {
2034
- parameters: {
2035
- query?: never;
2036
- header?: never;
2037
- path?: never;
2038
- cookie?: never;
2039
- };
2040
- get?: never;
2041
- put?: never;
2042
- /**
2043
- * Triggered when a subscription is canceled
2044
- * @description Webhook for ON_SUBSCRIPTION_CANCELED
2045
- */
2046
- post: {
2047
- parameters: {
2048
- query?: never;
2049
- header?: never;
2050
- path?: never;
2051
- cookie?: never;
2052
- };
2053
- requestBody: {
2054
- content: {
2055
- "application/json": {
2056
- /**
2057
- * @description The type of webhook event
2058
- * @example ON_SUBSCRIPTION_CANCELED
2059
- */
2060
- event_type: components["schemas"]["WebhookEventType"];
2061
- /**
2062
- * Format: flake-id
2063
- * @description The ID of the Webhook Event
2064
- * @example 411486491630370816
2065
- */
2066
- event_id: string;
2067
- body: {
2068
- /**
2069
- * Format: date-time
2070
- * @description Indicates when the subscription was canceled
2071
- * @example 2024-05-15T14:20:00Z
2072
- */
2073
- canceled_at?: null | string;
2074
- /**
2075
- * @description The reason for the subscription cancellation
2076
- * @example customer_request
2077
- */
2078
- cancel_reason?: null | string;
2079
- /**
2080
- * Format: flake-id
2081
- * @description The Flake ID of the Subscription
2082
- * @example 411486491630370816
2083
- */
2084
- id: string;
2085
- /**
2086
- * Format: flake-id
2087
- * @description The Flake ID of the Store associated with the Subscription
2088
- * @example 411486491630370816
2089
- */
2090
- store_id: string;
2091
- /**
2092
- * Format: flake-id
2093
- * @description The Flake ID of the Customer associated with the Subscription
2094
- * @example 411486491630370816
2095
- */
2096
- customer_id: string;
2097
- customer: components["schemas"]["CustomerDTO"];
2098
- checkout: components["schemas"]["CheckoutDTO"];
2099
- /**
2100
- * @description The current billing cycle number
2101
- * @example 1
2102
- */
2103
- billing_cycle_sequence: number;
2104
- /**
2105
- * @description The billing email address of the customer associated with the Subscription
2106
- * @example john@doe.com
2107
- */
2108
- billing_email: string;
2109
- /**
2110
- * @description The subtotal amount of the Subscription represented in cents
2111
- * @example 9999
2112
- */
2113
- subtotal_amount: number;
2114
- /**
2115
- * @description The tax amount of the Subscription represented in cents
2116
- * @example 1500
2117
- */
2118
- tax_amount: number;
2119
- /**
2120
- * @description The discount amount applied to the Subscription represented in cents
2121
- * @example 1000
2122
- */
2123
- discount_amount: number;
2124
- /**
2125
- * @description The total amount of the Subscription represented in cents
2126
- * @example 10499
2127
- */
2128
- total_amount: number;
2129
- /**
2130
- * @description The currency code of the Subscription
2131
- * @example USD
2132
- */
2133
- currency: string;
2134
- /**
2135
- * @description The interval value of the billing cycle
2136
- * @example 1
2137
- */
2138
- interval_value: number;
2139
- /**
2140
- * @description The interval scale of the billing cycle
2141
- * @example month
2142
- */
2143
- interval_scale: string;
2144
- /**
2145
- * Format: flake-id
2146
- * @description The Flake ID of the Product associated with the Subscription
2147
- * @example 411486491630370816
2148
- */
2149
- product_id: string;
2150
- /**
2151
- * Format: flake-id
2152
- * @description The Flake ID of the Product Version associated with the Subscription
2153
- * @example 411486491630370816
2154
- */
2155
- product_version_id: string;
2156
- /**
2157
- * @description The name of the Product associated with the Subscription
2158
- * @example Example Product
2159
- */
2160
- product_name: string;
2161
- /**
2162
- * @description The image URL of the Product associated with the Subscription
2163
- * @example https://example.com/image.jpg
2164
- */
2165
- product_image_url?: null | string;
2166
- product: components["schemas"]["ProductDTO"];
2167
- /**
2168
- * @description The ISO-3166 Country Code of the customer associated with the Subscription
2169
- * @example US
2170
- */
2171
- billing_country: string;
2172
- /**
2173
- * @description The initial subtotal amount of the Subscription represented in cents
2174
- * @example 9999
2175
- */
2176
- initial_subtotal_amount: number;
2177
- /**
2178
- * @description The initial tax amount of the Subscription represented in cents
2179
- * @example 1500
2180
- */
2181
- initial_tax_amount: number;
2182
- /**
2183
- * @description The initial discount amount applied to the Subscription represented in cents
2184
- * @example 2000
2185
- */
2186
- initial_discount_amount: number;
2187
- /**
2188
- * @description The initial gift card usage amount applied to the Subscription represented in cents
2189
- * @example 0
2190
- */
2191
- initial_giftcard_usage_amount: number;
2192
- /**
2193
- * @description The initial total amount of the Subscription represented in cents
2194
- * @example 9499
2195
- */
2196
- initial_total_amount: number;
2197
- /**
2198
- * @description The IP address of the Customer
2199
- * @example 127.0.0.1/24
2200
- */
2201
- customer_ip: string;
2202
- /**
2203
- * Format: date-time
2204
- * @description The start date of the current billing period
2205
- * @example 2024-02-01T00:00:00Z
2206
- */
2207
- current_period_start?: null | string;
2208
- /**
2209
- * Format: date-time
2210
- * @description The end date of the current billing period
2211
- * @example 2024-03-01T00:00:00Z
2212
- */
2213
- current_period_end?: null | string;
2214
- /**
2215
- * Format: date-time
2216
- * @description The date and time when the Subscription was created
2217
- * @example 2024-02-01T10:15:00Z
2218
- */
2219
- created_at?: null | string;
2220
- /**
2221
- * Format: date-time
2222
- * @description Indicates when the subscription was active
2223
- * @example 2024-02-01T10:20:00Z
2224
- */
2225
- active_at?: null | string;
2226
- /**
2227
- * Format: flake-id
2228
- * @description The Flake ID of the Checkout associated with the Subscription
2229
- * @example 411486491630370816
2230
- */
2231
- checkout_id: string;
2232
- /**
2233
- * Format: flake-id
2234
- * @description The Flake ID of the Checkout Line associated with the Subscription
2235
- * @example 411486491630370816
2236
- */
2237
- checkout_line_id: string;
2238
- /**
2239
- * @description The current status of the Subscription. Possible options: created, active, canceled
2240
- * @example created
2241
- */
2242
- status: string;
2243
- /** @description The lines of the Subscription */
2244
- lines: components["schemas"]["SubscriptionLineDTO"][];
2245
- };
2246
- };
2247
- };
2248
- };
2249
- responses: {
2250
- /** @description Webhook processed successfully */
2251
- 200: {
2252
- headers: {
2253
- [name: string]: unknown;
2254
- };
2255
- content?: never;
2256
- };
2257
- /** @description Bad request */
2258
- 400: {
2259
- headers: {
2260
- [name: string]: unknown;
2261
- };
2262
- content?: never;
2263
- };
2264
- /** @description Internal server error */
2265
- 500: {
2266
- headers: {
2267
- [name: string]: unknown;
2268
- };
2269
- content?: never;
2270
- };
2271
- };
2272
- };
2273
- delete?: never;
2274
- options?: never;
2275
- head?: never;
2276
- patch?: never;
2277
- trace?: never;
2278
- };
2279
- ON_SUBSCRIPTION_RENEWED: {
2280
- parameters: {
2281
- query?: never;
2282
- header?: never;
2283
- path?: never;
2284
- cookie?: never;
2285
- };
2286
- get?: never;
2287
- put?: never;
2288
- /**
2289
- * Triggered when a subscription is renewed
2290
- * @description Webhook for ON_SUBSCRIPTION_RENEWED
2291
- */
2292
- post: {
2293
- parameters: {
2294
- query?: never;
2295
- header?: never;
2296
- path?: never;
2297
- cookie?: never;
2298
- };
2299
- requestBody: {
2300
- content: {
2301
- "application/json": {
2302
- /**
2303
- * @description The type of webhook event
2304
- * @example ON_SUBSCRIPTION_RENEWED
2305
- */
2306
- event_type: components["schemas"]["WebhookEventType"];
2307
- /**
2308
- * Format: flake-id
2309
- * @description The ID of the Webhook Event
2310
- * @example 411486491630370816
2311
- */
2312
- event_id: string;
2313
- body: {
2314
- /**
2315
- * Format: flake-id
2316
- * @description The Flake ID of the Subscription
2317
- * @example 411486491630370816
2318
- */
2319
- id: string;
2320
- /**
2321
- * Format: flake-id
2322
- * @description The Flake ID of the Store associated with the Subscription
2323
- * @example 411486491630370816
2324
- */
2325
- store_id: string;
2326
- /**
2327
- * Format: flake-id
2328
- * @description The Flake ID of the Customer associated with the Subscription
2329
- * @example 411486491630370816
2330
- */
2331
- customer_id: string;
2332
- customer: components["schemas"]["CustomerDTO"];
2333
- checkout: components["schemas"]["CheckoutDTO"];
2334
- /**
2335
- * @description The current billing cycle number
2336
- * @example 1
2337
- */
2338
- billing_cycle_sequence: number;
2339
- /**
2340
- * @description The billing email address of the customer associated with the Subscription
2341
- * @example john@doe.com
2342
- */
2343
- billing_email: string;
2344
- /**
2345
- * @description The subtotal amount of the Subscription represented in cents
2346
- * @example 9999
2347
- */
2348
- subtotal_amount: number;
2349
- /**
2350
- * @description The tax amount of the Subscription represented in cents
2351
- * @example 1500
2352
- */
2353
- tax_amount: number;
2354
- /**
2355
- * @description The discount amount applied to the Subscription represented in cents
2356
- * @example 1000
2357
- */
2358
- discount_amount: number;
2359
- /**
2360
- * @description The total amount of the Subscription represented in cents
2361
- * @example 10499
2362
- */
2363
- total_amount: number;
2364
- /**
2365
- * @description The currency code of the Subscription
2366
- * @example USD
2367
- */
2368
- currency: string;
2369
- /**
2370
- * @description The interval value of the billing cycle
2371
- * @example 1
2372
- */
2373
- interval_value: number;
2374
- /**
2375
- * @description The interval scale of the billing cycle
2376
- * @example month
2377
- */
2378
- interval_scale: string;
2379
- /**
2380
- * Format: flake-id
2381
- * @description The Flake ID of the Product associated with the Subscription
2382
- * @example 411486491630370816
2383
- */
2384
- product_id: string;
2385
- /**
2386
- * Format: flake-id
2387
- * @description The Flake ID of the Product Version associated with the Subscription
2388
- * @example 411486491630370816
2389
- */
2390
- product_version_id: string;
2391
- /**
2392
- * @description The name of the Product associated with the Subscription
2393
- * @example Example Product
2394
- */
2395
- product_name: string;
2396
- /**
2397
- * @description The image URL of the Product associated with the Subscription
2398
- * @example https://example.com/image.jpg
2399
- */
2400
- product_image_url?: null | string;
2401
- product: components["schemas"]["ProductDTO"];
2402
- /**
2403
- * @description The ISO-3166 Country Code of the customer associated with the Subscription
2404
- * @example US
2405
- */
2406
- billing_country: string;
2407
- /**
2408
- * @description The initial subtotal amount of the Subscription represented in cents
2409
- * @example 9999
2410
- */
2411
- initial_subtotal_amount: number;
2412
- /**
2413
- * @description The initial tax amount of the Subscription represented in cents
2414
- * @example 1500
2415
- */
2416
- initial_tax_amount: number;
2417
- /**
2418
- * @description The initial discount amount applied to the Subscription represented in cents
2419
- * @example 2000
2420
- */
2421
- initial_discount_amount: number;
2422
- /**
2423
- * @description The initial gift card usage amount applied to the Subscription represented in cents
2424
- * @example 0
2425
- */
2426
- initial_giftcard_usage_amount: number;
2427
- /**
2428
- * @description The initial total amount of the Subscription represented in cents
2429
- * @example 9499
2430
- */
2431
- initial_total_amount: number;
2432
- /**
2433
- * @description The IP address of the Customer
2434
- * @example 127.0.0.1/24
2435
- */
2436
- customer_ip: string;
2437
- /**
2438
- * Format: date-time
2439
- * @description The start date of the current billing period
2440
- * @example 2024-02-01T00:00:00Z
2441
- */
2442
- current_period_start?: null | string;
2443
- /**
2444
- * Format: date-time
2445
- * @description The end date of the current billing period
2446
- * @example 2024-03-01T00:00:00Z
2447
- */
2448
- current_period_end?: null | string;
2449
- /**
2450
- * Format: date-time
2451
- * @description The date and time when the Subscription was created
2452
- * @example 2024-02-01T10:15:00Z
2453
- */
2454
- created_at?: null | string;
2455
- /**
2456
- * Format: date-time
2457
- * @description Indicates when the subscription was active
2458
- * @example 2024-02-01T10:20:00Z
2459
- */
2460
- active_at?: null | string;
2461
- /**
2462
- * Format: flake-id
2463
- * @description The Flake ID of the Checkout associated with the Subscription
2464
- * @example 411486491630370816
2465
- */
2466
- checkout_id: string;
2467
- /**
2468
- * Format: flake-id
2469
- * @description The Flake ID of the Checkout Line associated with the Subscription
2470
- * @example 411486491630370816
2471
- */
2472
- checkout_line_id: string;
2473
- /**
2474
- * @description The current status of the Subscription. Possible options: created, active, canceled
2475
- * @example created
2476
- */
2477
- status: string;
2478
- /** @description The lines of the Subscription */
2479
- lines: components["schemas"]["SubscriptionLineDTO"][];
2480
- };
2481
- };
2482
- };
2483
- };
2484
- responses: {
2485
- /** @description Webhook processed successfully */
2486
- 200: {
2487
- headers: {
2488
- [name: string]: unknown;
2489
- };
2490
- content?: never;
2491
- };
2492
- /** @description Bad request */
2493
- 400: {
2494
- headers: {
2495
- [name: string]: unknown;
2496
- };
2497
- content?: never;
2498
- };
2499
- /** @description Internal server error */
2500
- 500: {
2501
- headers: {
2502
- [name: string]: unknown;
2503
- };
2504
- content?: never;
2505
- };
2506
- };
2507
- };
2508
- delete?: never;
2509
- options?: never;
2510
- head?: never;
2511
- patch?: never;
2512
- trace?: never;
2513
- };
2514
- ON_TRIAL_ACTIVATED: {
2515
- parameters: {
2516
- query?: never;
2517
- header?: never;
2518
- path?: never;
2519
- cookie?: never;
2520
- };
2521
- get?: never;
2522
- put?: never;
2523
- /**
2524
- * Triggered when a trial is activated
2525
- * @description Webhook for ON_TRIAL_ACTIVATED
2526
- */
2527
- post: {
2528
- parameters: {
2529
- query?: never;
2530
- header?: never;
2531
- path?: never;
2532
- cookie?: never;
2533
- };
2534
- requestBody: {
2535
- content: {
2536
- "application/json": {
2537
- /**
2538
- * @description The type of webhook event
2539
- * @example ON_TRIAL_ACTIVATED
2540
- */
2541
- event_type: components["schemas"]["WebhookEventType"];
2542
- /**
2543
- * Format: flake-id
2544
- * @description The ID of the Webhook Event
2545
- * @example 411486491630370816
2546
- */
2547
- event_id: string;
2548
- body: {
2549
- /**
2550
- * Format: flake-id
2551
- * @description The Flake ID of the Trial
2552
- * @example 411486491630370816
2553
- */
2554
- id: string;
2555
- /**
2556
- * Format: flake-id
2557
- * @description The Flake ID of the Store associated with the Trial
2558
- * @example 411486491630370816
2559
- */
2560
- store_id: string;
2561
- /**
2562
- * Format: flake-id
2563
- * @description The Flake ID of the Customer associated with the Trial
2564
- * @example 411486491630370816
2565
- */
2566
- customer_id: string;
2567
- customer: components["schemas"]["CustomerDTO"];
2568
- /**
2569
- * Format: flake-id
2570
- * @description The Flake ID of the Checkout associated with the Trial
2571
- * @example 411486491630370816
2572
- */
2573
- checkout_id?: null | string;
2574
- /**
2575
- * Format: flake-id
2576
- * @description The Flake ID of the Checkout Line associated with the Trial
2577
- * @example 411486491630370816
2578
- */
2579
- checkout_line_id?: null | string;
2580
- /**
2581
- * Format: flake-id
2582
- * @description The Flake ID of the Product associated with the Trial
2583
- * @example 411486491630370816
2584
- */
2585
- product_id: string;
2586
- /**
2587
- * Format: flake-id
2588
- * @description The Flake ID of the Product Version associated with the Trial
2589
- * @example 411486491630370816
2590
- */
2591
- product_version_id: string;
2592
- /**
2593
- * @description The name of the Product associated with the Trial
2594
- * @example Example Product
2595
- */
2596
- product_name: string;
2597
- /**
2598
- * @description The image URL of the Product associated with the Trial
2599
- * @example https://example.com/image.jpg
2600
- */
2601
- product_image_url?: null | string;
2602
- /**
2603
- * @description The period value of the Trial
2604
- * @example 1
2605
- */
2606
- period_value: number;
2607
- /**
2608
- * @description The period scale of the Trial
2609
- * @example month
2610
- */
2611
- period_scale: string;
2612
- /**
2613
- * Format: date-time
2614
- * @description The start date of the Trial
2615
- * @example 2024-06-10T00:00:00Z
2616
- */
2617
- starts_at?: null | string;
2618
- /**
2619
- * Format: date-time
2620
- * @description The end date of the Trial
2621
- * @example 2024-06-17T23:59:59Z
2622
- */
2623
- ends_at?: null | string;
2624
- /**
2625
- * @description The current status of the Trial. Possible options: created, active, canceled, completed
2626
- * @example created
2627
- */
2628
- status: string;
2629
- /**
2630
- * Format: date-time
2631
- * @description The date and time when the Trial was created
2632
- * @example 2024-06-10T08:30:00Z
2633
- */
2634
- created_at: string;
2635
- /**
2636
- * Format: date-time
2637
- * @description Indicates when the Trial was canceled
2638
- * @example 2024-06-15T10:15:00Z
2639
- */
2640
- canceled_at?: null | string;
2641
- };
2642
- };
2643
- };
2644
- };
2645
- responses: {
2646
- /** @description Webhook processed successfully */
2647
- 200: {
2648
- headers: {
2649
- [name: string]: unknown;
2650
- };
2651
- content?: never;
2652
- };
2653
- /** @description Bad request */
2654
- 400: {
2655
- headers: {
2656
- [name: string]: unknown;
2657
- };
2658
- content?: never;
2659
- };
2660
- /** @description Internal server error */
2661
- 500: {
2662
- headers: {
2663
- [name: string]: unknown;
2664
- };
2665
- content?: never;
2666
- };
2667
- };
2668
- };
2669
- delete?: never;
2670
- options?: never;
2671
- head?: never;
2672
- patch?: never;
2673
- trace?: never;
2674
- };
2675
- ON_TRIAL_COMPLETED: {
2676
- parameters: {
2677
- query?: never;
2678
- header?: never;
2679
- path?: never;
2680
- cookie?: never;
2681
- };
2682
- get?: never;
2683
- put?: never;
2684
- /**
2685
- * Triggered when a trial is completed
2686
- * @description Webhook for ON_TRIAL_COMPLETED
2687
- */
2688
- post: {
2689
- parameters: {
2690
- query?: never;
2691
- header?: never;
2692
- path?: never;
2693
- cookie?: never;
2694
- };
2695
- requestBody: {
2696
- content: {
2697
- "application/json": {
2698
- /**
2699
- * @description The type of webhook event
2700
- * @example ON_TRIAL_COMPLETED
2701
- */
2702
- event_type: components["schemas"]["WebhookEventType"];
2703
- /**
2704
- * Format: flake-id
2705
- * @description The ID of the Webhook Event
2706
- * @example 411486491630370816
2707
- */
2708
- event_id: string;
2709
- body: {
2710
- /**
2711
- * Format: flake-id
2712
- * @description The Flake ID of the Trial
2713
- * @example 411486491630370816
2714
- */
2715
- id: string;
2716
- /**
2717
- * Format: flake-id
2718
- * @description The Flake ID of the Store associated with the Trial
2719
- * @example 411486491630370816
2720
- */
2721
- store_id: string;
2722
- /**
2723
- * Format: flake-id
2724
- * @description The Flake ID of the Customer associated with the Trial
2725
- * @example 411486491630370816
2726
- */
2727
- customer_id: string;
2728
- customer: components["schemas"]["CustomerDTO"];
2729
- /**
2730
- * Format: flake-id
2731
- * @description The Flake ID of the Checkout associated with the Trial
2732
- * @example 411486491630370816
2733
- */
2734
- checkout_id?: null | string;
2735
- /**
2736
- * Format: flake-id
2737
- * @description The Flake ID of the Checkout Line associated with the Trial
2738
- * @example 411486491630370816
2739
- */
2740
- checkout_line_id?: null | string;
2741
- /**
2742
- * Format: flake-id
2743
- * @description The Flake ID of the Product associated with the Trial
2744
- * @example 411486491630370816
2745
- */
2746
- product_id: string;
2747
- /**
2748
- * Format: flake-id
2749
- * @description The Flake ID of the Product Version associated with the Trial
2750
- * @example 411486491630370816
2751
- */
2752
- product_version_id: string;
2753
- /**
2754
- * @description The name of the Product associated with the Trial
2755
- * @example Example Product
2756
- */
2757
- product_name: string;
2758
- /**
2759
- * @description The image URL of the Product associated with the Trial
2760
- * @example https://example.com/image.jpg
2761
- */
2762
- product_image_url?: null | string;
2763
- /**
2764
- * @description The period value of the Trial
2765
- * @example 1
2766
- */
2767
- period_value: number;
2768
- /**
2769
- * @description The period scale of the Trial
2770
- * @example month
2771
- */
2772
- period_scale: string;
2773
- /**
2774
- * Format: date-time
2775
- * @description The start date of the Trial
2776
- * @example 2024-06-10T00:00:00Z
2777
- */
2778
- starts_at?: null | string;
2779
- /**
2780
- * Format: date-time
2781
- * @description The end date of the Trial
2782
- * @example 2024-06-17T23:59:59Z
2783
- */
2784
- ends_at?: null | string;
2785
- /**
2786
- * @description The current status of the Trial. Possible options: created, active, canceled, completed
2787
- * @example created
2788
- */
2789
- status: string;
2790
- /**
2791
- * Format: date-time
2792
- * @description The date and time when the Trial was created
2793
- * @example 2024-06-10T08:30:00Z
2794
- */
2795
- created_at: string;
2796
- /**
2797
- * Format: date-time
2798
- * @description Indicates when the Trial was canceled
2799
- * @example 2024-06-15T10:15:00Z
2800
- */
2801
- canceled_at?: null | string;
2802
- };
2803
- };
2804
- };
2805
- };
2806
- responses: {
2807
- /** @description Webhook processed successfully */
2808
- 200: {
2809
- headers: {
2810
- [name: string]: unknown;
2811
- };
2812
- content?: never;
2813
- };
2814
- /** @description Bad request */
2815
- 400: {
2816
- headers: {
2817
- [name: string]: unknown;
2818
- };
2819
- content?: never;
2820
- };
2821
- /** @description Internal server error */
2822
- 500: {
2823
- headers: {
2824
- [name: string]: unknown;
2825
- };
2826
- content?: never;
2827
- };
2828
- };
2829
- };
2830
- delete?: never;
2831
- options?: never;
2832
- head?: never;
2833
- patch?: never;
2834
- trace?: never;
2835
- };
2836
- ON_TRIAL_CANCELED: {
2837
- parameters: {
2838
- query?: never;
2839
- header?: never;
2840
- path?: never;
2841
- cookie?: never;
2842
- };
2843
- get?: never;
2844
- put?: never;
2845
- /**
2846
- * Triggered when a trial is canceled
2847
- * @description Webhook for ON_TRIAL_CANCELED
2848
- */
2849
- post: {
2850
- parameters: {
2851
- query?: never;
2852
- header?: never;
2853
- path?: never;
2854
- cookie?: never;
2855
- };
2856
- requestBody: {
2857
- content: {
2858
- "application/json": {
2859
- /**
2860
- * @description The type of webhook event
2861
- * @example ON_TRIAL_CANCELED
2862
- */
2863
- event_type: components["schemas"]["WebhookEventType"];
2864
- /**
2865
- * Format: flake-id
2866
- * @description The ID of the Webhook Event
2867
- * @example 411486491630370816
2868
- */
2869
- event_id: string;
2870
- body: {
2871
- /**
2872
- * Format: flake-id
2873
- * @description The Flake ID of the Trial
2874
- * @example 411486491630370816
2875
- */
2876
- id: string;
2877
- /**
2878
- * Format: flake-id
2879
- * @description The Flake ID of the Store associated with the Trial
2880
- * @example 411486491630370816
2881
- */
2882
- store_id: string;
2883
- /**
2884
- * Format: flake-id
2885
- * @description The Flake ID of the Customer associated with the Trial
2886
- * @example 411486491630370816
2887
- */
2888
- customer_id: string;
2889
- customer: components["schemas"]["CustomerDTO"];
2890
- /**
2891
- * Format: flake-id
2892
- * @description The Flake ID of the Checkout associated with the Trial
2893
- * @example 411486491630370816
2894
- */
2895
- checkout_id?: null | string;
2896
- /**
2897
- * Format: flake-id
2898
- * @description The Flake ID of the Checkout Line associated with the Trial
2899
- * @example 411486491630370816
2900
- */
2901
- checkout_line_id?: null | string;
2902
- /**
2903
- * Format: flake-id
2904
- * @description The Flake ID of the Product associated with the Trial
2905
- * @example 411486491630370816
2906
- */
2907
- product_id: string;
2908
- /**
2909
- * Format: flake-id
2910
- * @description The Flake ID of the Product Version associated with the Trial
2911
- * @example 411486491630370816
2912
- */
2913
- product_version_id: string;
2914
- /**
2915
- * @description The name of the Product associated with the Trial
2916
- * @example Example Product
2917
- */
2918
- product_name: string;
2919
- /**
2920
- * @description The image URL of the Product associated with the Trial
2921
- * @example https://example.com/image.jpg
2922
- */
2923
- product_image_url?: null | string;
2924
- /**
2925
- * @description The period value of the Trial
2926
- * @example 1
2927
- */
2928
- period_value: number;
2929
- /**
2930
- * @description The period scale of the Trial
2931
- * @example month
2932
- */
2933
- period_scale: string;
2934
- /**
2935
- * Format: date-time
2936
- * @description The start date of the Trial
2937
- * @example 2024-06-10T00:00:00Z
2938
- */
2939
- starts_at?: null | string;
2940
- /**
2941
- * Format: date-time
2942
- * @description The end date of the Trial
2943
- * @example 2024-06-17T23:59:59Z
2944
- */
2945
- ends_at?: null | string;
2946
- /**
2947
- * @description The current status of the Trial. Possible options: created, active, canceled, completed
2948
- * @example created
2949
- */
2950
- status: string;
2951
- /**
2952
- * Format: date-time
2953
- * @description The date and time when the Trial was created
2954
- * @example 2024-06-10T08:30:00Z
2955
- */
2956
- created_at: string;
2957
- /**
2958
- * Format: date-time
2959
- * @description Indicates when the Trial was canceled
2960
- * @example 2024-06-15T10:15:00Z
2961
- */
2962
- canceled_at?: null | string;
2963
- };
2964
- };
2965
- };
2966
- };
2967
- responses: {
2968
- /** @description Webhook processed successfully */
2969
- 200: {
2970
- headers: {
2971
- [name: string]: unknown;
2972
- };
2973
- content?: never;
2974
- };
2975
- /** @description Bad request */
2976
- 400: {
2977
- headers: {
2978
- [name: string]: unknown;
2979
- };
2980
- content?: never;
2981
- };
2982
- /** @description Internal server error */
2983
- 500: {
2984
- headers: {
2985
- [name: string]: unknown;
2986
- };
2987
- content?: never;
2988
- };
2989
- };
2990
- };
2991
- delete?: never;
2992
- options?: never;
2993
- head?: never;
2994
- patch?: never;
2995
- trace?: never;
2996
- };
2997
- }
2998
- export interface components {
2999
- schemas: {
3000
- CheckoutDTO: {
3001
- /**
3002
- * Format: flake-id
3003
- * @description The Flake ID of the Checkout
3004
- * @example 411486491630370816
3005
- */
3006
- id: string;
3007
- /** @description Metadata associated with the checkout */
3008
- metadata: {
3009
- [key: string]: string;
3010
- };
3011
- /** @description The lines of the Checkout */
3012
- lines: components["schemas"]["CheckoutLineDTO"][];
3013
- };
3014
- CheckoutLineDTO: {
3015
- /**
3016
- * Format: flake-id
3017
- * @description The ID of the Checkout line
3018
- * @example 411486491630370816
3019
- */
3020
- id: string;
3021
- /**
3022
- * Format: flake-id
3023
- * @description The Product Flake ID of the Checkout Line
3024
- * @example 411486491630370816
3025
- */
3026
- product_id: string;
3027
- /**
3028
- * Format: flake-id
3029
- * @description The Product Version Flake ID of the Checkout Line
3030
- * @example 411486491630370816
3031
- */
3032
- product_version_id: string;
3033
- /** @description Metadata associated with the Checkout Line */
3034
- metadata: {
3035
- [key: string]: string;
3036
- };
3037
- };
3038
- CustomerDTO: {
3039
- /**
3040
- * Format: flake-id
3041
- * @description The Flake ID of the Customer
3042
- * @example 411486491630370816
3043
- */
3044
- id: string;
3045
- /** @example John */
3046
- name?: null | string;
3047
- steam: components["schemas"]["SteamCustomerDTO"];
3048
- minecraft: components["schemas"]["MinecraftCustomerDTO"];
3049
- profile: components["schemas"]["GenericProfileDTO"];
3050
- };
3051
- GameServerDTO: {
3052
- /**
3053
- * Format: flake-id
3054
- * @description The Flake ID of the Game Server
3055
- * @example 411486491630370816
3056
- */
3057
- id: string;
3058
- /**
3059
- * @description The name of the Game Server
3060
- * @example John
3061
- */
3062
- name: string;
3063
- /** @description Indicates if the Game Server is enabled */
3064
- enabled: boolean;
3065
- };
3066
- GenericProfileDTO: {
3067
- id: string;
3068
- platform: string;
3069
- /** @example John */
3070
- name: string;
3071
- avatar_url: string;
3072
- };
3073
- MinecraftCustomerDTO: {
3074
- id: string;
3075
- /** @example Notch */
3076
- name: string;
3077
- avatar_url: string;
3078
- };
3079
- OrderCouponUsageDTO: {
3080
- /**
3081
- * Format: flake-id
3082
- * @example 411486491630370816
3083
- */
3084
- coupon_id: string;
3085
- usage_amount: number;
3086
- };
3087
- OrderDTO: {
3088
- /**
3089
- * Format: flake-id
3090
- * @description The Flake ID of the Order
3091
- * @example 411486491630370816
3092
- */
3093
- id: string;
3094
- /**
3095
- * Format: flake-id
3096
- * @description The Flake ID of the store associated with the order
3097
- * @example 411486491630370816
3098
- */
3099
- store_id: string;
3100
- customer: components["schemas"]["CustomerDTO"];
3101
- /**
3102
- * Format: flake-id
3103
- * @description The Flake ID of the Checkout associated with the order
3104
- * @example 411486491630370816
3105
- */
3106
- checkout_id: string;
3107
- checkout: components["schemas"]["CheckoutDTO"];
3108
- /**
3109
- * Format: flake-id
3110
- * @description The Flake ID of the Subscription associated with the order
3111
- * @example 411486491630370816
3112
- */
3113
- subscription_id?: null | string;
3114
- /** @description Applied coupons to this order */
3115
- applied_coupons: components["schemas"]["OrderCouponUsageDTO"][];
3116
- /** @description Applied gift cards to this order */
3117
- applied_giftcards: components["schemas"]["OrderGiftCardUsageDTO"][];
3118
- /**
3119
- * Format: flake-id
3120
- * @description The Flake ID of the Coupon associated with the order
3121
- * @example 411486491630370816
3122
- */
3123
- coupon_id: string;
3124
- /**
3125
- * @description The type of the order
3126
- * @example one_time
3127
- */
3128
- type: string;
3129
- /**
3130
- * @description The ISO-4217 Currency Code of the order
3131
- * @example USD
3132
- */
3133
- currency: string;
3134
- /**
3135
- * @description Indicates if the order value was inclusive of tax
3136
- * @example true
3137
- */
3138
- tax_inclusive: boolean;
3139
- /**
3140
- * @description The tax amount, represented as cents
3141
- * @example 1500
3142
- */
3143
- tax_amount: number;
3144
- /**
3145
- * @description The discount amount, represented as cents
3146
- * @example 500
3147
- */
3148
- discount_amount: number;
3149
- /**
3150
- * @description The subtotal amount, represented as cents
3151
- * @example 10000
3152
- */
3153
- subtotal_amount: number;
3154
- /**
3155
- * @description The total amount, represented as cents
3156
- * @example 11000
3157
- */
3158
- total_amount: number;
3159
- /**
3160
- * Format: date-time
3161
- * @description Indicates when the order was created
3162
- * @example 2024-01-15T10:30:00Z
3163
- */
3164
- created_at: string;
3165
- /**
3166
- * Format: date-time
3167
- * @description Indicates when the order was completed
3168
- * @example 2024-01-15T10:35:00Z
3169
- */
3170
- completed_at: string;
3171
- /**
3172
- * @description The billing name of the customer associated with the order
3173
- * @example John Doe
3174
- */
3175
- billing_name: string;
3176
- /**
3177
- * @description The billing email address of the customer associated with the order
3178
- * @example john@doe.com
3179
- */
3180
- billing_email: string;
3181
- /**
3182
- * @description The ISO-3316 Country Code of the customer associated with the order
3183
- * @example US
3184
- */
3185
- billing_address_country: string;
3186
- /**
3187
- * @description The IPv4 or IPv6 Address of the associated customer when creating the order
3188
- * @example 127.0.0.1/24
3189
- */
3190
- customer_ip: string;
3191
- /**
3192
- * @description The total amount of giftcard usage associated with the order, represented in cents
3193
- * @example 0
3194
- */
3195
- giftcard_usage_amount: number;
3196
- /** @description The order lines associated with the order */
3197
- lines: components["schemas"]["OrderLineDTO"][];
3198
- /**
3199
- * @description A comma-seperated string of the names of the product associated with the order
3200
- * @example Product A, Product B
3201
- */
3202
- product_names: string;
3203
- /**
3204
- * @description A comma-seperated string of the tags of the products associated with the order
3205
- * @example ranks, perks
3206
- */
3207
- product_tags: string;
3208
- /**
3209
- * @description A comma-seperated string of the gameservers of the product associated with the order
3210
- * @example game server one, game server two
3211
- */
3212
- product_gameservers: string;
3213
- /**
3214
- * @description The status of the Order. Possbile options: created, completed, canceled
3215
- * @example created
3216
- */
3217
- status: string;
3218
- };
3219
- OrderGiftCardUsageDTO: {
3220
- /**
3221
- * Format: flake-id
3222
- * @example 411486491630370816
3223
- */
3224
- giftcard_id: string;
3225
- usage_amount: number;
3226
- };
3227
- OrderLineDTO: {
3228
- /**
3229
- * Format: flake-id
3230
- * @description The Flake ID of the Order Line
3231
- * @example 411486491630370816
3232
- */
3233
- id: string;
3234
- /**
3235
- * Format: flake-id
3236
- * @description The Flake ID of the Checkout Line associated with this Order Line
3237
- * @example 411486491630370816
3238
- */
3239
- checkout_line_id?: null | string;
3240
- /**
3241
- * Format: flake-id
3242
- * @description The Flake ID of the Product ID associated with this Order Line
3243
- * @example 411486491630370816
3244
- */
3245
- product_id: string;
3246
- /**
3247
- * Format: flake-id
3248
- * @description The Flake ID of the Product Version ID associated with this Order Line
3249
- * @example 411486491630370816
3250
- */
3251
- product_version_id: string;
3252
- product: components["schemas"]["ProductDTO"];
3253
- /** @description The name of the product associated with this Order Line */
3254
- product_name: string;
3255
- /** @description The Image URL of the Product associated with this Order Line */
3256
- product_image_url?: null | string;
3257
- /**
3258
- * Format: flake-id
3259
- * @description The Flake ID of the Subscription associated with this Order Line
3260
- * @example 411486491630370816
3261
- */
3262
- subscription_id?: null | string;
3263
- /**
3264
- * Format: flake-id
3265
- * @description The Flake ID of the Subscription Line associated with this Order Line
3266
- * @example 411486491630370816
3267
- */
3268
- subscription_line_id?: null | string;
3269
- /**
3270
- * @description The value of the interval in which the subscription associated with this Order Line renews at
3271
- * @example 1
3272
- */
3273
- subscription_interval_value?: null | number;
3274
- /**
3275
- * @description The value of the scale in which the subscription associated with this Order Line renews at
3276
- * @example month
3277
- */
3278
- subscription_interval_scale?: null | string;
3279
- /**
3280
- * Format: flake-id
3281
- * @description The Flake ID of the Trial associated with this Order Line
3282
- * @example 411486491630370816
3283
- */
3284
- trial_id?: null | string;
3285
- gift_to_customer?: components["schemas"]["CustomerDTO"] | null;
3286
- /**
3287
- * @description The price of the Order Line
3288
- * @example 1000
3289
- */
3290
- price: number;
3291
- /**
3292
- * @description The quantity of the Order Line
3293
- * @example 1
3294
- */
3295
- quantity: number;
3296
- /**
3297
- * @description The discount amount of the order line, represented in cents
3298
- * @example 0
3299
- */
3300
- discount_amount: number;
3301
- /**
3302
- * @description The subtotal amount of the order line, represented in cents
3303
- * @example 1000
3304
- */
3305
- subtotal_amount: number;
3306
- /**
3307
- * @description The tax amount of the order line, represented in cents
3308
- * @example 100
3309
- */
3310
- tax_amount: number;
3311
- /**
3312
- * @description The total amount of the order line, represented in cents
3313
- * @example 1100
3314
- */
3315
- total_amount: number;
3316
- /**
3317
- * Format: flake-id
3318
- * @description The Flake ID of which was the selected Game Server ID for the Order Line
3319
- * @example 411486491630370816
3320
- */
3321
- selected_gameserver_id?: null | string;
3322
- };
3323
- ProductCommandDTO: {
3324
- /**
3325
- * @description The stage of which the Product Command should be executed. Possible options: on_purchase, on_expire, on_refund, on_renew, on_chargeback, on_trial_start, on_trial_expire
3326
- * @example on_purchase
3327
- */
3328
- stage: string;
3329
- /** @description The command to execute */
3330
- content: string;
3331
- /** @description Indicated if the command should be executed only when the customer is online */
3332
- online_only: boolean;
3333
- };
3334
- ProductDTO: {
3335
- /**
3336
- * Format: flake-id
3337
- * @description The Flake ID of the Product
3338
- * @example 411486491630370816
3339
- */
3340
- id: string;
3341
- /**
3342
- * Format: flake-id
3343
- * @description The Flake ID of the Store
3344
- * @example 411486491630370816
3345
- */
3346
- store_id: string;
3347
- /**
3348
- * Format: flake-id
3349
- * @description The Flake ID of the Version of the Product
3350
- * @example 411486491630370816
3351
- */
3352
- version_id: string;
3353
- /** @description The Image URL of the product */
3354
- image_url?: null | string;
3355
- /** @description The URL-Friendly Slug of the Product */
3356
- slug: string;
3357
- /** @description The name of the Product */
3358
- name: string;
3359
- /** @description The description of the product */
3360
- description: string;
3361
- /** @description Indicates if the product is enabled. */
3362
- enabled: boolean;
3363
- /** @description The label of the product */
3364
- label?: null | string;
3365
- /** @description The sort order of the product */
3366
- sort_order: number;
3367
- /** @description The price of the product, represented in cents. */
3368
- price: number;
3369
- /** @description Indicates if the customer must select a single game server when purchasing the product */
3370
- single_game_server_only: boolean;
3371
- /** @description Indicates if one-time purchases are supported on the product */
3372
- allow_one_time_purchase: boolean;
3373
- /** @description Indicates if subscriptions are supported on the product */
3374
- allow_subscription: boolean;
3375
- /**
3376
- * @description The value of the interval in which the product subscription renews at
3377
- * @example 1
3378
- */
3379
- subscription_interval_value?: null | number;
3380
- /**
3381
- * @description The value of the interval in which the product subscription renews at
3382
- * @example month
3383
- */
3384
- subscription_interval_scale?: null | string;
3385
- /** @description Indicates whether automatic removal is enabled */
3386
- remove_after_enabled: boolean;
3387
- /**
3388
- * @description The value of the time in which this product should be removed
3389
- * @example 1
3390
- */
3391
- remove_after_time_value?: null | number;
3392
- /**
3393
- * @description The scale of the time in which this product should be removed
3394
- * @example month
3395
- */
3396
- remove_after_time_scale?: null | string;
3397
- /** @description The tags associated with the product */
3398
- tags: components["schemas"]["ProductTagDTO"][];
3399
- /** @description A comma-seperated string of all the tags associated with the product */
3400
- tag_names: string;
3401
- /** @description The game servers associated with the product */
3402
- gameservers: components["schemas"]["ProductGameServerDTO"][];
3403
- /** @description A comma-seperated string of all the game servers associated with the product */
3404
- gameserver_names: string;
3405
- /** @description The commands associated with the product */
3406
- commands: components["schemas"]["ProductCommandDTO"][];
3407
- /**
3408
- * Format: date-time
3409
- * @description When the product was created
3410
- */
3411
- created_at?: null | string;
3412
- /**
3413
- * Format: date-time
3414
- * @description When the product was last updated
3415
- */
3416
- updated_at?: null | string;
3417
- /** @description The metadata of the product */
3418
- metadata: {
3419
- [key: string]: string;
3420
- };
3421
- };
3422
- ProductGameServerDTO: {
3423
- /**
3424
- * Format: flake-id
3425
- * @description The ID of the Game Server
3426
- * @example 411486491630370816
3427
- */
3428
- id: string;
3429
- /** @description The name of the Game Server */
3430
- name: string;
3431
- /** @description Indicates if the Game Server is enabled */
3432
- enabled: boolean;
3433
- };
3434
- ProductTagDTO: {
3435
- /**
3436
- * Format: flake-id
3437
- * @description The Flake ID of the Product Tag
3438
- * @example 411486491630370816
3439
- */
3440
- id: string;
3441
- /** @description The URL-Friendly slug of the Product Tag */
3442
- slug: string;
3443
- /** @description The name of the Product Tag */
3444
- name: string;
3445
- };
3446
- SteamCustomerDTO: {
3447
- /**
3448
- * @description SteamID64
3449
- * @example 76561197960287930
3450
- */
3451
- id: string;
3452
- /**
3453
- * @description The name on the Steam Profile
3454
- * @example John
3455
- */
3456
- name: string;
3457
- /** @description The Steam Avatar URL */
3458
- avatar_url: string;
3459
- };
3460
- SubscriptionLineDTO: {
3461
- /**
3462
- * Format: flake-id
3463
- * @description The Flake ID of the Subscription Line
3464
- * @example 411486491630370816
3465
- */
3466
- id: string;
3467
- /**
3468
- * Format: flake-id
3469
- * @description The Flake ID of the Subscription associated with this Subscription Line
3470
- * @example 411486491630370816
3471
- */
3472
- subscription_id: string;
3473
- /**
3474
- * Format: flake-id
3475
- * @description The Flake ID of the Checkout Line associated with this Subscription Line
3476
- * @example 411486491630370816
3477
- */
3478
- checkout_line_id?: null | string;
3479
- /**
3480
- * Format: flake-id
3481
- * @description The Flake ID of the initial Order Line associated with this Subscription Line
3482
- * @example 411486491630370816
3483
- */
3484
- initial_order_line_id?: null | string;
3485
- /**
3486
- * Format: flake-id
3487
- * @description The Flake ID of the customer this Subscription Line was gifted to
3488
- * @example 411486491630370816
3489
- */
3490
- gift_to_customer_id?: null | string;
3491
- gift_to_customer?: components["schemas"]["CustomerDTO"] | null;
3492
- /**
3493
- * Format: flake-id
3494
- * @description The Flake ID of the selected Game Server for this Subscription Line
3495
- * @example 411486491630370816
3496
- */
3497
- selected_gameserver_id?: null | string;
3498
- /**
3499
- * Format: flake-id
3500
- * @description The Flake ID of the Sale associated with this Subscription Line
3501
- * @example 411486491630370816
3502
- */
3503
- sale_id?: null | string;
3504
- /**
3505
- * Format: flake-id
3506
- * @description The Flake ID of the Trial associated with this Subscription Line
3507
- * @example 411486491630370816
3508
- */
3509
- trial_id?: null | string;
3510
- /**
3511
- * Format: flake-id
3512
- * @description The Flake ID of the Product associated with this Subscription Line
3513
- * @example 411486491630370816
3514
- */
3515
- product_id: string;
3516
- /**
3517
- * Format: flake-id
3518
- * @description The Flake ID of the Product Version associated with this Subscription Line
3519
- * @example 411486491630370816
3520
- */
3521
- product_version_id: string;
3522
- /**
3523
- * @description The name of the Product associated with this Subscription Line
3524
- * @example Example Product
3525
- */
3526
- product_name: string;
3527
- /**
3528
- * @description The image URL of the Product associated with this Subscription Line
3529
- * @example https://example.com/image.jpg
3530
- */
3531
- product_image_url?: null | string;
3532
- product?: components["schemas"]["ProductDTO"] | null;
3533
- /**
3534
- * @description Whether the price of this Subscription Line is tax inclusive
3535
- * @example false
3536
- */
3537
- tax_inclusive: boolean;
3538
- /**
3539
- * @description The price of this Subscription Line represented in cents
3540
- * @example 9999
3541
- */
3542
- price: number;
3543
- /**
3544
- * @description The discount amount applied to this Subscription Line represented in cents
3545
- * @example 1000
3546
- */
3547
- discount_amount: number;
3548
- /**
3549
- * @description The subtotal amount of this Subscription Line represented in cents
3550
- * @example 8999
3551
- */
3552
- subtotal_amount: number;
3553
- /**
3554
- * @description The tax amount of this Subscription Line represented in cents
3555
- * @example 1350
3556
- */
3557
- tax_amount: number;
3558
- /**
3559
- * @description The total amount of this Subscription Line represented in cents
3560
- * @example 10349
3561
- */
3562
- total_amount: number;
3563
- /**
3564
- * @description The initial discount amount applied to this Subscription Line represented in cents
3565
- * @example 2000
3566
- */
3567
- initial_discount_amount: number;
3568
- /**
3569
- * @description The initial subtotal amount of this Subscription Line represented in cents
3570
- * @example 7999
3571
- */
3572
- initial_subtotal_amount: number;
3573
- /**
3574
- * @description The initial gift card usage amount applied to this Subscription Line represented in cents
3575
- * @example 0
3576
- */
3577
- initial_giftcard_usage_amount: number;
3578
- /**
3579
- * @description The initial tax amount of this Subscription Line represented in cents
3580
- * @example 1200
3581
- */
3582
- initial_tax_amount: number;
3583
- /**
3584
- * @description The initial total amount of this Subscription Line represented in cents
3585
- * @example 9199
3586
- */
3587
- initial_total_amount: number;
3588
- /**
3589
- * @description The currency code of this Subscription Line
3590
- * @example USD
3591
- */
3592
- currency: string;
3593
- /**
3594
- * @description The presentment currency code of this Subscription Line
3595
- * @example EUR
3596
- */
3597
- presentment_currency?: null | string;
3598
- /**
3599
- * @description The presentment subtotal amount of this Subscription Line represented in cents
3600
- * @example 8299
3601
- */
3602
- presentment_subtotal_amount?: null | number;
3603
- /**
3604
- * @description The presentment discount amount of this Subscription Line represented in cents
3605
- * @example 0
3606
- */
3607
- presentment_discount_amount?: null | number;
3608
- /**
3609
- * @description The presentment tax amount of this Subscription Line represented in cents
3610
- * @example 1245
3611
- */
3612
- presentment_tax_amount?: null | number;
3613
- /**
3614
- * @description The presentment total amount of this Subscription Line represented in cents
3615
- * @example 9544
3616
- */
3617
- presentment_total_amount?: null | number;
3618
- /**
3619
- * @description The initial presentment discount amount of this Subscription Line represented in cents
3620
- * @example 0
3621
- */
3622
- initial_presentment_discount_amount?: null | number;
3623
- /**
3624
- * @description The initial presentment subtotal amount of this Subscription Line represented in cents
3625
- * @example 7359
3626
- */
3627
- initial_presentment_subtotal_amount?: null | number;
3628
- /**
3629
- * @description The initial presentment gift card usage amount of this Subscription Line represented in cents
3630
- * @example 0
3631
- */
3632
- initial_presentment_giftcard_usage_amount?: null | number;
3633
- /**
3634
- * @description The initial presentment tax amount of this Subscription Line represented in cents
3635
- * @example 1104
3636
- */
3637
- initial_presentment_tax_amount?: null | number;
3638
- /**
3639
- * @description The initial presentment total amount of this Subscription Line represented in cents
3640
- * @example 8463
3641
- */
3642
- initial_presentment_total_amount?: null | number;
3643
- };
3644
- /**
3645
- * @description The type of webhook event
3646
- * @enum {string}
3647
- */
3648
- WebhookEventType: "ON_ORDER_COMPLETED" | "ON_REFUND" | "ON_CHARGEBACK" | "ON_DELIVERY_ITEM_ADDED" | "ON_DELIVERY_ITEM_ACTIVATED" | "ON_DELIVERY_ITEM_USED" | "ON_DELIVERY_ITEM_REVOKED" | "ON_SUBSCRIPTION_ACTIVATED" | "ON_SUBSCRIPTION_RENEWED" | "ON_SUBSCRIPTION_CANCELED" | "ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT" | "ON_CONNECTED_USER_REGISTERED" | "ON_CONNECTED_USER_BECAME_PAYABLE" | "ON_CONNECTED_USER_PAYOUT_CREATED" | "ON_CONNECTED_USER_PAYOUT_COMPLETED" | "ON_CONNECTED_USER_TRANSACTION_INSERTED" | "ON_CONNECTED_USER_BECAME_UNPAYABLE" | "ON_TRIAL_ACTIVATED" | "ON_TRIAL_COMPLETED" | "ON_TRIAL_CANCELED" | "ON_PURCHASE_FOLLOW_UP_ATTEMPT_EMAIL_SENT" | "ON_PURCHASE_FOLLOW_UP_ATTEMPT_SUCCEEDED" | "ON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_EMAIL_SENT" | "ON_ABANDONED_CHECKOUT_RECOVERY_ATTEMPT_SUCCEEDED" | "ON_CHARGEBACK_CLOSED" | "ON_DELIVERY_ITEM_EXPIRED" | "ON_DELIVERY_ITEM_RENEWED";
3649
- };
3650
- responses: never;
3651
- parameters: never;
3652
- requestBodies: never;
3653
- headers: never;
3654
- pathItems: never;
3655
- }
3656
- export type $defs = Record<string, never>;
3657
- export type operations = Record<string, never>;
3658
- export declare const operationMappings: {};
3659
- //# sourceMappingURL=webhooks.d.ts.map