@paynow-gg/typescript-sdk 1.0.28 → 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.
- package/LICENSE +21 -21
- package/README.md +31 -31
- package/dist/generated/webhooks.d.ts +214 -209
- package/dist/generated/webhooks.d.ts.map +1 -1
- package/dist/generated/webhooks.js.map +1 -1
- package/package.json +29 -29
|
@@ -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: {
|
|
@@ -27,13 +27,13 @@ export interface webhooks {
|
|
|
27
27
|
* @description The type of webhook event
|
|
28
28
|
* @example ON_SUBSCRIPTION_RENEWED
|
|
29
29
|
*/
|
|
30
|
-
event_type:
|
|
30
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
31
31
|
/**
|
|
32
|
-
* Format:
|
|
33
|
-
* @description
|
|
34
|
-
* @example
|
|
32
|
+
* Format: flake-id
|
|
33
|
+
* @description The ID of the Webhook Event
|
|
34
|
+
* @example 411486491630370816
|
|
35
35
|
*/
|
|
36
|
-
|
|
36
|
+
event_id?: string;
|
|
37
37
|
body: {
|
|
38
38
|
/**
|
|
39
39
|
* Format: flake-id
|
|
@@ -120,7 +120,7 @@ export interface webhooks {
|
|
|
120
120
|
* @description The image URL of the Product associated with the Subscription
|
|
121
121
|
* @example https://example.com/biz.jpg
|
|
122
122
|
*/
|
|
123
|
-
product_image_url?: string;
|
|
123
|
+
product_image_url?: null | string;
|
|
124
124
|
product?: components["schemas"]["ProductDTO"];
|
|
125
125
|
/**
|
|
126
126
|
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
@@ -162,25 +162,25 @@ export interface webhooks {
|
|
|
162
162
|
* @description The start date of the current billing period
|
|
163
163
|
* @example 2024-03-01T00:00:00Z
|
|
164
164
|
*/
|
|
165
|
-
current_period_start?: string;
|
|
165
|
+
current_period_start?: null | string;
|
|
166
166
|
/**
|
|
167
167
|
* Format: date-time
|
|
168
168
|
* @description The end date of the current billing period
|
|
169
169
|
* @example 2024-06-01T00:00:00Z
|
|
170
170
|
*/
|
|
171
|
-
current_period_end?: string;
|
|
171
|
+
current_period_end?: null | string;
|
|
172
172
|
/**
|
|
173
173
|
* Format: date-time
|
|
174
174
|
* @description The date and time when the Subscription was created
|
|
175
175
|
* @example 2024-03-01T11:00:00Z
|
|
176
176
|
*/
|
|
177
|
-
created_at?: string;
|
|
177
|
+
created_at?: null | string;
|
|
178
178
|
/**
|
|
179
179
|
* Format: date-time
|
|
180
180
|
* @description Indicates when the subscription was active
|
|
181
181
|
* @example 2024-03-01T11:05:00Z
|
|
182
182
|
*/
|
|
183
|
-
active_at?: string;
|
|
183
|
+
active_at?: null | string;
|
|
184
184
|
/**
|
|
185
185
|
* Format: flake-id
|
|
186
186
|
* @description The Flake ID of the Checkout associated with the Subscription
|
|
@@ -232,7 +232,7 @@ export interface webhooks {
|
|
|
232
232
|
patch?: never;
|
|
233
233
|
trace?: never;
|
|
234
234
|
};
|
|
235
|
-
|
|
235
|
+
ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT: {
|
|
236
236
|
parameters: {
|
|
237
237
|
query?: never;
|
|
238
238
|
header?: never;
|
|
@@ -243,7 +243,7 @@ export interface webhooks {
|
|
|
243
243
|
put?: never;
|
|
244
244
|
/**
|
|
245
245
|
* Triggered when a Discord account is successfully linked to a checkout.
|
|
246
|
-
* @description Webhook for
|
|
246
|
+
* @description Webhook for ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
|
|
247
247
|
*/
|
|
248
248
|
post: {
|
|
249
249
|
parameters: {
|
|
@@ -259,13 +259,13 @@ export interface webhooks {
|
|
|
259
259
|
* @description The type of webhook event
|
|
260
260
|
* @example ON_DISCORD_ACCOUNT_LINKED_TO_CHECKOUT
|
|
261
261
|
*/
|
|
262
|
-
event_type:
|
|
262
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
263
263
|
/**
|
|
264
|
-
* Format:
|
|
265
|
-
* @description
|
|
266
|
-
* @example
|
|
264
|
+
* Format: flake-id
|
|
265
|
+
* @description The ID of the Webhook Event
|
|
266
|
+
* @example 411486491630370816
|
|
267
267
|
*/
|
|
268
|
-
|
|
268
|
+
event_id?: string;
|
|
269
269
|
body: {
|
|
270
270
|
/**
|
|
271
271
|
* Format: flake-id
|
|
@@ -332,7 +332,7 @@ export interface webhooks {
|
|
|
332
332
|
* @description Indicates when the Discord account link was enqueued
|
|
333
333
|
* @example 2024-01-15T10:30:00Z
|
|
334
334
|
*/
|
|
335
|
-
enqueued_at?: string;
|
|
335
|
+
enqueued_at?: null | string;
|
|
336
336
|
};
|
|
337
337
|
};
|
|
338
338
|
};
|
|
@@ -367,7 +367,7 @@ export interface webhooks {
|
|
|
367
367
|
patch?: never;
|
|
368
368
|
trace?: never;
|
|
369
369
|
};
|
|
370
|
-
|
|
370
|
+
ON_DELIVERY_ITEM_ADDED: {
|
|
371
371
|
parameters: {
|
|
372
372
|
query?: never;
|
|
373
373
|
header?: never;
|
|
@@ -378,7 +378,7 @@ export interface webhooks {
|
|
|
378
378
|
put?: never;
|
|
379
379
|
/**
|
|
380
380
|
* Triggered when a delivery item is added to the customers inventory
|
|
381
|
-
* @description Webhook for
|
|
381
|
+
* @description Webhook for ON_DELIVERY_ITEM_ADDED
|
|
382
382
|
*/
|
|
383
383
|
post: {
|
|
384
384
|
parameters: {
|
|
@@ -394,13 +394,13 @@ export interface webhooks {
|
|
|
394
394
|
* @description The type of webhook event
|
|
395
395
|
* @example ON_DELIVERY_ITEM_ADDED
|
|
396
396
|
*/
|
|
397
|
-
event_type:
|
|
397
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
398
398
|
/**
|
|
399
|
-
* Format:
|
|
400
|
-
* @description
|
|
401
|
-
* @example
|
|
399
|
+
* Format: flake-id
|
|
400
|
+
* @description The ID of the Webhook Event
|
|
401
|
+
* @example 411486491630370816
|
|
402
402
|
*/
|
|
403
|
-
|
|
403
|
+
event_id?: string;
|
|
404
404
|
body: {
|
|
405
405
|
/**
|
|
406
406
|
* Format: flake-id
|
|
@@ -414,44 +414,44 @@ export interface webhooks {
|
|
|
414
414
|
* @example 411486491630370816
|
|
415
415
|
*/
|
|
416
416
|
store_id?: string;
|
|
417
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
417
|
+
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
418
418
|
/**
|
|
419
419
|
* Format: flake-id
|
|
420
420
|
* @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
|
|
421
421
|
* @example 411486491630370816
|
|
422
422
|
*/
|
|
423
|
-
order_customer_id?: string;
|
|
423
|
+
order_customer_id?: null | string;
|
|
424
424
|
/**
|
|
425
425
|
* Format: flake-id
|
|
426
426
|
* @description The Flake ID of the Checkout associated with the Delivery Item
|
|
427
427
|
* @example 411486491630370816
|
|
428
428
|
*/
|
|
429
|
-
checkout_id?: string;
|
|
429
|
+
checkout_id?: null | string;
|
|
430
430
|
/**
|
|
431
431
|
* Format: flake-id
|
|
432
432
|
* @description The Flake ID of the Order ID associated with the Delivery Item
|
|
433
433
|
* @example 411486491630370816
|
|
434
434
|
*/
|
|
435
|
-
order_id?: string;
|
|
435
|
+
order_id?: null | string;
|
|
436
436
|
/**
|
|
437
437
|
* Format: flake-id
|
|
438
438
|
* @description The Flake Id of the Order Line ID associated with the Delivery Item
|
|
439
439
|
* @example 411486491630370816
|
|
440
440
|
*/
|
|
441
|
-
order_line_id?: string;
|
|
441
|
+
order_line_id?: null | string;
|
|
442
442
|
/**
|
|
443
443
|
* Format: flake-id
|
|
444
444
|
* @description The Flake ID of the Subscription associated with the Delivery Item
|
|
445
445
|
* @example 411486491630370816
|
|
446
446
|
*/
|
|
447
|
-
subscription_id?: string;
|
|
447
|
+
subscription_id?: null | string;
|
|
448
448
|
/**
|
|
449
449
|
* Format: flake-id
|
|
450
450
|
* @description The Flake ID of the Game Server the Delivery Item is associated with
|
|
451
451
|
* @example 411486491630370816
|
|
452
452
|
*/
|
|
453
|
-
execute_on_gameserver_id?: string;
|
|
454
|
-
execute_on_gameserver?: components["schemas"]["GameServerDTO"];
|
|
453
|
+
execute_on_gameserver_id?: null | string;
|
|
454
|
+
execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
|
|
455
455
|
/**
|
|
456
456
|
* Format: flake-id
|
|
457
457
|
* @description The associated Product ID of the Delivery Item
|
|
@@ -481,27 +481,27 @@ export interface webhooks {
|
|
|
481
481
|
* @description Indicates when the Delivery Item become active
|
|
482
482
|
* @example 2024-01-10T09:00:00Z
|
|
483
483
|
*/
|
|
484
|
-
active_at?: string;
|
|
484
|
+
active_at?: null | string;
|
|
485
485
|
/**
|
|
486
486
|
* Format: date-time
|
|
487
487
|
* @description Indicates when the Delivery Item expires
|
|
488
488
|
* @example 2024-12-31T23:59:59Z
|
|
489
489
|
*/
|
|
490
|
-
expires_at?: string;
|
|
490
|
+
expires_at?: null | string;
|
|
491
491
|
/**
|
|
492
492
|
* Format: date-time
|
|
493
493
|
* @description Indicates when the Delivery Item was removed from the customers inventory
|
|
494
494
|
* @example 2024-02-01T10:00:00Z
|
|
495
495
|
*/
|
|
496
|
-
removed_at?: string;
|
|
496
|
+
removed_at?: null | string;
|
|
497
497
|
/**
|
|
498
498
|
* Format: date-time
|
|
499
499
|
* @description Indicates when the Delivery Item was revoked from the customers inventory
|
|
500
500
|
* @example 2024-02-05T14:30:00Z
|
|
501
501
|
*/
|
|
502
|
-
revoked_at?: string;
|
|
502
|
+
revoked_at?: null | string;
|
|
503
503
|
/** @description Indicates the reason the delivery item was revoked from the customers inventory */
|
|
504
|
-
revoke_reason?: string;
|
|
504
|
+
revoke_reason?: null | string;
|
|
505
505
|
};
|
|
506
506
|
};
|
|
507
507
|
};
|
|
@@ -536,7 +536,7 @@ export interface webhooks {
|
|
|
536
536
|
patch?: never;
|
|
537
537
|
trace?: never;
|
|
538
538
|
};
|
|
539
|
-
|
|
539
|
+
ON_DELIVERY_ITEM_ACTIVATED: {
|
|
540
540
|
parameters: {
|
|
541
541
|
query?: never;
|
|
542
542
|
header?: never;
|
|
@@ -547,7 +547,7 @@ export interface webhooks {
|
|
|
547
547
|
put?: never;
|
|
548
548
|
/**
|
|
549
549
|
* Triggered when a delivery item in the customers inventory activates
|
|
550
|
-
* @description Webhook for
|
|
550
|
+
* @description Webhook for ON_DELIVERY_ITEM_ACTIVATED
|
|
551
551
|
*/
|
|
552
552
|
post: {
|
|
553
553
|
parameters: {
|
|
@@ -563,13 +563,13 @@ export interface webhooks {
|
|
|
563
563
|
* @description The type of webhook event
|
|
564
564
|
* @example ON_DELIVERY_ITEM_ACTIVATED
|
|
565
565
|
*/
|
|
566
|
-
event_type:
|
|
566
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
567
567
|
/**
|
|
568
|
-
* Format:
|
|
569
|
-
* @description
|
|
570
|
-
* @example
|
|
568
|
+
* Format: flake-id
|
|
569
|
+
* @description The ID of the Webhook Event
|
|
570
|
+
* @example 411486491630370816
|
|
571
571
|
*/
|
|
572
|
-
|
|
572
|
+
event_id?: string;
|
|
573
573
|
body: {
|
|
574
574
|
/**
|
|
575
575
|
* Format: flake-id
|
|
@@ -583,44 +583,44 @@ export interface webhooks {
|
|
|
583
583
|
* @example 411486491630370816
|
|
584
584
|
*/
|
|
585
585
|
store_id?: string;
|
|
586
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
586
|
+
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
587
587
|
/**
|
|
588
588
|
* Format: flake-id
|
|
589
589
|
* @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
|
|
590
590
|
* @example 411486491630370816
|
|
591
591
|
*/
|
|
592
|
-
order_customer_id?: string;
|
|
592
|
+
order_customer_id?: null | string;
|
|
593
593
|
/**
|
|
594
594
|
* Format: flake-id
|
|
595
595
|
* @description The Flake ID of the Checkout associated with the Delivery Item
|
|
596
596
|
* @example 411486491630370816
|
|
597
597
|
*/
|
|
598
|
-
checkout_id?: string;
|
|
598
|
+
checkout_id?: null | string;
|
|
599
599
|
/**
|
|
600
600
|
* Format: flake-id
|
|
601
601
|
* @description The Flake ID of the Order ID associated with the Delivery Item
|
|
602
602
|
* @example 411486491630370816
|
|
603
603
|
*/
|
|
604
|
-
order_id?: string;
|
|
604
|
+
order_id?: null | string;
|
|
605
605
|
/**
|
|
606
606
|
* Format: flake-id
|
|
607
607
|
* @description The Flake Id of the Order Line ID associated with the Delivery Item
|
|
608
608
|
* @example 411486491630370816
|
|
609
609
|
*/
|
|
610
|
-
order_line_id?: string;
|
|
610
|
+
order_line_id?: null | string;
|
|
611
611
|
/**
|
|
612
612
|
* Format: flake-id
|
|
613
613
|
* @description The Flake ID of the Subscription associated with the Delivery Item
|
|
614
614
|
* @example 411486491630370816
|
|
615
615
|
*/
|
|
616
|
-
subscription_id?: string;
|
|
616
|
+
subscription_id?: null | string;
|
|
617
617
|
/**
|
|
618
618
|
* Format: flake-id
|
|
619
619
|
* @description The Flake ID of the Game Server the Delivery Item is associated with
|
|
620
620
|
* @example 411486491630370816
|
|
621
621
|
*/
|
|
622
|
-
execute_on_gameserver_id?: string;
|
|
623
|
-
execute_on_gameserver?: components["schemas"]["GameServerDTO"];
|
|
622
|
+
execute_on_gameserver_id?: null | string;
|
|
623
|
+
execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
|
|
624
624
|
/**
|
|
625
625
|
* Format: flake-id
|
|
626
626
|
* @description The associated Product ID of the Delivery Item
|
|
@@ -650,27 +650,27 @@ export interface webhooks {
|
|
|
650
650
|
* @description Indicates when the Delivery Item become active
|
|
651
651
|
* @example 2024-01-10T09:00:00Z
|
|
652
652
|
*/
|
|
653
|
-
active_at?: string;
|
|
653
|
+
active_at?: null | string;
|
|
654
654
|
/**
|
|
655
655
|
* Format: date-time
|
|
656
656
|
* @description Indicates when the Delivery Item expires
|
|
657
657
|
* @example 2024-12-31T23:59:59Z
|
|
658
658
|
*/
|
|
659
|
-
expires_at?: string;
|
|
659
|
+
expires_at?: null | string;
|
|
660
660
|
/**
|
|
661
661
|
* Format: date-time
|
|
662
662
|
* @description Indicates when the Delivery Item was removed from the customers inventory
|
|
663
663
|
* @example 2024-02-01T10:00:00Z
|
|
664
664
|
*/
|
|
665
|
-
removed_at?: string;
|
|
665
|
+
removed_at?: null | string;
|
|
666
666
|
/**
|
|
667
667
|
* Format: date-time
|
|
668
668
|
* @description Indicates when the Delivery Item was revoked from the customers inventory
|
|
669
669
|
* @example 2024-02-05T14:30:00Z
|
|
670
670
|
*/
|
|
671
|
-
revoked_at?: string;
|
|
671
|
+
revoked_at?: null | string;
|
|
672
672
|
/** @description Indicates the reason the delivery item was revoked from the customers inventory */
|
|
673
|
-
revoke_reason?: string;
|
|
673
|
+
revoke_reason?: null | string;
|
|
674
674
|
};
|
|
675
675
|
};
|
|
676
676
|
};
|
|
@@ -705,7 +705,7 @@ export interface webhooks {
|
|
|
705
705
|
patch?: never;
|
|
706
706
|
trace?: never;
|
|
707
707
|
};
|
|
708
|
-
|
|
708
|
+
ON_DELIVERY_ITEM_USED: {
|
|
709
709
|
parameters: {
|
|
710
710
|
query?: never;
|
|
711
711
|
header?: never;
|
|
@@ -716,7 +716,7 @@ export interface webhooks {
|
|
|
716
716
|
put?: never;
|
|
717
717
|
/**
|
|
718
718
|
* Triggered when a delivery item in the customers inventory becomes used
|
|
719
|
-
* @description Webhook for
|
|
719
|
+
* @description Webhook for ON_DELIVERY_ITEM_USED
|
|
720
720
|
*/
|
|
721
721
|
post: {
|
|
722
722
|
parameters: {
|
|
@@ -732,13 +732,13 @@ export interface webhooks {
|
|
|
732
732
|
* @description The type of webhook event
|
|
733
733
|
* @example ON_DELIVERY_ITEM_USED
|
|
734
734
|
*/
|
|
735
|
-
event_type:
|
|
735
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
736
736
|
/**
|
|
737
|
-
* Format:
|
|
738
|
-
* @description
|
|
739
|
-
* @example
|
|
737
|
+
* Format: flake-id
|
|
738
|
+
* @description The ID of the Webhook Event
|
|
739
|
+
* @example 411486491630370816
|
|
740
740
|
*/
|
|
741
|
-
|
|
741
|
+
event_id?: string;
|
|
742
742
|
body: {
|
|
743
743
|
/**
|
|
744
744
|
* Format: flake-id
|
|
@@ -752,44 +752,44 @@ export interface webhooks {
|
|
|
752
752
|
* @example 411486491630370816
|
|
753
753
|
*/
|
|
754
754
|
store_id?: string;
|
|
755
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
755
|
+
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
756
756
|
/**
|
|
757
757
|
* Format: flake-id
|
|
758
758
|
* @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
|
|
759
759
|
* @example 411486491630370816
|
|
760
760
|
*/
|
|
761
|
-
order_customer_id?: string;
|
|
761
|
+
order_customer_id?: null | string;
|
|
762
762
|
/**
|
|
763
763
|
* Format: flake-id
|
|
764
764
|
* @description The Flake ID of the Checkout associated with the Delivery Item
|
|
765
765
|
* @example 411486491630370816
|
|
766
766
|
*/
|
|
767
|
-
checkout_id?: string;
|
|
767
|
+
checkout_id?: null | string;
|
|
768
768
|
/**
|
|
769
769
|
* Format: flake-id
|
|
770
770
|
* @description The Flake ID of the Order ID associated with the Delivery Item
|
|
771
771
|
* @example 411486491630370816
|
|
772
772
|
*/
|
|
773
|
-
order_id?: string;
|
|
773
|
+
order_id?: null | string;
|
|
774
774
|
/**
|
|
775
775
|
* Format: flake-id
|
|
776
776
|
* @description The Flake Id of the Order Line ID associated with the Delivery Item
|
|
777
777
|
* @example 411486491630370816
|
|
778
778
|
*/
|
|
779
|
-
order_line_id?: string;
|
|
779
|
+
order_line_id?: null | string;
|
|
780
780
|
/**
|
|
781
781
|
* Format: flake-id
|
|
782
782
|
* @description The Flake ID of the Subscription associated with the Delivery Item
|
|
783
783
|
* @example 411486491630370816
|
|
784
784
|
*/
|
|
785
|
-
subscription_id?: string;
|
|
785
|
+
subscription_id?: null | string;
|
|
786
786
|
/**
|
|
787
787
|
* Format: flake-id
|
|
788
788
|
* @description The Flake ID of the Game Server the Delivery Item is associated with
|
|
789
789
|
* @example 411486491630370816
|
|
790
790
|
*/
|
|
791
|
-
execute_on_gameserver_id?: string;
|
|
792
|
-
execute_on_gameserver?: components["schemas"]["GameServerDTO"];
|
|
791
|
+
execute_on_gameserver_id?: null | string;
|
|
792
|
+
execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
|
|
793
793
|
/**
|
|
794
794
|
* Format: flake-id
|
|
795
795
|
* @description The associated Product ID of the Delivery Item
|
|
@@ -819,27 +819,27 @@ export interface webhooks {
|
|
|
819
819
|
* @description Indicates when the Delivery Item become active
|
|
820
820
|
* @example 2024-01-10T09:00:00Z
|
|
821
821
|
*/
|
|
822
|
-
active_at?: string;
|
|
822
|
+
active_at?: null | string;
|
|
823
823
|
/**
|
|
824
824
|
* Format: date-time
|
|
825
825
|
* @description Indicates when the Delivery Item expires
|
|
826
826
|
* @example 2024-12-31T23:59:59Z
|
|
827
827
|
*/
|
|
828
|
-
expires_at?: string;
|
|
828
|
+
expires_at?: null | string;
|
|
829
829
|
/**
|
|
830
830
|
* Format: date-time
|
|
831
831
|
* @description Indicates when the Delivery Item was removed from the customers inventory
|
|
832
832
|
* @example 2024-02-01T10:00:00Z
|
|
833
833
|
*/
|
|
834
|
-
removed_at?: string;
|
|
834
|
+
removed_at?: null | string;
|
|
835
835
|
/**
|
|
836
836
|
* Format: date-time
|
|
837
837
|
* @description Indicates when the Delivery Item was revoked from the customers inventory
|
|
838
838
|
* @example 2024-02-05T14:30:00Z
|
|
839
839
|
*/
|
|
840
|
-
revoked_at?: string;
|
|
840
|
+
revoked_at?: null | string;
|
|
841
841
|
/** @description Indicates the reason the delivery item was revoked from the customers inventory */
|
|
842
|
-
revoke_reason?: string;
|
|
842
|
+
revoke_reason?: null | string;
|
|
843
843
|
};
|
|
844
844
|
};
|
|
845
845
|
};
|
|
@@ -874,7 +874,7 @@ export interface webhooks {
|
|
|
874
874
|
patch?: never;
|
|
875
875
|
trace?: never;
|
|
876
876
|
};
|
|
877
|
-
|
|
877
|
+
ON_DELIVERY_ITEM_REVOKED: {
|
|
878
878
|
parameters: {
|
|
879
879
|
query?: never;
|
|
880
880
|
header?: never;
|
|
@@ -885,7 +885,7 @@ export interface webhooks {
|
|
|
885
885
|
put?: never;
|
|
886
886
|
/**
|
|
887
887
|
* Triggered when a delivery item is revoked from the customers inventory
|
|
888
|
-
* @description Webhook for
|
|
888
|
+
* @description Webhook for ON_DELIVERY_ITEM_REVOKED
|
|
889
889
|
*/
|
|
890
890
|
post: {
|
|
891
891
|
parameters: {
|
|
@@ -901,13 +901,13 @@ export interface webhooks {
|
|
|
901
901
|
* @description The type of webhook event
|
|
902
902
|
* @example ON_DELIVERY_ITEM_REVOKED
|
|
903
903
|
*/
|
|
904
|
-
event_type:
|
|
904
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
905
905
|
/**
|
|
906
|
-
* Format:
|
|
907
|
-
* @description
|
|
908
|
-
* @example
|
|
906
|
+
* Format: flake-id
|
|
907
|
+
* @description The ID of the Webhook Event
|
|
908
|
+
* @example 411486491630370816
|
|
909
909
|
*/
|
|
910
|
-
|
|
910
|
+
event_id?: string;
|
|
911
911
|
body: {
|
|
912
912
|
/**
|
|
913
913
|
* Format: flake-id
|
|
@@ -921,44 +921,44 @@ export interface webhooks {
|
|
|
921
921
|
* @example 411486491630370816
|
|
922
922
|
*/
|
|
923
923
|
store_id?: string;
|
|
924
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
924
|
+
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
925
925
|
/**
|
|
926
926
|
* Format: flake-id
|
|
927
927
|
* @description The Flake ID of the customer who ordered the delivery item - which may differ to the customer because of gifting
|
|
928
928
|
* @example 411486491630370816
|
|
929
929
|
*/
|
|
930
|
-
order_customer_id?: string;
|
|
930
|
+
order_customer_id?: null | string;
|
|
931
931
|
/**
|
|
932
932
|
* Format: flake-id
|
|
933
933
|
* @description The Flake ID of the Checkout associated with the Delivery Item
|
|
934
934
|
* @example 411486491630370816
|
|
935
935
|
*/
|
|
936
|
-
checkout_id?: string;
|
|
936
|
+
checkout_id?: null | string;
|
|
937
937
|
/**
|
|
938
938
|
* Format: flake-id
|
|
939
939
|
* @description The Flake ID of the Order ID associated with the Delivery Item
|
|
940
940
|
* @example 411486491630370816
|
|
941
941
|
*/
|
|
942
|
-
order_id?: string;
|
|
942
|
+
order_id?: null | string;
|
|
943
943
|
/**
|
|
944
944
|
* Format: flake-id
|
|
945
945
|
* @description The Flake Id of the Order Line ID associated with the Delivery Item
|
|
946
946
|
* @example 411486491630370816
|
|
947
947
|
*/
|
|
948
|
-
order_line_id?: string;
|
|
948
|
+
order_line_id?: null | string;
|
|
949
949
|
/**
|
|
950
950
|
* Format: flake-id
|
|
951
951
|
* @description The Flake ID of the Subscription associated with the Delivery Item
|
|
952
952
|
* @example 411486491630370816
|
|
953
953
|
*/
|
|
954
|
-
subscription_id?: string;
|
|
954
|
+
subscription_id?: null | string;
|
|
955
955
|
/**
|
|
956
956
|
* Format: flake-id
|
|
957
957
|
* @description The Flake ID of the Game Server the Delivery Item is associated with
|
|
958
958
|
* @example 411486491630370816
|
|
959
959
|
*/
|
|
960
|
-
execute_on_gameserver_id?: string;
|
|
961
|
-
execute_on_gameserver?: components["schemas"]["GameServerDTO"];
|
|
960
|
+
execute_on_gameserver_id?: null | string;
|
|
961
|
+
execute_on_gameserver?: components["schemas"]["GameServerDTO"] | null;
|
|
962
962
|
/**
|
|
963
963
|
* Format: flake-id
|
|
964
964
|
* @description The associated Product ID of the Delivery Item
|
|
@@ -988,27 +988,27 @@ export interface webhooks {
|
|
|
988
988
|
* @description Indicates when the Delivery Item become active
|
|
989
989
|
* @example 2024-01-10T09:00:00Z
|
|
990
990
|
*/
|
|
991
|
-
active_at?: string;
|
|
991
|
+
active_at?: null | string;
|
|
992
992
|
/**
|
|
993
993
|
* Format: date-time
|
|
994
994
|
* @description Indicates when the Delivery Item expires
|
|
995
995
|
* @example 2024-12-31T23:59:59Z
|
|
996
996
|
*/
|
|
997
|
-
expires_at?: string;
|
|
997
|
+
expires_at?: null | string;
|
|
998
998
|
/**
|
|
999
999
|
* Format: date-time
|
|
1000
1000
|
* @description Indicates when the Delivery Item was removed from the customers inventory
|
|
1001
1001
|
* @example 2024-02-01T10:00:00Z
|
|
1002
1002
|
*/
|
|
1003
|
-
removed_at?: string;
|
|
1003
|
+
removed_at?: null | string;
|
|
1004
1004
|
/**
|
|
1005
1005
|
* Format: date-time
|
|
1006
1006
|
* @description Indicates when the Delivery Item was revoked from the customers inventory
|
|
1007
1007
|
* @example 2024-02-05T14:30:00Z
|
|
1008
1008
|
*/
|
|
1009
|
-
revoked_at?: string;
|
|
1009
|
+
revoked_at?: null | string;
|
|
1010
1010
|
/** @description Indicates the reason the delivery item was revoked from the customers inventory */
|
|
1011
|
-
revoke_reason?: string;
|
|
1011
|
+
revoke_reason?: null | string;
|
|
1012
1012
|
};
|
|
1013
1013
|
};
|
|
1014
1014
|
};
|
|
@@ -1043,7 +1043,7 @@ export interface webhooks {
|
|
|
1043
1043
|
patch?: never;
|
|
1044
1044
|
trace?: never;
|
|
1045
1045
|
};
|
|
1046
|
-
|
|
1046
|
+
ON_ORDER_COMPLETED: {
|
|
1047
1047
|
parameters: {
|
|
1048
1048
|
query?: never;
|
|
1049
1049
|
header?: never;
|
|
@@ -1054,7 +1054,7 @@ export interface webhooks {
|
|
|
1054
1054
|
put?: never;
|
|
1055
1055
|
/**
|
|
1056
1056
|
* Triggered when an order is completed
|
|
1057
|
-
* @description Webhook for
|
|
1057
|
+
* @description Webhook for ON_ORDER_COMPLETED
|
|
1058
1058
|
*/
|
|
1059
1059
|
post: {
|
|
1060
1060
|
parameters: {
|
|
@@ -1070,13 +1070,13 @@ export interface webhooks {
|
|
|
1070
1070
|
* @description The type of webhook event
|
|
1071
1071
|
* @example ON_ORDER_COMPLETED
|
|
1072
1072
|
*/
|
|
1073
|
-
event_type:
|
|
1073
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1074
1074
|
/**
|
|
1075
|
-
* Format:
|
|
1076
|
-
* @description
|
|
1077
|
-
* @example
|
|
1075
|
+
* Format: flake-id
|
|
1076
|
+
* @description The ID of the Webhook Event
|
|
1077
|
+
* @example 411486491630370816
|
|
1078
1078
|
*/
|
|
1079
|
-
|
|
1079
|
+
event_id?: string;
|
|
1080
1080
|
body: {
|
|
1081
1081
|
/**
|
|
1082
1082
|
* Format: flake-id
|
|
@@ -1103,13 +1103,13 @@ export interface webhooks {
|
|
|
1103
1103
|
* @description The Flake ID of the Subscription associated with the order
|
|
1104
1104
|
* @example 411486491630370816
|
|
1105
1105
|
*/
|
|
1106
|
-
subscription_id?: string;
|
|
1106
|
+
subscription_id?: null | string;
|
|
1107
1107
|
/**
|
|
1108
1108
|
* Format: flake-id
|
|
1109
1109
|
* @description The Flake ID of the Coupon associated with the order
|
|
1110
1110
|
* @example 411486491630370816
|
|
1111
1111
|
*/
|
|
1112
|
-
coupon_id?: string;
|
|
1112
|
+
coupon_id?: null | string;
|
|
1113
1113
|
/**
|
|
1114
1114
|
* @description The ISO-4217 Currency Code of the order
|
|
1115
1115
|
* @example USD
|
|
@@ -1233,7 +1233,7 @@ export interface webhooks {
|
|
|
1233
1233
|
patch?: never;
|
|
1234
1234
|
trace?: never;
|
|
1235
1235
|
};
|
|
1236
|
-
|
|
1236
|
+
ON_CHARGEBACK: {
|
|
1237
1237
|
parameters: {
|
|
1238
1238
|
query?: never;
|
|
1239
1239
|
header?: never;
|
|
@@ -1244,7 +1244,7 @@ export interface webhooks {
|
|
|
1244
1244
|
put?: never;
|
|
1245
1245
|
/**
|
|
1246
1246
|
* Triggered when a chargeback is created
|
|
1247
|
-
* @description Webhook for
|
|
1247
|
+
* @description Webhook for ON_CHARGEBACK
|
|
1248
1248
|
*/
|
|
1249
1249
|
post: {
|
|
1250
1250
|
parameters: {
|
|
@@ -1260,13 +1260,13 @@ export interface webhooks {
|
|
|
1260
1260
|
* @description The type of webhook event
|
|
1261
1261
|
* @example ON_CHARGEBACK
|
|
1262
1262
|
*/
|
|
1263
|
-
event_type:
|
|
1263
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1264
1264
|
/**
|
|
1265
|
-
* Format:
|
|
1266
|
-
* @description
|
|
1267
|
-
* @example
|
|
1265
|
+
* Format: flake-id
|
|
1266
|
+
* @description The ID of the Webhook Event
|
|
1267
|
+
* @example 411486491630370816
|
|
1268
1268
|
*/
|
|
1269
|
-
|
|
1269
|
+
event_id?: string;
|
|
1270
1270
|
body: {
|
|
1271
1271
|
/**
|
|
1272
1272
|
* Format: flake-id
|
|
@@ -1286,7 +1286,7 @@ export interface webhooks {
|
|
|
1286
1286
|
* @example 411486491630370816
|
|
1287
1287
|
*/
|
|
1288
1288
|
order_id?: string;
|
|
1289
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
1289
|
+
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
1290
1290
|
/**
|
|
1291
1291
|
* @description The Payment Gateway of the Payment
|
|
1292
1292
|
* @example stripe
|
|
@@ -1369,7 +1369,7 @@ export interface webhooks {
|
|
|
1369
1369
|
patch?: never;
|
|
1370
1370
|
trace?: never;
|
|
1371
1371
|
};
|
|
1372
|
-
|
|
1372
|
+
ON_REFUND: {
|
|
1373
1373
|
parameters: {
|
|
1374
1374
|
query?: never;
|
|
1375
1375
|
header?: never;
|
|
@@ -1380,7 +1380,7 @@ export interface webhooks {
|
|
|
1380
1380
|
put?: never;
|
|
1381
1381
|
/**
|
|
1382
1382
|
* Triggered when a refund is completed
|
|
1383
|
-
* @description Webhook for
|
|
1383
|
+
* @description Webhook for ON_REFUND
|
|
1384
1384
|
*/
|
|
1385
1385
|
post: {
|
|
1386
1386
|
parameters: {
|
|
@@ -1396,13 +1396,13 @@ export interface webhooks {
|
|
|
1396
1396
|
* @description The type of webhook event
|
|
1397
1397
|
* @example ON_REFUND
|
|
1398
1398
|
*/
|
|
1399
|
-
event_type:
|
|
1399
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1400
1400
|
/**
|
|
1401
|
-
* Format:
|
|
1402
|
-
* @description
|
|
1403
|
-
* @example
|
|
1401
|
+
* Format: flake-id
|
|
1402
|
+
* @description The ID of the Webhook Event
|
|
1403
|
+
* @example 411486491630370816
|
|
1404
1404
|
*/
|
|
1405
|
-
|
|
1405
|
+
event_id?: string;
|
|
1406
1406
|
body: {
|
|
1407
1407
|
/**
|
|
1408
1408
|
* Format: flake-id
|
|
@@ -1422,7 +1422,7 @@ export interface webhooks {
|
|
|
1422
1422
|
* @example 411486491630370816
|
|
1423
1423
|
*/
|
|
1424
1424
|
order_id?: string;
|
|
1425
|
-
customer?: components["schemas"]["CustomerDTO"];
|
|
1425
|
+
customer?: components["schemas"]["CustomerDTO"] | null;
|
|
1426
1426
|
/**
|
|
1427
1427
|
* Format: flake-id
|
|
1428
1428
|
* @description The Flake ID of the Payment associated with the refund
|
|
@@ -1539,7 +1539,7 @@ export interface webhooks {
|
|
|
1539
1539
|
patch?: never;
|
|
1540
1540
|
trace?: never;
|
|
1541
1541
|
};
|
|
1542
|
-
|
|
1542
|
+
ON_SUBSCRIPTION_ACTIVATED: {
|
|
1543
1543
|
parameters: {
|
|
1544
1544
|
query?: never;
|
|
1545
1545
|
header?: never;
|
|
@@ -1550,7 +1550,7 @@ export interface webhooks {
|
|
|
1550
1550
|
put?: never;
|
|
1551
1551
|
/**
|
|
1552
1552
|
* Triggered when a subscription is activated
|
|
1553
|
-
* @description Webhook for
|
|
1553
|
+
* @description Webhook for ON_SUBSCRIPTION_ACTIVATED
|
|
1554
1554
|
*/
|
|
1555
1555
|
post: {
|
|
1556
1556
|
parameters: {
|
|
@@ -1566,13 +1566,13 @@ export interface webhooks {
|
|
|
1566
1566
|
* @description The type of webhook event
|
|
1567
1567
|
* @example ON_SUBSCRIPTION_ACTIVATED
|
|
1568
1568
|
*/
|
|
1569
|
-
event_type:
|
|
1569
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1570
1570
|
/**
|
|
1571
|
-
* Format:
|
|
1572
|
-
* @description
|
|
1573
|
-
* @example
|
|
1571
|
+
* Format: flake-id
|
|
1572
|
+
* @description The ID of the Webhook Event
|
|
1573
|
+
* @example 411486491630370816
|
|
1574
1574
|
*/
|
|
1575
|
-
|
|
1575
|
+
event_id?: string;
|
|
1576
1576
|
body: {
|
|
1577
1577
|
/**
|
|
1578
1578
|
* Format: flake-id
|
|
@@ -1659,7 +1659,7 @@ export interface webhooks {
|
|
|
1659
1659
|
* @description The image URL of the Product associated with the Subscription
|
|
1660
1660
|
* @example https://example.com/image.jpg
|
|
1661
1661
|
*/
|
|
1662
|
-
product_image_url?: string;
|
|
1662
|
+
product_image_url?: null | string;
|
|
1663
1663
|
product?: components["schemas"]["ProductDTO"];
|
|
1664
1664
|
/**
|
|
1665
1665
|
* @description The ISO-3166 Country Code of customer associated with the Subscription
|
|
@@ -1701,25 +1701,25 @@ export interface webhooks {
|
|
|
1701
1701
|
* @description The start date of the current billing period
|
|
1702
1702
|
* @example 2024-02-01T00:00:00Z
|
|
1703
1703
|
*/
|
|
1704
|
-
current_period_start?: string;
|
|
1704
|
+
current_period_start?: null | string;
|
|
1705
1705
|
/**
|
|
1706
1706
|
* Format: date-time
|
|
1707
1707
|
* @description The end date of the current billing period
|
|
1708
1708
|
* @example 2024-03-01T00:00:00Z
|
|
1709
1709
|
*/
|
|
1710
|
-
current_period_end?: string;
|
|
1710
|
+
current_period_end?: null | string;
|
|
1711
1711
|
/**
|
|
1712
1712
|
* Format: date-time
|
|
1713
1713
|
* @description The date and time when the Subscription was created
|
|
1714
1714
|
* @example 2024-02-01T10:15:00Z
|
|
1715
1715
|
*/
|
|
1716
|
-
created_at?: string;
|
|
1716
|
+
created_at?: null | string;
|
|
1717
1717
|
/**
|
|
1718
1718
|
* Format: date-time
|
|
1719
1719
|
* @description Indicates when the subscription was active
|
|
1720
1720
|
* @example 2024-02-01T10:20:00Z
|
|
1721
1721
|
*/
|
|
1722
|
-
active_at?: string;
|
|
1722
|
+
active_at?: null | string;
|
|
1723
1723
|
/**
|
|
1724
1724
|
* Format: flake-id
|
|
1725
1725
|
* @description The Flake ID of the Checkout associated with the Subscription
|
|
@@ -1771,7 +1771,7 @@ export interface webhooks {
|
|
|
1771
1771
|
patch?: never;
|
|
1772
1772
|
trace?: never;
|
|
1773
1773
|
};
|
|
1774
|
-
|
|
1774
|
+
ON_SUBSCRIPTION_CANCELED: {
|
|
1775
1775
|
parameters: {
|
|
1776
1776
|
query?: never;
|
|
1777
1777
|
header?: never;
|
|
@@ -1782,7 +1782,7 @@ export interface webhooks {
|
|
|
1782
1782
|
put?: never;
|
|
1783
1783
|
/**
|
|
1784
1784
|
* Triggered when a subscription is canceled
|
|
1785
|
-
* @description Webhook for
|
|
1785
|
+
* @description Webhook for ON_SUBSCRIPTION_CANCELED
|
|
1786
1786
|
*/
|
|
1787
1787
|
post: {
|
|
1788
1788
|
parameters: {
|
|
@@ -1798,13 +1798,13 @@ export interface webhooks {
|
|
|
1798
1798
|
* @description The type of webhook event
|
|
1799
1799
|
* @example ON_SUBSCRIPTION_CANCELED
|
|
1800
1800
|
*/
|
|
1801
|
-
event_type:
|
|
1801
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
1802
1802
|
/**
|
|
1803
|
-
* Format:
|
|
1804
|
-
* @description
|
|
1805
|
-
* @example
|
|
1803
|
+
* Format: flake-id
|
|
1804
|
+
* @description The ID of the Webhook Event
|
|
1805
|
+
* @example 411486491630370816
|
|
1806
1806
|
*/
|
|
1807
|
-
|
|
1807
|
+
event_id?: string;
|
|
1808
1808
|
body: {
|
|
1809
1809
|
/**
|
|
1810
1810
|
* Format: flake-id
|
|
@@ -1891,7 +1891,7 @@ export interface webhooks {
|
|
|
1891
1891
|
* @description The image URL of the Product associated with the Subscription
|
|
1892
1892
|
* @example https://example.com/starter.jpg
|
|
1893
1893
|
*/
|
|
1894
|
-
product_image_url?: string;
|
|
1894
|
+
product_image_url?: null | string;
|
|
1895
1895
|
product?: components["schemas"]["ProductDTO"];
|
|
1896
1896
|
/**
|
|
1897
1897
|
* @description The ISO-3166 country code of customer associated with the Subscription
|
|
@@ -1933,36 +1933,36 @@ export interface webhooks {
|
|
|
1933
1933
|
* @description The start date of the current billing period
|
|
1934
1934
|
* @example 2024-04-01T00:00:00Z
|
|
1935
1935
|
*/
|
|
1936
|
-
current_period_start?: string;
|
|
1936
|
+
current_period_start?: null | string;
|
|
1937
1937
|
/**
|
|
1938
1938
|
* Format: date-time
|
|
1939
1939
|
* @description The end date of the current billing period
|
|
1940
1940
|
* @example 2025-04-01T00:00:00Z
|
|
1941
1941
|
*/
|
|
1942
|
-
current_period_end?: string;
|
|
1942
|
+
current_period_end?: null | string;
|
|
1943
1943
|
/**
|
|
1944
1944
|
* Format: date-time
|
|
1945
1945
|
* @description The date and time when the Subscription was created
|
|
1946
1946
|
* @example 2024-04-01T09:30:00Z
|
|
1947
1947
|
*/
|
|
1948
|
-
created_at?: string;
|
|
1948
|
+
created_at?: null | string;
|
|
1949
1949
|
/**
|
|
1950
1950
|
* Format: date-time
|
|
1951
1951
|
* @description Indicates when the subscription was active
|
|
1952
1952
|
* @example 2024-04-01T09:35:00Z
|
|
1953
1953
|
*/
|
|
1954
|
-
active_at?: string;
|
|
1954
|
+
active_at?: null | string;
|
|
1955
1955
|
/**
|
|
1956
1956
|
* Format: date-time
|
|
1957
1957
|
* @description Indicates when the subscription was canceled
|
|
1958
1958
|
* @example 2024-05-15T14:20:00Z
|
|
1959
1959
|
*/
|
|
1960
|
-
canceled_at?: string;
|
|
1960
|
+
canceled_at?: null | string;
|
|
1961
1961
|
/**
|
|
1962
1962
|
* @description The reason for the subscription cancellation
|
|
1963
1963
|
* @example customer_request
|
|
1964
1964
|
*/
|
|
1965
|
-
cancel_reason?: string;
|
|
1965
|
+
cancel_reason?: null | string;
|
|
1966
1966
|
/**
|
|
1967
1967
|
* Format: flake-id
|
|
1968
1968
|
* @description The Flake ID of the Checkout associated with the Subscription
|
|
@@ -2014,7 +2014,7 @@ export interface webhooks {
|
|
|
2014
2014
|
patch?: never;
|
|
2015
2015
|
trace?: never;
|
|
2016
2016
|
};
|
|
2017
|
-
|
|
2017
|
+
ON_TRIAL_ACTIVATED: {
|
|
2018
2018
|
parameters: {
|
|
2019
2019
|
query?: never;
|
|
2020
2020
|
header?: never;
|
|
@@ -2025,7 +2025,7 @@ export interface webhooks {
|
|
|
2025
2025
|
put?: never;
|
|
2026
2026
|
/**
|
|
2027
2027
|
* Triggered when a trial is activated
|
|
2028
|
-
* @description Webhook for
|
|
2028
|
+
* @description Webhook for ON_TRIAL_ACTIVATED
|
|
2029
2029
|
*/
|
|
2030
2030
|
post: {
|
|
2031
2031
|
parameters: {
|
|
@@ -2041,13 +2041,13 @@ export interface webhooks {
|
|
|
2041
2041
|
* @description The type of webhook event
|
|
2042
2042
|
* @example ON_TRIAL_ACTIVATED
|
|
2043
2043
|
*/
|
|
2044
|
-
event_type:
|
|
2044
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
2045
2045
|
/**
|
|
2046
|
-
* Format:
|
|
2047
|
-
* @description
|
|
2048
|
-
* @example
|
|
2046
|
+
* Format: flake-id
|
|
2047
|
+
* @description The ID of the Webhook Event
|
|
2048
|
+
* @example 411486491630370816
|
|
2049
2049
|
*/
|
|
2050
|
-
|
|
2050
|
+
event_id?: string;
|
|
2051
2051
|
body: {
|
|
2052
2052
|
/**
|
|
2053
2053
|
* Format: flake-id
|
|
@@ -2073,13 +2073,13 @@ export interface webhooks {
|
|
|
2073
2073
|
* @description The Flake ID of the Checkout associated with the Trial
|
|
2074
2074
|
* @example 411486491630370816
|
|
2075
2075
|
*/
|
|
2076
|
-
checkout_id?: string;
|
|
2076
|
+
checkout_id?: null | string;
|
|
2077
2077
|
/**
|
|
2078
2078
|
* Format: flake-id
|
|
2079
2079
|
* @description The Flake ID of the Checkout Line associated with the Trial
|
|
2080
2080
|
* @example 411486491630370816
|
|
2081
2081
|
*/
|
|
2082
|
-
checkout_line_id?: string;
|
|
2082
|
+
checkout_line_id?: null | string;
|
|
2083
2083
|
/**
|
|
2084
2084
|
* Format: flake-id
|
|
2085
2085
|
* @description The Flake ID of the Product associated with the Trial
|
|
@@ -2101,7 +2101,7 @@ export interface webhooks {
|
|
|
2101
2101
|
* @description The image URL of the Product associated with the Trial
|
|
2102
2102
|
* @example https://example.com/image.jpg
|
|
2103
2103
|
*/
|
|
2104
|
-
product_image_url?: string;
|
|
2104
|
+
product_image_url?: null | string;
|
|
2105
2105
|
/**
|
|
2106
2106
|
* @description The period value of the Trial
|
|
2107
2107
|
* @example 1
|
|
@@ -2117,13 +2117,13 @@ export interface webhooks {
|
|
|
2117
2117
|
* @description The start date of the Trial
|
|
2118
2118
|
* @example 2024-06-10T00:00:00Z
|
|
2119
2119
|
*/
|
|
2120
|
-
starts_at?: string;
|
|
2120
|
+
starts_at?: null | string;
|
|
2121
2121
|
/**
|
|
2122
2122
|
* Format: date-time
|
|
2123
2123
|
* @description The end date of the Trial
|
|
2124
2124
|
* @example 2024-06-17T23:59:59Z
|
|
2125
2125
|
*/
|
|
2126
|
-
ends_at?: string;
|
|
2126
|
+
ends_at?: null | string;
|
|
2127
2127
|
/**
|
|
2128
2128
|
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2129
2129
|
* @example created
|
|
@@ -2140,7 +2140,7 @@ export interface webhooks {
|
|
|
2140
2140
|
* @description Indicates when the Trial was canceled
|
|
2141
2141
|
* @example 2024-06-15T10:15:00Z
|
|
2142
2142
|
*/
|
|
2143
|
-
canceled_at?: string;
|
|
2143
|
+
canceled_at?: null | string;
|
|
2144
2144
|
};
|
|
2145
2145
|
};
|
|
2146
2146
|
};
|
|
@@ -2175,7 +2175,7 @@ export interface webhooks {
|
|
|
2175
2175
|
patch?: never;
|
|
2176
2176
|
trace?: never;
|
|
2177
2177
|
};
|
|
2178
|
-
|
|
2178
|
+
ON_TRIAL_COMPLETED: {
|
|
2179
2179
|
parameters: {
|
|
2180
2180
|
query?: never;
|
|
2181
2181
|
header?: never;
|
|
@@ -2186,7 +2186,7 @@ export interface webhooks {
|
|
|
2186
2186
|
put?: never;
|
|
2187
2187
|
/**
|
|
2188
2188
|
* Triggered when a trial is completed
|
|
2189
|
-
* @description Webhook for
|
|
2189
|
+
* @description Webhook for ON_TRIAL_COMPLETED
|
|
2190
2190
|
*/
|
|
2191
2191
|
post: {
|
|
2192
2192
|
parameters: {
|
|
@@ -2202,13 +2202,13 @@ export interface webhooks {
|
|
|
2202
2202
|
* @description The type of webhook event
|
|
2203
2203
|
* @example ON_TRIAL_COMPLETED
|
|
2204
2204
|
*/
|
|
2205
|
-
event_type:
|
|
2205
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
2206
2206
|
/**
|
|
2207
|
-
* Format:
|
|
2208
|
-
* @description
|
|
2209
|
-
* @example
|
|
2207
|
+
* Format: flake-id
|
|
2208
|
+
* @description The ID of the Webhook Event
|
|
2209
|
+
* @example 411486491630370816
|
|
2210
2210
|
*/
|
|
2211
|
-
|
|
2211
|
+
event_id?: string;
|
|
2212
2212
|
body: {
|
|
2213
2213
|
/**
|
|
2214
2214
|
* Format: flake-id
|
|
@@ -2234,13 +2234,13 @@ export interface webhooks {
|
|
|
2234
2234
|
* @description The Flake ID of the Checkout associated with the Trial
|
|
2235
2235
|
* @example 411486491630370816
|
|
2236
2236
|
*/
|
|
2237
|
-
checkout_id?: string;
|
|
2237
|
+
checkout_id?: null | string;
|
|
2238
2238
|
/**
|
|
2239
2239
|
* Format: flake-id
|
|
2240
2240
|
* @description The Flake ID of the Checkout Line associated with the Trial
|
|
2241
2241
|
* @example 411486491630370816
|
|
2242
2242
|
*/
|
|
2243
|
-
checkout_line_id?: string;
|
|
2243
|
+
checkout_line_id?: null | string;
|
|
2244
2244
|
/**
|
|
2245
2245
|
* Format: flake-id
|
|
2246
2246
|
* @description The Flake ID of the Product associated with the Trial
|
|
@@ -2262,7 +2262,7 @@ export interface webhooks {
|
|
|
2262
2262
|
* @description The image URL of the Product associated with the Trial
|
|
2263
2263
|
* @example https://example.com/image.jpg
|
|
2264
2264
|
*/
|
|
2265
|
-
product_image_url?: string;
|
|
2265
|
+
product_image_url?: null | string;
|
|
2266
2266
|
/**
|
|
2267
2267
|
* @description The period value of the Trial
|
|
2268
2268
|
* @example 1
|
|
@@ -2278,13 +2278,13 @@ export interface webhooks {
|
|
|
2278
2278
|
* @description The start date of the Trial
|
|
2279
2279
|
* @example 2024-06-10T00:00:00Z
|
|
2280
2280
|
*/
|
|
2281
|
-
starts_at?: string;
|
|
2281
|
+
starts_at?: null | string;
|
|
2282
2282
|
/**
|
|
2283
2283
|
* Format: date-time
|
|
2284
2284
|
* @description The end date of the Trial
|
|
2285
2285
|
* @example 2024-06-17T23:59:59Z
|
|
2286
2286
|
*/
|
|
2287
|
-
ends_at?: string;
|
|
2287
|
+
ends_at?: null | string;
|
|
2288
2288
|
/**
|
|
2289
2289
|
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2290
2290
|
* @example created
|
|
@@ -2301,7 +2301,7 @@ export interface webhooks {
|
|
|
2301
2301
|
* @description Indicates when the Trial was canceled
|
|
2302
2302
|
* @example 2024-06-15T10:15:00Z
|
|
2303
2303
|
*/
|
|
2304
|
-
canceled_at?: string;
|
|
2304
|
+
canceled_at?: null | string;
|
|
2305
2305
|
};
|
|
2306
2306
|
};
|
|
2307
2307
|
};
|
|
@@ -2336,7 +2336,7 @@ export interface webhooks {
|
|
|
2336
2336
|
patch?: never;
|
|
2337
2337
|
trace?: never;
|
|
2338
2338
|
};
|
|
2339
|
-
|
|
2339
|
+
ON_TRIAL_CANCELED: {
|
|
2340
2340
|
parameters: {
|
|
2341
2341
|
query?: never;
|
|
2342
2342
|
header?: never;
|
|
@@ -2347,7 +2347,7 @@ export interface webhooks {
|
|
|
2347
2347
|
put?: never;
|
|
2348
2348
|
/**
|
|
2349
2349
|
* Triggered when a trial is canceled
|
|
2350
|
-
* @description Webhook for
|
|
2350
|
+
* @description Webhook for ON_TRIAL_CANCELED
|
|
2351
2351
|
*/
|
|
2352
2352
|
post: {
|
|
2353
2353
|
parameters: {
|
|
@@ -2361,15 +2361,15 @@ export interface webhooks {
|
|
|
2361
2361
|
"application/json": {
|
|
2362
2362
|
/**
|
|
2363
2363
|
* @description The type of webhook event
|
|
2364
|
-
* @example
|
|
2364
|
+
* @example ON_TRIAL_CANCELED
|
|
2365
2365
|
*/
|
|
2366
|
-
event_type:
|
|
2366
|
+
event_type: components["schemas"]["WebhookEventType"];
|
|
2367
2367
|
/**
|
|
2368
|
-
* Format:
|
|
2369
|
-
* @description
|
|
2370
|
-
* @example
|
|
2368
|
+
* Format: flake-id
|
|
2369
|
+
* @description The ID of the Webhook Event
|
|
2370
|
+
* @example 411486491630370816
|
|
2371
2371
|
*/
|
|
2372
|
-
|
|
2372
|
+
event_id?: string;
|
|
2373
2373
|
body: {
|
|
2374
2374
|
/**
|
|
2375
2375
|
* Format: flake-id
|
|
@@ -2395,13 +2395,13 @@ export interface webhooks {
|
|
|
2395
2395
|
* @description The Flake ID of the Checkout associated with the Trial
|
|
2396
2396
|
* @example 411486491630370816
|
|
2397
2397
|
*/
|
|
2398
|
-
checkout_id?: string;
|
|
2398
|
+
checkout_id?: null | string;
|
|
2399
2399
|
/**
|
|
2400
2400
|
* Format: flake-id
|
|
2401
2401
|
* @description The Flake ID of the Checkout Line associated with the Trial
|
|
2402
2402
|
* @example 411486491630370816
|
|
2403
2403
|
*/
|
|
2404
|
-
checkout_line_id?: string;
|
|
2404
|
+
checkout_line_id?: null | string;
|
|
2405
2405
|
/**
|
|
2406
2406
|
* Format: flake-id
|
|
2407
2407
|
* @description The Flake ID of the Product associated with the Trial
|
|
@@ -2423,7 +2423,7 @@ export interface webhooks {
|
|
|
2423
2423
|
* @description The image URL of the Product associated with the Trial
|
|
2424
2424
|
* @example https://example.com/image.jpg
|
|
2425
2425
|
*/
|
|
2426
|
-
product_image_url?: string;
|
|
2426
|
+
product_image_url?: null | string;
|
|
2427
2427
|
/**
|
|
2428
2428
|
* @description The period value of the Trial
|
|
2429
2429
|
* @example 1
|
|
@@ -2439,13 +2439,13 @@ export interface webhooks {
|
|
|
2439
2439
|
* @description The start date of the Trial
|
|
2440
2440
|
* @example 2024-06-10T00:00:00Z
|
|
2441
2441
|
*/
|
|
2442
|
-
starts_at?: string;
|
|
2442
|
+
starts_at?: null | string;
|
|
2443
2443
|
/**
|
|
2444
2444
|
* Format: date-time
|
|
2445
2445
|
* @description The end date of the Trial
|
|
2446
2446
|
* @example 2024-06-17T23:59:59Z
|
|
2447
2447
|
*/
|
|
2448
|
-
ends_at?: string;
|
|
2448
|
+
ends_at?: null | string;
|
|
2449
2449
|
/**
|
|
2450
2450
|
* @description The current status of the Trial. Possible options: created, active, canceled, completed
|
|
2451
2451
|
* @example created
|
|
@@ -2462,7 +2462,7 @@ export interface webhooks {
|
|
|
2462
2462
|
* @description Indicates when the Trial was canceled
|
|
2463
2463
|
* @example 2024-06-15T10:15:00Z
|
|
2464
2464
|
*/
|
|
2465
|
-
canceled_at?: string;
|
|
2465
|
+
canceled_at?: null | string;
|
|
2466
2466
|
};
|
|
2467
2467
|
};
|
|
2468
2468
|
};
|
|
@@ -2546,7 +2546,7 @@ export interface components {
|
|
|
2546
2546
|
*/
|
|
2547
2547
|
id?: string;
|
|
2548
2548
|
/** @example John */
|
|
2549
|
-
name?: string;
|
|
2549
|
+
name?: null | string;
|
|
2550
2550
|
steam?: components["schemas"]["SteamCustomerDTO"];
|
|
2551
2551
|
minecraft?: components["schemas"]["MinecraftCustomerDTO"];
|
|
2552
2552
|
profile?: components["schemas"]["GenericProfileDTO"];
|
|
@@ -2605,13 +2605,13 @@ export interface components {
|
|
|
2605
2605
|
* @description The Flake ID of the Subscription associated with the order
|
|
2606
2606
|
* @example 411486491630370816
|
|
2607
2607
|
*/
|
|
2608
|
-
subscription_id?: string;
|
|
2608
|
+
subscription_id?: null | string;
|
|
2609
2609
|
/**
|
|
2610
2610
|
* Format: flake-id
|
|
2611
2611
|
* @description The Flake ID of the Coupon associated with the order
|
|
2612
2612
|
* @example 411486491630370816
|
|
2613
2613
|
*/
|
|
2614
|
-
coupon_id?: string;
|
|
2614
|
+
coupon_id?: null | string;
|
|
2615
2615
|
/**
|
|
2616
2616
|
* @description The ISO-4217 Currency Code of the order
|
|
2617
2617
|
* @example USD
|
|
@@ -2731,30 +2731,30 @@ export interface components {
|
|
|
2731
2731
|
/** @description The name of the product associated with this Order Line */
|
|
2732
2732
|
product_name?: string;
|
|
2733
2733
|
/** @description The Image URL of the Product associated with this Order Line */
|
|
2734
|
-
product_image_url?: string;
|
|
2734
|
+
product_image_url?: null | string;
|
|
2735
2735
|
/**
|
|
2736
2736
|
* Format: flake-id
|
|
2737
2737
|
* @description The Flake ID of the Subscription associated with this Order Line
|
|
2738
2738
|
* @example 411486491630370816
|
|
2739
2739
|
*/
|
|
2740
|
-
subscription_id?: string;
|
|
2740
|
+
subscription_id?: null | string;
|
|
2741
2741
|
/**
|
|
2742
2742
|
* @description The value of the interval in which the subscription associated with this Order Line renews at
|
|
2743
2743
|
* @example 1
|
|
2744
2744
|
*/
|
|
2745
|
-
subscription_interval_value?: number;
|
|
2745
|
+
subscription_interval_value?: null | number;
|
|
2746
2746
|
/**
|
|
2747
2747
|
* @description The value of the scale in which the subscription associated with this Order Line renews at
|
|
2748
2748
|
* @example month
|
|
2749
2749
|
*/
|
|
2750
|
-
subscription_interval_scale?: string;
|
|
2750
|
+
subscription_interval_scale?: null | string;
|
|
2751
2751
|
/**
|
|
2752
2752
|
* Format: flake-id
|
|
2753
2753
|
* @description The Flake ID of the Trial associated with this Order Line
|
|
2754
2754
|
* @example 411486491630370816
|
|
2755
2755
|
*/
|
|
2756
|
-
trial_id?: string;
|
|
2757
|
-
gift_to_customer?: components["schemas"]["CustomerDTO"];
|
|
2756
|
+
trial_id?: null | string;
|
|
2757
|
+
gift_to_customer?: components["schemas"]["CustomerDTO"] | null;
|
|
2758
2758
|
/**
|
|
2759
2759
|
* @description The price of the Order Line
|
|
2760
2760
|
* @example 1000
|
|
@@ -2790,7 +2790,7 @@ export interface components {
|
|
|
2790
2790
|
* @description The Flake ID of which was the selected Game Server ID for the Order Line
|
|
2791
2791
|
* @example 411486491630370816
|
|
2792
2792
|
*/
|
|
2793
|
-
selected_gameserver_id?: string;
|
|
2793
|
+
selected_gameserver_id?: null | string;
|
|
2794
2794
|
};
|
|
2795
2795
|
ProductCommandDTO: {
|
|
2796
2796
|
/**
|
|
@@ -2823,7 +2823,7 @@ export interface components {
|
|
|
2823
2823
|
*/
|
|
2824
2824
|
version_id?: string;
|
|
2825
2825
|
/** @description The Image URL of the product */
|
|
2826
|
-
image_url?: string;
|
|
2826
|
+
image_url?: null | string;
|
|
2827
2827
|
/** @description The URL-Friendly Slug of the Product */
|
|
2828
2828
|
slug?: string;
|
|
2829
2829
|
/** @description The name of the Product */
|
|
@@ -2833,7 +2833,7 @@ export interface components {
|
|
|
2833
2833
|
/** @description Indicates if the product is enabled. */
|
|
2834
2834
|
enabled?: boolean;
|
|
2835
2835
|
/** @description The label of the product */
|
|
2836
|
-
label?: string;
|
|
2836
|
+
label?: null | string;
|
|
2837
2837
|
/** @description The sort order of the product */
|
|
2838
2838
|
sort_order?: number;
|
|
2839
2839
|
/** @description The price of the product, represented in cents. */
|
|
@@ -2848,24 +2848,24 @@ export interface components {
|
|
|
2848
2848
|
* @description The value of the interval in which the product subscription renews at
|
|
2849
2849
|
* @example 1
|
|
2850
2850
|
*/
|
|
2851
|
-
subscription_interval_value?: number;
|
|
2851
|
+
subscription_interval_value?: null | number;
|
|
2852
2852
|
/**
|
|
2853
2853
|
* @description The value of the interval in which the product subscription renews at
|
|
2854
2854
|
* @example month
|
|
2855
2855
|
*/
|
|
2856
|
-
subscription_interval_scale?: string;
|
|
2856
|
+
subscription_interval_scale?: null | string;
|
|
2857
2857
|
/** @description Indicates whether automatic removal is enabled */
|
|
2858
2858
|
remove_after_enabled?: boolean;
|
|
2859
2859
|
/**
|
|
2860
2860
|
* @description The value of the time in which this product should be removed
|
|
2861
2861
|
* @example 1
|
|
2862
2862
|
*/
|
|
2863
|
-
remove_after_time_value?: number;
|
|
2863
|
+
remove_after_time_value?: null | number;
|
|
2864
2864
|
/**
|
|
2865
2865
|
* @description The scale of the time in which this product should be removed
|
|
2866
2866
|
* @example month
|
|
2867
2867
|
*/
|
|
2868
|
-
remove_after_time_scale?: string;
|
|
2868
|
+
remove_after_time_scale?: null | string;
|
|
2869
2869
|
/** @description The tags associated with the product */
|
|
2870
2870
|
tags?: components["schemas"]["ProductTagDTO"][];
|
|
2871
2871
|
/** @description A comma-seperated string of all the tags associated with the product */
|
|
@@ -2880,12 +2880,12 @@ export interface components {
|
|
|
2880
2880
|
* Format: date-time
|
|
2881
2881
|
* @description When the product was created
|
|
2882
2882
|
*/
|
|
2883
|
-
created_at?: string;
|
|
2883
|
+
created_at?: null | string;
|
|
2884
2884
|
/**
|
|
2885
2885
|
* Format: date-time
|
|
2886
2886
|
* @description When the product was last updated
|
|
2887
2887
|
*/
|
|
2888
|
-
updated_at?: string;
|
|
2888
|
+
updated_at?: null | string;
|
|
2889
2889
|
/** @description The metadata of the product */
|
|
2890
2890
|
metadata?: {
|
|
2891
2891
|
[key: string]: string;
|
|
@@ -2929,6 +2929,11 @@ export interface components {
|
|
|
2929
2929
|
/** @description The Steam Avatar URL */
|
|
2930
2930
|
avatar_url?: string;
|
|
2931
2931
|
};
|
|
2932
|
+
/**
|
|
2933
|
+
* @description The type of webhook event
|
|
2934
|
+
* @enum {string}
|
|
2935
|
+
*/
|
|
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";
|
|
2932
2937
|
};
|
|
2933
2938
|
responses: never;
|
|
2934
2939
|
parameters: never;
|