@capibox/bridge-server 0.0.77 → 0.0.78
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/dist/index.d.mts +1163 -162
- package/dist/index.d.ts +1163 -162
- package/dist/index.js.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -558,113 +558,140 @@ interface components {
|
|
|
558
558
|
other: components["schemas"]["IntegrationResponseDto"][];
|
|
559
559
|
};
|
|
560
560
|
FunnelTemplatesEnumDto: {
|
|
561
|
-
/**
|
|
562
|
-
*
|
|
563
|
-
*
|
|
564
|
-
*
|
|
565
|
-
* ]
|
|
566
|
-
*/
|
|
561
|
+
/** @example [
|
|
562
|
+
* "hp_default",
|
|
563
|
+
* "hp_longform"
|
|
564
|
+
* ] */
|
|
567
565
|
homePageTemplate: string[];
|
|
568
|
-
/**
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
*
|
|
572
|
-
* ]
|
|
573
|
-
*/
|
|
566
|
+
/** @example [
|
|
567
|
+
* "quiz_v1",
|
|
568
|
+
* "quiz_v2"
|
|
569
|
+
* ] */
|
|
574
570
|
quizPageTemplate: string[];
|
|
575
|
-
/**
|
|
576
|
-
*
|
|
577
|
-
*
|
|
578
|
-
*
|
|
579
|
-
* ]
|
|
580
|
-
*/
|
|
571
|
+
/** @example [
|
|
572
|
+
* "result_basic",
|
|
573
|
+
* "result_pro"
|
|
574
|
+
* ] */
|
|
581
575
|
resultPageTemplate: string[];
|
|
582
|
-
/**
|
|
583
|
-
*
|
|
584
|
-
*
|
|
585
|
-
*
|
|
586
|
-
* ]
|
|
587
|
-
*/
|
|
576
|
+
/** @example [
|
|
577
|
+
* "email_capture_simple",
|
|
578
|
+
* "email_capture_2step"
|
|
579
|
+
* ] */
|
|
588
580
|
emailPageTemplate: string[];
|
|
589
|
-
/**
|
|
590
|
-
*
|
|
591
|
-
*
|
|
592
|
-
*
|
|
593
|
-
* ]
|
|
594
|
-
*/
|
|
581
|
+
/** @example [
|
|
582
|
+
* "checkout_onepage",
|
|
583
|
+
* "checkout_two_step"
|
|
584
|
+
* ] */
|
|
595
585
|
checkoutPageTemplate: string[];
|
|
596
|
-
/**
|
|
597
|
-
*
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
* ]
|
|
601
|
-
*/
|
|
586
|
+
/** @example [
|
|
587
|
+
* "upsell_inline",
|
|
588
|
+
* "upsell_popup"
|
|
589
|
+
* ] */
|
|
602
590
|
upsellPageTemplate: string[];
|
|
603
|
-
/**
|
|
604
|
-
*
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
* ]
|
|
608
|
-
*/
|
|
591
|
+
/** @example [
|
|
592
|
+
* "payment_sidecar",
|
|
593
|
+
* "payment_modal"
|
|
594
|
+
* ] */
|
|
609
595
|
paymentWindowTemplate: string[];
|
|
596
|
+
/** @example [
|
|
597
|
+
* "thankyou_basic",
|
|
598
|
+
* "thankyou_with_survey"
|
|
599
|
+
* ] */
|
|
600
|
+
thankyouPageTemplate: string[];
|
|
610
601
|
};
|
|
611
602
|
FunnelTemplatesEnumResponseDto: {
|
|
612
|
-
/** @
|
|
603
|
+
/** @example true */
|
|
613
604
|
success: boolean;
|
|
614
605
|
data: components["schemas"]["FunnelTemplatesEnumDto"];
|
|
615
606
|
};
|
|
616
607
|
CreateFunnelDtoBridge: {
|
|
608
|
+
/** @example weight-loss-women-40+ */
|
|
617
609
|
angle: string;
|
|
610
|
+
/** @example v3 */
|
|
618
611
|
version: string;
|
|
612
|
+
/** @example Initial rollout for ES market */
|
|
619
613
|
note?: string;
|
|
614
|
+
/** @example hp_default */
|
|
620
615
|
home_page?: string;
|
|
616
|
+
/** @example quiz_v2 */
|
|
621
617
|
quiz_page?: string;
|
|
618
|
+
/** @example result_pro */
|
|
622
619
|
results_page?: string;
|
|
620
|
+
/** @example email_capture_2step */
|
|
623
621
|
email_page?: string;
|
|
622
|
+
/** @example checkout_two_step */
|
|
624
623
|
checkout_page?: string;
|
|
624
|
+
/** @example payment_modal */
|
|
625
625
|
payment_window?: string;
|
|
626
|
+
/** @example upsell_inline */
|
|
626
627
|
upsell_page: string;
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
628
|
+
/** @example thankyou_basic */
|
|
629
|
+
thankyou_page_template?: string;
|
|
630
|
+
/** @example {
|
|
631
|
+
* "offerA": true,
|
|
632
|
+
* "bump": "shipping-insurance"
|
|
633
|
+
* } */
|
|
634
|
+
upsell_options?: Record<string, never>;
|
|
635
|
+
/** @example {
|
|
636
|
+
* "locale": "es-ES",
|
|
637
|
+
* "currency": "EUR"
|
|
638
|
+
* } */
|
|
639
|
+
options?: Record<string, never>;
|
|
633
640
|
};
|
|
634
641
|
FunnelResponseDto: {
|
|
642
|
+
/** @example 42 */
|
|
635
643
|
id: number;
|
|
644
|
+
/** @example fametonic-es */
|
|
636
645
|
project: string;
|
|
646
|
+
/** @example weight-loss-women-40+ */
|
|
637
647
|
angle: string;
|
|
648
|
+
/** @example v3 */
|
|
638
649
|
version: string;
|
|
650
|
+
/** @example A/B test for new hero copy */
|
|
639
651
|
note?: string;
|
|
652
|
+
/** @example hp_default */
|
|
640
653
|
home_page: string;
|
|
654
|
+
/** @example quiz_v2 */
|
|
641
655
|
quiz_page: string;
|
|
656
|
+
/** @example result_pro */
|
|
642
657
|
results_page: string;
|
|
658
|
+
/** @example email_capture_2step */
|
|
643
659
|
email_page: string;
|
|
660
|
+
/** @example checkout_two_step */
|
|
644
661
|
checkout_page: string;
|
|
662
|
+
/** @example payment_modal */
|
|
645
663
|
payment_window: string;
|
|
664
|
+
/** @example upsell_inline */
|
|
646
665
|
upsell_page: string;
|
|
666
|
+
/** @example thankyou_with_survey */
|
|
667
|
+
thankyou_page_template: string;
|
|
668
|
+
/** @example {
|
|
669
|
+
* "offerA": true,
|
|
670
|
+
* "offerB": false,
|
|
671
|
+
* "bump": "shipping-insurance"
|
|
672
|
+
* } */
|
|
647
673
|
upsell_options?: Record<string, never>;
|
|
674
|
+
/** @example {
|
|
675
|
+
* "locale": "es-ES",
|
|
676
|
+
* "currency": "EUR",
|
|
677
|
+
* "flags": [
|
|
678
|
+
* "gdpr",
|
|
679
|
+
* "cookie-consent"
|
|
680
|
+
* ]
|
|
681
|
+
* } */
|
|
648
682
|
options?: Record<string, never>;
|
|
649
683
|
};
|
|
650
684
|
UpdateFunnelDto: {
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
upsell_page?: string;
|
|
662
|
-
upsell_options?: {
|
|
663
|
-
[key: string]: unknown;
|
|
664
|
-
};
|
|
665
|
-
options?: {
|
|
666
|
-
[key: string]: unknown;
|
|
667
|
-
};
|
|
685
|
+
/** @example Conversion Funnel */
|
|
686
|
+
funnel?: string;
|
|
687
|
+
/**
|
|
688
|
+
* @description Attribute IDs
|
|
689
|
+
* @example [
|
|
690
|
+
* 1,
|
|
691
|
+
* 2
|
|
692
|
+
* ]
|
|
693
|
+
*/
|
|
694
|
+
attributeIds?: string[];
|
|
668
695
|
};
|
|
669
696
|
SplitItemDto: {
|
|
670
697
|
url: string;
|
|
@@ -1690,23 +1717,42 @@ interface components {
|
|
|
1690
1717
|
updatedAt: string;
|
|
1691
1718
|
};
|
|
1692
1719
|
RefundResponseDto: {
|
|
1693
|
-
/**
|
|
1720
|
+
/**
|
|
1721
|
+
* @description Primary ID of the refund record
|
|
1722
|
+
* @example 1
|
|
1723
|
+
*/
|
|
1694
1724
|
id: number;
|
|
1695
|
-
/**
|
|
1725
|
+
/**
|
|
1726
|
+
* @description External identifier for the refund
|
|
1727
|
+
* @example REF-001
|
|
1728
|
+
*/
|
|
1696
1729
|
externalId: string;
|
|
1697
|
-
/**
|
|
1698
|
-
*
|
|
1699
|
-
*
|
|
1700
|
-
*
|
|
1730
|
+
/**
|
|
1731
|
+
* @description Refund metadata or provider response stored as JSON
|
|
1732
|
+
* @example {
|
|
1733
|
+
* "status": "COMPLETED",
|
|
1734
|
+
* "amount": {
|
|
1735
|
+
* "value": "15.00",
|
|
1736
|
+
* "currency_code": "USD"
|
|
1737
|
+
* },
|
|
1738
|
+
* "reason": "Customer request",
|
|
1739
|
+
* "payer_info": {
|
|
1740
|
+
* "email": "customer@example.com"
|
|
1741
|
+
* },
|
|
1742
|
+
* "transaction_id": "TRX-REF-998812"
|
|
1743
|
+
* }
|
|
1744
|
+
*/
|
|
1701
1745
|
data: Record<string, never> | null;
|
|
1702
1746
|
/**
|
|
1703
1747
|
* Format: date-time
|
|
1704
|
-
* @
|
|
1748
|
+
* @description Timestamp when the refund record was created
|
|
1749
|
+
* @example 2025-11-10T06:40:51.000Z
|
|
1705
1750
|
*/
|
|
1706
1751
|
createdAt: string;
|
|
1707
1752
|
/**
|
|
1708
1753
|
* Format: date-time
|
|
1709
|
-
* @
|
|
1754
|
+
* @description Timestamp when the refund record was last updated
|
|
1755
|
+
* @example 2025-11-10T06:40:51.000Z
|
|
1710
1756
|
*/
|
|
1711
1757
|
updatedAt: string;
|
|
1712
1758
|
};
|
|
@@ -2415,6 +2461,8 @@ interface components {
|
|
|
2415
2461
|
currency: string;
|
|
2416
2462
|
/** @description Event value/total */
|
|
2417
2463
|
value: number | string;
|
|
2464
|
+
/** @description Event Order ID */
|
|
2465
|
+
order_id: string;
|
|
2418
2466
|
};
|
|
2419
2467
|
SnapchatCapiBridgeDto: {
|
|
2420
2468
|
uuid: string;
|
|
@@ -2662,6 +2710,28 @@ interface components {
|
|
|
2662
2710
|
/** @example 10 */
|
|
2663
2711
|
totalPages: number;
|
|
2664
2712
|
};
|
|
2713
|
+
ErpRequestDto: {
|
|
2714
|
+
/** @example Access request */
|
|
2715
|
+
type: string;
|
|
2716
|
+
/** @example Access request note */
|
|
2717
|
+
note: string;
|
|
2718
|
+
/**
|
|
2719
|
+
* @description Value of window.location.origin
|
|
2720
|
+
* @example http://localhost:3000
|
|
2721
|
+
*/
|
|
2722
|
+
system: string;
|
|
2723
|
+
/**
|
|
2724
|
+
* @description Additional details
|
|
2725
|
+
* @example {
|
|
2726
|
+
* "integrationId": "123"
|
|
2727
|
+
* }
|
|
2728
|
+
*/
|
|
2729
|
+
details: Record<string, never>;
|
|
2730
|
+
};
|
|
2731
|
+
ErpRequestResponseDto: {
|
|
2732
|
+
/** @example true */
|
|
2733
|
+
success: boolean;
|
|
2734
|
+
};
|
|
2665
2735
|
PaymentCreateSessionRequestDto: {
|
|
2666
2736
|
/** @description Unique Customer ID for the transaction. */
|
|
2667
2737
|
referenceId: string;
|
|
@@ -2823,6 +2893,57 @@ interface components {
|
|
|
2823
2893
|
*/
|
|
2824
2894
|
sortOrder?: string;
|
|
2825
2895
|
};
|
|
2896
|
+
CaptureResponseDto: {
|
|
2897
|
+
/**
|
|
2898
|
+
* @description Primary ID of the capture record
|
|
2899
|
+
* @example 1
|
|
2900
|
+
*/
|
|
2901
|
+
id: number;
|
|
2902
|
+
/**
|
|
2903
|
+
* @description External identifier for the capture entry
|
|
2904
|
+
* @example CAP-001-EXTERNAL
|
|
2905
|
+
*/
|
|
2906
|
+
externalId: string;
|
|
2907
|
+
/**
|
|
2908
|
+
* @description Stored response/data returned from a payment provider
|
|
2909
|
+
* @example {
|
|
2910
|
+
* "status": "COMPLETED",
|
|
2911
|
+
* "amount": {
|
|
2912
|
+
* "value": "19.99",
|
|
2913
|
+
* "currency_code": "USD"
|
|
2914
|
+
* },
|
|
2915
|
+
* "payer_info": {
|
|
2916
|
+
* "email": "customer@example.com",
|
|
2917
|
+
* "country_code": "US"
|
|
2918
|
+
* },
|
|
2919
|
+
* "transaction_id": "83HSKJ29DHSKJ2"
|
|
2920
|
+
* }
|
|
2921
|
+
*/
|
|
2922
|
+
data: Record<string, never> | null;
|
|
2923
|
+
/**
|
|
2924
|
+
* Format: date-time
|
|
2925
|
+
* @description Timestamp when the record was created
|
|
2926
|
+
* @example 2025-11-10T06:38:51.000Z
|
|
2927
|
+
*/
|
|
2928
|
+
createdAt: string;
|
|
2929
|
+
/**
|
|
2930
|
+
* Format: date-time
|
|
2931
|
+
* @description Timestamp when the record was last updated
|
|
2932
|
+
* @example 2025-11-10T06:38:51.000Z
|
|
2933
|
+
*/
|
|
2934
|
+
updatedAt: string;
|
|
2935
|
+
};
|
|
2936
|
+
CaptureListResponseDto: {
|
|
2937
|
+
/** @example 4 */
|
|
2938
|
+
total: number;
|
|
2939
|
+
/** @example 1 */
|
|
2940
|
+
page: number;
|
|
2941
|
+
/** @example 1 */
|
|
2942
|
+
limit: number;
|
|
2943
|
+
/** @example 1 */
|
|
2944
|
+
totalPages: number;
|
|
2945
|
+
data: components["schemas"]["CaptureResponseDto"][];
|
|
2946
|
+
};
|
|
2826
2947
|
PaypalCaptureV1AmountDto: {
|
|
2827
2948
|
/**
|
|
2828
2949
|
* @description Currency code in ISO 4217 format
|
|
@@ -2936,6 +3057,11 @@ interface components {
|
|
|
2936
3057
|
/** @description HATEOAS links related to the capture */
|
|
2937
3058
|
links: components["schemas"]["PaypalCaptureV1LinkDto"][];
|
|
2938
3059
|
};
|
|
3060
|
+
CaptureDetailResponseDto: {
|
|
3061
|
+
/** @example Capture retrieved successfully */
|
|
3062
|
+
message: string;
|
|
3063
|
+
capture: components["schemas"]["CaptureResponseDto"];
|
|
3064
|
+
};
|
|
2939
3065
|
PaypalCommonAmountDto: {
|
|
2940
3066
|
/**
|
|
2941
3067
|
* @description The currency code of the amount
|
|
@@ -3418,6 +3544,17 @@ interface components {
|
|
|
3418
3544
|
*/
|
|
3419
3545
|
expiration_time: string;
|
|
3420
3546
|
};
|
|
3547
|
+
RefundListResponseDto: {
|
|
3548
|
+
/** @example 4 */
|
|
3549
|
+
total: number;
|
|
3550
|
+
/** @example 1 */
|
|
3551
|
+
page: number;
|
|
3552
|
+
/** @example 1 */
|
|
3553
|
+
limit: number;
|
|
3554
|
+
/** @example 1 */
|
|
3555
|
+
totalPages: number;
|
|
3556
|
+
refunds: components["schemas"]["RefundResponseDto"][];
|
|
3557
|
+
};
|
|
3421
3558
|
PaypalMoneyDto: {
|
|
3422
3559
|
currency_code: string;
|
|
3423
3560
|
value: string;
|
|
@@ -3450,6 +3587,11 @@ interface components {
|
|
|
3450
3587
|
payer: components["schemas"]["PaypalRefundPayerDto"];
|
|
3451
3588
|
links: components["schemas"]["PaypalLinkDto"][];
|
|
3452
3589
|
};
|
|
3590
|
+
RefundDetailResponseDto: {
|
|
3591
|
+
/** @example Refund retrieved successfully */
|
|
3592
|
+
message: string;
|
|
3593
|
+
refund: components["schemas"]["RefundResponseDto"];
|
|
3594
|
+
};
|
|
3453
3595
|
PaypalPaymentCaptureRequestDto: {
|
|
3454
3596
|
/**
|
|
3455
3597
|
* @description Amount to capture (if different from authorized amount)
|
|
@@ -3746,19 +3888,19 @@ interface components {
|
|
|
3746
3888
|
MetaDto: {
|
|
3747
3889
|
/**
|
|
3748
3890
|
* @description Total number of items
|
|
3749
|
-
* @example
|
|
3891
|
+
* @example 3
|
|
3750
3892
|
*/
|
|
3751
3893
|
total: number;
|
|
3894
|
+
/**
|
|
3895
|
+
* @description Total number of pages
|
|
3896
|
+
* @example 3
|
|
3897
|
+
*/
|
|
3898
|
+
pages: number;
|
|
3752
3899
|
/**
|
|
3753
3900
|
* @description Current page number
|
|
3754
3901
|
* @example 1
|
|
3755
3902
|
*/
|
|
3756
3903
|
currentPage: number;
|
|
3757
|
-
/**
|
|
3758
|
-
* @description Total number of pages
|
|
3759
|
-
* @example 10
|
|
3760
|
-
*/
|
|
3761
|
-
pages: number;
|
|
3762
3904
|
};
|
|
3763
3905
|
AuthorizationResponseDto: {
|
|
3764
3906
|
/** @example 1 */
|
|
@@ -3788,58 +3930,50 @@ interface components {
|
|
|
3788
3930
|
items: components["schemas"]["AuthorizationResponseDto"][];
|
|
3789
3931
|
};
|
|
3790
3932
|
BillingAgreementResponseDto: {
|
|
3791
|
-
/** @example 1 */
|
|
3792
|
-
id: number;
|
|
3793
|
-
/** @example ba_001 */
|
|
3794
|
-
externalId: string;
|
|
3795
|
-
/** @example {
|
|
3796
|
-
* "plan": "monthly",
|
|
3797
|
-
* "status": "active"
|
|
3798
|
-
* } */
|
|
3799
|
-
data: Record<string, never> | null;
|
|
3800
3933
|
/**
|
|
3801
|
-
*
|
|
3802
|
-
* @example
|
|
3934
|
+
* @description Primary ID of the billing agreement
|
|
3935
|
+
* @example 1
|
|
3803
3936
|
*/
|
|
3804
|
-
|
|
3937
|
+
id: number;
|
|
3805
3938
|
/**
|
|
3806
|
-
*
|
|
3807
|
-
* @example
|
|
3939
|
+
* @description External PayPal Billing Agreement ID
|
|
3940
|
+
* @example BILL-AG-001
|
|
3808
3941
|
*/
|
|
3809
|
-
updatedAt: string;
|
|
3810
|
-
};
|
|
3811
|
-
BillingAgreementListResponseDto: {
|
|
3812
|
-
/** @example Billing agreements retrieved successfully */
|
|
3813
|
-
message: string;
|
|
3814
|
-
meta: components["schemas"]["MetaDto"];
|
|
3815
|
-
items: components["schemas"]["BillingAgreementResponseDto"][];
|
|
3816
|
-
};
|
|
3817
|
-
CaptureResponseDto: {
|
|
3818
|
-
/** @example 1 */
|
|
3819
|
-
id: number;
|
|
3820
|
-
/** @example capture_001 */
|
|
3821
3942
|
externalId: string;
|
|
3822
|
-
/**
|
|
3823
|
-
*
|
|
3824
|
-
*
|
|
3825
|
-
*
|
|
3943
|
+
/**
|
|
3944
|
+
* @description Stored PayPal billing agreement data returned from PayPal
|
|
3945
|
+
* @example {
|
|
3946
|
+
* "plan": "Premium",
|
|
3947
|
+
* "payer": {
|
|
3948
|
+
* "email": "user1@example.com"
|
|
3949
|
+
* },
|
|
3950
|
+
* "status": "ACTIVE"
|
|
3951
|
+
* }
|
|
3952
|
+
*/
|
|
3826
3953
|
data: Record<string, never> | null;
|
|
3827
3954
|
/**
|
|
3828
3955
|
* Format: date-time
|
|
3829
|
-
* @
|
|
3956
|
+
* @description Creation timestamp (ISO string)
|
|
3957
|
+
* @example 2025-11-10T06:38:51.000Z
|
|
3830
3958
|
*/
|
|
3831
3959
|
createdAt: string;
|
|
3832
3960
|
/**
|
|
3833
3961
|
* Format: date-time
|
|
3834
|
-
* @
|
|
3962
|
+
* @description Last updated timestamp (ISO string)
|
|
3963
|
+
* @example 2025-11-10T06:38:51.000Z
|
|
3835
3964
|
*/
|
|
3836
3965
|
updatedAt: string;
|
|
3837
3966
|
};
|
|
3838
|
-
|
|
3839
|
-
/** @example
|
|
3840
|
-
|
|
3841
|
-
|
|
3842
|
-
|
|
3967
|
+
BillingAgreementListResponseDto: {
|
|
3968
|
+
/** @example 4 */
|
|
3969
|
+
total: number;
|
|
3970
|
+
/** @example 1 */
|
|
3971
|
+
page: number;
|
|
3972
|
+
/** @example 10 */
|
|
3973
|
+
limit: number;
|
|
3974
|
+
/** @example 1 */
|
|
3975
|
+
totalPages: number;
|
|
3976
|
+
data: components["schemas"]["BillingAgreementResponseDto"][];
|
|
3843
3977
|
};
|
|
3844
3978
|
OrderResponseDto: {
|
|
3845
3979
|
/** @example 1 */
|
|
@@ -3864,16 +3998,15 @@ interface components {
|
|
|
3864
3998
|
updatedAt: string;
|
|
3865
3999
|
};
|
|
3866
4000
|
OrderListResponseDto: {
|
|
3867
|
-
|
|
3868
|
-
|
|
3869
|
-
|
|
3870
|
-
|
|
3871
|
-
|
|
3872
|
-
|
|
3873
|
-
|
|
3874
|
-
|
|
3875
|
-
|
|
3876
|
-
items: components["schemas"]["RefundResponseDto"][];
|
|
4001
|
+
data: components["schemas"]["OrderResponseDto"][];
|
|
4002
|
+
/** @example 100 */
|
|
4003
|
+
total: number;
|
|
4004
|
+
/** @example 1 */
|
|
4005
|
+
page: number;
|
|
4006
|
+
/** @example 10 */
|
|
4007
|
+
limit: number;
|
|
4008
|
+
/** @example 10 */
|
|
4009
|
+
totalPages: number;
|
|
3877
4010
|
};
|
|
3878
4011
|
PaypalBillingAgreementV1CreateDto: {
|
|
3879
4012
|
/**
|
|
@@ -4010,6 +4143,11 @@ interface components {
|
|
|
4010
4143
|
agreement_details: Record<string, never>;
|
|
4011
4144
|
links: components["schemas"]["PaypalBillingAgreementLinkDto"][];
|
|
4012
4145
|
};
|
|
4146
|
+
BillingAgreementDetailesponseDto: {
|
|
4147
|
+
/** @example Billing agreement retrieved successfully */
|
|
4148
|
+
message: string;
|
|
4149
|
+
billingAggrement: components["schemas"]["BillingAgreementResponseDto"];
|
|
4150
|
+
};
|
|
4013
4151
|
PaypalOrderV1CreateDto: {
|
|
4014
4152
|
/**
|
|
4015
4153
|
* @description The intent of the payment.
|
|
@@ -6041,38 +6179,252 @@ interface components {
|
|
|
6041
6179
|
/** @example Start date cannot be greater than end date */
|
|
6042
6180
|
message: string;
|
|
6043
6181
|
};
|
|
6044
|
-
|
|
6045
|
-
/** @example EUR */
|
|
6046
|
-
from: string;
|
|
6047
|
-
/** @example USD */
|
|
6048
|
-
to: string;
|
|
6049
|
-
/** @example 100 */
|
|
6050
|
-
amount: number;
|
|
6051
|
-
};
|
|
6052
|
-
ConvertCurrencyResponseDto: {
|
|
6182
|
+
TrustpilotReviewReplyToRequestDto: {
|
|
6053
6183
|
/**
|
|
6054
|
-
* @description
|
|
6055
|
-
* @example
|
|
6184
|
+
* @description The ID of the business user who is replying
|
|
6185
|
+
* @example 688a9dc3b64bbca236f08910
|
|
6056
6186
|
*/
|
|
6057
|
-
|
|
6187
|
+
authorBusinessUserId: string;
|
|
6058
6188
|
/**
|
|
6059
|
-
* @description
|
|
6060
|
-
* @example
|
|
6189
|
+
* @description The reply message text
|
|
6190
|
+
* @example Thank you for your feedback! We appreciate your business.
|
|
6061
6191
|
*/
|
|
6062
|
-
|
|
6192
|
+
message: string;
|
|
6193
|
+
};
|
|
6194
|
+
TrustpilotReviewReplyToResponseDto: {
|
|
6063
6195
|
/**
|
|
6064
|
-
* @description
|
|
6065
|
-
* @example
|
|
6196
|
+
* @description Indicates if the reply was posted successfully
|
|
6197
|
+
* @example true
|
|
6066
6198
|
*/
|
|
6067
|
-
|
|
6199
|
+
success: boolean;
|
|
6068
6200
|
/**
|
|
6069
|
-
* @description
|
|
6070
|
-
* @example
|
|
6201
|
+
* @description Response message
|
|
6202
|
+
* @example Reply posted successfully
|
|
6071
6203
|
*/
|
|
6072
|
-
|
|
6204
|
+
message: string;
|
|
6205
|
+
/** @description Additional data from the API */
|
|
6206
|
+
data?: Record<string, never>;
|
|
6207
|
+
};
|
|
6208
|
+
TrustpilotReviewReplyToBadRequestErrorDto: {
|
|
6073
6209
|
/**
|
|
6074
|
-
* @description
|
|
6075
|
-
* @example
|
|
6210
|
+
* @description HTTP status code
|
|
6211
|
+
* @example 400
|
|
6212
|
+
*/
|
|
6213
|
+
statusCode: number;
|
|
6214
|
+
/**
|
|
6215
|
+
* @description Validation error messages
|
|
6216
|
+
* @example [
|
|
6217
|
+
* "authorBusinessUserId should not be empty",
|
|
6218
|
+
* "authorBusinessUserId must be a string",
|
|
6219
|
+
* "message should not be empty",
|
|
6220
|
+
* "message must be a string"
|
|
6221
|
+
* ]
|
|
6222
|
+
*/
|
|
6223
|
+
message: string[];
|
|
6224
|
+
/**
|
|
6225
|
+
* @description Error type
|
|
6226
|
+
* @example Bad Request
|
|
6227
|
+
*/
|
|
6228
|
+
error: string;
|
|
6229
|
+
};
|
|
6230
|
+
TrustpilotReviewReplyToInternalServerErrorDto: {
|
|
6231
|
+
/**
|
|
6232
|
+
* @description HTTP status code
|
|
6233
|
+
* @example 500
|
|
6234
|
+
*/
|
|
6235
|
+
statusCode: number;
|
|
6236
|
+
/**
|
|
6237
|
+
* @description Error message describing what went wrong while posting reply
|
|
6238
|
+
* @example Failed to reply to review
|
|
6239
|
+
*/
|
|
6240
|
+
message: string;
|
|
6241
|
+
/**
|
|
6242
|
+
* @description Error type
|
|
6243
|
+
* @example Internal Server Error
|
|
6244
|
+
*/
|
|
6245
|
+
error: string;
|
|
6246
|
+
};
|
|
6247
|
+
CreateTrustpilotInviteDto: {
|
|
6248
|
+
/** @example ext-456 */
|
|
6249
|
+
externalId?: string | null;
|
|
6250
|
+
/** @example customer@example.com */
|
|
6251
|
+
email: string;
|
|
6252
|
+
/** @example John Doe */
|
|
6253
|
+
name?: string | null;
|
|
6254
|
+
/** @example 9b00016b-a006-492e-8fe8-f15c906dc538 */
|
|
6255
|
+
batchId?: string | null;
|
|
6256
|
+
/** @example 507f191e810c19729de860ea */
|
|
6257
|
+
templateId?: string | null;
|
|
6258
|
+
/** @example 2025-09-09T10:00:00.000Z */
|
|
6259
|
+
scheduledAt: string;
|
|
6260
|
+
/** @example 2025-09-09T09:00:00.000Z */
|
|
6261
|
+
initialScheduledAt: string;
|
|
6262
|
+
/**
|
|
6263
|
+
* @example pending
|
|
6264
|
+
* @enum {string}
|
|
6265
|
+
*/
|
|
6266
|
+
status?: "pending" | "retry" | "sent" | "failed" | "cancelled";
|
|
6267
|
+
};
|
|
6268
|
+
UpdateTrustpilotInviteDto: {
|
|
6269
|
+
/** @example ext-456 */
|
|
6270
|
+
externalId?: string | null;
|
|
6271
|
+
/** @example customer@example.com */
|
|
6272
|
+
email?: string;
|
|
6273
|
+
/** @example John Doe */
|
|
6274
|
+
name?: string | null;
|
|
6275
|
+
/** @example 9b00016b-a006-492e-8fe8-f15c906dc538 */
|
|
6276
|
+
batchId?: string | null;
|
|
6277
|
+
/** @example 507f191e810c19729de860ea */
|
|
6278
|
+
templateId?: string | null;
|
|
6279
|
+
/** @example 2025-09-09T10:00:00.000Z */
|
|
6280
|
+
scheduledAt?: string;
|
|
6281
|
+
/** @example 2025-09-09T09:00:00.000Z */
|
|
6282
|
+
initialScheduledAt?: string;
|
|
6283
|
+
/**
|
|
6284
|
+
* @example pending
|
|
6285
|
+
* @enum {string}
|
|
6286
|
+
*/
|
|
6287
|
+
status?: "pending" | "retry" | "sent" | "failed" | "cancelled";
|
|
6288
|
+
};
|
|
6289
|
+
MySQLConnectionStatsDto: {
|
|
6290
|
+
/**
|
|
6291
|
+
* @description Current open connections
|
|
6292
|
+
* @example 12
|
|
6293
|
+
*/
|
|
6294
|
+
current: number;
|
|
6295
|
+
/**
|
|
6296
|
+
* @description Peak concurrent connections since server start
|
|
6297
|
+
* @example 95
|
|
6298
|
+
*/
|
|
6299
|
+
max_used: number;
|
|
6300
|
+
/**
|
|
6301
|
+
* @description Configured maximum allowed connections
|
|
6302
|
+
* @example 151
|
|
6303
|
+
*/
|
|
6304
|
+
max_allowed: number;
|
|
6305
|
+
};
|
|
6306
|
+
HealthCheckResultDto: {
|
|
6307
|
+
/**
|
|
6308
|
+
* @example UP
|
|
6309
|
+
* @enum {string}
|
|
6310
|
+
*/
|
|
6311
|
+
service: "UP" | "DOWN" | "UNKNOWN";
|
|
6312
|
+
/**
|
|
6313
|
+
* @example UP
|
|
6314
|
+
* @enum {string}
|
|
6315
|
+
*/
|
|
6316
|
+
database: "UP" | "DOWN" | "UNKNOWN";
|
|
6317
|
+
/**
|
|
6318
|
+
* @description DB ping latency in milliseconds
|
|
6319
|
+
* @example 7
|
|
6320
|
+
*/
|
|
6321
|
+
db_latency_ms: number;
|
|
6322
|
+
mysql_connections?: components["schemas"]["MySQLConnectionStatsDto"];
|
|
6323
|
+
/**
|
|
6324
|
+
* Format: date-time
|
|
6325
|
+
* @example 2025-11-07T05:12:34.123Z
|
|
6326
|
+
*/
|
|
6327
|
+
timestamp: string;
|
|
6328
|
+
/** @example ECONNREFUSED 127.0.0.1:3306 */
|
|
6329
|
+
error?: string;
|
|
6330
|
+
};
|
|
6331
|
+
HealthStatusResponseDto: {
|
|
6332
|
+
healthStatus: components["schemas"]["HealthCheckResultDto"];
|
|
6333
|
+
};
|
|
6334
|
+
ServiceReplyTemplateDto: {
|
|
6335
|
+
/**
|
|
6336
|
+
* @description Unique ID of the service reply template
|
|
6337
|
+
* @example 1
|
|
6338
|
+
*/
|
|
6339
|
+
id: number;
|
|
6340
|
+
/**
|
|
6341
|
+
* @description The reply message text of the template
|
|
6342
|
+
* @example Thank you for contacting us. We will get back to you shortly.
|
|
6343
|
+
*/
|
|
6344
|
+
reply: string;
|
|
6345
|
+
/**
|
|
6346
|
+
* @description Indicates if this template is active or inactive
|
|
6347
|
+
* @example true
|
|
6348
|
+
*/
|
|
6349
|
+
active: boolean;
|
|
6350
|
+
};
|
|
6351
|
+
ServiceReplyTemplateListResponseDto: {
|
|
6352
|
+
/** @example Service reply templates retrieved successfully */
|
|
6353
|
+
message: string;
|
|
6354
|
+
/** @example 4 */
|
|
6355
|
+
total: number;
|
|
6356
|
+
/** @example 1 */
|
|
6357
|
+
page: number;
|
|
6358
|
+
/** @example 10 */
|
|
6359
|
+
limit: number;
|
|
6360
|
+
/** @example 1 */
|
|
6361
|
+
totalPages: number;
|
|
6362
|
+
data: components["schemas"]["ServiceReplyTemplateDto"][];
|
|
6363
|
+
};
|
|
6364
|
+
ServiceReplyTemplateResponseDto: {
|
|
6365
|
+
/** @description Response message indicating the result of the operation */
|
|
6366
|
+
message: string;
|
|
6367
|
+
/** @description The service reply template object returned by the operation */
|
|
6368
|
+
serviceReplyTemplate: components["schemas"]["ServiceReplyTemplateDto"];
|
|
6369
|
+
};
|
|
6370
|
+
CreateServiceReplyTemplateDto: {
|
|
6371
|
+
/**
|
|
6372
|
+
* @description The text of the service reply template
|
|
6373
|
+
* @example Thank you for reaching out. Our support team will get back to you shortly.
|
|
6374
|
+
*/
|
|
6375
|
+
reply: string;
|
|
6376
|
+
/**
|
|
6377
|
+
* @description Indicates whether the template is active
|
|
6378
|
+
* @default true
|
|
6379
|
+
* @example true
|
|
6380
|
+
*/
|
|
6381
|
+
active: boolean;
|
|
6382
|
+
};
|
|
6383
|
+
UpdateServiceReplyTemplateDto: {
|
|
6384
|
+
/**
|
|
6385
|
+
* @description Updated reply text of the service reply template
|
|
6386
|
+
* @example We have received your message and will reply within 24 hours.
|
|
6387
|
+
*/
|
|
6388
|
+
reply?: string;
|
|
6389
|
+
/**
|
|
6390
|
+
* @description Whether this reply template is active or inactive
|
|
6391
|
+
* @default true
|
|
6392
|
+
* @example false
|
|
6393
|
+
*/
|
|
6394
|
+
active: boolean;
|
|
6395
|
+
};
|
|
6396
|
+
ConvertCurrencyDto: {
|
|
6397
|
+
/** @example EUR */
|
|
6398
|
+
from: string;
|
|
6399
|
+
/** @example USD */
|
|
6400
|
+
to: string;
|
|
6401
|
+
/** @example 100 */
|
|
6402
|
+
amount: number;
|
|
6403
|
+
};
|
|
6404
|
+
ConvertCurrencyResponseDto: {
|
|
6405
|
+
/**
|
|
6406
|
+
* @description Source currency
|
|
6407
|
+
* @example USD
|
|
6408
|
+
*/
|
|
6409
|
+
from: string;
|
|
6410
|
+
/**
|
|
6411
|
+
* @description Target currency
|
|
6412
|
+
* @example PKR
|
|
6413
|
+
*/
|
|
6414
|
+
to: string;
|
|
6415
|
+
/**
|
|
6416
|
+
* @description Original amount in source currency
|
|
6417
|
+
* @example 100
|
|
6418
|
+
*/
|
|
6419
|
+
amount: number;
|
|
6420
|
+
/**
|
|
6421
|
+
* @description Converted amount in target currency
|
|
6422
|
+
* @example 28140
|
|
6423
|
+
*/
|
|
6424
|
+
converted: number;
|
|
6425
|
+
/**
|
|
6426
|
+
* @description Conversion rate (target per source)
|
|
6427
|
+
* @example 281.4
|
|
6076
6428
|
*/
|
|
6077
6429
|
rate: number;
|
|
6078
6430
|
/**
|
|
@@ -6972,29 +7324,41 @@ interface components {
|
|
|
6972
7324
|
};
|
|
6973
7325
|
HealthResponseDto: {
|
|
6974
7326
|
/**
|
|
6975
|
-
* @description
|
|
6976
|
-
* @example
|
|
7327
|
+
* @description Health check message
|
|
7328
|
+
* @example Klaviyo Backend API is running!
|
|
6977
7329
|
*/
|
|
6978
|
-
|
|
7330
|
+
message: string;
|
|
6979
7331
|
/**
|
|
6980
|
-
* @description
|
|
6981
|
-
* @example
|
|
7332
|
+
* @description Current server timestamp
|
|
7333
|
+
* @example 2024-01-01T00:00:00.000Z
|
|
6982
7334
|
*/
|
|
6983
|
-
|
|
7335
|
+
timestamp: string;
|
|
6984
7336
|
/**
|
|
6985
|
-
* @description
|
|
6986
|
-
* @example
|
|
7337
|
+
* @description API version
|
|
7338
|
+
* @example 1.0.0
|
|
6987
7339
|
*/
|
|
6988
|
-
|
|
7340
|
+
version: string;
|
|
6989
7341
|
/**
|
|
6990
|
-
* @description
|
|
6991
|
-
* @example
|
|
7342
|
+
* @description Database connection status
|
|
7343
|
+
* @example true
|
|
6992
7344
|
*/
|
|
6993
|
-
|
|
7345
|
+
database: Record<string, never>;
|
|
6994
7346
|
};
|
|
6995
7347
|
CreateBulkEventDto: {
|
|
6996
7348
|
events: components["schemas"]["CreateEventDto"][];
|
|
6997
7349
|
};
|
|
7350
|
+
KlaviyoProfileMergeByEmailRequestDto: {
|
|
7351
|
+
/**
|
|
7352
|
+
* @description Source email - profile to be merged into target
|
|
7353
|
+
* @example source@example.com
|
|
7354
|
+
*/
|
|
7355
|
+
sourceEmail: string;
|
|
7356
|
+
/**
|
|
7357
|
+
* @description Target email - destination profile (will be created if does not exist)
|
|
7358
|
+
* @example target@example.com
|
|
7359
|
+
*/
|
|
7360
|
+
targetEmail: string;
|
|
7361
|
+
};
|
|
6998
7362
|
HelloResponseDto: {
|
|
6999
7363
|
/**
|
|
7000
7364
|
* @description Greeting message
|
|
@@ -7050,6 +7414,62 @@ interface components {
|
|
|
7050
7414
|
message: string[];
|
|
7051
7415
|
error: string;
|
|
7052
7416
|
};
|
|
7417
|
+
ReportItemChangeLogDto: {
|
|
7418
|
+
/** @example 1 */
|
|
7419
|
+
id: number;
|
|
7420
|
+
/** @example 101 */
|
|
7421
|
+
reportItemId: number;
|
|
7422
|
+
/**
|
|
7423
|
+
* @description Changed field name or scope
|
|
7424
|
+
* @example customerEmail
|
|
7425
|
+
*/
|
|
7426
|
+
field: string;
|
|
7427
|
+
/**
|
|
7428
|
+
* @description Old value(s) as JSON
|
|
7429
|
+
* @example {
|
|
7430
|
+
* "customerEmail": "old@example.com"
|
|
7431
|
+
* }
|
|
7432
|
+
*/
|
|
7433
|
+
oldValue: {
|
|
7434
|
+
[key: string]: unknown;
|
|
7435
|
+
} | null;
|
|
7436
|
+
/**
|
|
7437
|
+
* @description New value(s) as JSON
|
|
7438
|
+
* @example {
|
|
7439
|
+
* "customerEmail": "new@example.com"
|
|
7440
|
+
* }
|
|
7441
|
+
*/
|
|
7442
|
+
newValue: {
|
|
7443
|
+
[key: string]: unknown;
|
|
7444
|
+
} | null;
|
|
7445
|
+
/** @example admin@company.com */
|
|
7446
|
+
changedBy: Record<string, never> | null;
|
|
7447
|
+
/** @example Customer support correction */
|
|
7448
|
+
reason: Record<string, never> | null;
|
|
7449
|
+
/**
|
|
7450
|
+
* @description Optional metadata (IP, user agent, etc.)
|
|
7451
|
+
* @example {
|
|
7452
|
+
* "ip": "203.0.113.10",
|
|
7453
|
+
* "source": "bridge-crm"
|
|
7454
|
+
* }
|
|
7455
|
+
*/
|
|
7456
|
+
meta: {
|
|
7457
|
+
[key: string]: unknown;
|
|
7458
|
+
} | null;
|
|
7459
|
+
/** @example 2025-11-11T12:35:11.000Z */
|
|
7460
|
+
createdAt: string;
|
|
7461
|
+
};
|
|
7462
|
+
ReportItemChangeLogListResponseDto: {
|
|
7463
|
+
/** @example 4 */
|
|
7464
|
+
total: number;
|
|
7465
|
+
/** @example 1 */
|
|
7466
|
+
page: number;
|
|
7467
|
+
/** @example 1 */
|
|
7468
|
+
limit: number;
|
|
7469
|
+
/** @example 1 */
|
|
7470
|
+
totalPages: number;
|
|
7471
|
+
data: components["schemas"]["ReportItemChangeLogDto"][];
|
|
7472
|
+
};
|
|
7053
7473
|
ReportItemResponseDto: {
|
|
7054
7474
|
/**
|
|
7055
7475
|
* @description Unique report item ID
|
|
@@ -7312,6 +7732,34 @@ interface components {
|
|
|
7312
7732
|
*/
|
|
7313
7733
|
utmData: Record<string, never>;
|
|
7314
7734
|
};
|
|
7735
|
+
UpdateCustomerEmailDto: {
|
|
7736
|
+
/**
|
|
7737
|
+
* @description New primary customer email to set
|
|
7738
|
+
* @example new.customer@example.com
|
|
7739
|
+
*/
|
|
7740
|
+
customerEmail: string;
|
|
7741
|
+
};
|
|
7742
|
+
ReportItemEmailUpdateResponseDto: {
|
|
7743
|
+
/**
|
|
7744
|
+
* @description Whether the update request was successful
|
|
7745
|
+
* @example true
|
|
7746
|
+
*/
|
|
7747
|
+
success: boolean;
|
|
7748
|
+
/**
|
|
7749
|
+
* @description Updated report item payload
|
|
7750
|
+
* @example {
|
|
7751
|
+
* "id": 1,
|
|
7752
|
+
* "orderId": "ORD-123456",
|
|
7753
|
+
* "country": "US",
|
|
7754
|
+
* "origin": "web",
|
|
7755
|
+
* "gender": "male",
|
|
7756
|
+
* "language": "en",
|
|
7757
|
+
* "slug": "sample-slug-1",
|
|
7758
|
+
* "email": "new.email@example.com"
|
|
7759
|
+
* }
|
|
7760
|
+
*/
|
|
7761
|
+
data: components["schemas"]["ReportItemDto"];
|
|
7762
|
+
};
|
|
7315
7763
|
CreateOrderItemDto: {
|
|
7316
7764
|
/** @example REF-98765 */
|
|
7317
7765
|
referenceId: string;
|
|
@@ -7467,6 +7915,23 @@ interface components {
|
|
|
7467
7915
|
/** @description The list of order items */
|
|
7468
7916
|
data: components["schemas"]["OrderItemResponseDto"][];
|
|
7469
7917
|
};
|
|
7918
|
+
MySQLConnectionsDto: {
|
|
7919
|
+
/**
|
|
7920
|
+
* @description Current active connections
|
|
7921
|
+
* @example 5
|
|
7922
|
+
*/
|
|
7923
|
+
current: number;
|
|
7924
|
+
/**
|
|
7925
|
+
* @description Maximum connections used
|
|
7926
|
+
* @example 10
|
|
7927
|
+
*/
|
|
7928
|
+
max_used: number;
|
|
7929
|
+
/**
|
|
7930
|
+
* @description Maximum allowed connections
|
|
7931
|
+
* @example 151
|
|
7932
|
+
*/
|
|
7933
|
+
max_allowed: number;
|
|
7934
|
+
};
|
|
7470
7935
|
WebhookPaginatedResponseDto: {
|
|
7471
7936
|
data: components["schemas"]["WebhookResponseDto"][];
|
|
7472
7937
|
/** @example 100 */
|
|
@@ -7768,6 +8233,36 @@ interface components {
|
|
|
7768
8233
|
/** @description Pagination metadata */
|
|
7769
8234
|
meta: components["schemas"]["PaymentMetaDto"];
|
|
7770
8235
|
};
|
|
8236
|
+
HealthStatusDto: {
|
|
8237
|
+
/**
|
|
8238
|
+
* @description Service status
|
|
8239
|
+
* @example UP
|
|
8240
|
+
*/
|
|
8241
|
+
service: string;
|
|
8242
|
+
/**
|
|
8243
|
+
* @description Database status
|
|
8244
|
+
* @example UP
|
|
8245
|
+
*/
|
|
8246
|
+
database: string;
|
|
8247
|
+
/**
|
|
8248
|
+
* @description Database latency in milliseconds
|
|
8249
|
+
* @example 2
|
|
8250
|
+
*/
|
|
8251
|
+
db_latency_ms: number;
|
|
8252
|
+
/** @description MySQL connection statistics */
|
|
8253
|
+
mysql_connections?: components["schemas"]["MySQLConnectionsDto"];
|
|
8254
|
+
/**
|
|
8255
|
+
* Format: date-time
|
|
8256
|
+
* @description Timestamp of health check
|
|
8257
|
+
* @example 2025-11-07T09:49:01.235Z
|
|
8258
|
+
*/
|
|
8259
|
+
timestamp: string;
|
|
8260
|
+
/**
|
|
8261
|
+
* @description Error message if health check fails
|
|
8262
|
+
* @example Connection failed
|
|
8263
|
+
*/
|
|
8264
|
+
error?: string;
|
|
8265
|
+
};
|
|
7771
8266
|
QueueStatsResponseDto: {
|
|
7772
8267
|
/**
|
|
7773
8268
|
* @description Queue name
|
|
@@ -8483,6 +8978,512 @@ interface components {
|
|
|
8483
8978
|
*/
|
|
8484
8979
|
status?: number;
|
|
8485
8980
|
};
|
|
8981
|
+
CreateAttributeDto: {
|
|
8982
|
+
/** @example Age */
|
|
8983
|
+
title: string;
|
|
8984
|
+
/** @example 1 */
|
|
8985
|
+
groupId: number;
|
|
8986
|
+
};
|
|
8987
|
+
AttributeResponseDto: {
|
|
8988
|
+
/** @example 1 */
|
|
8989
|
+
id: number;
|
|
8990
|
+
/** @example Age */
|
|
8991
|
+
title: string;
|
|
8992
|
+
/** @example 1 */
|
|
8993
|
+
groupId: number;
|
|
8994
|
+
};
|
|
8995
|
+
PaginatedAttributeResponse: {
|
|
8996
|
+
/** @example 1 */
|
|
8997
|
+
page: number;
|
|
8998
|
+
/** @example 10 */
|
|
8999
|
+
limit: number;
|
|
9000
|
+
/** @example 100 */
|
|
9001
|
+
total: number;
|
|
9002
|
+
data: components["schemas"]["AttributeResponseDto"][];
|
|
9003
|
+
};
|
|
9004
|
+
UpdateAttributeDto: {
|
|
9005
|
+
/** @example Age */
|
|
9006
|
+
title?: string;
|
|
9007
|
+
/** @example 1 */
|
|
9008
|
+
groupId?: number;
|
|
9009
|
+
};
|
|
9010
|
+
CreateCampaignDto: {
|
|
9011
|
+
/** @example Summer Promo */
|
|
9012
|
+
campaign: string;
|
|
9013
|
+
/**
|
|
9014
|
+
* @description Attribute IDs
|
|
9015
|
+
* @example [
|
|
9016
|
+
* 1,
|
|
9017
|
+
* 2
|
|
9018
|
+
* ]
|
|
9019
|
+
*/
|
|
9020
|
+
attributeIds: string[];
|
|
9021
|
+
};
|
|
9022
|
+
CampaignResponseDto: {
|
|
9023
|
+
/** @example 1 */
|
|
9024
|
+
id: number;
|
|
9025
|
+
/** @example Summer Promo */
|
|
9026
|
+
campaign: string;
|
|
9027
|
+
/** @example [
|
|
9028
|
+
* 1,
|
|
9029
|
+
* 2
|
|
9030
|
+
* ] */
|
|
9031
|
+
attributeIds: string[];
|
|
9032
|
+
};
|
|
9033
|
+
PaginatedCampaignResponse: {
|
|
9034
|
+
/** @example 1 */
|
|
9035
|
+
page: number;
|
|
9036
|
+
/** @example 10 */
|
|
9037
|
+
limit: number;
|
|
9038
|
+
/** @example 100 */
|
|
9039
|
+
total: number;
|
|
9040
|
+
data: components["schemas"]["CampaignResponseDto"][];
|
|
9041
|
+
};
|
|
9042
|
+
UpdateCampaignDto: {
|
|
9043
|
+
/** @example Summer Promo */
|
|
9044
|
+
campaign?: string;
|
|
9045
|
+
/**
|
|
9046
|
+
* @description Attribute IDs
|
|
9047
|
+
* @example [
|
|
9048
|
+
* 1,
|
|
9049
|
+
* 2
|
|
9050
|
+
* ]
|
|
9051
|
+
*/
|
|
9052
|
+
attributeIds?: string[];
|
|
9053
|
+
};
|
|
9054
|
+
CreateCampaignAdditionDto: {
|
|
9055
|
+
/**
|
|
9056
|
+
* @description Campaign ID
|
|
9057
|
+
* @example 1
|
|
9058
|
+
*/
|
|
9059
|
+
campaignId: number;
|
|
9060
|
+
/**
|
|
9061
|
+
* Format: date-time
|
|
9062
|
+
* @example 2025-01-01
|
|
9063
|
+
*/
|
|
9064
|
+
date_from: string;
|
|
9065
|
+
/**
|
|
9066
|
+
* Format: date-time
|
|
9067
|
+
* @example 2025-01-31
|
|
9068
|
+
*/
|
|
9069
|
+
date_to: string;
|
|
9070
|
+
/**
|
|
9071
|
+
* @description Attribute IDs
|
|
9072
|
+
* @example [
|
|
9073
|
+
* 1,
|
|
9074
|
+
* 2
|
|
9075
|
+
* ]
|
|
9076
|
+
*/
|
|
9077
|
+
attributeIds: string[];
|
|
9078
|
+
};
|
|
9079
|
+
CampaignAdditionResponseDto: {
|
|
9080
|
+
/** @example 1 */
|
|
9081
|
+
id: number;
|
|
9082
|
+
/** @example 1 */
|
|
9083
|
+
campaignId: number;
|
|
9084
|
+
/**
|
|
9085
|
+
* Format: date-time
|
|
9086
|
+
* @example 2025-01-01
|
|
9087
|
+
*/
|
|
9088
|
+
date_from: string;
|
|
9089
|
+
/**
|
|
9090
|
+
* Format: date-time
|
|
9091
|
+
* @example 2025-01-31
|
|
9092
|
+
*/
|
|
9093
|
+
date_to: string;
|
|
9094
|
+
/** @example [
|
|
9095
|
+
* 1,
|
|
9096
|
+
* 2
|
|
9097
|
+
* ] */
|
|
9098
|
+
attributeIds: string[];
|
|
9099
|
+
};
|
|
9100
|
+
PaginatedCampaignAdditionResponse: {
|
|
9101
|
+
/** @example 1 */
|
|
9102
|
+
page: number;
|
|
9103
|
+
/** @example 10 */
|
|
9104
|
+
limit: number;
|
|
9105
|
+
/** @example 100 */
|
|
9106
|
+
total: number;
|
|
9107
|
+
data: components["schemas"]["CampaignAdditionResponseDto"][];
|
|
9108
|
+
};
|
|
9109
|
+
UpdateCampaignAdditionDto: {
|
|
9110
|
+
/**
|
|
9111
|
+
* @description Campaign ID
|
|
9112
|
+
* @example 1
|
|
9113
|
+
*/
|
|
9114
|
+
campaignId?: number;
|
|
9115
|
+
/**
|
|
9116
|
+
* Format: date-time
|
|
9117
|
+
* @example 2025-01-01
|
|
9118
|
+
*/
|
|
9119
|
+
date_from?: string;
|
|
9120
|
+
/**
|
|
9121
|
+
* Format: date-time
|
|
9122
|
+
* @example 2025-01-31
|
|
9123
|
+
*/
|
|
9124
|
+
date_to?: string;
|
|
9125
|
+
/**
|
|
9126
|
+
* @description Attribute IDs
|
|
9127
|
+
* @example [
|
|
9128
|
+
* 1,
|
|
9129
|
+
* 2
|
|
9130
|
+
* ]
|
|
9131
|
+
*/
|
|
9132
|
+
attributeIds?: string[];
|
|
9133
|
+
};
|
|
9134
|
+
CreateFunnelDto: {
|
|
9135
|
+
/** @example Conversion Funnel */
|
|
9136
|
+
funnel: string;
|
|
9137
|
+
/**
|
|
9138
|
+
* @description Attribute IDs
|
|
9139
|
+
* @example [
|
|
9140
|
+
* 1,
|
|
9141
|
+
* 2
|
|
9142
|
+
* ]
|
|
9143
|
+
*/
|
|
9144
|
+
attributeIds: string[];
|
|
9145
|
+
};
|
|
9146
|
+
GpStatsFunnelResponseDto: {
|
|
9147
|
+
/** @example 1 */
|
|
9148
|
+
id: number;
|
|
9149
|
+
/** @example Conversion Funnel */
|
|
9150
|
+
funnel: string;
|
|
9151
|
+
/** @example [
|
|
9152
|
+
* 1,
|
|
9153
|
+
* 2
|
|
9154
|
+
* ] */
|
|
9155
|
+
attributeIds: string[];
|
|
9156
|
+
};
|
|
9157
|
+
PaginatedFunnelResponse: {
|
|
9158
|
+
/** @example 1 */
|
|
9159
|
+
page: number;
|
|
9160
|
+
/** @example 10 */
|
|
9161
|
+
limit: number;
|
|
9162
|
+
/** @example 100 */
|
|
9163
|
+
total: number;
|
|
9164
|
+
data: components["schemas"]["GpStatsFunnelResponseDto"][];
|
|
9165
|
+
};
|
|
9166
|
+
CreateFunnelAdditionDto: {
|
|
9167
|
+
/**
|
|
9168
|
+
* @description Funnel ID
|
|
9169
|
+
* @example 1
|
|
9170
|
+
*/
|
|
9171
|
+
funnelId: number;
|
|
9172
|
+
/**
|
|
9173
|
+
* Format: date-time
|
|
9174
|
+
* @example 2025-01-01
|
|
9175
|
+
*/
|
|
9176
|
+
date_from: string;
|
|
9177
|
+
/**
|
|
9178
|
+
* Format: date-time
|
|
9179
|
+
* @example 2025-01-31
|
|
9180
|
+
*/
|
|
9181
|
+
date_to: string;
|
|
9182
|
+
/**
|
|
9183
|
+
* @description Attribute IDs
|
|
9184
|
+
* @example [
|
|
9185
|
+
* 1,
|
|
9186
|
+
* 2
|
|
9187
|
+
* ]
|
|
9188
|
+
*/
|
|
9189
|
+
attributeIds: string[];
|
|
9190
|
+
};
|
|
9191
|
+
FunnelAdditionResponseDto: {
|
|
9192
|
+
/** @example 1 */
|
|
9193
|
+
id: number;
|
|
9194
|
+
/** @example 1 */
|
|
9195
|
+
funnelId: number;
|
|
9196
|
+
/**
|
|
9197
|
+
* Format: date-time
|
|
9198
|
+
* @example 2025-01-01
|
|
9199
|
+
*/
|
|
9200
|
+
date_from: string;
|
|
9201
|
+
/**
|
|
9202
|
+
* Format: date-time
|
|
9203
|
+
* @example 2025-01-31
|
|
9204
|
+
*/
|
|
9205
|
+
date_to: string;
|
|
9206
|
+
/** @example [
|
|
9207
|
+
* 1,
|
|
9208
|
+
* 2
|
|
9209
|
+
* ] */
|
|
9210
|
+
attributeIds: string[];
|
|
9211
|
+
};
|
|
9212
|
+
PaginatedFunnelAdditionResponse: {
|
|
9213
|
+
/** @example 1 */
|
|
9214
|
+
page: number;
|
|
9215
|
+
/** @example 10 */
|
|
9216
|
+
limit: number;
|
|
9217
|
+
/** @example 100 */
|
|
9218
|
+
total: number;
|
|
9219
|
+
data: components["schemas"]["FunnelAdditionResponseDto"][];
|
|
9220
|
+
};
|
|
9221
|
+
UpdateFunnelAdditionDto: {
|
|
9222
|
+
/**
|
|
9223
|
+
* @description Funnel ID
|
|
9224
|
+
* @example 1
|
|
9225
|
+
*/
|
|
9226
|
+
funnelId?: number;
|
|
9227
|
+
/**
|
|
9228
|
+
* Format: date-time
|
|
9229
|
+
* @example 2025-01-01
|
|
9230
|
+
*/
|
|
9231
|
+
date_from?: string;
|
|
9232
|
+
/**
|
|
9233
|
+
* Format: date-time
|
|
9234
|
+
* @example 2025-01-31
|
|
9235
|
+
*/
|
|
9236
|
+
date_to?: string;
|
|
9237
|
+
/**
|
|
9238
|
+
* @description Attribute IDs
|
|
9239
|
+
* @example [
|
|
9240
|
+
* 1,
|
|
9241
|
+
* 2
|
|
9242
|
+
* ]
|
|
9243
|
+
*/
|
|
9244
|
+
attributeIds?: string[];
|
|
9245
|
+
};
|
|
9246
|
+
CreateGroupDto: {
|
|
9247
|
+
/** @example User Demographics */
|
|
9248
|
+
title: string;
|
|
9249
|
+
};
|
|
9250
|
+
GroupResponseDto: {
|
|
9251
|
+
/** @example 1 */
|
|
9252
|
+
id: number;
|
|
9253
|
+
/** @example User Demographics */
|
|
9254
|
+
title: string;
|
|
9255
|
+
};
|
|
9256
|
+
PaginatedGroupResponse: {
|
|
9257
|
+
/** @example 1 */
|
|
9258
|
+
page: number;
|
|
9259
|
+
/** @example 10 */
|
|
9260
|
+
limit: number;
|
|
9261
|
+
/** @example 100 */
|
|
9262
|
+
total: number;
|
|
9263
|
+
data: components["schemas"]["GroupResponseDto"][];
|
|
9264
|
+
};
|
|
9265
|
+
UpdateGroupDto: {
|
|
9266
|
+
/** @example Demographics */
|
|
9267
|
+
title?: string;
|
|
9268
|
+
};
|
|
9269
|
+
HealthStatusResponseDto_GET_Single_Health_status_retrieve_successful_Default: {
|
|
9270
|
+
/** @example true */
|
|
9271
|
+
success: Record<string, never>;
|
|
9272
|
+
/** @example GET */
|
|
9273
|
+
method: Record<string, never>;
|
|
9274
|
+
/** @example OK */
|
|
9275
|
+
status: Record<string, never>;
|
|
9276
|
+
/** @example 200 */
|
|
9277
|
+
statusCode: Record<string, never>;
|
|
9278
|
+
/** @example healths */
|
|
9279
|
+
path: Record<string, never>;
|
|
9280
|
+
/** @example 2025-11-17T06:58:17.118Z */
|
|
9281
|
+
timestamp: Record<string, never>;
|
|
9282
|
+
/** @example Health status retrieve successful */
|
|
9283
|
+
message: Record<string, never>;
|
|
9284
|
+
data?: components["schemas"]["HealthStatusResponseDto"];
|
|
9285
|
+
};
|
|
9286
|
+
CreatePeriodDto: {
|
|
9287
|
+
/**
|
|
9288
|
+
* @description Type of period
|
|
9289
|
+
* @example minute
|
|
9290
|
+
* @enum {string}
|
|
9291
|
+
*/
|
|
9292
|
+
type: "minute" | "hour" | "daily";
|
|
9293
|
+
/**
|
|
9294
|
+
* @description Value in minutes or hours (depending on type)
|
|
9295
|
+
* @example 5
|
|
9296
|
+
*/
|
|
9297
|
+
value?: number;
|
|
9298
|
+
/**
|
|
9299
|
+
* @description Time of day for daily jobs (HH:mm)
|
|
9300
|
+
* @example 14:30
|
|
9301
|
+
*/
|
|
9302
|
+
time?: string;
|
|
9303
|
+
};
|
|
9304
|
+
CreateScheduledActionDto: {
|
|
9305
|
+
/**
|
|
9306
|
+
* @description Human readable name of the scheduled job
|
|
9307
|
+
* @example Ping Google
|
|
9308
|
+
*/
|
|
9309
|
+
title: string;
|
|
9310
|
+
/**
|
|
9311
|
+
* @description Target URL to make the request
|
|
9312
|
+
* @example https://google.com
|
|
9313
|
+
*/
|
|
9314
|
+
url: string;
|
|
9315
|
+
/**
|
|
9316
|
+
* @description HTTP method to use for the request
|
|
9317
|
+
* @example GET
|
|
9318
|
+
* @enum {string}
|
|
9319
|
+
*/
|
|
9320
|
+
method: "GET" | "POST";
|
|
9321
|
+
/** @description Body for POST requests (optional for GET) */
|
|
9322
|
+
body?: Record<string, never>;
|
|
9323
|
+
/** @description Period definition for when this job should run */
|
|
9324
|
+
period: components["schemas"]["CreatePeriodDto"];
|
|
9325
|
+
};
|
|
9326
|
+
PeriodDto: {
|
|
9327
|
+
/**
|
|
9328
|
+
* @description Type of period
|
|
9329
|
+
* @example minute
|
|
9330
|
+
* @enum {string}
|
|
9331
|
+
*/
|
|
9332
|
+
type: "minute" | "hour" | "daily";
|
|
9333
|
+
/**
|
|
9334
|
+
* @description Value in minutes or hours (depending on type)
|
|
9335
|
+
* @example 5
|
|
9336
|
+
*/
|
|
9337
|
+
value?: number;
|
|
9338
|
+
/**
|
|
9339
|
+
* @description Time of day for daily jobs (HH:mm)
|
|
9340
|
+
* @example 14:30
|
|
9341
|
+
*/
|
|
9342
|
+
time?: string;
|
|
9343
|
+
};
|
|
9344
|
+
ScheduledActionDto: {
|
|
9345
|
+
/** @example 1 */
|
|
9346
|
+
id: number;
|
|
9347
|
+
/** @example Ping Google */
|
|
9348
|
+
title: string;
|
|
9349
|
+
/** @example https://google.com */
|
|
9350
|
+
url: string;
|
|
9351
|
+
/**
|
|
9352
|
+
* @example GET
|
|
9353
|
+
* @enum {string}
|
|
9354
|
+
*/
|
|
9355
|
+
method: "GET" | "POST";
|
|
9356
|
+
/** @example {
|
|
9357
|
+
* "userId": 123,
|
|
9358
|
+
* "message": "Auto sync triggered"
|
|
9359
|
+
* } */
|
|
9360
|
+
body: Record<string, never> | null;
|
|
9361
|
+
/**
|
|
9362
|
+
* @description Period configuration of the job
|
|
9363
|
+
* @example {
|
|
9364
|
+
* "type": "minute",
|
|
9365
|
+
* "value": 5
|
|
9366
|
+
* }
|
|
9367
|
+
*/
|
|
9368
|
+
period: components["schemas"]["PeriodDto"];
|
|
9369
|
+
/**
|
|
9370
|
+
* @description Timestamp of job creation
|
|
9371
|
+
* @example 2025-01-15T12:34:56.789Z
|
|
9372
|
+
*/
|
|
9373
|
+
createdAt: Record<string, never>;
|
|
9374
|
+
};
|
|
9375
|
+
ScheduledActionResponseDto: {
|
|
9376
|
+
shedulledAction: components["schemas"]["ScheduledActionDto"];
|
|
9377
|
+
};
|
|
9378
|
+
ScheduledActionResponseDto_POST_Single_Scheduled_action_created_successfully_Default: {
|
|
9379
|
+
/** @example true */
|
|
9380
|
+
success: Record<string, never>;
|
|
9381
|
+
/** @example POST */
|
|
9382
|
+
method: Record<string, never>;
|
|
9383
|
+
/** @example CREATED */
|
|
9384
|
+
status: Record<string, never>;
|
|
9385
|
+
/** @example 201 */
|
|
9386
|
+
statusCode: Record<string, never>;
|
|
9387
|
+
/** @example shedulled-actions */
|
|
9388
|
+
path: Record<string, never>;
|
|
9389
|
+
/** @example 2025-11-17T06:58:17.231Z */
|
|
9390
|
+
timestamp: Record<string, never>;
|
|
9391
|
+
/** @example Scheduled action created successfully */
|
|
9392
|
+
message: Record<string, never>;
|
|
9393
|
+
data?: components["schemas"]["ScheduledActionResponseDto"];
|
|
9394
|
+
};
|
|
9395
|
+
UpdateScheduledActionDto: {
|
|
9396
|
+
/**
|
|
9397
|
+
* @description Human readable name of the scheduled job
|
|
9398
|
+
* @example Ping Google
|
|
9399
|
+
*/
|
|
9400
|
+
title?: string;
|
|
9401
|
+
/**
|
|
9402
|
+
* @description Target URL to make the request
|
|
9403
|
+
* @example https://google.com
|
|
9404
|
+
*/
|
|
9405
|
+
url?: string;
|
|
9406
|
+
/**
|
|
9407
|
+
* @description HTTP method to use for the request
|
|
9408
|
+
* @enum {string}
|
|
9409
|
+
*/
|
|
9410
|
+
method?: "GET" | "POST";
|
|
9411
|
+
/** @description Body for POST requests (optional for GET) */
|
|
9412
|
+
body?: Record<string, never>;
|
|
9413
|
+
/** @description Period definition for when this job should run */
|
|
9414
|
+
period?: components["schemas"]["CreatePeriodDto"];
|
|
9415
|
+
};
|
|
9416
|
+
ScheduledActionResponseDto_PATCH_Single_Scheduled_action_updated_successfully_Default: {
|
|
9417
|
+
/** @example true */
|
|
9418
|
+
success: Record<string, never>;
|
|
9419
|
+
/** @example PATCH */
|
|
9420
|
+
method: Record<string, never>;
|
|
9421
|
+
/** @example OK */
|
|
9422
|
+
status: Record<string, never>;
|
|
9423
|
+
/** @example 200 */
|
|
9424
|
+
statusCode: Record<string, never>;
|
|
9425
|
+
/** @example shedulled-actions/{id} */
|
|
9426
|
+
path: Record<string, never>;
|
|
9427
|
+
/** @example 2025-11-17T06:58:17.233Z */
|
|
9428
|
+
timestamp: Record<string, never>;
|
|
9429
|
+
/** @example Scheduled action updated successfully */
|
|
9430
|
+
message: Record<string, never>;
|
|
9431
|
+
data?: components["schemas"]["ScheduledActionResponseDto"];
|
|
9432
|
+
};
|
|
9433
|
+
NoData_DELETE_Response_Scheduled_action_deleted_successfully_Default: {
|
|
9434
|
+
/** @example true */
|
|
9435
|
+
success: Record<string, never>;
|
|
9436
|
+
/** @example DELETE */
|
|
9437
|
+
method: Record<string, never>;
|
|
9438
|
+
/** @example NO_CONTENT */
|
|
9439
|
+
status: Record<string, never>;
|
|
9440
|
+
/** @example 204 */
|
|
9441
|
+
statusCode: Record<string, never>;
|
|
9442
|
+
/** @example shedulled-actions/{id} */
|
|
9443
|
+
path: Record<string, never>;
|
|
9444
|
+
/** @example 2025-11-17T06:58:17.235Z */
|
|
9445
|
+
timestamp: Record<string, never>;
|
|
9446
|
+
/** @example Scheduled action deleted successfully */
|
|
9447
|
+
message: Record<string, never>;
|
|
9448
|
+
};
|
|
9449
|
+
ScheduledActionResponseDto_GET_Single_Scheduled_action_detail_retrieved_successfully_Default: {
|
|
9450
|
+
/** @example true */
|
|
9451
|
+
success: Record<string, never>;
|
|
9452
|
+
/** @example GET */
|
|
9453
|
+
method: Record<string, never>;
|
|
9454
|
+
/** @example OK */
|
|
9455
|
+
status: Record<string, never>;
|
|
9456
|
+
/** @example 200 */
|
|
9457
|
+
statusCode: Record<string, never>;
|
|
9458
|
+
/** @example shedulled-actions/{id} */
|
|
9459
|
+
path: Record<string, never>;
|
|
9460
|
+
/** @example 2025-11-17T06:58:17.237Z */
|
|
9461
|
+
timestamp: Record<string, never>;
|
|
9462
|
+
/** @example Scheduled action detail retrieved successfully */
|
|
9463
|
+
message: Record<string, never>;
|
|
9464
|
+
data?: components["schemas"]["ScheduledActionResponseDto"];
|
|
9465
|
+
};
|
|
9466
|
+
ScheduledActionListResponseDto: {
|
|
9467
|
+
meta: components["schemas"]["MetaDto"];
|
|
9468
|
+
shedulledActions: components["schemas"]["ScheduledActionDto"][];
|
|
9469
|
+
};
|
|
9470
|
+
ScheduledActionListResponseDto_GET_Array_Scheduled_action_list_retrieved_successfully_Default: {
|
|
9471
|
+
/** @example true */
|
|
9472
|
+
success: Record<string, never>;
|
|
9473
|
+
/** @example GET */
|
|
9474
|
+
method: Record<string, never>;
|
|
9475
|
+
/** @example OK */
|
|
9476
|
+
status: Record<string, never>;
|
|
9477
|
+
/** @example 200 */
|
|
9478
|
+
statusCode: Record<string, never>;
|
|
9479
|
+
/** @example shedulled-actions */
|
|
9480
|
+
path: Record<string, never>;
|
|
9481
|
+
/** @example 2025-11-17T06:58:17.238Z */
|
|
9482
|
+
timestamp: Record<string, never>;
|
|
9483
|
+
/** @example Scheduled action list retrieved successfully */
|
|
9484
|
+
message: Record<string, never>;
|
|
9485
|
+
data?: components["schemas"]["ScheduledActionListResponseDto"][];
|
|
9486
|
+
};
|
|
8486
9487
|
};
|
|
8487
9488
|
responses: never;
|
|
8488
9489
|
parameters: never;
|