@paynow-gg/typescript-sdk 1.0.29 → 1.0.30
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.
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export type paths = Record<string, never>;
|
|
2
2
|
export interface webhooks {
|
|
3
|
-
|
|
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
|
|
14
|
+
* @description Webhook for ON_SUBSCRIPTION_RENEWED
|
|
15
15
|
*/
|
|
16
16
|
post: {
|
|
17
17
|
parameters: {
|
|
@@ -23,6 +23,10 @@ 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
|
|
@@ -116,7 +120,7 @@ export interface webhooks {
|
|
|
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;
|
|
123
|
+
product_image_url?: null | string;
|
|
120
124
|
product?: components["schemas"]["ProductDTO"];
|
|
121
125
|
/**
|
|
122
126
|
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
@@ -158,25 +162,25 @@ export interface webhooks {
|
|
|
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
|
|
@@ -228,7 +232,7 @@ export interface webhooks {
|
|
|
228
232
|
patch?: never;
|
|
229
233
|
trace?: never;
|
|
230
234
|
};
|
|
231
|
-
|
|
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
|
|
246
|
+
* @description Webhook for ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
|
|
243
247
|
*/
|
|
244
248
|
post: {
|
|
245
249
|
parameters: {
|
|
@@ -251,6 +255,10 @@ 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
|
|
@@ -324,7 +332,7 @@ export interface webhooks {
|
|
|
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
|
-
|
|
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
|
|
381
|
+
* @description Webhook for ON_DELIVERY_ITEM_ADDED
|
|
374
382
|
*/
|
|
375
383
|
post: {
|
|
376
384
|
parameters: {
|
|
@@ -382,6 +390,10 @@ 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
|
|
@@ -402,44 +414,44 @@ export interface webhooks {
|
|
|
402
414
|
* @example 411486491630370816
|
|
403
415
|
*/
|
|
404
416
|
store_id?: string;
|
|
405
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
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
|
|
@@ -469,27 +481,27 @@ export interface webhooks {
|
|
|
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
|
-
|
|
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
|
|
550
|
+
* @description Webhook for ON_DELIVERY_ITEM_ACTIVATED
|
|
539
551
|
*/
|
|
540
552
|
post: {
|
|
541
553
|
parameters: {
|
|
@@ -547,6 +559,10 @@ 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
|
|
@@ -567,44 +583,44 @@ export interface webhooks {
|
|
|
567
583
|
* @example 411486491630370816
|
|
568
584
|
*/
|
|
569
585
|
store_id?: string;
|
|
570
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
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
|
|
@@ -634,27 +650,27 @@ export interface webhooks {
|
|
|
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
|
-
|
|
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
|
|
719
|
+
* @description Webhook for ON_DELIVERY_ITEM_USED
|
|
704
720
|
*/
|
|
705
721
|
post: {
|
|
706
722
|
parameters: {
|
|
@@ -712,6 +728,10 @@ 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
|
|
@@ -732,44 +752,44 @@ export interface webhooks {
|
|
|
732
752
|
* @example 411486491630370816
|
|
733
753
|
*/
|
|
734
754
|
store_id?: string;
|
|
735
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
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
|
|
@@ -799,27 +819,27 @@ export interface webhooks {
|
|
|
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
|
-
|
|
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
|
|
888
|
+
* @description Webhook for ON_DELIVERY_ITEM_REVOKED
|
|
869
889
|
*/
|
|
870
890
|
post: {
|
|
871
891
|
parameters: {
|
|
@@ -877,6 +897,10 @@ 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
|
|
@@ -897,44 +921,44 @@ export interface webhooks {
|
|
|
897
921
|
* @example 411486491630370816
|
|
898
922
|
*/
|
|
899
923
|
store_id?: string;
|
|
900
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
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
|
|
@@ -964,27 +988,27 @@ export interface webhooks {
|
|
|
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
|
-
|
|
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
|
|
1057
|
+
* @description Webhook for ON_ORDER_COMPLETED
|
|
1034
1058
|
*/
|
|
1035
1059
|
post: {
|
|
1036
1060
|
parameters: {
|
|
@@ -1042,6 +1066,10 @@ 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
|
|
@@ -1075,13 +1103,13 @@ export interface webhooks {
|
|
|
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
|
|
@@ -1205,7 +1233,7 @@ export interface webhooks {
|
|
|
1205
1233
|
patch?: never;
|
|
1206
1234
|
trace?: never;
|
|
1207
1235
|
};
|
|
1208
|
-
|
|
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
|
|
1247
|
+
* @description Webhook for ON_CHARGEBACK
|
|
1220
1248
|
*/
|
|
1221
1249
|
post: {
|
|
1222
1250
|
parameters: {
|
|
@@ -1228,6 +1256,10 @@ 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
|
|
@@ -1254,7 +1286,7 @@ export interface webhooks {
|
|
|
1254
1286
|
* @example 411486491630370816
|
|
1255
1287
|
*/
|
|
1256
1288
|
order_id?: string;
|
|
1257
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
1289
|
+
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
1258
1290
|
/**
|
|
1259
1291
|
* @description The Payment Gateway of the Payment
|
|
1260
1292
|
* @example stripe
|
|
@@ -1337,7 +1369,7 @@ export interface webhooks {
|
|
|
1337
1369
|
patch?: never;
|
|
1338
1370
|
trace?: never;
|
|
1339
1371
|
};
|
|
1340
|
-
|
|
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
|
|
1383
|
+
* @description Webhook for ON_REFUND
|
|
1352
1384
|
*/
|
|
1353
1385
|
post: {
|
|
1354
1386
|
parameters: {
|
|
@@ -1360,6 +1392,10 @@ 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
|
|
@@ -1386,7 +1422,7 @@ export interface webhooks {
|
|
|
1386
1422
|
* @example 411486491630370816
|
|
1387
1423
|
*/
|
|
1388
1424
|
order_id?: string;
|
|
1389
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
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
|
|
@@ -1503,7 +1539,7 @@ export interface webhooks {
|
|
|
1503
1539
|
patch?: never;
|
|
1504
1540
|
trace?: never;
|
|
1505
1541
|
};
|
|
1506
|
-
|
|
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
|
|
1553
|
+
* @description Webhook for ON_SUBSCRIPTION_ACTIVATED
|
|
1518
1554
|
*/
|
|
1519
1555
|
post: {
|
|
1520
1556
|
parameters: {
|
|
@@ -1526,6 +1562,10 @@ 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
|
|
@@ -1619,7 +1659,7 @@ export interface webhooks {
|
|
|
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;
|
|
1662
|
+
product_image_url?: null | string;
|
|
1623
1663
|
product?: components["schemas"]["ProductDTO"];
|
|
1624
1664
|
/**
|
|
1625
1665
|
* @description The ISO-3166 Country Code of customer associated with the Subscription
|
|
@@ -1661,25 +1701,25 @@ export interface webhooks {
|
|
|
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
|
|
@@ -1731,7 +1771,7 @@ export interface webhooks {
|
|
|
1731
1771
|
patch?: never;
|
|
1732
1772
|
trace?: never;
|
|
1733
1773
|
};
|
|
1734
|
-
|
|
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
|
|
1785
|
+
* @description Webhook for ON_SUBSCRIPTION_CANCELED
|
|
1746
1786
|
*/
|
|
1747
1787
|
post: {
|
|
1748
1788
|
parameters: {
|
|
@@ -1754,6 +1794,10 @@ 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
|
|
@@ -1847,7 +1891,7 @@ export interface webhooks {
|
|
|
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;
|
|
1894
|
+
product_image_url?: null | string;
|
|
1851
1895
|
product?: components["schemas"]["ProductDTO"];
|
|
1852
1896
|
/**
|
|
1853
1897
|
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
@@ -1889,36 +1933,36 @@ export interface webhooks {
|
|
|
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
|
|
@@ -1970,7 +2014,7 @@ export interface webhooks {
|
|
|
1970
2014
|
patch?: never;
|
|
1971
2015
|
trace?: never;
|
|
1972
2016
|
};
|
|
1973
|
-
|
|
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
|
|
2028
|
+
* @description Webhook for ON_TRIAL_ACTIVATED
|
|
1985
2029
|
*/
|
|
1986
2030
|
post: {
|
|
1987
2031
|
parameters: {
|
|
@@ -1993,6 +2037,10 @@ 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
|
|
@@ -2025,13 +2073,13 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2053,7 +2101,7 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2069,13 +2117,13 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2092,7 +2140,7 @@ export interface webhooks {
|
|
|
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
|
-
|
|
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
|
|
2189
|
+
* @description Webhook for ON_TRIAL_COMPLETED
|
|
2142
2190
|
*/
|
|
2143
2191
|
post: {
|
|
2144
2192
|
parameters: {
|
|
@@ -2150,6 +2198,10 @@ 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
|
|
@@ -2182,13 +2234,13 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2210,7 +2262,7 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2226,13 +2278,13 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2249,7 +2301,7 @@ export interface webhooks {
|
|
|
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
|
-
|
|
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
|
|
2350
|
+
* @description Webhook for ON_TRIAL_CANCELED
|
|
2299
2351
|
*/
|
|
2300
2352
|
post: {
|
|
2301
2353
|
parameters: {
|
|
@@ -2307,6 +2359,10 @@ 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
|
|
@@ -2339,13 +2395,13 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2367,7 +2423,7 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2383,13 +2439,13 @@ export interface webhooks {
|
|
|
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
|
|
@@ -2406,7 +2462,7 @@ export interface webhooks {
|
|
|
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
|
};
|
|
@@ -2490,7 +2546,7 @@ export interface components {
|
|
|
2490
2546
|
*/
|
|
2491
2547
|
id?: string;
|
|
2492
2548
|
/** @example John */
|
|
2493
|
-
name?: string;
|
|
2549
|
+
name?: null | string;
|
|
2494
2550
|
steam?: components["schemas"]["SteamCustomerDTO"];
|
|
2495
2551
|
minecraft?: components["schemas"]["MinecraftCustomerDTO"];
|
|
2496
2552
|
profile?: components["schemas"]["GenericProfileDTO"];
|
|
@@ -2549,13 +2605,13 @@ export interface components {
|
|
|
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
|
|
@@ -2675,30 +2731,30 @@ export interface components {
|
|
|
2675
2731
|
/** @description The name of the product associated with this Order Line */
|
|
2676
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
|
|
@@ -2734,7 +2790,7 @@ export interface components {
|
|
|
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
|
/**
|
|
@@ -2767,7 +2823,7 @@ export interface components {
|
|
|
2767
2823
|
*/
|
|
2768
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
2828
|
slug?: string;
|
|
2773
2829
|
/** @description The name of the Product */
|
|
@@ -2777,7 +2833,7 @@ export interface components {
|
|
|
2777
2833
|
/** @description Indicates if the product is enabled. */
|
|
2778
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
2838
|
sort_order?: number;
|
|
2783
2839
|
/** @description The price of the product, represented in cents. */
|
|
@@ -2792,24 +2848,24 @@ export interface components {
|
|
|
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
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
2870
|
tags?: components["schemas"]["ProductTagDTO"][];
|
|
2815
2871
|
/** @description A comma-seperated string of all the tags associated with the product */
|
|
@@ -2824,12 +2880,12 @@ export interface components {
|
|
|
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
2890
|
metadata?: {
|
|
2835
2891
|
[key: string]: string;
|
|
@@ -2877,7 +2933,7 @@ export interface components {
|
|
|
2877
2933
|
* @description The type of webhook event
|
|
2878
2934
|
* @enum {string}
|
|
2879
2935
|
*/
|
|
2880
|
-
WebhookEventType: "
|
|
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;
|