@paynow-gg/typescript-sdk 1.0.29 → 1.0.31

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 (4) hide show
  1. package/dist/generated/webhooks.d.ts +506 -450
  2. package/dist/generated/webhooks.d.ts.map +1 -1
  3. package/dist/generated/webhooks.js.map +1 -1
  4. package/package.json +1 -1
package/dist/generated/webhooks.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export type paths = Record<string, never>;
2
2
  export interface webhooks {
3
- OnSubscriptionRenewed: {
3
+ ON_SUBSCRIPTION_RENEWED: {
4
4
  parameters: {
5
5
  query?: never;
6
6
  header?: never;
@@ -11,7 +11,7 @@ export interface webhooks {
11
11
  put?: never;
12
12
  /**
13
13
  * Triggered when a subscription is renewed
14
- * @description Webhook for OnSubscriptionRenewed
14
+ * @description Webhook for ON_SUBSCRIPTION_RENEWED
15
15
  */
16
16
  post: {
17
17
  parameters: {
@@ -23,177 +23,181 @@ export interface webhooks {
23
23
  requestBody: {
24
24
  content: {
25
25
  "application/json": {
26
+ /**
27
+ * @description The type of webhook event
28
+ * @example ON_SUBSCRIPTION_RENEWED
29
+ */
26
30
  event_type: components["schemas"]["WebhookEventType"];
27
31
  /**
28
32
  * Format: flake-id
29
33
  * @description The ID of the Webhook Event
30
34
  * @example 411486491630370816
31
35
  */
32
- event_id?: string;
36
+ event_id: string;
33
37
  body: {
34
38
  /**
35
39
  * Format: flake-id
36
40
  * @description The Flake ID of the Subscription
37
41
  * @example 411486491630370816
38
42
  */
39
- id?: string;
43
+ id: string;
40
44
  /**
41
45
  * Format: flake-id
42
46
  * @description The Flake ID of the Store associated with the Subscription
43
47
  * @example 411486491630370816
44
48
  */
45
- store_id?: string;
49
+ store_id: string;
46
50
  /**
47
51
  * Format: flake-id
48
52
  * @description The Flake ID of the Customer associated with the Subscription
49
53
  * @example 411486491630370816
50
54
  */
51
- customer_id?: string;
52
- customer?: components["schemas"]["CustomerDTO"];
55
+ customer_id: string;
56
+ customer: components["schemas"]["CustomerDTO"];
53
57
  /**
54
58
  * @description The current billing cycle number
55
59
  * @example 2
56
60
  */
57
- billing_cycle_sequence?: number;
61
+ billing_cycle_sequence: number;
58
62
  /**
59
63
  * @description The billing email address of the customer associated with the Subscription
60
64
  * @example john@doe.com
61
65
  */
62
- billing_email?: string;
66
+ billing_email: string;
63
67
  /**
64
68
  * @description The subtotal amount of the Subscription represented in cents
65
69
  * @example 8999
66
70
  */
67
- subtotal_amount?: number;
71
+ subtotal_amount: number;
68
72
  /**
69
73
  * @description The tax amount of the Subscription represented in cents
70
74
  * @example 1350
71
75
  */
72
- tax_amount?: number;
76
+ tax_amount: number;
73
77
  /**
74
78
  * @description The discount amount applied to the Subscription represented in cents
75
79
  * @example 0
76
80
  */
77
- discount_amount?: number;
81
+ discount_amount: number;
78
82
  /**
79
83
  * @description The total amount of the Subscription represented in cents
80
84
  * @example 10349
81
85
  */
82
- total_amount?: number;
86
+ total_amount: number;
83
87
  /**
84
88
  * @description The currency code of the Subscription
85
89
  * @example USD
86
90
  */
87
- currency?: string;
91
+ currency: string;
88
92
  /**
89
93
  * @description The interval value of the billing cycle
90
94
  * @example 1
91
95
  */
92
- interval_value?: number;
96
+ interval_value: number;
93
97
  /**
94
98
  * @description The interval scale of the billing cycle
95
99
  * @example month
96
100
  */
97
- interval_scale?: string;
101
+ interval_scale: string;
98
102
  /**
99
103
  * Format: flake-id
100
104
  * @description The Flake ID of the Product associated with the Subscription
101
105
  * @example 411486491630370816
102
106
  */
103
- product_id?: string;
107
+ product_id: string;
104
108
  /**
105
109
  * Format: flake-id
106
110
  * @description The Flake ID of the Product Version associated with the Subscription
107
111
  * @example 411486491630370816
108
112
  */
109
- product_version_id?: string;
113
+ product_version_id: string;
110
114
  /**
111
115
  * @description The name of the Product associated with the Subscription
112
116
  * @example Example Product
113
117
  */
114
- product_name?: string;
118
+ product_name: string;
115
119
  /**
116
120
  * @description The image URL of the Product associated with the Subscription
117
121
  * @example https://example.com/biz.jpg
118
122
  */
119
- product_image_url?: string;
120
- product?: components["schemas"]["ProductDTO"];
123
+ product_image_url?: null | string;
124
+ product: components["schemas"]["ProductDTO"];
121
125
  /**
122
126
  * @description The ISO-3166 country code of customer associated with the Subscription
123
127
  * @example US
124
128
  */
125
- billing_country?: string;
129
+ billing_country: string;
126
130
  /**
127
131
  * @description The initial subtotal amount of the Subscription represented in cents
128
132
  * @example 8999
129
133
  */
130
- initial_subtotal_amount?: number;
134
+ initial_subtotal_amount: number;
131
135
  /**
132
136
  * @description The initial tax amount of the Subscription represented in cents
133
137
  * @example 1350
134
138
  */
135
- initial_tax_amount?: number;
139
+ initial_tax_amount: number;
136
140
  /**
137
141
  * @description The initial discount amount applied to the Subscription represented in cents
138
142
  * @example 1500
139
143
  */
140
- initial_discount_amount?: number;
144
+ initial_discount_amount: number;
141
145
  /**
142
146
  * @description The initial gift card usage amount applied to the Subscription represented in cents
143
147
  * @example 0
144
148
  */
145
- initial_giftcard_usage_amount?: number;
149
+ initial_giftcard_usage_amount: number;
146
150
  /**
147
151
  * @description The initial total amount of the Subscription represented in cents
148
152
  * @example 8849
149
153
  */
150
- initial_total_amount?: number;
154
+ initial_total_amount: number;
151
155
  /**
152
156
  * @description The IP address of the Customer
153
157
  * @example 127.0.0.1/24
154
158
  */
155
- customer_ip?: string;
159
+ customer_ip: string;
156
160
  /**
157
161
  * Format: date-time
158
162
  * @description The start date of the current billing period
159
163
  * @example 2024-03-01T00:00:00Z
160
164
  */
161
- current_period_start?: string;
165
+ current_period_start?: null | string;
162
166
  /**
163
167
  * Format: date-time
164
168
  * @description The end date of the current billing period
165
169
  * @example 2024-06-01T00:00:00Z
166
170
  */
167
- current_period_end?: string;
171
+ current_period_end?: null | string;
168
172
  /**
169
173
  * Format: date-time
170
174
  * @description The date and time when the Subscription was created
171
175
  * @example 2024-03-01T11:00:00Z
172
176
  */
173
- created_at?: string;
177
+ created_at?: null | string;
174
178
  /**
175
179
  * Format: date-time
176
180
  * @description Indicates when the subscription was active
177
181
  * @example 2024-03-01T11:05:00Z
178
182
  */
179
- active_at?: string;
183
+ active_at?: null | string;
180
184
  /**
181
185
  * Format: flake-id
182
186
  * @description The Flake ID of the Checkout associated with the Subscription
183
187
  * @example 411486491630370816
184
188
  */
185
- checkout_id?: string;
189
+ checkout_id: string;
186
190
  /**
187
191
  * Format: flake-id
188
192
  * @description The Flake ID of the Checkout Line associated with the Subscription
189
193
  * @example 411486491630370816
190
194
  */
191
- checkout_line_id?: string;
195
+ checkout_line_id: string;
192
196
  /**
193
197
  * @description The current status of the Subscription. Possible options: created, active, canceled
194
198
  * @example created
195
199
  */
196
- status?: string;
200
+ status: string;
197
201
  };
198
202
  };
199
203
  };
@@ -228,7 +232,7 @@ export interface webhooks {
228
232
  patch?: never;
229
233
  trace?: never;
230
234
  };
231
- OnDiscordAccountLinkedToCheckout: {
235
+ ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT: {
232
236
  parameters: {
233
237
  query?: never;
234
238
  header?: never;
@@ -239,7 +243,7 @@ export interface webhooks {
239
243
  put?: never;
240
244
  /**
241
245
  * Triggered when a Discord account is successfully linked to a checkout.
242
- * @description Webhook for OnDiscordAccountLinkedToCheckout
246
+ * @description Webhook for ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
243
247
  */
244
248
  post: {
245
249
  parameters: {
@@ -251,80 +255,84 @@ export interface webhooks {
251
255
  requestBody: {
252
256
  content: {
253
257
  "application/json": {
258
+ /**
259
+ * @description The type of webhook event
260
+ * @example ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
261
+ */
254
262
  event_type: components["schemas"]["WebhookEventType"];
255
263
  /**
256
264
  * Format: flake-id
257
265
  * @description The ID of the Webhook Event
258
266
  * @example 411486491630370816
259
267
  */
260
- event_id?: string;
268
+ event_id: string;
261
269
  body: {
262
270
  /**
263
271
  * Format: flake-id
264
272
  * @description The Flake ID of the Store associated with the Checkout
265
273
  * @example 411486491630370816
266
274
  */
267
- store_id?: string;
275
+ store_id: string;
268
276
  /**
269
277
  * Format: flake-id
270
278
  * @description The Flake ID of the Customer associated with the Checkout
271
279
  * @example 411486491630370816
272
280
  */
273
- customer_id?: string;
274
- customer?: components["schemas"]["CustomerDTO"];
281
+ customer_id: string;
282
+ customer: components["schemas"]["CustomerDTO"];
275
283
  /**
276
284
  * Format: flake-id
277
285
  * @description The Flake ID of the Checkout
278
286
  * @example 411486491630370816
279
287
  */
280
- checkout_id?: string;
288
+ checkout_id: string;
281
289
  /**
282
290
  * Format: flake-id
283
291
  * @description The Flake ID of the Checkout Line
284
292
  * @example 411486491630370816
285
293
  */
286
- checkout_line_id?: string;
294
+ checkout_line_id: string;
287
295
  /**
288
296
  * Format: flake-id
289
297
  * @description The Flake ID of the Order associated with the Checkout
290
298
  * @example 411486491630370816
291
299
  */
292
- order_id?: string;
293
- order?: components["schemas"]["OrderDTO"];
300
+ order_id: string;
301
+ order: components["schemas"]["OrderDTO"];
294
302
  /**
295
303
  * @description The Discord User ID of the linked account
296
304
  * @example 123456789012345678
297
305
  */
298
- discord_user_id?: string;
306
+ discord_user_id: string;
299
307
  /**
300
308
  * @description The Discord username of the linked account
301
309
  * @example john_doe
302
310
  */
303
- discord_user_name?: string;
311
+ discord_user_name: string;
304
312
  /**
305
313
  * @description The Discord avatar hash of the linked account
306
314
  * @example a1b2c3d4e5f6g7h8i9j0
307
315
  */
308
- discord_user_avatar_hash?: string;
316
+ discord_user_avatar_hash: string;
309
317
  /**
310
318
  * Format: flake-id
311
319
  * @description The Flake ID of the Product associated with the Checkout
312
320
  * @example 411486491630370816
313
321
  */
314
- product_id?: string;
322
+ product_id: string;
315
323
  /**
316
324
  * Format: flake-id
317
325
  * @description The Flake ID of the Product Version associated with the Checkout
318
326
  * @example 411486491630370816
319
327
  */
320
- product_version_id?: string;
321
- product?: components["schemas"]["ProductDTO"];
328
+ product_version_id: string;
329
+ product: components["schemas"]["ProductDTO"];
322
330
  /**
323
331
  * Format: date-time
324
332
  * @description Indicates when the Discord account link was enqueued
325
333
  * @example 2024-01-15T10:30:00Z
326
334
  */
327
- enqueued_at?: string;
335
+ enqueued_at?: null | string;
328
336
  };
329
337
  };
330
338
  };
@@ -359,7 +367,7 @@ export interface webhooks {
359
367
  patch?: never;
360
368
  trace?: never;
361
369
  };
362
- OnDeliveryItemAdded: {
370
+ ON_DELIVERY_ITEM_ADDED: {
363
371
  parameters: {
364
372
  query?: never;
365
373
  header?: never;
@@ -370,7 +378,7 @@ export interface webhooks {
370
378
  put?: never;
371
379
  /**
372
380
  * Triggered when a delivery item is added to the customers inventory
373
- * @description Webhook for OnDeliveryItemAdded
381
+ * @description Webhook for ON_DELIVERY_ITEM_ADDED
374
382
  */
375
383
  post: {
376
384
  parameters: {
@@ -382,114 +390,118 @@ export interface webhooks {
382
390
  requestBody: {
383
391
  content: {
384
392
  "application/json": {
393
+ /**
394
+ * @description The type of webhook event
395
+ * @example ON_DELIVERY_ITEM_ADDED
396
+ */
385
397
  event_type: components["schemas"]["WebhookEventType"];
386
398
  /**
387
399
  * Format: flake-id
388
400
  * @description The ID of the Webhook Event
389
401
  * @example 411486491630370816
390
402
  */
391
- event_id?: string;
403
+ event_id: string;
392
404
  body: {
393
405
  /**
394
406
  * Format: flake-id
395
407
  * @description The Flake ID of the Delivery Item
396
408
  * @example 411486491630370816
397
409
  */
398
- id?: string;
410
+ id: string;
399
411
  /**
400
412
  * Format: flake-id
401
413
  * @description The Flake ID of the Store associated with the Delivery Item
402
414
  * @example 411486491630370816
403
415
  */
404
- store_id?: string;
405
- customer?: components["schemas"]["CustomerDTO"];
416
+ store_id: string;
417
+ customer?: components["schemas"]["CustomerDTO"] | null;
406
418
  /**
407
419
  * Format: flake-id
408
420
  * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
409
421
  * @example 411486491630370816
410
422
  */
411
- order_customer_id?: string;
423
+ order_customer_id?: null | string;
412
424
  /**
413
425
  * Format: flake-id
414
426
  * @description The Flake ID of the Checkout associated with the Delivery Item
415
427
  * @example 411486491630370816
416
428
  */
417
- checkout_id?: string;
429
+ checkout_id?: null | string;
418
430
  /**
419
431
  * Format: flake-id
420
432
  * @description The Flake ID of the Order ID associated with the Delivery Item
421
433
  * @example 411486491630370816
422
434
  */
423
- order_id?: string;
435
+ order_id?: null | string;
424
436
  /**
425
437
  * Format: flake-id
426
438
  * @description The Flake Id of the Order Line ID associated with the Delivery Item
427
439
  * @example 411486491630370816
428
440
  */
429
- order_line_id?: string;
441
+ order_line_id?: null | string;
430
442
  /**
431
443
  * Format: flake-id
432
444
  * @description The Flake ID of the Subscription associated with the Delivery Item
433
445
  * @example 411486491630370816
434
446
  */
435
- subscription_id?: string;
447
+ subscription_id?: null | string;
436
448
  /**
437
449
  * Format: flake-id
438
450
  * @description The Flake ID of the Game Server the Delivery Item is associated with
439
451
  * @example 411486491630370816
440
452
  */
441
- execute_on_gameserver_id?: string;
442
- execute_on_gameserver?: components["schemas"]["GameServerDTO"];
453
+ execute_on_gameserver_id?: null | string;
454
+ execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
443
455
  /**
444
456
  * Format: flake-id
445
457
  * @description The associated Product ID of the Delivery Item
446
458
  * @example 411486491630370816
447
459
  */
448
- product_id?: string;
460
+ product_id: string;
449
461
  /**
450
462
  * Format: flake-id
451
463
  * @description The associated Product Version ID of the Delivery Item
452
464
  * @example 411486491630370816
453
465
  */
454
- product_version_id?: string;
455
- product?: components["schemas"]["ProductDTO"];
466
+ product_version_id: string;
467
+ product: components["schemas"]["ProductDTO"];
456
468
  /**
457
469
  * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
458
470
  * @example usable
459
471
  */
460
- state?: string;
472
+ state: string;
461
473
  /**
462
474
  * Format: date-time
463
475
  * @description Indicates when the Delivery Item was added to the customers inventory
464
476
  * @example 2024-01-10T08:00:00Z
465
477
  */
466
- added_at?: string;
478
+ added_at: string;
467
479
  /**
468
480
  * Format: date-time
469
481
  * @description Indicates when the Delivery Item become active
470
482
  * @example 2024-01-10T09:00:00Z
471
483
  */
472
- active_at?: string;
484
+ active_at?: null | string;
473
485
  /**
474
486
  * Format: date-time
475
487
  * @description Indicates when the Delivery Item expires
476
488
  * @example 2024-12-31T23:59:59Z
477
489
  */
478
- expires_at?: string;
490
+ expires_at?: null | string;
479
491
  /**
480
492
  * Format: date-time
481
493
  * @description Indicates when the Delivery Item was removed from the customers inventory
482
494
  * @example 2024-02-01T10:00:00Z
483
495
  */
484
- removed_at?: string;
496
+ removed_at?: null | string;
485
497
  /**
486
498
  * Format: date-time
487
499
  * @description Indicates when the Delivery Item was revoked from the customers inventory
488
500
  * @example 2024-02-05T14:30:00Z
489
501
  */
490
- revoked_at?: string;
502
+ revoked_at?: null | string;
491
503
  /** @description Indicates the reason the delivery item was revoked from the customers inventory */
492
- revoke_reason?: string;
504
+ revoke_reason?: null | string;
493
505
  };
494
506
  };
495
507
  };
@@ -524,7 +536,7 @@ export interface webhooks {
524
536
  patch?: never;
525
537
  trace?: never;
526
538
  };
527
- OnDeliveryItemActivated: {
539
+ ON_DELIVERY_ITEM_ACTIVATED: {
528
540
  parameters: {
529
541
  query?: never;
530
542
  header?: never;
@@ -535,7 +547,7 @@ export interface webhooks {
535
547
  put?: never;
536
548
  /**
537
549
  * Triggered when a delivery item in the customers inventory activates
538
- * @description Webhook for OnDeliveryItemActivated
550
+ * @description Webhook for ON_DELIVERY_ITEM_ACTIVATED
539
551
  */
540
552
  post: {
541
553
  parameters: {
@@ -547,114 +559,118 @@ export interface webhooks {
547
559
  requestBody: {
548
560
  content: {
549
561
  "application/json": {
562
+ /**
563
+ * @description The type of webhook event
564
+ * @example ON_DELIVERY_ITEM_ACTIVATED
565
+ */
550
566
  event_type: components["schemas"]["WebhookEventType"];
551
567
  /**
552
568
  * Format: flake-id
553
569
  * @description The ID of the Webhook Event
554
570
  * @example 411486491630370816
555
571
  */
556
- event_id?: string;
572
+ event_id: string;
557
573
  body: {
558
574
  /**
559
575
  * Format: flake-id
560
576
  * @description The Flake ID of the Delivery Item
561
577
  * @example 411486491630370816
562
578
  */
563
- id?: string;
579
+ id: string;
564
580
  /**
565
581
  * Format: flake-id
566
582
  * @description The Flake ID of the Store associated with the Delivery Item
567
583
  * @example 411486491630370816
568
584
  */
569
- store_id?: string;
570
- customer?: components["schemas"]["CustomerDTO"];
585
+ store_id: string;
586
+ customer?: components["schemas"]["CustomerDTO"] | null;
571
587
  /**
572
588
  * Format: flake-id
573
589
  * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
574
590
  * @example 411486491630370816
575
591
  */
576
- order_customer_id?: string;
592
+ order_customer_id?: null | string;
577
593
  /**
578
594
  * Format: flake-id
579
595
  * @description The Flake ID of the Checkout associated with the Delivery Item
580
596
  * @example 411486491630370816
581
597
  */
582
- checkout_id?: string;
598
+ checkout_id?: null | string;
583
599
  /**
584
600
  * Format: flake-id
585
601
  * @description The Flake ID of the Order ID associated with the Delivery Item
586
602
  * @example 411486491630370816
587
603
  */
588
- order_id?: string;
604
+ order_id?: null | string;
589
605
  /**
590
606
  * Format: flake-id
591
607
  * @description The Flake Id of the Order Line ID associated with the Delivery Item
592
608
  * @example 411486491630370816
593
609
  */
594
- order_line_id?: string;
610
+ order_line_id?: null | string;
595
611
  /**
596
612
  * Format: flake-id
597
613
  * @description The Flake ID of the Subscription associated with the Delivery Item
598
614
  * @example 411486491630370816
599
615
  */
600
- subscription_id?: string;
616
+ subscription_id?: null | string;
601
617
  /**
602
618
  * Format: flake-id
603
619
  * @description The Flake ID of the Game Server the Delivery Item is associated with
604
620
  * @example 411486491630370816
605
621
  */
606
- execute_on_gameserver_id?: string;
607
- execute_on_gameserver?: components["schemas"]["GameServerDTO"];
622
+ execute_on_gameserver_id?: null | string;
623
+ execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
608
624
  /**
609
625
  * Format: flake-id
610
626
  * @description The associated Product ID of the Delivery Item
611
627
  * @example 411486491630370816
612
628
  */
613
- product_id?: string;
629
+ product_id: string;
614
630
  /**
615
631
  * Format: flake-id
616
632
  * @description The associated Product Version ID of the Delivery Item
617
633
  * @example 411486491630370816
618
634
  */
619
- product_version_id?: string;
620
- product?: components["schemas"]["ProductDTO"];
635
+ product_version_id: string;
636
+ product: components["schemas"]["ProductDTO"];
621
637
  /**
622
638
  * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
623
639
  * @example usable
624
640
  */
625
- state?: string;
641
+ state: string;
626
642
  /**
627
643
  * Format: date-time
628
644
  * @description Indicates when the Delivery Item was added to the customers inventory
629
645
  * @example 2024-01-10T08:00:00Z
630
646
  */
631
- added_at?: string;
647
+ added_at: string;
632
648
  /**
633
649
  * Format: date-time
634
650
  * @description Indicates when the Delivery Item become active
635
651
  * @example 2024-01-10T09:00:00Z
636
652
  */
637
- active_at?: string;
653
+ active_at?: null | string;
638
654
  /**
639
655
  * Format: date-time
640
656
  * @description Indicates when the Delivery Item expires
641
657
  * @example 2024-12-31T23:59:59Z
642
658
  */
643
- expires_at?: string;
659
+ expires_at?: null | string;
644
660
  /**
645
661
  * Format: date-time
646
662
  * @description Indicates when the Delivery Item was removed from the customers inventory
647
663
  * @example 2024-02-01T10:00:00Z
648
664
  */
649
- removed_at?: string;
665
+ removed_at?: null | string;
650
666
  /**
651
667
  * Format: date-time
652
668
  * @description Indicates when the Delivery Item was revoked from the customers inventory
653
669
  * @example 2024-02-05T14:30:00Z
654
670
  */
655
- revoked_at?: string;
671
+ revoked_at?: null | string;
656
672
  /** @description Indicates the reason the delivery item was revoked from the customers inventory */
657
- revoke_reason?: string;
673
+ revoke_reason?: null | string;
658
674
  };
659
675
  };
660
676
  };
@@ -689,7 +705,7 @@ export interface webhooks {
689
705
  patch?: never;
690
706
  trace?: never;
691
707
  };
692
- OnDeliveryItemUsed: {
708
+ ON_DELIVERY_ITEM_USED: {
693
709
  parameters: {
694
710
  query?: never;
695
711
  header?: never;
@@ -700,7 +716,7 @@ export interface webhooks {
700
716
  put?: never;
701
717
  /**
702
718
  * Triggered when a delivery item in the customers inventory becomes used
703
- * @description Webhook for OnDeliveryItemUsed
719
+ * @description Webhook for ON_DELIVERY_ITEM_USED
704
720
  */
705
721
  post: {
706
722
  parameters: {
@@ -712,114 +728,118 @@ export interface webhooks {
712
728
  requestBody: {
713
729
  content: {
714
730
  "application/json": {
731
+ /**
732
+ * @description The type of webhook event
733
+ * @example ON_DELIVERY_ITEM_USED
734
+ */
715
735
  event_type: components["schemas"]["WebhookEventType"];
716
736
  /**
717
737
  * Format: flake-id
718
738
  * @description The ID of the Webhook Event
719
739
  * @example 411486491630370816
720
740
  */
721
- event_id?: string;
741
+ event_id: string;
722
742
  body: {
723
743
  /**
724
744
  * Format: flake-id
725
745
  * @description The Flake ID of the Delivery Item
726
746
  * @example 411486491630370816
727
747
  */
728
- id?: string;
748
+ id: string;
729
749
  /**
730
750
  * Format: flake-id
731
751
  * @description The Flake ID of the Store associated with the Delivery Item
732
752
  * @example 411486491630370816
733
753
  */
734
- store_id?: string;
735
- customer?: components["schemas"]["CustomerDTO"];
754
+ store_id: string;
755
+ customer?: components["schemas"]["CustomerDTO"] | null;
736
756
  /**
737
757
  * Format: flake-id
738
758
  * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
739
759
  * @example 411486491630370816
740
760
  */
741
- order_customer_id?: string;
761
+ order_customer_id?: null | string;
742
762
  /**
743
763
  * Format: flake-id
744
764
  * @description The Flake ID of the Checkout associated with the Delivery Item
745
765
  * @example 411486491630370816
746
766
  */
747
- checkout_id?: string;
767
+ checkout_id?: null | string;
748
768
  /**
749
769
  * Format: flake-id
750
770
  * @description The Flake ID of the Order ID associated with the Delivery Item
751
771
  * @example 411486491630370816
752
772
  */
753
- order_id?: string;
773
+ order_id?: null | string;
754
774
  /**
755
775
  * Format: flake-id
756
776
  * @description The Flake Id of the Order Line ID associated with the Delivery Item
757
777
  * @example 411486491630370816
758
778
  */
759
- order_line_id?: string;
779
+ order_line_id?: null | string;
760
780
  /**
761
781
  * Format: flake-id
762
782
  * @description The Flake ID of the Subscription associated with the Delivery Item
763
783
  * @example 411486491630370816
764
784
  */
765
- subscription_id?: string;
785
+ subscription_id?: null | string;
766
786
  /**
767
787
  * Format: flake-id
768
788
  * @description The Flake ID of the Game Server the Delivery Item is associated with
769
789
  * @example 411486491630370816
770
790
  */
771
- execute_on_gameserver_id?: string;
772
- execute_on_gameserver?: components["schemas"]["GameServerDTO"];
791
+ execute_on_gameserver_id?: null | string;
792
+ execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
773
793
  /**
774
794
  * Format: flake-id
775
795
  * @description The associated Product ID of the Delivery Item
776
796
  * @example 411486491630370816
777
797
  */
778
- product_id?: string;
798
+ product_id: string;
779
799
  /**
780
800
  * Format: flake-id
781
801
  * @description The associated Product Version ID of the Delivery Item
782
802
  * @example 411486491630370816
783
803
  */
784
- product_version_id?: string;
785
- product?: components["schemas"]["ProductDTO"];
804
+ product_version_id: string;
805
+ product: components["schemas"]["ProductDTO"];
786
806
  /**
787
807
  * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
788
808
  * @example usable
789
809
  */
790
- state?: string;
810
+ state: string;
791
811
  /**
792
812
  * Format: date-time
793
813
  * @description Indicates when the Delivery Item was added to the customers inventory
794
814
  * @example 2024-01-10T08:00:00Z
795
815
  */
796
- added_at?: string;
816
+ added_at: string;
797
817
  /**
798
818
  * Format: date-time
799
819
  * @description Indicates when the Delivery Item become active
800
820
  * @example 2024-01-10T09:00:00Z
801
821
  */
802
- active_at?: string;
822
+ active_at?: null | string;
803
823
  /**
804
824
  * Format: date-time
805
825
  * @description Indicates when the Delivery Item expires
806
826
  * @example 2024-12-31T23:59:59Z
807
827
  */
808
- expires_at?: string;
828
+ expires_at?: null | string;
809
829
  /**
810
830
  * Format: date-time
811
831
  * @description Indicates when the Delivery Item was removed from the customers inventory
812
832
  * @example 2024-02-01T10:00:00Z
813
833
  */
814
- removed_at?: string;
834
+ removed_at?: null | string;
815
835
  /**
816
836
  * Format: date-time
817
837
  * @description Indicates when the Delivery Item was revoked from the customers inventory
818
838
  * @example 2024-02-05T14:30:00Z
819
839
  */
820
- revoked_at?: string;
840
+ revoked_at?: null | string;
821
841
  /** @description Indicates the reason the delivery item was revoked from the customers inventory */
822
- revoke_reason?: string;
842
+ revoke_reason?: null | string;
823
843
  };
824
844
  };
825
845
  };
@@ -854,7 +874,7 @@ export interface webhooks {
854
874
  patch?: never;
855
875
  trace?: never;
856
876
  };
857
- OnDeliveryItemRevoked: {
877
+ ON_DELIVERY_ITEM_REVOKED: {
858
878
  parameters: {
859
879
  query?: never;
860
880
  header?: never;
@@ -865,7 +885,7 @@ export interface webhooks {
865
885
  put?: never;
866
886
  /**
867
887
  * Triggered when a delivery item is revoked from the customers inventory
868
- * @description Webhook for OnDeliveryItemRevoked
888
+ * @description Webhook for ON_DELIVERY_ITEM_REVOKED
869
889
  */
870
890
  post: {
871
891
  parameters: {
@@ -877,114 +897,118 @@ export interface webhooks {
877
897
  requestBody: {
878
898
  content: {
879
899
  "application/json": {
900
+ /**
901
+ * @description The type of webhook event
902
+ * @example ON_DELIVERY_ITEM_REVOKED
903
+ */
880
904
  event_type: components["schemas"]["WebhookEventType"];
881
905
  /**
882
906
  * Format: flake-id
883
907
  * @description The ID of the Webhook Event
884
908
  * @example 411486491630370816
885
909
  */
886
- event_id?: string;
910
+ event_id: string;
887
911
  body: {
888
912
  /**
889
913
  * Format: flake-id
890
914
  * @description The Flake ID of the Delivery Item
891
915
  * @example 411486491630370816
892
916
  */
893
- id?: string;
917
+ id: string;
894
918
  /**
895
919
  * Format: flake-id
896
920
  * @description The Flake ID of the Store associated with the Delivery Item
897
921
  * @example 411486491630370816
898
922
  */
899
- store_id?: string;
900
- customer?: components["schemas"]["CustomerDTO"];
923
+ store_id: string;
924
+ customer?: components["schemas"]["CustomerDTO"] | null;
901
925
  /**
902
926
  * Format: flake-id
903
927
  * @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
904
928
  * @example 411486491630370816
905
929
  */
906
- order_customer_id?: string;
930
+ order_customer_id?: null | string;
907
931
  /**
908
932
  * Format: flake-id
909
933
  * @description The Flake ID of the Checkout associated with the Delivery Item
910
934
  * @example 411486491630370816
911
935
  */
912
- checkout_id?: string;
936
+ checkout_id?: null | string;
913
937
  /**
914
938
  * Format: flake-id
915
939
  * @description The Flake ID of the Order ID associated with the Delivery Item
916
940
  * @example 411486491630370816
917
941
  */
918
- order_id?: string;
942
+ order_id?: null | string;
919
943
  /**
920
944
  * Format: flake-id
921
945
  * @description The Flake Id of the Order Line ID associated with the Delivery Item
922
946
  * @example 411486491630370816
923
947
  */
924
- order_line_id?: string;
948
+ order_line_id?: null | string;
925
949
  /**
926
950
  * Format: flake-id
927
951
  * @description The Flake ID of the Subscription associated with the Delivery Item
928
952
  * @example 411486491630370816
929
953
  */
930
- subscription_id?: string;
954
+ subscription_id?: null | string;
931
955
  /**
932
956
  * Format: flake-id
933
957
  * @description The Flake ID of the Game Server the Delivery Item is associated with
934
958
  * @example 411486491630370816
935
959
  */
936
- execute_on_gameserver_id?: string;
937
- execute_on_gameserver?: components["schemas"]["GameServerDTO"];
960
+ execute_on_gameserver_id?: null | string;
961
+ execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
938
962
  /**
939
963
  * Format: flake-id
940
964
  * @description The associated Product ID of the Delivery Item
941
965
  * @example 411486491630370816
942
966
  */
943
- product_id?: string;
967
+ product_id: string;
944
968
  /**
945
969
  * Format: flake-id
946
970
  * @description The associated Product Version ID of the Delivery Item
947
971
  * @example 411486491630370816
948
972
  */
949
- product_version_id?: string;
950
- product?: components["schemas"]["ProductDTO"];
973
+ product_version_id: string;
974
+ product: components["schemas"]["ProductDTO"];
951
975
  /**
952
976
  * @description The state of the Delivery Item. Possible options: usable, active, used, revoked, renewed
953
977
  * @example usable
954
978
  */
955
- state?: string;
979
+ state: string;
956
980
  /**
957
981
  * Format: date-time
958
982
  * @description Indicates when the Delivery Item was added to the customers inventory
959
983
  * @example 2024-01-10T08:00:00Z
960
984
  */
961
- added_at?: string;
985
+ added_at: string;
962
986
  /**
963
987
  * Format: date-time
964
988
  * @description Indicates when the Delivery Item become active
965
989
  * @example 2024-01-10T09:00:00Z
966
990
  */
967
- active_at?: string;
991
+ active_at?: null | string;
968
992
  /**
969
993
  * Format: date-time
970
994
  * @description Indicates when the Delivery Item expires
971
995
  * @example 2024-12-31T23:59:59Z
972
996
  */
973
- expires_at?: string;
997
+ expires_at?: null | string;
974
998
  /**
975
999
  * Format: date-time
976
1000
  * @description Indicates when the Delivery Item was removed from the customers inventory
977
1001
  * @example 2024-02-01T10:00:00Z
978
1002
  */
979
- removed_at?: string;
1003
+ removed_at?: null | string;
980
1004
  /**
981
1005
  * Format: date-time
982
1006
  * @description Indicates when the Delivery Item was revoked from the customers inventory
983
1007
  * @example 2024-02-05T14:30:00Z
984
1008
  */
985
- revoked_at?: string;
1009
+ revoked_at?: null | string;
986
1010
  /** @description Indicates the reason the delivery item was revoked from the customers inventory */
987
- revoke_reason?: string;
1011
+ revoke_reason?: null | string;
988
1012
  };
989
1013
  };
990
1014
  };
@@ -1019,7 +1043,7 @@ export interface webhooks {
1019
1043
  patch?: never;
1020
1044
  trace?: never;
1021
1045
  };
1022
- OnOrderCompleted: {
1046
+ ON_ORDER_COMPLETED: {
1023
1047
  parameters: {
1024
1048
  query?: never;
1025
1049
  header?: never;
@@ -1030,7 +1054,7 @@ export interface webhooks {
1030
1054
  put?: never;
1031
1055
  /**
1032
1056
  * Triggered when an order is completed
1033
- * @description Webhook for OnOrderCompleted
1057
+ * @description Webhook for ON_ORDER_COMPLETED
1034
1058
  */
1035
1059
  post: {
1036
1060
  parameters: {
@@ -1042,135 +1066,139 @@ export interface webhooks {
1042
1066
  requestBody: {
1043
1067
  content: {
1044
1068
  "application/json": {
1069
+ /**
1070
+ * @description The type of webhook event
1071
+ * @example ON_ORDER_COMPLETED
1072
+ */
1045
1073
  event_type: components["schemas"]["WebhookEventType"];
1046
1074
  /**
1047
1075
  * Format: flake-id
1048
1076
  * @description The ID of the Webhook Event
1049
1077
  * @example 411486491630370816
1050
1078
  */
1051
- event_id?: string;
1079
+ event_id: string;
1052
1080
  body: {
1053
1081
  /**
1054
1082
  * Format: flake-id
1055
1083
  * @description The Flake ID of the Order
1056
1084
  * @example 411486491630370816
1057
1085
  */
1058
- id?: string;
1086
+ id: string;
1059
1087
  /**
1060
1088
  * Format: flake-id
1061
1089
  * @description The Flake ID of the store associated with the order
1062
1090
  * @example 411486491630370816
1063
1091
  */
1064
- store_id?: string;
1065
- customer?: components["schemas"]["CustomerDTO"];
1092
+ store_id: string;
1093
+ customer: components["schemas"]["CustomerDTO"];
1066
1094
  /**
1067
1095
  * Format: flake-id
1068
1096
  * @description The Flake ID of the Checkout associated with the order
1069
1097
  * @example 411486491630370816
1070
1098
  */
1071
- checkout_id?: string;
1072
- checkout?: components["schemas"]["CheckoutDTO"];
1099
+ checkout_id: string;
1100
+ checkout: components["schemas"]["CheckoutDTO"];
1073
1101
  /**
1074
1102
  * Format: flake-id
1075
1103
  * @description The Flake ID of the Subscription associated with the order
1076
1104
  * @example 411486491630370816
1077
1105
  */
1078
- subscription_id?: string;
1106
+ subscription_id?: null | string;
1079
1107
  /**
1080
1108
  * Format: flake-id
1081
1109
  * @description The Flake ID of the Coupon associated with the order
1082
1110
  * @example 411486491630370816
1083
1111
  */
1084
- coupon_id?: string;
1112
+ coupon_id?: null | string;
1085
1113
  /**
1086
1114
  * @description The ISO-4217 Currency Code of the order
1087
1115
  * @example USD
1088
1116
  */
1089
- currency?: string;
1117
+ currency: string;
1090
1118
  /**
1091
1119
  * @description Indicates if the order value was inclusive of tax
1092
1120
  * @example true
1093
1121
  */
1094
- tax_inclusive?: boolean;
1122
+ tax_inclusive: boolean;
1095
1123
  /**
1096
1124
  * @description The tax amount, represented as cents
1097
1125
  * @example 1500
1098
1126
  */
1099
- tax_amount?: number;
1127
+ tax_amount: number;
1100
1128
  /**
1101
1129
  * @description The discount amount, represented as cents
1102
1130
  * @example 500
1103
1131
  */
1104
- discount_amount?: number;
1132
+ discount_amount: number;
1105
1133
  /**
1106
1134
  * @description The subtotal amount, represented as cents
1107
1135
  * @example 10000
1108
1136
  */
1109
- subtotal_amount?: number;
1137
+ subtotal_amount: number;
1110
1138
  /**
1111
1139
  * @description The total amount, represented as cents
1112
1140
  * @example 11000
1113
1141
  */
1114
- total_amount?: number;
1142
+ total_amount: number;
1115
1143
  /**
1116
1144
  * Format: date-time
1117
1145
  * @description Indicates when the order was created
1118
1146
  * @example 2024-01-15T10:30:00Z
1119
1147
  */
1120
- created_at?: string;
1148
+ created_at: string;
1121
1149
  /**
1122
1150
  * Format: date-time
1123
1151
  * @description Indicates when the order was completed
1124
1152
  * @example 2024-01-15T10:35:00Z
1125
1153
  */
1126
- completed_at?: string;
1154
+ completed_at: string;
1127
1155
  /**
1128
1156
  * @description The billing name of the customer associated with the order
1129
1157
  * @example John Doe
1130
1158
  */
1131
- billing_name?: string;
1159
+ billing_name: string;
1132
1160
  /**
1133
1161
  * @description The billing email address of the customer associated with the order
1134
1162
  * @example john@doe.com
1135
1163
  */
1136
- billing_email?: string;
1164
+ billing_email: string;
1137
1165
  /**
1138
1166
  * @description The ISO-3316 Country Code of the customer associated with the order
1139
1167
  * @example US
1140
1168
  */
1141
- billing_address_country?: string;
1169
+ billing_address_country: string;
1142
1170
  /**
1143
1171
  * @description The IPv4 or IPv6 Address of the associated customer when creating the order
1144
1172
  * @example 127.0.0.1/24
1145
1173
  */
1146
- customer_ip?: string;
1174
+ customer_ip: string;
1147
1175
  /**
1148
1176
  * @description The total amount of giftcard usage associated with the order, represented in cents
1149
1177
  * @example 0
1150
1178
  */
1151
- giftcard_usage_amount?: number;
1179
+ giftcard_usage_amount: number;
1152
1180
  /** @description The order lines associated with the order */
1153
- lines?: components["schemas"]["OrderLineDTO"][];
1181
+ lines: components["schemas"]["OrderLineDTO"][];
1154
1182
  /**
1155
1183
  * @description A comma-seperated string of the names of the product associated with the order
1156
1184
  * @example Product A, Product B
1157
1185
  */
1158
- product_names?: string;
1186
+ product_names: string;
1159
1187
  /**
1160
1188
  * @description A comma-seperated string of the tags of the products associated with the order
1161
1189
  * @example ranks, perks
1162
1190
  */
1163
- product_tags?: string;
1191
+ product_tags: string;
1164
1192
  /**
1165
1193
  * @description A comma-seperated string of the gameservers of the product associated with the order
1166
1194
  * @example game server one, game server two
1167
1195
  */
1168
- product_gameservers?: string;
1196
+ product_gameservers: string;
1169
1197
  /**
1170
1198
  * @description The status of the Order. Possbile options: created, completed, canceled
1171
1199
  * @example created
1172
1200
  */
1173
- status?: string;
1201
+ status: string;
1174
1202
  };
1175
1203
  };
1176
1204
  };
@@ -1205,7 +1233,7 @@ export interface webhooks {
1205
1233
  patch?: never;
1206
1234
  trace?: never;
1207
1235
  };
1208
- OnChargeback: {
1236
+ ON_CHARGEBACK: {
1209
1237
  parameters: {
1210
1238
  query?: never;
1211
1239
  header?: never;
@@ -1216,7 +1244,7 @@ export interface webhooks {
1216
1244
  put?: never;
1217
1245
  /**
1218
1246
  * Triggered when a chargeback is created
1219
- * @description Webhook for OnChargeback
1247
+ * @description Webhook for ON_CHARGEBACK
1220
1248
  */
1221
1249
  post: {
1222
1250
  parameters: {
@@ -1228,81 +1256,85 @@ export interface webhooks {
1228
1256
  requestBody: {
1229
1257
  content: {
1230
1258
  "application/json": {
1259
+ /**
1260
+ * @description The type of webhook event
1261
+ * @example ON_CHARGEBACK
1262
+ */
1231
1263
  event_type: components["schemas"]["WebhookEventType"];
1232
1264
  /**
1233
1265
  * Format: flake-id
1234
1266
  * @description The ID of the Webhook Event
1235
1267
  * @example 411486491630370816
1236
1268
  */
1237
- event_id?: string;
1269
+ event_id: string;
1238
1270
  body: {
1239
1271
  /**
1240
1272
  * Format: flake-id
1241
1273
  * @description The Flake ID of the Payment associated with the Payment
1242
1274
  * @example 411486491630370816
1243
1275
  */
1244
- id?: string;
1276
+ id: string;
1245
1277
  /**
1246
1278
  * Format: flake-id
1247
1279
  * @description The Flake ID of the Store associated with the Payment
1248
1280
  * @example 411486491630370816
1249
1281
  */
1250
- store_id?: string;
1282
+ store_id: string;
1251
1283
  /**
1252
1284
  * Format: flake-id
1253
1285
  * @description The Flake ID of the Order associated with Payment
1254
1286
  * @example 411486491630370816
1255
1287
  */
1256
- order_id?: string;
1257
- customer?: components["schemas"]["CustomerDTO"];
1288
+ order_id: string;
1289
+ customer?: components["schemas"]["CustomerDTO"] | null;
1258
1290
  /**
1259
1291
  * @description The Payment Gateway of the Payment
1260
1292
  * @example stripe
1261
1293
  */
1262
- gateway?: string;
1294
+ gateway: string;
1263
1295
  /**
1264
1296
  * @description The ISO-4217 Currency Code of the Payment
1265
1297
  * @example USD
1266
1298
  */
1267
- currency?: string;
1299
+ currency: string;
1268
1300
  /**
1269
1301
  * @description Indicates if the payment was Tax Inclusive
1270
1302
  * @example true
1271
1303
  */
1272
- tax_inclusive?: boolean;
1304
+ tax_inclusive: boolean;
1273
1305
  /**
1274
1306
  * @description The payment amount, represented in cents
1275
1307
  * @example 7500
1276
1308
  */
1277
- amount?: number;
1309
+ amount: number;
1278
1310
  /**
1279
1311
  * @description The gateway fee amount, represented in cents
1280
1312
  * @example 200
1281
1313
  */
1282
- gateway_fee_amount?: number;
1314
+ gateway_fee_amount: number;
1283
1315
  /**
1284
1316
  * @description The tax amount, represented in cents
1285
1317
  * @example 1200
1286
1318
  */
1287
- tax_amount?: number;
1319
+ tax_amount: number;
1288
1320
  /**
1289
1321
  * @description The platform fee amount, represented in cents
1290
1322
  * @example 375
1291
1323
  */
1292
- platform_fee_amount?: number;
1324
+ platform_fee_amount: number;
1293
1325
  /**
1294
1326
  * @description The net amount recieved by the associated store, represented in cents
1295
1327
  * @example 5925
1296
1328
  */
1297
- store_net_amount?: number;
1329
+ store_net_amount: number;
1298
1330
  /** @description The status of the payment */
1299
- status?: string;
1331
+ status: string;
1300
1332
  /**
1301
1333
  * Format: date-time
1302
1334
  * @description Indicated when a chargeback was opened for the payment
1303
1335
  * @example 2024-01-25T14:45:00Z
1304
1336
  */
1305
- chargeback_at?: string;
1337
+ chargeback_at: string;
1306
1338
  };
1307
1339
  };
1308
1340
  };
@@ -1337,7 +1369,7 @@ export interface webhooks {
1337
1369
  patch?: never;
1338
1370
  trace?: never;
1339
1371
  };
1340
- OnRefund: {
1372
+ ON_REFUND: {
1341
1373
  parameters: {
1342
1374
  query?: never;
1343
1375
  header?: never;
@@ -1348,7 +1380,7 @@ export interface webhooks {
1348
1380
  put?: never;
1349
1381
  /**
1350
1382
  * Triggered when a refund is completed
1351
- * @description Webhook for OnRefund
1383
+ * @description Webhook for ON_REFUND
1352
1384
  */
1353
1385
  post: {
1354
1386
  parameters: {
@@ -1360,115 +1392,119 @@ export interface webhooks {
1360
1392
  requestBody: {
1361
1393
  content: {
1362
1394
  "application/json": {
1395
+ /**
1396
+ * @description The type of webhook event
1397
+ * @example ON_REFUND
1398
+ */
1363
1399
  event_type: components["schemas"]["WebhookEventType"];
1364
1400
  /**
1365
1401
  * Format: flake-id
1366
1402
  * @description The ID of the Webhook Event
1367
1403
  * @example 411486491630370816
1368
1404
  */
1369
- event_id?: string;
1405
+ event_id: string;
1370
1406
  body: {
1371
1407
  /**
1372
1408
  * Format: flake-id
1373
1409
  * @description The Flake ID of the Refund
1374
1410
  * @example 411486491630370816
1375
1411
  */
1376
- id?: string;
1412
+ id: string;
1377
1413
  /**
1378
1414
  * Format: flake-id
1379
1415
  * @description The Flake ID of the store associated with the Refund
1380
1416
  * @example 411486491630370816
1381
1417
  */
1382
- store_id?: string;
1418
+ store_id: string;
1383
1419
  /**
1384
1420
  * Format: flake-id
1385
1421
  * @description The Flake ID of Order associated with the refund
1386
1422
  * @example 411486491630370816
1387
1423
  */
1388
- order_id?: string;
1389
- customer?: components["schemas"]["CustomerDTO"];
1424
+ order_id: string;
1425
+ customer?: components["schemas"]["CustomerDTO"] | null;
1390
1426
  /**
1391
1427
  * Format: flake-id
1392
1428
  * @description The Flake ID of the Payment associated with the refund
1393
1429
  * @example 411486491630370816
1394
1430
  */
1395
- payment_id?: string;
1431
+ payment_id: string;
1396
1432
  /** @description The Payment Gateway associated with the refund */
1397
- gateway?: string;
1433
+ gateway: string;
1398
1434
  /**
1399
1435
  * @description The ISO-4217 Currency Code of the Payment
1400
1436
  * @example USD
1401
1437
  */
1402
- currency?: string;
1438
+ currency: string;
1403
1439
  /**
1404
1440
  * @description Indicates if taxes were inclusive in the associated payment
1405
1441
  * @example false
1406
1442
  */
1407
- tax_inclusive?: boolean;
1443
+ tax_inclusive: boolean;
1408
1444
  /**
1409
1445
  * @description The initial payment amount, represented in cents
1410
1446
  * @example 5000
1411
1447
  */
1412
- amount?: number;
1448
+ amount: number;
1413
1449
  /**
1414
1450
  * @description The initial gateway fee amount, represented in cents
1415
1451
  * @example 150
1416
1452
  */
1417
- gateway_fee_amount?: number;
1453
+ gateway_fee_amount: number;
1418
1454
  /**
1419
1455
  * @description The initial tax amount, represented in cents
1420
1456
  * @example 800
1421
1457
  */
1422
- tax_amount?: number;
1458
+ tax_amount: number;
1423
1459
  /**
1424
1460
  * @description The initial platform fee amount, represented in cents
1425
1461
  * @example 250
1426
1462
  */
1427
- platform_fee_amount?: number;
1463
+ platform_fee_amount: number;
1428
1464
  /**
1429
1465
  * @description The initial store net amount, represented in cents
1430
1466
  * @example 3800
1431
1467
  */
1432
- store_net_amount?: number;
1468
+ store_net_amount: number;
1433
1469
  /**
1434
1470
  * @description The amount refunded to the store, represented in cents
1435
1471
  * @example 5000
1436
1472
  */
1437
- store_refund_amount?: number;
1473
+ store_refund_amount: number;
1438
1474
  /**
1439
1475
  * Format: date-time
1440
1476
  * @description Indicates when the refund was created
1441
1477
  * @example 2024-01-20T12:00:00Z
1442
1478
  */
1443
- created_at?: string;
1479
+ created_at: string;
1444
1480
  /**
1445
1481
  * Format: date-time
1446
1482
  * @description Indicates when the refund was approved
1447
1483
  * @example 2024-01-20T12:30:00Z
1448
1484
  */
1449
- approved_at?: string;
1485
+ approved_at: string;
1450
1486
  /**
1451
1487
  * Format: date-time
1452
1488
  * @description Indicates when the refund was pending
1453
1489
  * @example 2024-01-20T12:15:00Z
1454
1490
  */
1455
- pending_at?: string;
1491
+ pending_at: string;
1456
1492
  /**
1457
1493
  * Format: date-time
1458
1494
  * @description Indicates when the refund was completed
1459
1495
  * @example 2024-01-20T13:00:00Z
1460
1496
  */
1461
- completed_at?: string;
1497
+ completed_at: string;
1462
1498
  /**
1463
1499
  * @description The email address of the intial payment customer
1464
1500
  * @example john@doe.com
1465
1501
  */
1466
- billing_email?: string;
1502
+ billing_email: string;
1467
1503
  /**
1468
1504
  * @description The status of the refund. Possible options: created, approved, processing, completed, canceled, failed
1469
1505
  * @example created
1470
1506
  */
1471
- status?: string;
1507
+ status: string;
1472
1508
  };
1473
1509
  };
1474
1510
  };
@@ -1503,7 +1539,7 @@ export interface webhooks {
1503
1539
  patch?: never;
1504
1540
  trace?: never;
1505
1541
  };
1506
- OnSubscriptionActivated: {
1542
+ ON_SUBSCRIPTION_ACTIVATED: {
1507
1543
  parameters: {
1508
1544
  query?: never;
1509
1545
  header?: never;
@@ -1514,7 +1550,7 @@ export interface webhooks {
1514
1550
  put?: never;
1515
1551
  /**
1516
1552
  * Triggered when a subscription is activated
1517
- * @description Webhook for OnSubscriptionActivated
1553
+ * @description Webhook for ON_SUBSCRIPTION_ACTIVATED
1518
1554
  */
1519
1555
  post: {
1520
1556
  parameters: {
@@ -1526,177 +1562,181 @@ export interface webhooks {
1526
1562
  requestBody: {
1527
1563
  content: {
1528
1564
  "application/json": {
1565
+ /**
1566
+ * @description The type of webhook event
1567
+ * @example ON_SUBSCRIPTION_ACTIVATED
1568
+ */
1529
1569
  event_type: components["schemas"]["WebhookEventType"];
1530
1570
  /**
1531
1571
  * Format: flake-id
1532
1572
  * @description The ID of the Webhook Event
1533
1573
  * @example 411486491630370816
1534
1574
  */
1535
- event_id?: string;
1575
+ event_id: string;
1536
1576
  body: {
1537
1577
  /**
1538
1578
  * Format: flake-id
1539
1579
  * @description The Flake ID of the Subscription
1540
1580
  * @example 411486491630370816
1541
1581
  */
1542
- id?: string;
1582
+ id: string;
1543
1583
  /**
1544
1584
  * Format: flake-id
1545
1585
  * @description The Flake ID of the Store associated with the Subscription
1546
1586
  * @example 411486491630370816
1547
1587
  */
1548
- store_id?: string;
1588
+ store_id: string;
1549
1589
  /**
1550
1590
  * Format: flake-id
1551
1591
  * @description The Flake ID of the Customer associated with the Subscription
1552
1592
  * @example 411486491630370816
1553
1593
  */
1554
- customer_id?: string;
1555
- customer?: components["schemas"]["CustomerDTO"];
1594
+ customer_id: string;
1595
+ customer: components["schemas"]["CustomerDTO"];
1556
1596
  /**
1557
1597
  * @description The current billing cycle number
1558
1598
  * @example 1
1559
1599
  */
1560
- billing_cycle_sequence?: number;
1600
+ billing_cycle_sequence: number;
1561
1601
  /**
1562
1602
  * @description The billing email address of the customer associated with the Subscription
1563
1603
  * @example john@doe.com
1564
1604
  */
1565
- billing_email?: string;
1605
+ billing_email: string;
1566
1606
  /**
1567
1607
  * @description The subtotal amount of the Subscription represented in cents
1568
1608
  * @example 9999
1569
1609
  */
1570
- subtotal_amount?: number;
1610
+ subtotal_amount: number;
1571
1611
  /**
1572
1612
  * @description The tax amount of the Subscription represented in cents
1573
1613
  * @example 1500
1574
1614
  */
1575
- tax_amount?: number;
1615
+ tax_amount: number;
1576
1616
  /**
1577
1617
  * @description The discount amount applied to the Subscription represented in cents
1578
1618
  * @example 1000
1579
1619
  */
1580
- discount_amount?: number;
1620
+ discount_amount: number;
1581
1621
  /**
1582
1622
  * @description The total amount of the Subscription represented in cents
1583
1623
  * @example 10499
1584
1624
  */
1585
- total_amount?: number;
1625
+ total_amount: number;
1586
1626
  /**
1587
1627
  * @description The currency code of the Subscription
1588
1628
  * @example USD
1589
1629
  */
1590
- currency?: string;
1630
+ currency: string;
1591
1631
  /**
1592
1632
  * @description The interval value of the billing cycle
1593
1633
  * @example 1
1594
1634
  */
1595
- interval_value?: number;
1635
+ interval_value: number;
1596
1636
  /**
1597
1637
  * @description The interval scale of the billing cycle
1598
1638
  * @example month
1599
1639
  */
1600
- interval_scale?: string;
1640
+ interval_scale: string;
1601
1641
  /**
1602
1642
  * Format: flake-id
1603
1643
  * @description The Flake ID of the Product associated with the Subscription
1604
1644
  * @example 411486491630370816
1605
1645
  */
1606
- product_id?: string;
1646
+ product_id: string;
1607
1647
  /**
1608
1648
  * Format: flake-id
1609
1649
  * @description The Flake ID of the Product Version associated with the Subscription
1610
1650
  * @example 411486491630370816
1611
1651
  */
1612
- product_version_id?: string;
1652
+ product_version_id: string;
1613
1653
  /**
1614
1654
  * @description The name of the Product associated with the Subscription
1615
1655
  * @example Example Product
1616
1656
  */
1617
- product_name?: string;
1657
+ product_name: string;
1618
1658
  /**
1619
1659
  * @description The image URL of the Product associated with the Subscription
1620
1660
  * @example https://example.com/image.jpg
1621
1661
  */
1622
- product_image_url?: string;
1623
- product?: components["schemas"]["ProductDTO"];
1662
+ product_image_url?: null | string;
1663
+ product: components["schemas"]["ProductDTO"];
1624
1664
  /**
1625
1665
  * @description The ISO-3166 Country Code of customer associated with the Subscription
1626
1666
  * @example US
1627
1667
  */
1628
- billing_country?: string;
1668
+ billing_country: string;
1629
1669
  /**
1630
1670
  * @description The initial subtotal amount of the Subscription represented in cents
1631
1671
  * @example 9999
1632
1672
  */
1633
- initial_subtotal_amount?: number;
1673
+ initial_subtotal_amount: number;
1634
1674
  /**
1635
1675
  * @description The initial tax amount of the Subscription represented in cents
1636
1676
  * @example 1500
1637
1677
  */
1638
- initial_tax_amount?: number;
1678
+ initial_tax_amount: number;
1639
1679
  /**
1640
1680
  * @description The initial discount amount applied to the Subscription represented in cents
1641
1681
  * @example 2000
1642
1682
  */
1643
- initial_discount_amount?: number;
1683
+ initial_discount_amount: number;
1644
1684
  /**
1645
1685
  * @description The initial gift card usage amount applied to the Subscription represented in cents
1646
1686
  * @example 0
1647
1687
  */
1648
- initial_giftcard_usage_amount?: number;
1688
+ initial_giftcard_usage_amount: number;
1649
1689
  /**
1650
1690
  * @description The initial total amount of the Subscription represented in cents
1651
1691
  * @example 9499
1652
1692
  */
1653
- initial_total_amount?: number;
1693
+ initial_total_amount: number;
1654
1694
  /**
1655
1695
  * @description The IP address of the Customer
1656
1696
  * @example 127.0.0.1/24
1657
1697
  */
1658
- customer_ip?: string;
1698
+ customer_ip: string;
1659
1699
  /**
1660
1700
  * Format: date-time
1661
1701
  * @description The start date of the current billing period
1662
1702
  * @example 2024-02-01T00:00:00Z
1663
1703
  */
1664
- current_period_start?: string;
1704
+ current_period_start?: null | string;
1665
1705
  /**
1666
1706
  * Format: date-time
1667
1707
  * @description The end date of the current billing period
1668
1708
  * @example 2024-03-01T00:00:00Z
1669
1709
  */
1670
- current_period_end?: string;
1710
+ current_period_end?: null | string;
1671
1711
  /**
1672
1712
  * Format: date-time
1673
1713
  * @description The date and time when the Subscription was created
1674
1714
  * @example 2024-02-01T10:15:00Z
1675
1715
  */
1676
- created_at?: string;
1716
+ created_at?: null | string;
1677
1717
  /**
1678
1718
  * Format: date-time
1679
1719
  * @description Indicates when the subscription was active
1680
1720
  * @example 2024-02-01T10:20:00Z
1681
1721
  */
1682
- active_at?: string;
1722
+ active_at?: null | string;
1683
1723
  /**
1684
1724
  * Format: flake-id
1685
1725
  * @description The Flake ID of the Checkout associated with the Subscription
1686
1726
  * @example 411486491630370816
1687
1727
  */
1688
- checkout_id?: string;
1728
+ checkout_id: string;
1689
1729
  /**
1690
1730
  * Format: flake-id
1691
1731
  * @description The Flake ID of the Checkout Line associated with the Subscription
1692
1732
  * @example 411486491630370816
1693
1733
  */
1694
- checkout_line_id?: string;
1734
+ checkout_line_id: string;
1695
1735
  /**
1696
1736
  * @description The current status of the Subscription. Possible options: created, active, canceled
1697
1737
  * @example created
1698
1738
  */
1699
- status?: string;
1739
+ status: string;
1700
1740
  };
1701
1741
  };
1702
1742
  };
@@ -1731,7 +1771,7 @@ export interface webhooks {
1731
1771
  patch?: never;
1732
1772
  trace?: never;
1733
1773
  };
1734
- OnSubscriptionCanceled: {
1774
+ ON_SUBSCRIPTION_CANCELED: {
1735
1775
  parameters: {
1736
1776
  query?: never;
1737
1777
  header?: never;
@@ -1742,7 +1782,7 @@ export interface webhooks {
1742
1782
  put?: never;
1743
1783
  /**
1744
1784
  * Triggered when a subscription is canceled
1745
- * @description Webhook for OnSubscriptionCanceled
1785
+ * @description Webhook for ON_SUBSCRIPTION_CANCELED
1746
1786
  */
1747
1787
  post: {
1748
1788
  parameters: {
@@ -1754,188 +1794,192 @@ export interface webhooks {
1754
1794
  requestBody: {
1755
1795
  content: {
1756
1796
  "application/json": {
1797
+ /**
1798
+ * @description The type of webhook event
1799
+ * @example ON_SUBSCRIPTION_CANCELED
1800
+ */
1757
1801
  event_type: components["schemas"]["WebhookEventType"];
1758
1802
  /**
1759
1803
  * Format: flake-id
1760
1804
  * @description The ID of the Webhook Event
1761
1805
  * @example 411486491630370816
1762
1806
  */
1763
- event_id?: string;
1807
+ event_id: string;
1764
1808
  body: {
1765
1809
  /**
1766
1810
  * Format: flake-id
1767
1811
  * @description The Flake ID of the Subscription
1768
1812
  * @example 411486491630370816
1769
1813
  */
1770
- id?: string;
1814
+ id: string;
1771
1815
  /**
1772
1816
  * Format: flake-id
1773
1817
  * @description The Flake ID of the Store associated with the Subscription
1774
1818
  * @example 411486491630370816
1775
1819
  */
1776
- store_id?: string;
1820
+ store_id: string;
1777
1821
  /**
1778
1822
  * Format: flake-id
1779
1823
  * @description The Flake ID of the Customer associated with the Subscription
1780
1824
  * @example 411486491630370816
1781
1825
  */
1782
- customer_id?: string;
1783
- customer?: components["schemas"]["CustomerDTO"];
1826
+ customer_id: string;
1827
+ customer: components["schemas"]["CustomerDTO"];
1784
1828
  /**
1785
1829
  * @description The current billing cycle number
1786
1830
  * @example 1
1787
1831
  */
1788
- billing_cycle_sequence?: number;
1832
+ billing_cycle_sequence: number;
1789
1833
  /**
1790
1834
  * @description The billing email address of the customer associated with the Subscription
1791
1835
  * @example cancel@example.com
1792
1836
  */
1793
- billing_email?: string;
1837
+ billing_email: string;
1794
1838
  /**
1795
1839
  * @description The subtotal amount of the Subscription represented in cents
1796
1840
  * @example 4999
1797
1841
  */
1798
- subtotal_amount?: number;
1842
+ subtotal_amount: number;
1799
1843
  /**
1800
1844
  * @description The tax amount of the Subscription represented in cents
1801
1845
  * @example 750
1802
1846
  */
1803
- tax_amount?: number;
1847
+ tax_amount: number;
1804
1848
  /**
1805
1849
  * @description The discount amount applied to the Subscription represented in cents
1806
1850
  * @example 0
1807
1851
  */
1808
- discount_amount?: number;
1852
+ discount_amount: number;
1809
1853
  /**
1810
1854
  * @description The total amount of the Subscription represented in cents
1811
1855
  * @example 5749
1812
1856
  */
1813
- total_amount?: number;
1857
+ total_amount: number;
1814
1858
  /**
1815
1859
  * @description The currency code of the Subscription
1816
1860
  * @example USD
1817
1861
  */
1818
- currency?: string;
1862
+ currency: string;
1819
1863
  /**
1820
1864
  * @description The interval value of the billing cycle
1821
1865
  * @example 1
1822
1866
  */
1823
- interval_value?: number;
1867
+ interval_value: number;
1824
1868
  /**
1825
1869
  * @description The interval scale of the billing cycle
1826
1870
  * @example annually
1827
1871
  */
1828
- interval_scale?: string;
1872
+ interval_scale: string;
1829
1873
  /**
1830
1874
  * Format: flake-id
1831
1875
  * @description The Flake ID of the Product associated with the Subscription
1832
1876
  * @example 411486491630370816
1833
1877
  */
1834
- product_id?: string;
1878
+ product_id: string;
1835
1879
  /**
1836
1880
  * Format: flake-id
1837
1881
  * @description The Flake ID of the Product Version associated with the Subscription
1838
1882
  * @example 411486491630370816
1839
1883
  */
1840
- product_version_id?: string;
1884
+ product_version_id: string;
1841
1885
  /**
1842
1886
  * @description The name of the Product associated with the Subscription
1843
1887
  * @example Starter Plan
1844
1888
  */
1845
- product_name?: string;
1889
+ product_name: string;
1846
1890
  /**
1847
1891
  * @description The image URL of the Product associated with the Subscription
1848
1892
  * @example https://example.com/starter.jpg
1849
1893
  */
1850
- product_image_url?: string;
1851
- product?: components["schemas"]["ProductDTO"];
1894
+ product_image_url?: null | string;
1895
+ product: components["schemas"]["ProductDTO"];
1852
1896
  /**
1853
1897
  * @description The ISO-3166 country code of customer associated with the Subscription
1854
1898
  * @example US
1855
1899
  */
1856
- billing_country?: string;
1900
+ billing_country: string;
1857
1901
  /**
1858
1902
  * @description The initial subtotal amount of the Subscription represented in cents
1859
1903
  * @example 4999
1860
1904
  */
1861
- initial_subtotal_amount?: number;
1905
+ initial_subtotal_amount: number;
1862
1906
  /**
1863
1907
  * @description The initial tax amount of the Subscription represented in cents
1864
1908
  * @example 750
1865
1909
  */
1866
- initial_tax_amount?: number;
1910
+ initial_tax_amount: number;
1867
1911
  /**
1868
1912
  * @description The initial discount amount applied to the Subscription represented in cents
1869
1913
  * @example 500
1870
1914
  */
1871
- initial_discount_amount?: number;
1915
+ initial_discount_amount: number;
1872
1916
  /**
1873
1917
  * @description The initial gift card usage amount applied to the Subscription represented in cents
1874
1918
  * @example 0
1875
1919
  */
1876
- initial_giftcard_usage_amount?: number;
1920
+ initial_giftcard_usage_amount: number;
1877
1921
  /**
1878
1922
  * @description The initial total amount of the Subscription represented in cents
1879
1923
  * @example 5249
1880
1924
  */
1881
- initial_total_amount?: number;
1925
+ initial_total_amount: number;
1882
1926
  /**
1883
1927
  * @description The IP address of the Customer
1884
1928
  * @example 127.0.0.1/24
1885
1929
  */
1886
- customer_ip?: string;
1930
+ customer_ip: string;
1887
1931
  /**
1888
1932
  * Format: date-time
1889
1933
  * @description The start date of the current billing period
1890
1934
  * @example 2024-04-01T00:00:00Z
1891
1935
  */
1892
- current_period_start?: string;
1936
+ current_period_start?: null | string;
1893
1937
  /**
1894
1938
  * Format: date-time
1895
1939
  * @description The end date of the current billing period
1896
1940
  * @example 2025-04-01T00:00:00Z
1897
1941
  */
1898
- current_period_end?: string;
1942
+ current_period_end?: null | string;
1899
1943
  /**
1900
1944
  * Format: date-time
1901
1945
  * @description The date and time when the Subscription was created
1902
1946
  * @example 2024-04-01T09:30:00Z
1903
1947
  */
1904
- created_at?: string;
1948
+ created_at?: null | string;
1905
1949
  /**
1906
1950
  * Format: date-time
1907
1951
  * @description Indicates when the subscription was active
1908
1952
  * @example 2024-04-01T09:35:00Z
1909
1953
  */
1910
- active_at?: string;
1954
+ active_at?: null | string;
1911
1955
  /**
1912
1956
  * Format: date-time
1913
1957
  * @description Indicates when the subscription was canceled
1914
1958
  * @example 2024-05-15T14:20:00Z
1915
1959
  */
1916
- canceled_at?: string;
1960
+ canceled_at?: null | string;
1917
1961
  /**
1918
1962
  * @description The reason for the subscription cancellation
1919
1963
  * @example customer_request
1920
1964
  */
1921
- cancel_reason?: string;
1965
+ cancel_reason?: null | string;
1922
1966
  /**
1923
1967
  * Format: flake-id
1924
1968
  * @description The Flake ID of the Checkout associated with the Subscription
1925
1969
  * @example 411486491630370816
1926
1970
  */
1927
- checkout_id?: string;
1971
+ checkout_id: string;
1928
1972
  /**
1929
1973
  * Format: flake-id
1930
1974
  * @description The Flake ID of the Checkout Line associated with the Subscription
1931
1975
  * @example 411486491630370816
1932
1976
  */
1933
- checkout_line_id?: string;
1977
+ checkout_line_id: string;
1934
1978
  /**
1935
1979
  * @description The current status of the Subscription. Possible options: created, active, canceled
1936
1980
  * @example created
1937
1981
  */
1938
- status?: string;
1982
+ status: string;
1939
1983
  };
1940
1984
  };
1941
1985
  };
@@ -1970,7 +2014,7 @@ export interface webhooks {
1970
2014
  patch?: never;
1971
2015
  trace?: never;
1972
2016
  };
1973
- OnTrialActivated: {
2017
+ ON_TRIAL_ACTIVATED: {
1974
2018
  parameters: {
1975
2019
  query?: never;
1976
2020
  header?: never;
@@ -1981,7 +2025,7 @@ export interface webhooks {
1981
2025
  put?: never;
1982
2026
  /**
1983
2027
  * Triggered when a trial is activated
1984
- * @description Webhook for OnTrialActivated
2028
+ * @description Webhook for ON_TRIAL_ACTIVATED
1985
2029
  */
1986
2030
  post: {
1987
2031
  parameters: {
@@ -1993,106 +2037,110 @@ export interface webhooks {
1993
2037
  requestBody: {
1994
2038
  content: {
1995
2039
  "application/json": {
2040
+ /**
2041
+ * @description The type of webhook event
2042
+ * @example ON_TRIAL_ACTIVATED
2043
+ */
1996
2044
  event_type: components["schemas"]["WebhookEventType"];
1997
2045
  /**
1998
2046
  * Format: flake-id
1999
2047
  * @description The ID of the Webhook Event
2000
2048
  * @example 411486491630370816
2001
2049
  */
2002
- event_id?: string;
2050
+ event_id: string;
2003
2051
  body: {
2004
2052
  /**
2005
2053
  * Format: flake-id
2006
2054
  * @description The Flake ID of the Trial
2007
2055
  * @example 411486491630370816
2008
2056
  */
2009
- id?: string;
2057
+ id: string;
2010
2058
  /**
2011
2059
  * Format: flake-id
2012
2060
  * @description The Flake ID of the Store associated with the Trial
2013
2061
  * @example 411486491630370816
2014
2062
  */
2015
- store_id?: string;
2063
+ store_id: string;
2016
2064
  /**
2017
2065
  * Format: flake-id
2018
2066
  * @description The Flake ID of the Customer associated with the Trial
2019
2067
  * @example 411486491630370816
2020
2068
  */
2021
- customer_id?: string;
2022
- customer?: components["schemas"]["CustomerDTO"];
2069
+ customer_id: string;
2070
+ customer: components["schemas"]["CustomerDTO"];
2023
2071
  /**
2024
2072
  * Format: flake-id
2025
2073
  * @description The Flake ID of the Checkout associated with the Trial
2026
2074
  * @example 411486491630370816
2027
2075
  */
2028
- checkout_id?: string;
2076
+ checkout_id?: null | string;
2029
2077
  /**
2030
2078
  * Format: flake-id
2031
2079
  * @description The Flake ID of the Checkout Line associated with the Trial
2032
2080
  * @example 411486491630370816
2033
2081
  */
2034
- checkout_line_id?: string;
2082
+ checkout_line_id?: null | string;
2035
2083
  /**
2036
2084
  * Format: flake-id
2037
2085
  * @description The Flake ID of the Product associated with the Trial
2038
2086
  * @example 411486491630370816
2039
2087
  */
2040
- product_id?: string;
2088
+ product_id: string;
2041
2089
  /**
2042
2090
  * Format: flake-id
2043
2091
  * @description The Flake ID of the Product Version associated with the Trial
2044
2092
  * @example 411486491630370816
2045
2093
  */
2046
- product_version_id?: string;
2094
+ product_version_id: string;
2047
2095
  /**
2048
2096
  * @description The name of the Product associated with the Trial
2049
2097
  * @example Example Product
2050
2098
  */
2051
- product_name?: string;
2099
+ product_name: string;
2052
2100
  /**
2053
2101
  * @description The image URL of the Product associated with the Trial
2054
2102
  * @example https://example.com/image.jpg
2055
2103
  */
2056
- product_image_url?: string;
2104
+ product_image_url?: null | string;
2057
2105
  /**
2058
2106
  * @description The period value of the Trial
2059
2107
  * @example 1
2060
2108
  */
2061
- period_value?: number;
2109
+ period_value: number;
2062
2110
  /**
2063
2111
  * @description The period scale of the Trial
2064
2112
  * @example month
2065
2113
  */
2066
- period_scale?: string;
2114
+ period_scale: string;
2067
2115
  /**
2068
2116
  * Format: date-time
2069
2117
  * @description The start date of the Trial
2070
2118
  * @example 2024-06-10T00:00:00Z
2071
2119
  */
2072
- starts_at?: string;
2120
+ starts_at?: null | string;
2073
2121
  /**
2074
2122
  * Format: date-time
2075
2123
  * @description The end date of the Trial
2076
2124
  * @example 2024-06-17T23:59:59Z
2077
2125
  */
2078
- ends_at?: string;
2126
+ ends_at?: null | string;
2079
2127
  /**
2080
2128
  * @description The current status of the Trial. Possible options: created, active, canceled, completed
2081
2129
  * @example created
2082
2130
  */
2083
- status?: string;
2131
+ status: string;
2084
2132
  /**
2085
2133
  * Format: date-time
2086
2134
  * @description The date and time when the Trial was created
2087
2135
  * @example 2024-06-10T08:30:00Z
2088
2136
  */
2089
- created_at?: string;
2137
+ created_at: string;
2090
2138
  /**
2091
2139
  * Format: date-time
2092
2140
  * @description Indicates when the Trial was canceled
2093
2141
  * @example 2024-06-15T10:15:00Z
2094
2142
  */
2095
- canceled_at?: string;
2143
+ canceled_at?: null | string;
2096
2144
  };
2097
2145
  };
2098
2146
  };
@@ -2127,7 +2175,7 @@ export interface webhooks {
2127
2175
  patch?: never;
2128
2176
  trace?: never;
2129
2177
  };
2130
- OnTrialCompleted: {
2178
+ ON_TRIAL_COMPLETED: {
2131
2179
  parameters: {
2132
2180
  query?: never;
2133
2181
  header?: never;
@@ -2138,7 +2186,7 @@ export interface webhooks {
2138
2186
  put?: never;
2139
2187
  /**
2140
2188
  * Triggered when a trial is completed
2141
- * @description Webhook for OnTrialCompleted
2189
+ * @description Webhook for ON_TRIAL_COMPLETED
2142
2190
  */
2143
2191
  post: {
2144
2192
  parameters: {
@@ -2150,106 +2198,110 @@ export interface webhooks {
2150
2198
  requestBody: {
2151
2199
  content: {
2152
2200
  "application/json": {
2201
+ /**
2202
+ * @description The type of webhook event
2203
+ * @example ON_TRIAL_COMPLETED
2204
+ */
2153
2205
  event_type: components["schemas"]["WebhookEventType"];
2154
2206
  /**
2155
2207
  * Format: flake-id
2156
2208
  * @description The ID of the Webhook Event
2157
2209
  * @example 411486491630370816
2158
2210
  */
2159
- event_id?: string;
2211
+ event_id: string;
2160
2212
  body: {
2161
2213
  /**
2162
2214
  * Format: flake-id
2163
2215
  * @description The Flake ID of the Trial
2164
2216
  * @example 411486491630370816
2165
2217
  */
2166
- id?: string;
2218
+ id: string;
2167
2219
  /**
2168
2220
  * Format: flake-id
2169
2221
  * @description The Flake ID of the Store associated with the Trial
2170
2222
  * @example 411486491630370816
2171
2223
  */
2172
- store_id?: string;
2224
+ store_id: string;
2173
2225
  /**
2174
2226
  * Format: flake-id
2175
2227
  * @description The Flake ID of the Customer associated with the Trial
2176
2228
  * @example 411486491630370816
2177
2229
  */
2178
- customer_id?: string;
2179
- customer?: components["schemas"]["CustomerDTO"];
2230
+ customer_id: string;
2231
+ customer: components["schemas"]["CustomerDTO"];
2180
2232
  /**
2181
2233
  * Format: flake-id
2182
2234
  * @description The Flake ID of the Checkout associated with the Trial
2183
2235
  * @example 411486491630370816
2184
2236
  */
2185
- checkout_id?: string;
2237
+ checkout_id?: null | string;
2186
2238
  /**
2187
2239
  * Format: flake-id
2188
2240
  * @description The Flake ID of the Checkout Line associated with the Trial
2189
2241
  * @example 411486491630370816
2190
2242
  */
2191
- checkout_line_id?: string;
2243
+ checkout_line_id?: null | string;
2192
2244
  /**
2193
2245
  * Format: flake-id
2194
2246
  * @description The Flake ID of the Product associated with the Trial
2195
2247
  * @example 411486491630370816
2196
2248
  */
2197
- product_id?: string;
2249
+ product_id: string;
2198
2250
  /**
2199
2251
  * Format: flake-id
2200
2252
  * @description The Flake ID of the Product Version associated with the Trial
2201
2253
  * @example 411486491630370816
2202
2254
  */
2203
- product_version_id?: string;
2255
+ product_version_id: string;
2204
2256
  /**
2205
2257
  * @description The name of the Product associated with the Trial
2206
2258
  * @example Example Product
2207
2259
  */
2208
- product_name?: string;
2260
+ product_name: string;
2209
2261
  /**
2210
2262
  * @description The image URL of the Product associated with the Trial
2211
2263
  * @example https://example.com/image.jpg
2212
2264
  */
2213
- product_image_url?: string;
2265
+ product_image_url?: null | string;
2214
2266
  /**
2215
2267
  * @description The period value of the Trial
2216
2268
  * @example 1
2217
2269
  */
2218
- period_value?: number;
2270
+ period_value: number;
2219
2271
  /**
2220
2272
  * @description The period scale of the Trial
2221
2273
  * @example month
2222
2274
  */
2223
- period_scale?: string;
2275
+ period_scale: string;
2224
2276
  /**
2225
2277
  * Format: date-time
2226
2278
  * @description The start date of the Trial
2227
2279
  * @example 2024-06-10T00:00:00Z
2228
2280
  */
2229
- starts_at?: string;
2281
+ starts_at?: null | string;
2230
2282
  /**
2231
2283
  * Format: date-time
2232
2284
  * @description The end date of the Trial
2233
2285
  * @example 2024-06-17T23:59:59Z
2234
2286
  */
2235
- ends_at?: string;
2287
+ ends_at?: null | string;
2236
2288
  /**
2237
2289
  * @description The current status of the Trial. Possible options: created, active, canceled, completed
2238
2290
  * @example created
2239
2291
  */
2240
- status?: string;
2292
+ status: string;
2241
2293
  /**
2242
2294
  * Format: date-time
2243
2295
  * @description The date and time when the Trial was created
2244
2296
  * @example 2024-06-10T08:30:00Z
2245
2297
  */
2246
- created_at?: string;
2298
+ created_at: string;
2247
2299
  /**
2248
2300
  * Format: date-time
2249
2301
  * @description Indicates when the Trial was canceled
2250
2302
  * @example 2024-06-15T10:15:00Z
2251
2303
  */
2252
- canceled_at?: string;
2304
+ canceled_at?: null | string;
2253
2305
  };
2254
2306
  };
2255
2307
  };
@@ -2284,7 +2336,7 @@ export interface webhooks {
2284
2336
  patch?: never;
2285
2337
  trace?: never;
2286
2338
  };
2287
- OnTrialCanceled: {
2339
+ ON_TRIAL_CANCELED: {
2288
2340
  parameters: {
2289
2341
  query?: never;
2290
2342
  header?: never;
@@ -2295,7 +2347,7 @@ export interface webhooks {
2295
2347
  put?: never;
2296
2348
  /**
2297
2349
  * Triggered when a trial is canceled
2298
- * @description Webhook for OnTrialCanceled
2350
+ * @description Webhook for ON_TRIAL_CANCELED
2299
2351
  */
2300
2352
  post: {
2301
2353
  parameters: {
@@ -2307,106 +2359,110 @@ export interface webhooks {
2307
2359
  requestBody: {
2308
2360
  content: {
2309
2361
  "application/json": {
2362
+ /**
2363
+ * @description The type of webhook event
2364
+ * @example ON_TRIAL_CANCELED
2365
+ */
2310
2366
  event_type: components["schemas"]["WebhookEventType"];
2311
2367
  /**
2312
2368
  * Format: flake-id
2313
2369
  * @description The ID of the Webhook Event
2314
2370
  * @example 411486491630370816
2315
2371
  */
2316
- event_id?: string;
2372
+ event_id: string;
2317
2373
  body: {
2318
2374
  /**
2319
2375
  * Format: flake-id
2320
2376
  * @description The Flake ID of the Trial
2321
2377
  * @example 411486491630370816
2322
2378
  */
2323
- id?: string;
2379
+ id: string;
2324
2380
  /**
2325
2381
  * Format: flake-id
2326
2382
  * @description The Flake ID of the Store associated with the Trial
2327
2383
  * @example 411486491630370816
2328
2384
  */
2329
- store_id?: string;
2385
+ store_id: string;
2330
2386
  /**
2331
2387
  * Format: flake-id
2332
2388
  * @description The Flake ID of the Customer associated with the Trial
2333
2389
  * @example 411486491630370816
2334
2390
  */
2335
- customer_id?: string;
2336
- customer?: components["schemas"]["CustomerDTO"];
2391
+ customer_id: string;
2392
+ customer: components["schemas"]["CustomerDTO"];
2337
2393
  /**
2338
2394
  * Format: flake-id
2339
2395
  * @description The Flake ID of the Checkout associated with the Trial
2340
2396
  * @example 411486491630370816
2341
2397
  */
2342
- checkout_id?: string;
2398
+ checkout_id?: null | string;
2343
2399
  /**
2344
2400
  * Format: flake-id
2345
2401
  * @description The Flake ID of the Checkout Line associated with the Trial
2346
2402
  * @example 411486491630370816
2347
2403
  */
2348
- checkout_line_id?: string;
2404
+ checkout_line_id?: null | string;
2349
2405
  /**
2350
2406
  * Format: flake-id
2351
2407
  * @description The Flake ID of the Product associated with the Trial
2352
2408
  * @example 411486491630370816
2353
2409
  */
2354
- product_id?: string;
2410
+ product_id: string;
2355
2411
  /**
2356
2412
  * Format: flake-id
2357
2413
  * @description The Flake ID of the Product Version associated with the Trial
2358
2414
  * @example 411486491630370816
2359
2415
  */
2360
- product_version_id?: string;
2416
+ product_version_id: string;
2361
2417
  /**
2362
2418
  * @description The name of the Product associated with the Trial
2363
2419
  * @example Example Product
2364
2420
  */
2365
- product_name?: string;
2421
+ product_name: string;
2366
2422
  /**
2367
2423
  * @description The image URL of the Product associated with the Trial
2368
2424
  * @example https://example.com/image.jpg
2369
2425
  */
2370
- product_image_url?: string;
2426
+ product_image_url?: null | string;
2371
2427
  /**
2372
2428
  * @description The period value of the Trial
2373
2429
  * @example 1
2374
2430
  */
2375
- period_value?: number;
2431
+ period_value: number;
2376
2432
  /**
2377
2433
  * @description The period scale of the Trial
2378
2434
  * @example month
2379
2435
  */
2380
- period_scale?: string;
2436
+ period_scale: string;
2381
2437
  /**
2382
2438
  * Format: date-time
2383
2439
  * @description The start date of the Trial
2384
2440
  * @example 2024-06-10T00:00:00Z
2385
2441
  */
2386
- starts_at?: string;
2442
+ starts_at?: null | string;
2387
2443
  /**
2388
2444
  * Format: date-time
2389
2445
  * @description The end date of the Trial
2390
2446
  * @example 2024-06-17T23:59:59Z
2391
2447
  */
2392
- ends_at?: string;
2448
+ ends_at?: null | string;
2393
2449
  /**
2394
2450
  * @description The current status of the Trial. Possible options: created, active, canceled, completed
2395
2451
  * @example created
2396
2452
  */
2397
- status?: string;
2453
+ status: string;
2398
2454
  /**
2399
2455
  * Format: date-time
2400
2456
  * @description The date and time when the Trial was created
2401
2457
  * @example 2024-06-10T08:30:00Z
2402
2458
  */
2403
- created_at?: string;
2459
+ created_at: string;
2404
2460
  /**
2405
2461
  * Format: date-time
2406
2462
  * @description Indicates when the Trial was canceled
2407
2463
  * @example 2024-06-15T10:15:00Z
2408
2464
  */
2409
- canceled_at?: string;
2465
+ canceled_at?: null | string;
2410
2466
  };
2411
2467
  };
2412
2468
  };
@@ -2450,13 +2506,13 @@ export interface components {
2450
2506
  * @description The Flake ID of the Checkout
2451
2507
  * @example 411486491630370816
2452
2508
  */
2453
- id?: string;
2509
+ id: string;
2454
2510
  /** @description Metadata associated with the checkout */
2455
- metadata?: {
2511
+ metadata: {
2456
2512
  [key: string]: string;
2457
2513
  };
2458
2514
  /** @description The lines of the Checkout */
2459
- lines?: components["schemas"]["CheckoutLineDTO"][];
2515
+ lines: components["schemas"]["CheckoutLineDTO"][];
2460
2516
  };
2461
2517
  CheckoutLineDTO: {
2462
2518
  /**
@@ -2464,21 +2520,21 @@ export interface components {
2464
2520
  * @description The ID of the Checkout line
2465
2521
  * @example 411486491630370816
2466
2522
  */
2467
- id?: string;
2523
+ id: string;
2468
2524
  /**
2469
2525
  * Format: flake-id
2470
2526
  * @description The Product Flake ID of the Checkout Line
2471
2527
  * @example 411486491630370816
2472
2528
  */
2473
- product_id?: string;
2529
+ product_id: string;
2474
2530
  /**
2475
2531
  * Format: flake-id
2476
2532
  * @description The Product Version Flake ID of the Checkout Line
2477
2533
  * @example 411486491630370816
2478
2534
  */
2479
- product_version_id?: string;
2535
+ product_version_id: string;
2480
2536
  /** @description Metadata associated with the Checkout Line */
2481
- metadata?: {
2537
+ metadata: {
2482
2538
  [key: string]: string;
2483
2539
  };
2484
2540
  };
@@ -2488,12 +2544,12 @@ export interface components {
2488
2544
  * @description The Flake ID of the Customer
2489
2545
  * @example 411486491630370816
2490
2546
  */
2491
- id?: string;
2547
+ id: string;
2492
2548
  /** @example John */
2493
- name?: string;
2494
- steam?: components["schemas"]["SteamCustomerDTO"];
2495
- minecraft?: components["schemas"]["MinecraftCustomerDTO"];
2496
- profile?: components["schemas"]["GenericProfileDTO"];
2549
+ name?: null | string;
2550
+ steam: components["schemas"]["SteamCustomerDTO"];
2551
+ minecraft: components["schemas"]["MinecraftCustomerDTO"];
2552
+ profile: components["schemas"]["GenericProfileDTO"];
2497
2553
  };
2498
2554
  GameServerDTO: {
2499
2555
  /**
@@ -2501,27 +2557,27 @@ export interface components {
2501
2557
  * @description The Flake ID of the Game Server
2502
2558
  * @example 411486491630370816
2503
2559
  */
2504
- id?: string;
2560
+ id: string;
2505
2561
  /**
2506
2562
  * @description The name of the Game Server
2507
2563
  * @example John
2508
2564
  */
2509
- name?: string;
2565
+ name: string;
2510
2566
  /** @description Indicates if the Game Server is enabled */
2511
- enabled?: boolean;
2567
+ enabled: boolean;
2512
2568
  };
2513
2569
  GenericProfileDTO: {
2514
- id?: string;
2515
- platform?: string;
2570
+ id: string;
2571
+ platform: string;
2516
2572
  /** @example John */
2517
- name?: string;
2518
- avatar_url?: string;
2573
+ name: string;
2574
+ avatar_url: string;
2519
2575
  };
2520
2576
  MinecraftCustomerDTO: {
2521
- id?: string;
2577
+ id: string;
2522
2578
  /** @example Notch */
2523
- name?: string;
2524
- avatar_url?: string;
2579
+ name: string;
2580
+ avatar_url: string;
2525
2581
  };
2526
2582
  OrderDTO: {
2527
2583
  /**
@@ -2529,122 +2585,122 @@ export interface components {
2529
2585
  * @description The Flake ID of the Order
2530
2586
  * @example 411486491630370816
2531
2587
  */
2532
- id?: string;
2588
+ id: string;
2533
2589
  /**
2534
2590
  * Format: flake-id
2535
2591
  * @description The Flake ID of the store associated with the order
2536
2592
  * @example 411486491630370816
2537
2593
  */
2538
- store_id?: string;
2539
- customer?: components["schemas"]["CustomerDTO"];
2594
+ store_id: string;
2595
+ customer: components["schemas"]["CustomerDTO"];
2540
2596
  /**
2541
2597
  * Format: flake-id
2542
2598
  * @description The Flake ID of the Checkout associated with the order
2543
2599
  * @example 411486491630370816
2544
2600
  */
2545
- checkout_id?: string;
2546
- checkout?: components["schemas"]["CheckoutDTO"];
2601
+ checkout_id: string;
2602
+ checkout: components["schemas"]["CheckoutDTO"];
2547
2603
  /**
2548
2604
  * Format: flake-id
2549
2605
  * @description The Flake ID of the Subscription associated with the order
2550
2606
  * @example 411486491630370816
2551
2607
  */
2552
- subscription_id?: string;
2608
+ subscription_id?: null | string;
2553
2609
  /**
2554
2610
  * Format: flake-id
2555
2611
  * @description The Flake ID of the Coupon associated with the order
2556
2612
  * @example 411486491630370816
2557
2613
  */
2558
- coupon_id?: string;
2614
+ coupon_id?: null | string;
2559
2615
  /**
2560
2616
  * @description The ISO-4217 Currency Code of the order
2561
2617
  * @example USD
2562
2618
  */
2563
- currency?: string;
2619
+ currency: string;
2564
2620
  /**
2565
2621
  * @description Indicates if the order value was inclusive of tax
2566
2622
  * @example true
2567
2623
  */
2568
- tax_inclusive?: boolean;
2624
+ tax_inclusive: boolean;
2569
2625
  /**
2570
2626
  * @description The tax amount, represented as cents
2571
2627
  * @example 1500
2572
2628
  */
2573
- tax_amount?: number;
2629
+ tax_amount: number;
2574
2630
  /**
2575
2631
  * @description The discount amount, represented as cents
2576
2632
  * @example 500
2577
2633
  */
2578
- discount_amount?: number;
2634
+ discount_amount: number;
2579
2635
  /**
2580
2636
  * @description The subtotal amount, represented as cents
2581
2637
  * @example 10000
2582
2638
  */
2583
- subtotal_amount?: number;
2639
+ subtotal_amount: number;
2584
2640
  /**
2585
2641
  * @description The total amount, represented as cents
2586
2642
  * @example 11000
2587
2643
  */
2588
- total_amount?: number;
2644
+ total_amount: number;
2589
2645
  /**
2590
2646
  * Format: date-time
2591
2647
  * @description Indicates when the order was created
2592
2648
  * @example 2024-01-15T10:30:00Z
2593
2649
  */
2594
- created_at?: string;
2650
+ created_at: string;
2595
2651
  /**
2596
2652
  * Format: date-time
2597
2653
  * @description Indicates when the order was completed
2598
2654
  * @example 2024-01-15T10:35:00Z
2599
2655
  */
2600
- completed_at?: string;
2656
+ completed_at: string;
2601
2657
  /**
2602
2658
  * @description The billing name of the customer associated with the order
2603
2659
  * @example John Doe
2604
2660
  */
2605
- billing_name?: string;
2661
+ billing_name: string;
2606
2662
  /**
2607
2663
  * @description The billing email address of the customer associated with the order
2608
2664
  * @example john@doe.com
2609
2665
  */
2610
- billing_email?: string;
2666
+ billing_email: string;
2611
2667
  /**
2612
2668
  * @description The ISO-3316 Country Code of the customer associated with the order
2613
2669
  * @example US
2614
2670
  */
2615
- billing_address_country?: string;
2671
+ billing_address_country: string;
2616
2672
  /**
2617
2673
  * @description The IPv4 or IPv6 Address of the associated customer when creating the order
2618
2674
  * @example 127.0.0.1/24
2619
2675
  */
2620
- customer_ip?: string;
2676
+ customer_ip: string;
2621
2677
  /**
2622
2678
  * @description The total amount of giftcard usage associated with the order, represented in cents
2623
2679
  * @example 0
2624
2680
  */
2625
- giftcard_usage_amount?: number;
2681
+ giftcard_usage_amount: number;
2626
2682
  /** @description The order lines associated with the order */
2627
- lines?: components["schemas"]["OrderLineDTO"][];
2683
+ lines: components["schemas"]["OrderLineDTO"][];
2628
2684
  /**
2629
2685
  * @description A comma-seperated string of the names of the product associated with the order
2630
2686
  * @example Product A, Product B
2631
2687
  */
2632
- product_names?: string;
2688
+ product_names: string;
2633
2689
  /**
2634
2690
  * @description A comma-seperated string of the tags of the products associated with the order
2635
2691
  * @example ranks, perks
2636
2692
  */
2637
- product_tags?: string;
2693
+ product_tags: string;
2638
2694
  /**
2639
2695
  * @description A comma-seperated string of the gameservers of the product associated with the order
2640
2696
  * @example game server one, game server two
2641
2697
  */
2642
- product_gameservers?: string;
2698
+ product_gameservers: string;
2643
2699
  /**
2644
2700
  * @description The status of the Order. Possbile options: created, completed, canceled
2645
2701
  * @example created
2646
2702
  */
2647
- status?: string;
2703
+ status: string;
2648
2704
  };
2649
2705
  OrderLineDTO: {
2650
2706
  /**
@@ -2652,100 +2708,100 @@ export interface components {
2652
2708
  * @description The Flake ID of the Order Line
2653
2709
  * @example 411486491630370816
2654
2710
  */
2655
- id?: string;
2711
+ id: string;
2656
2712
  /**
2657
2713
  * Format: flake-id
2658
2714
  * @description The Flake ID of the Checkout Line associated with this Order Line
2659
2715
  * @example 411486491630370816
2660
2716
  */
2661
- checkout_line_id?: string;
2717
+ checkout_line_id: string;
2662
2718
  /**
2663
2719
  * Format: flake-id
2664
2720
  * @description The Flake ID of the Product ID associated with this Order Line
2665
2721
  * @example 411486491630370816
2666
2722
  */
2667
- product_id?: string;
2723
+ product_id: string;
2668
2724
  /**
2669
2725
  * Format: flake-id
2670
2726
  * @description The Flake ID of the Product Version ID associated with this Order Line
2671
2727
  * @example 411486491630370816
2672
2728
  */
2673
- product_version_id?: string;
2674
- product?: components["schemas"]["ProductDTO"];
2729
+ product_version_id: string;
2730
+ product: components["schemas"]["ProductDTO"];
2675
2731
  /** @description The name of the product associated with this Order Line */
2676
- product_name?: string;
2732
+ product_name: string;
2677
2733
  /** @description The Image URL of the Product associated with this Order Line */
2678
- product_image_url?: string;
2734
+ product_image_url?: null | string;
2679
2735
  /**
2680
2736
  * Format: flake-id
2681
2737
  * @description The Flake ID of the Subscription associated with this Order Line
2682
2738
  * @example 411486491630370816
2683
2739
  */
2684
- subscription_id?: string;
2740
+ subscription_id?: null | string;
2685
2741
  /**
2686
2742
  * @description The value of the interval in which the subscription associated with this Order Line renews at
2687
2743
  * @example 1
2688
2744
  */
2689
- subscription_interval_value?: number;
2745
+ subscription_interval_value?: null | number;
2690
2746
  /**
2691
2747
  * @description The value of the scale in which the subscription associated with this Order Line renews at
2692
2748
  * @example month
2693
2749
  */
2694
- subscription_interval_scale?: string;
2750
+ subscription_interval_scale?: null | string;
2695
2751
  /**
2696
2752
  * Format: flake-id
2697
2753
  * @description The Flake ID of the Trial associated with this Order Line
2698
2754
  * @example 411486491630370816
2699
2755
  */
2700
- trial_id?: string;
2701
- gift_to_customer?: components["schemas"]["CustomerDTO"];
2756
+ trial_id?: null | string;
2757
+ gift_to_customer?: components["schemas"]["CustomerDTO"] | null;
2702
2758
  /**
2703
2759
  * @description The price of the Order Line
2704
2760
  * @example 1000
2705
2761
  */
2706
- price?: number;
2762
+ price: number;
2707
2763
  /**
2708
2764
  * @description The quantity of the Order Line
2709
2765
  * @example 1
2710
2766
  */
2711
- quantity?: number;
2767
+ quantity: number;
2712
2768
  /**
2713
2769
  * @description The discount amount of the order line, represented in cents
2714
2770
  * @example 0
2715
2771
  */
2716
- discount_amount?: number;
2772
+ discount_amount: number;
2717
2773
  /**
2718
2774
  * @description The subtotal amount of the order line, represented in cents
2719
2775
  * @example 1000
2720
2776
  */
2721
- subtotal_amount?: number;
2777
+ subtotal_amount: number;
2722
2778
  /**
2723
2779
  * @description The tax amount of the order line, represented in cents
2724
2780
  * @example 100
2725
2781
  */
2726
- tax_amount?: number;
2782
+ tax_amount: number;
2727
2783
  /**
2728
2784
  * @description The total amount of the order line, represented in cents
2729
2785
  * @example 1100
2730
2786
  */
2731
- total_amount?: number;
2787
+ total_amount: number;
2732
2788
  /**
2733
2789
  * Format: flake-id
2734
2790
  * @description The Flake ID of which was the selected Game Server ID for the Order Line
2735
2791
  * @example 411486491630370816
2736
2792
  */
2737
- selected_gameserver_id?: string;
2793
+ selected_gameserver_id?: null | string;
2738
2794
  };
2739
2795
  ProductCommandDTO: {
2740
2796
  /**
2741
2797
  * @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
2742
2798
  * @example on_purchase
2743
2799
  */
2744
- stage?: string;
2800
+ stage: string;
2745
2801
  /** @description The command to execute */
2746
- content?: string;
2802
+ content: string;
2747
2803
  /** @description Indicated if the command should be executed only when the customer is online */
2748
- online_only?: boolean;
2804
+ online_only: boolean;
2749
2805
  };
2750
2806
  ProductDTO: {
2751
2807
  /**
@@ -2753,85 +2809,85 @@ export interface components {
2753
2809
  * @description The Flake ID of the Product
2754
2810
  * @example 411486491630370816
2755
2811
  */
2756
- id?: string;
2812
+ id: string;
2757
2813
  /**
2758
2814
  * Format: flake-id
2759
2815
  * @description The Flake ID of the Store
2760
2816
  * @example 411486491630370816
2761
2817
  */
2762
- store_id?: string;
2818
+ store_id: string;
2763
2819
  /**
2764
2820
  * Format: flake-id
2765
2821
  * @description The Flake ID of the Version of the Product
2766
2822
  * @example 411486491630370816
2767
2823
  */
2768
- version_id?: string;
2824
+ version_id: string;
2769
2825
  /** @description The Image URL of the product */
2770
- image_url?: string;
2826
+ image_url?: null | string;
2771
2827
  /** @description The URL-Friendly Slug of the Product */
2772
- slug?: string;
2828
+ slug: string;
2773
2829
  /** @description The name of the Product */
2774
- name?: string;
2830
+ name: string;
2775
2831
  /** @description The description of the product */
2776
- description?: string;
2832
+ description: string;
2777
2833
  /** @description Indicates if the product is enabled. */
2778
- enabled?: boolean;
2834
+ enabled: boolean;
2779
2835
  /** @description The label of the product */
2780
- label?: string;
2836
+ label?: null | string;
2781
2837
  /** @description The sort order of the product */
2782
- sort_order?: number;
2838
+ sort_order: number;
2783
2839
  /** @description The price of the product, represented in cents. */
2784
- price?: number;
2840
+ price: number;
2785
2841
  /** @description Indicates if the customer must select a single game server when purchasing the product */
2786
- single_game_server_only?: boolean;
2842
+ single_game_server_only: boolean;
2787
2843
  /** @description Indicates if one-time purchases are supported on the product */
2788
- allow_one_time_purchase?: boolean;
2844
+ allow_one_time_purchase: boolean;
2789
2845
  /** @description Indicates if subscriptions are supported on the product */
2790
- allow_subscription?: boolean;
2846
+ allow_subscription: boolean;
2791
2847
  /**
2792
2848
  * @description The value of the interval in which the product subscription renews at
2793
2849
  * @example 1
2794
2850
  */
2795
- subscription_interval_value?: number;
2851
+ subscription_interval_value?: null | number;
2796
2852
  /**
2797
2853
  * @description The value of the interval in which the product subscription renews at
2798
2854
  * @example month
2799
2855
  */
2800
- subscription_interval_scale?: string;
2856
+ subscription_interval_scale?: null | string;
2801
2857
  /** @description Indicates whether automatic removal is enabled */
2802
- remove_after_enabled?: boolean;
2858
+ remove_after_enabled: boolean;
2803
2859
  /**
2804
2860
  * @description The value of the time in which this product should be removed
2805
2861
  * @example 1
2806
2862
  */
2807
- remove_after_time_value?: number;
2863
+ remove_after_time_value?: null | number;
2808
2864
  /**
2809
2865
  * @description The scale of the time in which this product should be removed
2810
2866
  * @example month
2811
2867
  */
2812
- remove_after_time_scale?: string;
2868
+ remove_after_time_scale?: null | string;
2813
2869
  /** @description The tags associated with the product */
2814
- tags?: components["schemas"]["ProductTagDTO"][];
2870
+ tags: components["schemas"]["ProductTagDTO"][];
2815
2871
  /** @description A comma-seperated string of all the tags associated with the product */
2816
- tag_names?: string;
2872
+ tag_names: string;
2817
2873
  /** @description The game servers associated with the product */
2818
- gameservers?: components["schemas"]["ProductGameServerDTO"][];
2874
+ gameservers: components["schemas"]["ProductGameServerDTO"][];
2819
2875
  /** @description A comma-seperated string of all the game servers associated with the product */
2820
- gameserver_names?: string;
2876
+ gameserver_names: string;
2821
2877
  /** @description The commands associated with the product */
2822
- commands?: components["schemas"]["ProductCommandDTO"][];
2878
+ commands: components["schemas"]["ProductCommandDTO"][];
2823
2879
  /**
2824
2880
  * Format: date-time
2825
2881
  * @description When the product was created
2826
2882
  */
2827
- created_at?: string;
2883
+ created_at?: null | string;
2828
2884
  /**
2829
2885
  * Format: date-time
2830
2886
  * @description When the product was last updated
2831
2887
  */
2832
- updated_at?: string;
2888
+ updated_at?: null | string;
2833
2889
  /** @description The metadata of the product */
2834
- metadata?: {
2890
+ metadata: {
2835
2891
  [key: string]: string;
2836
2892
  };
2837
2893
  };
@@ -2841,11 +2897,11 @@ export interface components {
2841
2897
  * @description The ID of the Game Server
2842
2898
  * @example 411486491630370816
2843
2899
  */
2844
- id?: string;
2900
+ id: string;
2845
2901
  /** @description The name of the Game Server */
2846
- name?: string;
2902
+ name: string;
2847
2903
  /** @description Indicates if the Game Server is enabled */
2848
- enabled?: boolean;
2904
+ enabled: boolean;
2849
2905
  };
2850
2906
  ProductTagDTO: {
2851
2907
  /**
@@ -2853,31 +2909,31 @@ export interface components {
2853
2909
  * @description The Flake ID of the Product Tag
2854
2910
  * @example 411486491630370816
2855
2911
  */
2856
- id?: string;
2912
+ id: string;
2857
2913
  /** @description The URL-Friendly slug of the Product Tag */
2858
- slug?: string;
2914
+ slug: string;
2859
2915
  /** @description The name of the Product Tag */
2860
- name?: string;
2916
+ name: string;
2861
2917
  };
2862
2918
  SteamCustomerDTO: {
2863
2919
  /**
2864
2920
  * @description SteamID64
2865
2921
  * @example 76561197960287930
2866
2922
  */
2867
- id?: string;
2923
+ id: string;
2868
2924
  /**
2869
2925
  * @description The name on the Steam Profile
2870
2926
  * @example John
2871
2927
  */
2872
- name?: string;
2928
+ name: string;
2873
2929
  /** @description The Steam Avatar URL */
2874
- avatar_url?: string;
2930
+ avatar_url: string;
2875
2931
  };
2876
2932
  /**
2877
2933
  * @description The type of webhook event
2878
2934
  * @enum {string}
2879
2935
  */
2880
- WebhookEventType: "OnOrderCompleted" | "OnRefund" | "OnChargeback" | "OnDeliveryItemAdded" | "OnDeliveryItemActivated" | "OnDeliveryItemUsed" | "OnDeliveryItemRevoked" | "OnSubscriptionActivated" | "OnSubscriptionRenewed" | "OnSubscriptionCanceled" | "OnDiscordAccountLinkedToCheckout" | "OnConnectedUserRegistered" | "OnConnectedUserBecamePayable" | "OnConnectedUserPayoutCreated" | "OnConnectedUserPayoutCompleted" | "OnConnectedUserTransactionInserted" | "OnConnectedUserBecameUnpayable" | "OnTrialActivated" | "OnTrialCompleted" | "OnTrialCanceled" | "OnPurchaseFollowUpAttemptEmailSent" | "OnPurchaseFollowUpAttemptSucceeded" | "OnAbandonedCheckoutRecoveryAttemptEmailSent" | "OnAbandonedCheckoutRecoveryAttemptSucceeded";
2936
+ 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";
2881
2937
  };
2882
2938
  responses: never;
2883
2939
  parameters: never;