@capibox/bridge-server 0.0.50 → 0.0.55

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 CHANGED
@@ -1,6 +1,2405 @@
1
1
  import * as next_navigation from 'next/navigation';
2
2
  import * as next_server from 'next/server';
3
3
 
4
+ interface components {
5
+ schemas: {
6
+ CreateLinkDto: {
7
+ /** @example Documentation Page */
8
+ title: string;
9
+ /** @example https://example.com/page */
10
+ url: string;
11
+ /** @example true */
12
+ active?: boolean;
13
+ /** @example en */
14
+ language: string;
15
+ /** @example Google Drive */
16
+ source: string;
17
+ /** @example Project Alpha */
18
+ project: string;
19
+ };
20
+ LinkResponseDto: {
21
+ /** @description Link ID */
22
+ id: number;
23
+ /** @description Link title */
24
+ title: string;
25
+ /** @description Target URL */
26
+ url: string;
27
+ /** @description Whether the link is active */
28
+ active: boolean;
29
+ /** @description Language of the account */
30
+ language: string;
31
+ /** @description Source of the link (e.g., google, facebook) */
32
+ source: string;
33
+ /** @description Project this link belongs to */
34
+ project: string;
35
+ /** @description Spreadsheet URL if applicable */
36
+ spreadsheet_url?: string;
37
+ };
38
+ UpdateLinkDto: {
39
+ /** @example Documentation Page */
40
+ title?: string;
41
+ /** @example https://example.com/page */
42
+ url?: string;
43
+ /** @example true */
44
+ active?: boolean;
45
+ /** @example en */
46
+ language?: string;
47
+ /** @example Google Drive */
48
+ source?: string;
49
+ /** @example Project Alpha */
50
+ project?: string;
51
+ };
52
+ CreateLanguageRuleDto: {
53
+ /** @example 1 */
54
+ accountId: number;
55
+ /** @example Greeting Rule */
56
+ title: string;
57
+ /** @example en */
58
+ language: string;
59
+ /**
60
+ * @example contains
61
+ * @enum {string}
62
+ */
63
+ condition_type: "contains" | "equals" | "not_contains";
64
+ /** @example hello */
65
+ condition_value: string;
66
+ /** @example 1 */
67
+ sort?: number;
68
+ };
69
+ LanguageRuleAccountDto: {
70
+ /** @description Account ID (Link ID) */
71
+ id: number;
72
+ /** @description Account source */
73
+ source: string;
74
+ /** @description Account language */
75
+ language: string;
76
+ };
77
+ LanguageRuleResponseDto: {
78
+ /** @description Rule ID */
79
+ id: number;
80
+ /** @description Condition type (contains, equals) */
81
+ condition_type: string;
82
+ /** @description Condition value (string to match against campaign name) */
83
+ condition_value: string;
84
+ /** @description Language code to assign if matched */
85
+ language: string;
86
+ /** @description Sort order */
87
+ sort: number;
88
+ /** @description Associated account (Link) */
89
+ account?: components["schemas"]["LanguageRuleAccountDto"];
90
+ };
91
+ UpdateLanguageRuleDto: {
92
+ /** @example 1 */
93
+ accountId?: number;
94
+ /** @example Greeting Rule */
95
+ title?: string;
96
+ /** @example en */
97
+ language?: string;
98
+ /**
99
+ * @example contains
100
+ * @enum {string}
101
+ */
102
+ condition_type?: "contains" | "equals" | "not_contains";
103
+ /** @example hello */
104
+ condition_value?: string;
105
+ /** @example 1 */
106
+ sort?: number;
107
+ };
108
+ AdSpendAccountDto: {
109
+ /** @description Account (Link) ID */
110
+ id: number;
111
+ /** @description Account source */
112
+ source: string;
113
+ /** @description Account language */
114
+ language: string;
115
+ };
116
+ AdSpendResponseDto: {
117
+ /** @description AdSpend record ID */
118
+ id: number;
119
+ /** @description Spend date (YYYY-MM-DD) */
120
+ date: string;
121
+ /** @description Country (mapped from country code) */
122
+ country: string;
123
+ /** @description Language code applied */
124
+ language: string;
125
+ /** @description Spend amount in account currency */
126
+ spend: number;
127
+ /** @description Associated account (Link) */
128
+ account?: components["schemas"]["AdSpendAccountDto"];
129
+ };
130
+ AdSpendPaginatedResponseDto: {
131
+ data: components["schemas"]["AdSpendResponseDto"][];
132
+ /** @example 100 */
133
+ total: number;
134
+ /** @example 1 */
135
+ page: number;
136
+ /** @example 10 */
137
+ limit: number;
138
+ /** @example 10 */
139
+ totalPages: number;
140
+ };
141
+ AdSpendDataForErpDto: {
142
+ /**
143
+ * @description Nested object with three levels of string keys and number values
144
+ * @example {
145
+ * "account1": {
146
+ * "campaign1": {
147
+ * "metric1": 100,
148
+ * "metric2": 200
149
+ * }
150
+ * }
151
+ * }
152
+ */
153
+ data: Record<string, never>;
154
+ };
155
+ TeamResponseDto: {
156
+ /**
157
+ * @description The unique identifier of the team
158
+ * @example 1
159
+ */
160
+ id: number;
161
+ /**
162
+ * @description The title of the team
163
+ * @example Development Team
164
+ */
165
+ title: string;
166
+ /**
167
+ * @description The access for element
168
+ * @example [
169
+ * "xx@netzet.com",
170
+ * "xx2@netzet.com"
171
+ * ]
172
+ */
173
+ access?: string[];
174
+ };
175
+ ProjectGroupResponseDto: {
176
+ /**
177
+ * @description The unique identifier of the project group
178
+ * @example 1
179
+ */
180
+ id: number;
181
+ /**
182
+ * @description The title of the project group
183
+ * @example Frontend Projects
184
+ */
185
+ title: string;
186
+ /**
187
+ * @description The ID of the team this project group belongs to
188
+ * @example 1
189
+ */
190
+ teamId: number;
191
+ /** @description The team this project group belongs to */
192
+ team: components["schemas"]["TeamResponseDto"];
193
+ /**
194
+ * @description The access for element
195
+ * @example [
196
+ * "xx@netzet.com",
197
+ * "xx2@netzet.com"
198
+ * ]
199
+ */
200
+ access?: string[];
201
+ };
202
+ ProjectResponseDto: {
203
+ /**
204
+ * @description The unique identifier of the project
205
+ * @example 1
206
+ */
207
+ id: number;
208
+ /**
209
+ * @description The title of the project
210
+ * @example My Awesome Project
211
+ */
212
+ title: string;
213
+ /**
214
+ * @description The unique UUID of the project used for authentication
215
+ * @example 123e4567-e89b-12d3-a456-426614174000
216
+ */
217
+ uuid: string;
218
+ /**
219
+ * @description The unique UUID for development purposes
220
+ * @example 123e4567-e89b-12d3-a456-426614174001
221
+ */
222
+ uuidDev?: string;
223
+ /**
224
+ * @description The URL of the project
225
+ * @example https://myproject.example.com
226
+ */
227
+ url: string;
228
+ /**
229
+ * @description The support email address for the project
230
+ * @example support@example.com
231
+ */
232
+ support_email: string;
233
+ /**
234
+ * @description Project language
235
+ * @example en
236
+ */
237
+ language?: string;
238
+ /**
239
+ * @description The slug of the project
240
+ * @example my-awesome-project
241
+ */
242
+ slug: string;
243
+ groupId?: number;
244
+ teamId?: number;
245
+ team?: components["schemas"]["TeamResponseDto"];
246
+ group?: components["schemas"]["ProjectGroupResponseDto"];
247
+ /**
248
+ * @description The access for element
249
+ * @example [
250
+ * "xx@netzet.com",
251
+ * "xx2@netzet.com"
252
+ * ]
253
+ */
254
+ access?: string[];
255
+ };
256
+ CreateProjectDto: {
257
+ /**
258
+ * @description The title of the project
259
+ * @example My Awesome Project
260
+ */
261
+ title: string;
262
+ /**
263
+ * @description The URL of the project
264
+ * @example https://myproject.example.com
265
+ */
266
+ url: string;
267
+ /**
268
+ * @description The support email address for the project
269
+ * @example support@example.com
270
+ */
271
+ support_email?: string;
272
+ /**
273
+ * @description Project language
274
+ * @example en
275
+ */
276
+ language?: string;
277
+ /**
278
+ * @description The slug of the project
279
+ * @example my-awesome-project
280
+ */
281
+ slug: string;
282
+ groupId?: number;
283
+ teamId?: number;
284
+ /**
285
+ * @description The access for element
286
+ * @example [
287
+ * "xx@netzet.com",
288
+ * "xx2@netzet.com"
289
+ * ]
290
+ */
291
+ access?: string[];
292
+ };
293
+ UpdateProjectDto: {
294
+ /**
295
+ * @description The title of the project
296
+ * @example My Awesome Project
297
+ */
298
+ title?: string;
299
+ /**
300
+ * @description The URL of the project
301
+ * @example https://myproject.example.com
302
+ */
303
+ url?: string;
304
+ /**
305
+ * @description The support email address for the project
306
+ * @example support@example.com
307
+ */
308
+ support_email?: string;
309
+ /**
310
+ * @description Project language
311
+ * @example en
312
+ */
313
+ language?: string;
314
+ /**
315
+ * @description The slug of the project
316
+ * @example my-awesome-project
317
+ */
318
+ slug?: string;
319
+ groupId?: number;
320
+ teamId?: number;
321
+ /**
322
+ * @description The access for element
323
+ * @example [
324
+ * "xx@netzet.com",
325
+ * "xx2@netzet.com"
326
+ * ]
327
+ */
328
+ access?: string[];
329
+ };
330
+ CreateTeamDto: {
331
+ /**
332
+ * @description The title of the team
333
+ * @example Development Team
334
+ */
335
+ title: string;
336
+ /**
337
+ * @description The access for element
338
+ * @example [
339
+ * "xx@netzet.com",
340
+ * "xx2@netzet.com"
341
+ * ]
342
+ */
343
+ access?: string[];
344
+ };
345
+ UpdateTeamDto: {
346
+ /**
347
+ * @description The title of the team
348
+ * @example Development Team
349
+ */
350
+ title?: string;
351
+ /**
352
+ * @description The access for element
353
+ * @example [
354
+ * "xx@netzet.com",
355
+ * "xx2@netzet.com"
356
+ * ]
357
+ */
358
+ access?: string[];
359
+ };
360
+ CreateProjectGroupDto: {
361
+ /**
362
+ * @description The title of the project group
363
+ * @example Frontend Projects
364
+ */
365
+ title: string;
366
+ /**
367
+ * @description The ID of the team this project group belongs to
368
+ * @example 1
369
+ */
370
+ teamId: number;
371
+ /**
372
+ * @description The access for element
373
+ * @example [
374
+ * "xx@netzet.com",
375
+ * "xx2@netzet.com"
376
+ * ]
377
+ */
378
+ access?: string[];
379
+ };
380
+ UpdateProjectGroupDto: {
381
+ /**
382
+ * @description The title of the project group
383
+ * @example Frontend Projects
384
+ */
385
+ title?: string;
386
+ /**
387
+ * @description The ID of the team this project group belongs to
388
+ * @example 1
389
+ */
390
+ teamId?: number;
391
+ /**
392
+ * @description The access for element
393
+ * @example [
394
+ * "xx@netzet.com",
395
+ * "xx2@netzet.com"
396
+ * ]
397
+ */
398
+ access?: string[];
399
+ };
400
+ IntegrationResponseDto: {
401
+ /**
402
+ * @description The unique identifier of the integration
403
+ * @example 1
404
+ */
405
+ id: number;
406
+ /**
407
+ * @description The title of the integration
408
+ * @example My Facebook Integration
409
+ */
410
+ title: string;
411
+ /**
412
+ * @description The ID of the project this integration belongs to
413
+ * @example 1
414
+ */
415
+ projectId: number;
416
+ /**
417
+ * @description The type of integration
418
+ * @example facebook
419
+ */
420
+ type: string;
421
+ /**
422
+ * @description The URL for the integration
423
+ * @example https://example.com/api
424
+ */
425
+ url: string;
426
+ /**
427
+ * @description Additional options for the integration
428
+ * @example {
429
+ * "apiKey": "abc123",
430
+ * "enabled": true
431
+ * }
432
+ */
433
+ options?: Record<string, never>;
434
+ /** @description The project this integration belongs to */
435
+ project?: components["schemas"]["ProjectResponseDto"];
436
+ /**
437
+ * @description The access for element
438
+ * @example [
439
+ * "xx@netzet.com",
440
+ * "xx2@netzet.com"
441
+ * ]
442
+ */
443
+ access?: string[];
444
+ };
445
+ CreateIntegrationDto: {
446
+ /**
447
+ * @description The type of integration
448
+ * @example facebook
449
+ */
450
+ type: string;
451
+ /**
452
+ * @description The title of the integration
453
+ * @example My Facebook Integration
454
+ */
455
+ title: string;
456
+ /**
457
+ * @description The ID of the project this integration belongs to
458
+ * @example 1
459
+ */
460
+ projectId: number;
461
+ /**
462
+ * @description Additional options for the integration
463
+ * @example {
464
+ * "apiKey": "abc123",
465
+ * "enabled": true
466
+ * }
467
+ */
468
+ options?: Record<string, never>;
469
+ /**
470
+ * @description The URL for the integration
471
+ * @example https://example.com/api
472
+ */
473
+ url?: string;
474
+ /**
475
+ * @description The access for element
476
+ * @example [
477
+ * "xx@netzet.com",
478
+ * "xx2@netzet.com"
479
+ * ]
480
+ */
481
+ access?: string[];
482
+ };
483
+ UpdateIntegrationDto: {
484
+ /**
485
+ * @description The title of the integration
486
+ * @example Updated Facebook Integration
487
+ */
488
+ title?: string;
489
+ /**
490
+ * @description The ID of the project this integration belongs to
491
+ * @example 1
492
+ */
493
+ projectId?: number;
494
+ /**
495
+ * @description The type of integration
496
+ * @example facebook
497
+ */
498
+ type?: string;
499
+ /**
500
+ * @description The URL for the integration
501
+ * @example https://example.com/api
502
+ */
503
+ url?: string;
504
+ /**
505
+ * @description Description of the integration
506
+ * @example This is a Facebook integration for our project
507
+ */
508
+ _description?: string;
509
+ /**
510
+ * @description Additional options for the integration
511
+ * @example {
512
+ * "apiKey": "abc123",
513
+ * "enabled": true
514
+ * }
515
+ */
516
+ options?: Record<string, never>;
517
+ /**
518
+ * @description The access for element
519
+ * @example [
520
+ * "xx@netzet.com",
521
+ * "xx2@netzet.com"
522
+ * ]
523
+ */
524
+ access?: string[];
525
+ };
526
+ FunnelTemplatesEnumDto: {
527
+ /**
528
+ * @description Available templates for the home page
529
+ * @example [
530
+ * "Default"
531
+ * ]
532
+ */
533
+ homePageTemplate: string[];
534
+ /**
535
+ * @description Available templates for the quiz page
536
+ * @example [
537
+ * "Default"
538
+ * ]
539
+ */
540
+ quizPageTemplate: string[];
541
+ /**
542
+ * @description Available templates for the result page
543
+ * @example [
544
+ * "Default"
545
+ * ]
546
+ */
547
+ resultPageTemplate: string[];
548
+ /**
549
+ * @description Available templates for the email page
550
+ * @example [
551
+ * "Default"
552
+ * ]
553
+ */
554
+ emailPageTemplate: string[];
555
+ /**
556
+ * @description Available templates for the checkout page
557
+ * @example [
558
+ * "Default"
559
+ * ]
560
+ */
561
+ checkoutPageTemplate: string[];
562
+ /**
563
+ * @description Available templates for the upsell page
564
+ * @example [
565
+ * "Default"
566
+ * ]
567
+ */
568
+ upsellPageTemplate: string[];
569
+ /**
570
+ * @description Available templates for the payment window
571
+ * @example [
572
+ * "Default"
573
+ * ]
574
+ */
575
+ paymentWindowTemplate: string[];
576
+ };
577
+ FunnelTemplatesEnumResponseDto: {
578
+ /** @description Indicates if the request was successful */
579
+ success: boolean;
580
+ data: components["schemas"]["FunnelTemplatesEnumDto"];
581
+ };
582
+ CreateFunnelDtoBridge: {
583
+ angle: string;
584
+ version: string;
585
+ note?: string;
586
+ home_page?: string;
587
+ quiz_page?: string;
588
+ results_page?: string;
589
+ email_page?: string;
590
+ checkout_page?: string;
591
+ payment_window?: string;
592
+ upsell_page: string;
593
+ upsell_options?: {
594
+ [key: string]: unknown;
595
+ };
596
+ options?: {
597
+ [key: string]: unknown;
598
+ };
599
+ };
600
+ FunnelResponseDto: {
601
+ id: number;
602
+ project: string;
603
+ angle: string;
604
+ version: string;
605
+ note?: string;
606
+ home_page: string;
607
+ quiz_page: string;
608
+ results_page: string;
609
+ email_page: string;
610
+ checkout_page: string;
611
+ payment_window: string;
612
+ upsell_page: string;
613
+ upsell_options?: Record<string, never>;
614
+ options?: Record<string, never>;
615
+ };
616
+ UpdateFunnelDto: {
617
+ project?: string;
618
+ angle?: string;
619
+ version?: string;
620
+ note?: string;
621
+ home_page?: string;
622
+ quiz_page?: string;
623
+ results_page?: string;
624
+ email_page?: string;
625
+ checkout_page?: string;
626
+ payment_window?: string;
627
+ upsell_page?: string;
628
+ upsell_options?: {
629
+ [key: string]: unknown;
630
+ };
631
+ options?: {
632
+ [key: string]: unknown;
633
+ };
634
+ };
635
+ SplitItemDto: {
636
+ url: string;
637
+ split: number;
638
+ };
639
+ CreateSplitDto: {
640
+ project: string;
641
+ url?: string;
642
+ splits?: components["schemas"]["SplitItemDto"][];
643
+ options?: {
644
+ [key: string]: unknown;
645
+ };
646
+ active: boolean;
647
+ };
648
+ SplitResponseDto: {
649
+ id: number;
650
+ project: string;
651
+ url?: string;
652
+ splits?: components["schemas"]["SplitItemDto"][];
653
+ options?: Record<string, never>;
654
+ active: boolean;
655
+ };
656
+ UpdateSplitDto: {
657
+ project?: string;
658
+ url?: string;
659
+ splits?: components["schemas"]["SplitItemDto"][];
660
+ options?: {
661
+ [key: string]: unknown;
662
+ };
663
+ active?: boolean;
664
+ };
665
+ SendMailToRecipientDto: {
666
+ /**
667
+ * @description Email recipient address
668
+ * @example recipient@example.com
669
+ */
670
+ to: string;
671
+ /**
672
+ * @description Email subject
673
+ * @example Important information about your account
674
+ */
675
+ subject: string;
676
+ /**
677
+ * @description HTML content of the email
678
+ * @example <p>Hello, this is an <strong>important</strong> message.</p>
679
+ */
680
+ htmlPart?: string;
681
+ /**
682
+ * @description Plain text content of the email
683
+ * @example Hello, this is an important message.
684
+ */
685
+ textPart?: string;
686
+ };
687
+ SendMailResponseDto: {
688
+ /**
689
+ * @description Success status
690
+ * @example true
691
+ */
692
+ success: boolean;
693
+ };
694
+ SendMailToSupportDto: {
695
+ /**
696
+ * @description Email subject
697
+ * @example Important information about your account
698
+ */
699
+ subject: string;
700
+ /**
701
+ * @description HTML content of the email
702
+ * @example <p>Hello, this is an <strong>important</strong> message.</p>
703
+ */
704
+ htmlPart?: string;
705
+ /**
706
+ * @description Plain text content of the email
707
+ * @example Hello, this is an important message.
708
+ */
709
+ textPart?: string;
710
+ };
711
+ CreateSessionBridgeDto: {
712
+ extraData?: {
713
+ [key: string]: unknown;
714
+ };
715
+ quiz?: {
716
+ [key: string]: unknown;
717
+ };
718
+ cookies: string;
719
+ uuid?: string;
720
+ analyticsId?: string;
721
+ analyticsIdv3?: string;
722
+ origin?: string;
723
+ query: {
724
+ [key: string]: unknown;
725
+ };
726
+ referer?: string;
727
+ slug: string;
728
+ };
729
+ SessionResponseDto: {
730
+ id: string;
731
+ project: string;
732
+ /** @example {
733
+ * "session_id": "1234567890",
734
+ * "session_token": "1234567890"
735
+ * } */
736
+ cookies: {
737
+ [key: string]: unknown;
738
+ };
739
+ country: string;
740
+ createdAt: string;
741
+ ip: string;
742
+ isEu: boolean;
743
+ /** @example https://www.example.com */
744
+ origin: string;
745
+ /** @example {
746
+ * "utm_source": "google",
747
+ * "utm_medium": "cpc",
748
+ * "utm_campaign": "adwords"
749
+ * } */
750
+ query: {
751
+ [key: string]: unknown;
752
+ };
753
+ /** @example https://www.example.com */
754
+ referer: string;
755
+ /** @example main/a */
756
+ slug: string;
757
+ updatedAt: string;
758
+ /** @example Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36 */
759
+ useragent: string;
760
+ /** @example {
761
+ * "language": "en",
762
+ * "currency": "USD",
763
+ * "email": "xxx@example.com"
764
+ * } */
765
+ extraData: {
766
+ [key: string]: unknown;
767
+ };
768
+ };
769
+ SessionResponseFullDto: {
770
+ success: number;
771
+ data: components["schemas"]["SessionResponseDto"];
772
+ };
773
+ AppendSessionDto: {
774
+ extraData?: {
775
+ [key: string]: unknown;
776
+ };
777
+ };
778
+ GetCurrencyDto: {
779
+ /** @example [
780
+ * "EUR",
781
+ * "GBP"
782
+ * ] */
783
+ currencies: string[];
784
+ };
785
+ CurrencyRateResponseDto: {
786
+ /**
787
+ * @description Unique ID of the rate record
788
+ * @example 6
789
+ */
790
+ id: number;
791
+ /**
792
+ * @description Date when the rate was recorded
793
+ * @example 2025-09-24
794
+ */
795
+ date: string;
796
+ /**
797
+ * @description Target currency code (ISO 4217)
798
+ * @example PKR
799
+ */
800
+ currency: string;
801
+ /**
802
+ * @description Base currency code (ISO 4217)
803
+ * @example USD
804
+ */
805
+ base_currency: string;
806
+ /**
807
+ * @description Exchange rate relative to base currency
808
+ * @example 281.4
809
+ */
810
+ rate: number;
811
+ };
812
+ CreateWebhookDto: {
813
+ /** @description The title of the webhook */
814
+ title?: string;
815
+ /** @description The events that trigger the webhook */
816
+ events: string[];
817
+ /** @description The URL endpoint to send the webhook to */
818
+ endpoint: string;
819
+ /**
820
+ * @description The HTTP method to use when sending the webhook
821
+ * @default GET
822
+ */
823
+ method: string;
824
+ /** @description The authorization header to use when sending the webhook */
825
+ authorization?: string;
826
+ /** @description The project associated with the webhook */
827
+ project?: string;
828
+ };
829
+ WebhookResponseDto: {
830
+ /** @description The unique identifier of the webhook */
831
+ id: number;
832
+ /** @description The title of the webhook */
833
+ title?: string;
834
+ /** @description The events that trigger the webhook */
835
+ events: string[];
836
+ /** @description The URL endpoint to send the webhook to */
837
+ endpoint: string;
838
+ /**
839
+ * @description The HTTP method to use when sending the webhook
840
+ * @default GET
841
+ */
842
+ method: string;
843
+ /** @description The authorization header to use when sending the webhook */
844
+ authorization?: string;
845
+ /** @description The project associated with the webhook */
846
+ project?: string;
847
+ };
848
+ UpdateWebhookDto: {
849
+ /** @description The title of the webhook */
850
+ title?: string;
851
+ /** @description The URL endpoint to send the webhook to */
852
+ endpoint?: string;
853
+ /** @description The HTTP method to use when sending the webhook */
854
+ method?: string;
855
+ /** @description The authorization header to use when sending the webhook */
856
+ authorization?: string;
857
+ /** @description The project associated with the webhook */
858
+ project?: string;
859
+ };
860
+ QuizResponseDto: {
861
+ /**
862
+ * @description Quiz data with dynamic keys
863
+ * @example {
864
+ * "q-1": {
865
+ * "q": "What is your age?",
866
+ * "v": {
867
+ * "answer": "25"
868
+ * }
869
+ * },
870
+ * "q-2": {
871
+ * "q": "Which Social Media Platform Do You Use the most?",
872
+ * "v": {
873
+ * "answers": [
874
+ * "Facebook",
875
+ * "TikTok"
876
+ * ]
877
+ * }
878
+ * }
879
+ * }
880
+ */
881
+ quiz: {
882
+ [key: string]: unknown;
883
+ };
884
+ };
885
+ QuizFullResponseDto: {
886
+ /**
887
+ * @description Success flag
888
+ * @example 1
889
+ */
890
+ success: number;
891
+ /** @description Response data containing quiz information */
892
+ data: components["schemas"]["QuizResponseDto"];
893
+ };
894
+ TrackRealtimeEventDto: {
895
+ type: string;
896
+ uuid?: string;
897
+ pathname: string;
898
+ referer: string;
899
+ origin: string;
900
+ /** @example {
901
+ * "session_id": "a1b2c3d4-e5f6-7890",
902
+ * "status": "active"
903
+ * } */
904
+ query: {
905
+ [key: string]: string;
906
+ };
907
+ /** @example {
908
+ * "user_id": 12345,
909
+ * "session_id": "a1b2c3d4-e5f6-7890",
910
+ * "status": "active",
911
+ * "retry_count": 3
912
+ * } */
913
+ eventData?: {
914
+ [key: string]: string | number;
915
+ };
916
+ /** @example {
917
+ * "user_id": 12345,
918
+ * "session_id": "a1b2c3d4-e5f6-7890",
919
+ * "status": "active",
920
+ * "retry_count": 3
921
+ * } */
922
+ attr?: {
923
+ [key: string]: string | number;
924
+ };
925
+ skipEvent?: boolean;
926
+ };
927
+ CreateRealtimeAttributeDtoBridge: {
928
+ attr_key: string;
929
+ attr_value: string;
930
+ funnel: string;
931
+ created_at: number;
932
+ uuid: string;
933
+ };
934
+ CreateRealtimeEventDtoBridge: {
935
+ uuid: string;
936
+ name: string;
937
+ data?: {
938
+ [key: string]: unknown;
939
+ };
940
+ order_id?: string;
941
+ created_at: number;
942
+ funnel: string;
943
+ };
944
+ CreateRealtimeSessionDtoBridge: {
945
+ uuid: string;
946
+ ip: string;
947
+ user_agent: string;
948
+ origin: string;
949
+ referer: string;
950
+ os: string;
951
+ browser: string;
952
+ type: string;
953
+ };
954
+ CreateRealtimeUtmDtoBridge: {
955
+ utm_key: string;
956
+ utm_value: string;
957
+ funnel: string;
958
+ created_at: number;
959
+ uuid: string;
960
+ };
961
+ VerifyPhoneResponseDto: {
962
+ /** @description Valid number or not */
963
+ valid: boolean;
964
+ /** @description Landline number or not. Possible values: 1 - YES, 0 - NO, -1 - api not support this feature */
965
+ landline: number;
966
+ /** @description Validation error if exists */
967
+ error: string;
968
+ };
969
+ VerifyEmailResponseDto: {
970
+ /** @description Valid email or not */
971
+ valid: boolean;
972
+ /** @description Validation error if exists */
973
+ error?: string;
974
+ };
975
+ PaymentCreateSessionBridgeRequestDto: {
976
+ /** @description Unique Customer ID for the transaction. */
977
+ referenceId: string;
978
+ paymentDescription: string;
979
+ /**
980
+ * @description Optional metadata for the transaction.
981
+ * @example {
982
+ * "orderId": "123",
983
+ * "customerId": "456"
984
+ * }
985
+ */
986
+ metaData?: {
987
+ [key: string]: unknown;
988
+ };
989
+ };
990
+ PaymentCreateSessionBridgeResponseItemDto: {
991
+ /**
992
+ * @description The token for the payment session
993
+ * @example tok_1234567890
994
+ */
995
+ token: string;
996
+ /**
997
+ * @description The source for the payment session from integration system
998
+ * @example paypal-us
999
+ */
1000
+ source: string;
1001
+ /**
1002
+ * @description The provider for the payment session
1003
+ * @example paypal
1004
+ */
1005
+ provider: string;
1006
+ };
1007
+ EarlyFraudWarningSearchDto: {
1008
+ /**
1009
+ * @description Start date in YYYY-MM-DD format.
1010
+ * @example 2025-08-01
1011
+ */
1012
+ startDate?: string;
1013
+ /**
1014
+ * @description End date in YYYY-MM-DD format.
1015
+ * @example 2025-08-10
1016
+ */
1017
+ endDate?: string;
1018
+ };
1019
+ YunoCreatePaymentDto: {
1020
+ /** @description Main Order ID */
1021
+ referenceId: string;
1022
+ /** @description Payment method */
1023
+ paymentMethod: string;
1024
+ /** @description Payment token */
1025
+ token: string;
1026
+ };
1027
+ CheckoutConditionsDto: {
1028
+ /** @example true */
1029
+ enabled: boolean;
1030
+ /** @example null */
1031
+ rules: Record<string, never> | null;
1032
+ };
1033
+ YunoCheckoutDto: {
1034
+ /** @example xxxxxx-xxxxx-xxxx-xxxx-xxxxxxx */
1035
+ session: string;
1036
+ /** @example true */
1037
+ sdk_required_action: boolean;
1038
+ conditions: components["schemas"]["CheckoutConditionsDto"];
1039
+ };
1040
+ YunoPaymentMethodResponseDto: {
1041
+ /** @example Card */
1042
+ name: string;
1043
+ /** @example xxxx */
1044
+ vaulted_token: string | null;
1045
+ /** @example Card */
1046
+ description: string;
1047
+ /** @example CARD */
1048
+ type: string;
1049
+ /** @example CARD */
1050
+ category: string;
1051
+ /** @example https://sdk.prod.y.uno/brands/card_image.png */
1052
+ icon: string;
1053
+ /** @example null */
1054
+ last_successfully_used: string | null;
1055
+ /** @example null */
1056
+ last_successfully_used_at: string | null;
1057
+ checkout: components["schemas"]["YunoCheckoutDto"];
1058
+ /** @example true */
1059
+ preferred: boolean;
1060
+ };
1061
+ PaymentRefundRequestDto: {
1062
+ /** @description Order ID */
1063
+ orderId: string;
1064
+ /** @description Transaction or Charge ID */
1065
+ transactionId: string;
1066
+ /** @description Refund amount */
1067
+ amount: number;
1068
+ /** @description Original transaction amount */
1069
+ originalAmount?: number;
1070
+ /** @description Currency */
1071
+ currency: string;
1072
+ };
1073
+ PaymentRefundResponseDto: {
1074
+ /** @description Success or not */
1075
+ success: boolean;
1076
+ /**
1077
+ * @description Refund type
1078
+ * @enum {string}
1079
+ */
1080
+ type: "refund" | "cancel";
1081
+ /** @description Refund error if exists */
1082
+ error: string;
1083
+ };
1084
+ PrimerCreateReferencePaymentRequestDto: {
1085
+ /**
1086
+ * @description The payment method token used to authorize the payment. If not provided, we will search for a token by client.
1087
+ * @example oXxI7BvGTZWRBucAd92D-HwxNzU0NDAxNTUy
1088
+ */
1089
+ paymentMethodToken?: string;
1090
+ /**
1091
+ * @description Your reference for the payment
1092
+ * @example 123456789
1093
+ */
1094
+ orderId: string;
1095
+ /**
1096
+ * @description The amount you would like to charge the customer, in minor units. e.g. for $7, use 700.
1097
+ * @example 1000
1098
+ */
1099
+ amount: number;
1100
+ /**
1101
+ * @description Payment metadata (optional)
1102
+ * @example {
1103
+ * "productId": 123,
1104
+ * "merchantId": "a13bsd62s"
1105
+ * }
1106
+ */
1107
+ metadata?: {
1108
+ [key: string]: unknown;
1109
+ };
1110
+ };
1111
+ PrimerCreatePaymentResponseDto: {
1112
+ /** @example success */
1113
+ success: boolean;
1114
+ };
1115
+ PrimerCreateRecurringPaymentRequestDto: {
1116
+ /**
1117
+ * @description The payment method token used to authorize the payment. If not provided, we will search for a token by client.
1118
+ * @example oXxI7BvGTZWRBucAd92D-HwxNzU0NDAxNTUy
1119
+ */
1120
+ paymentMethodToken?: string;
1121
+ /**
1122
+ * @description Your reference for the payment
1123
+ * @example 123456789
1124
+ */
1125
+ orderId: string;
1126
+ /**
1127
+ * @description The amount you would like to charge the customer, in minor units. e.g. for $7, use 700.
1128
+ * @example 1000
1129
+ */
1130
+ amount: number;
1131
+ /**
1132
+ * @description Payment metadata (optional)
1133
+ * @example {
1134
+ * "productId": 123,
1135
+ * "merchantId": "a13bsd62s"
1136
+ * }
1137
+ */
1138
+ metadata?: {
1139
+ [key: string]: unknown;
1140
+ };
1141
+ };
1142
+ PrimerCreateReferencePaymentRequestWithDelayDto: {
1143
+ /**
1144
+ * @description The payment method token used to authorize the payment. If not provided, we will search for a token by client.
1145
+ * @example oXxI7BvGTZWRBucAd92D-HwxNzU0NDAxNTUy
1146
+ */
1147
+ paymentMethodToken?: string;
1148
+ /**
1149
+ * @description Your reference for the payment
1150
+ * @example 123456789
1151
+ */
1152
+ orderId: string;
1153
+ /**
1154
+ * @description The amount you would like to charge the customer, in minor units. e.g. for $7, use 700.
1155
+ * @example 1000
1156
+ */
1157
+ amount: number;
1158
+ /**
1159
+ * @description Payment metadata (optional)
1160
+ * @example {
1161
+ * "productId": 123,
1162
+ * "merchantId": "a13bsd62s"
1163
+ * }
1164
+ */
1165
+ metadata?: {
1166
+ [key: string]: unknown;
1167
+ };
1168
+ /**
1169
+ * @description The delay in minutes before the payment is processed
1170
+ * @example 10
1171
+ */
1172
+ delay: number;
1173
+ };
1174
+ TaxValueCountryStateRequestDto: {
1175
+ /**
1176
+ * @description ISO 3166-1 alpha-2 country code (e.g., US, CA)
1177
+ * @example US
1178
+ */
1179
+ countryCode: string;
1180
+ /**
1181
+ * @description State
1182
+ * @example Arizona
1183
+ */
1184
+ state: string;
1185
+ /**
1186
+ * @description Amount for tax calculation
1187
+ * @example 2
1188
+ */
1189
+ amount: number;
1190
+ };
1191
+ TaxValueCountryStateResponseDto: {
1192
+ /**
1193
+ * @description Tax percent
1194
+ * @example 5.6
1195
+ */
1196
+ taxPercent: number;
1197
+ /**
1198
+ * @description Tax amount
1199
+ * @example 2
1200
+ */
1201
+ taxAmount: number;
1202
+ /**
1203
+ * @description Amount with tax
1204
+ * @example 12
1205
+ */
1206
+ amountWithTax: number;
1207
+ };
1208
+ TaxPercentCountryStateRequestDto: {
1209
+ /**
1210
+ * @description ISO 3166-1 alpha-2 country code (e.g., US, CA)
1211
+ * @example US
1212
+ */
1213
+ countryCode: string;
1214
+ /**
1215
+ * @description State
1216
+ * @example Arizona
1217
+ */
1218
+ state: string;
1219
+ };
1220
+ TaxPercentCountryStateResponseDto: {
1221
+ /**
1222
+ * @description Tax percent
1223
+ * @example 5.6
1224
+ */
1225
+ taxPercent: number;
1226
+ };
1227
+ PaymentCreateSessionResponseDto: {
1228
+ /** @description Token for initiate payment session */
1229
+ token: string;
1230
+ };
1231
+ PaypalCaptureOrderResponseDto: {
1232
+ /** @example 23T524207X938445J */
1233
+ id: string;
1234
+ /** @example COMPLETED */
1235
+ status: string;
1236
+ };
1237
+ PaypalCapturePaymentResponseDto: {
1238
+ /** @example 23T524207X938445J */
1239
+ id: string;
1240
+ /** @example COMPLETED */
1241
+ status: string;
1242
+ };
1243
+ TokenRetrieveRequestDto: {
1244
+ /** @description Main Order ID */
1245
+ orderId: string;
1246
+ /** @description Charge ID */
1247
+ chargeId: string;
1248
+ };
1249
+ TokenRetrieveResponseDto: {
1250
+ /** @description Token */
1251
+ token: string;
1252
+ /** @description Token type */
1253
+ type: string;
1254
+ };
1255
+ ImportDisputesUrlRequestDto: {
1256
+ /**
1257
+ * @description URL of the CSV file to import
1258
+ * @example https://example.com/disputes.csv
1259
+ */
1260
+ url: string;
1261
+ };
1262
+ AdyenTransactionPaginatedResponseDto: {
1263
+ /** @description Array of items for the current page */
1264
+ data: string[];
1265
+ /** @description Total number of items available */
1266
+ total: number;
1267
+ /**
1268
+ * @description Current page number
1269
+ * @example 1
1270
+ */
1271
+ page: number;
1272
+ /**
1273
+ * @description Number of items per page
1274
+ * @example 10
1275
+ */
1276
+ limit: number;
1277
+ };
1278
+ ChargeResponseDto: {
1279
+ /**
1280
+ * @description Internal database ID.
1281
+ * @example 1
1282
+ */
1283
+ id: number;
1284
+ /**
1285
+ * @description Stripe charge ID.
1286
+ * @example ch_123
1287
+ */
1288
+ sourceId: string;
1289
+ /**
1290
+ * @description Time at which the charge was created on Stripe. Seconds since Unix epoch.
1291
+ * @example 1679090539
1292
+ */
1293
+ created: number;
1294
+ /**
1295
+ * @description True if the object exists in live mode; false if the object exists in test mode.
1296
+ * @example false
1297
+ */
1298
+ livemode: boolean;
1299
+ /** @description Full Stripe charge object stored as JSON. */
1300
+ data: Record<string, never>;
1301
+ /**
1302
+ * Format: date-time
1303
+ * @description Record creation timestamp.
1304
+ */
1305
+ createdAt: string;
1306
+ /**
1307
+ * Format: date-time
1308
+ * @description Record last update timestamp.
1309
+ */
1310
+ updatedAt: string;
1311
+ };
1312
+ BadRequestErrorDto: {
1313
+ /**
1314
+ * @description HTTP status code.
1315
+ * @example 400
1316
+ */
1317
+ statusCode: number;
1318
+ /**
1319
+ * @description List of error messages.
1320
+ * @example [
1321
+ * "property must be a string"
1322
+ * ]
1323
+ */
1324
+ message: string[];
1325
+ /**
1326
+ * @description Error message.
1327
+ * @example Bad Request
1328
+ */
1329
+ error: string;
1330
+ };
1331
+ DisputeResponseDto: {
1332
+ /**
1333
+ * @description Internal database ID.
1334
+ * @example 1
1335
+ */
1336
+ id: number;
1337
+ /**
1338
+ * @description The ID of the charge associated with the dispute.
1339
+ * @example du_1RqrpqHUCmnJBv5wT1EOPHlg
1340
+ */
1341
+ sourceId: string;
1342
+ /**
1343
+ * Format: date-time
1344
+ * @description The date and time when the dispute was created in UTC.
1345
+ * @example 2025-07-31T10:00:00Z
1346
+ */
1347
+ disputeCreatedUtc: string;
1348
+ /**
1349
+ * Format: date-time
1350
+ * @description The date and time when the original charge was created in UTC.
1351
+ * @example 2025-07-30T15:30:00Z
1352
+ */
1353
+ chargeCreatedUtc: string;
1354
+ /**
1355
+ * @description The amount of the dispute.
1356
+ * @example 100.5
1357
+ */
1358
+ disputeAmount: number;
1359
+ /**
1360
+ * @description The currency of the dispute.
1361
+ * @example USD
1362
+ */
1363
+ disputeCurrency: string;
1364
+ /**
1365
+ * @description The amount of the original charge.
1366
+ * @example 100.5
1367
+ */
1368
+ chargeAmount: number;
1369
+ /**
1370
+ * @description The currency of the original charge.
1371
+ * @example USD
1372
+ */
1373
+ chargeCurrencyChargeId: string;
1374
+ /**
1375
+ * @description The reason for the dispute.
1376
+ * @example fraudulent
1377
+ */
1378
+ reason: string;
1379
+ /**
1380
+ * @description The status of the dispute.
1381
+ * @example needs_response
1382
+ */
1383
+ status: string;
1384
+ /**
1385
+ * @description Indicates if this is a Visa Rapid Dispute Resolution case.
1386
+ * @example false
1387
+ */
1388
+ isVisaRapidDisputeResolution: boolean;
1389
+ /**
1390
+ * @description The ID of the Payment Intent associated with the charge.
1391
+ * @example pi_3Lp7g22eZvKYlo2C1A2B3D4E
1392
+ */
1393
+ paymentIntent: string;
1394
+ /**
1395
+ * @description The ID of the charge that was disputed.
1396
+ * @example ch_3Lp7g22eZvKYlo2C1A2B3D4E
1397
+ */
1398
+ chargeId: string;
1399
+ /**
1400
+ * Format: date-time
1401
+ * @description Timestamp of when the record was created in the database.
1402
+ */
1403
+ createdAt: string;
1404
+ /**
1405
+ * Format: date-time
1406
+ * @description Timestamp of when the record was last updated in the database.
1407
+ */
1408
+ updatedAt: string;
1409
+ };
1410
+ EarlyFraudWarningResponseDto: {
1411
+ /**
1412
+ * @description Internal database ID.
1413
+ * @example 1
1414
+ */
1415
+ id: number;
1416
+ /**
1417
+ * @description The unique identifier for the resource, from Stripe.
1418
+ * @example issfr_1Pb2dF2eZvKYlo2C5Z4Z4Z4Z
1419
+ */
1420
+ sourceId: string;
1421
+ /**
1422
+ * @description String representing the object's type.
1423
+ * @example radar.early_fraud_warning
1424
+ */
1425
+ object: string;
1426
+ /**
1427
+ * @description Whether the fraud warning is actionable.
1428
+ * @example true
1429
+ */
1430
+ actionable: boolean;
1431
+ /**
1432
+ * @description ID of the charge this fraud warning is for.
1433
+ * @example ch_3Pb2dF2eZvKYlo2C1Z4Z4Z4Z
1434
+ */
1435
+ charge: string;
1436
+ /**
1437
+ * @description Time at which the object was created. Measured in seconds since the Unix epoch.
1438
+ * @example 1672531199
1439
+ */
1440
+ created: number;
1441
+ /**
1442
+ * @description The type of fraud.
1443
+ * @example card_risk_level_elevated
1444
+ */
1445
+ fraudType: string;
1446
+ /**
1447
+ * @description Has the value true if the object exists in live mode or the value false if the object exists in test mode.
1448
+ * @example false
1449
+ */
1450
+ livemode: boolean;
1451
+ /**
1452
+ * Format: date-time
1453
+ * @description Timestamp of when the record was created in the database.
1454
+ */
1455
+ createdAt: string;
1456
+ /**
1457
+ * Format: date-time
1458
+ * @description Timestamp of when the record was last updated in the database.
1459
+ */
1460
+ updatedAt: string;
1461
+ };
1462
+ RefundResponseDto: {
1463
+ /**
1464
+ * @description Internal database ID.
1465
+ * @example 1
1466
+ */
1467
+ id: number;
1468
+ /**
1469
+ * @description Stripe refund ID.
1470
+ * @example re_123
1471
+ */
1472
+ sourceId: string;
1473
+ /**
1474
+ * @description Time at which the refund was created on Stripe. Seconds since Unix epoch.
1475
+ * @example 1692942318
1476
+ */
1477
+ created: number;
1478
+ /**
1479
+ * @description True if the object exists in live mode; false if the object exists in test mode.
1480
+ * @example false
1481
+ */
1482
+ livemode: boolean;
1483
+ /** @description Full Stripe refund object stored as JSON. */
1484
+ data: Record<string, never>;
1485
+ /**
1486
+ * Format: date-time
1487
+ * @description Record creation timestamp.
1488
+ */
1489
+ createdAt: string;
1490
+ /**
1491
+ * Format: date-time
1492
+ * @description Record last update timestamp.
1493
+ */
1494
+ updatedAt: string;
1495
+ };
1496
+ PaymentResponseDto: {
1497
+ /** @example 1 */
1498
+ id: number;
1499
+ /** @example pay_123456789 */
1500
+ external_id: string;
1501
+ /** @example SETTLED */
1502
+ status: Record<string, never> | null;
1503
+ /** @example 1000 */
1504
+ amount: Record<string, never> | null;
1505
+ /** @example USD */
1506
+ currency: Record<string, never> | null;
1507
+ /**
1508
+ * Format: date-time
1509
+ * @example 2024-01-01T00:00:00.000Z
1510
+ */
1511
+ created_at: string;
1512
+ /**
1513
+ * Format: date-time
1514
+ * @example 2024-01-01T00:00:00.000Z
1515
+ */
1516
+ updated_at: string;
1517
+ };
1518
+ PaymentsListResponseDto: {
1519
+ data: components["schemas"]["PaymentResponseDto"][];
1520
+ /** @example 1 */
1521
+ page: number;
1522
+ /** @example 10 */
1523
+ limit: number;
1524
+ /** @example 100 */
1525
+ total: number;
1526
+ /** @example 10 */
1527
+ total_pages: number;
1528
+ };
1529
+ TransactionResponseDto: {
1530
+ /** @example 1 */
1531
+ id: number;
1532
+ /** @example txn_123456789 */
1533
+ external_txn_id: string;
1534
+ /** @example 123 */
1535
+ payment_id: number;
1536
+ /** @example pay_123456789 */
1537
+ payment_external_id: string;
1538
+ /**
1539
+ * Format: date-time
1540
+ * @example 2024-01-01T00:00:00.000Z
1541
+ */
1542
+ created_at: string;
1543
+ /**
1544
+ * Format: date-time
1545
+ * @example 2024-01-01T00:00:00.000Z
1546
+ */
1547
+ updated_at: string;
1548
+ };
1549
+ TransactionsListResponseDto: {
1550
+ data: components["schemas"]["TransactionResponseDto"][];
1551
+ /** @example 1 */
1552
+ page: number;
1553
+ /** @example 10 */
1554
+ limit: number;
1555
+ /** @example 100 */
1556
+ total: number;
1557
+ /** @example 10 */
1558
+ total_pages: number;
1559
+ };
1560
+ RefundsListResponseDto: {
1561
+ data: components["schemas"]["RefundResponseDto"][];
1562
+ /** @example 1 */
1563
+ page: number;
1564
+ /** @example 10 */
1565
+ limit: number;
1566
+ /** @example 100 */
1567
+ total: number;
1568
+ /** @example 10 */
1569
+ total_pages: number;
1570
+ };
1571
+ OrderDto: {
1572
+ /** @example DE */
1573
+ countryCode: string;
1574
+ };
1575
+ BillingAddressDto: {
1576
+ /** @example DE */
1577
+ countryCode: string;
1578
+ };
1579
+ CustomerDto: {
1580
+ /** @example nadiakraevaa@gmail.com */
1581
+ emailAddress: string;
1582
+ billingAddress: components["schemas"]["BillingAddressDto"];
1583
+ };
1584
+ BinDataDto: {
1585
+ /** @example MASTERCARD */
1586
+ network: string;
1587
+ /** @example DE */
1588
+ issuerCountryCode: string;
1589
+ /** @example DEUTSCHER SPARKASSEN UND GIROVERBAND */
1590
+ issuerName: string;
1591
+ /** @example EUR */
1592
+ issuerCurrencyCode: string;
1593
+ /** @example UNKNOWN */
1594
+ regionalRestriction: string;
1595
+ /** @example DIGITAL_PAN */
1596
+ accountNumberType: string;
1597
+ /** @example DEBIT */
1598
+ accountFundingType: string;
1599
+ /** @example NOT_APPLICABLE */
1600
+ prepaidReloadableIndicator: string;
1601
+ /** @example CONSUMER */
1602
+ productUsageType: string;
1603
+ /** @example MDS */
1604
+ productCode: string;
1605
+ /** @example DEBIT STANDARD */
1606
+ productName: string;
1607
+ };
1608
+ PaymentMethodDataDto: {
1609
+ /** @example 8276 */
1610
+ last4Digits: string;
1611
+ /** @example 535558 */
1612
+ first6Digits: string;
1613
+ /** @example 12 */
1614
+ expirationMonth: string;
1615
+ /** @example 2027 */
1616
+ expirationYear: string;
1617
+ /** @example MASTERCARD */
1618
+ network: string;
1619
+ /** @example true */
1620
+ isNetworkTokenized: boolean;
1621
+ binData: components["schemas"]["BinDataDto"];
1622
+ };
1623
+ ThreeDSecureAuthenticationDto: {
1624
+ /** @example NOT_PERFORMED */
1625
+ responseCode: string;
1626
+ };
1627
+ PaymentMethodDto: {
1628
+ /** @example SUBSCRIPTION */
1629
+ paymentType: string;
1630
+ /** @example FINAL */
1631
+ authorizationType: string;
1632
+ /** @example Z3-cwYTuSfCklsqVHTtINnwxNzU0NzI1NzM5 */
1633
+ paymentMethodToken: string;
1634
+ /** @example true */
1635
+ isVaulted: boolean;
1636
+ /** @example 7T5oQC13Vlaff55v8jGb1HJW */
1637
+ analyticsId: string;
1638
+ /** @example APPLE_PAY */
1639
+ paymentMethodType: string;
1640
+ paymentMethodData: components["schemas"]["PaymentMethodDataDto"];
1641
+ threeDSecureAuthentication: components["schemas"]["ThreeDSecureAuthenticationDto"];
1642
+ };
1643
+ ProcessorDto: {
1644
+ /** @example ADYEN */
1645
+ name: string;
1646
+ /** @example Parenting_Leader */
1647
+ processorMerchantId: string;
1648
+ /** @example 0 */
1649
+ amountCaptured: number;
1650
+ /** @example 0 */
1651
+ amountRefunded: number;
1652
+ };
1653
+ TransactionDto: {
1654
+ /** @example 2025-09-08T21:18:47.813160 */
1655
+ date: string;
1656
+ /** @example 5359 */
1657
+ amount: number;
1658
+ /** @example EUR */
1659
+ currencyCode: string;
1660
+ /** @example SALE */
1661
+ transactionType: string;
1662
+ /** @example LRXB8Q6HZRTDVCR9 */
1663
+ processorTransactionId: string;
1664
+ /** @example ADYEN */
1665
+ processorName: string;
1666
+ /** @example Parenting_Leader */
1667
+ processorMerchantId: string;
1668
+ /** @example AUTHORIZED */
1669
+ processorStatus: string;
1670
+ /** @example 8557a01b-f88d-4154-8c50-37deab59eb71-re-25092 */
1671
+ orderId: string;
1672
+ };
1673
+ CvvCheckDto: {
1674
+ /** @example ADYEN */
1675
+ source: string;
1676
+ /** @example NOT_APPLICABLE */
1677
+ result: string;
1678
+ };
1679
+ AvsCheckResultDto: {
1680
+ /** @example NOT_APPLICABLE */
1681
+ streetAddress: string;
1682
+ /** @example NOT_APPLICABLE */
1683
+ postalCode: string;
1684
+ };
1685
+ AvsCheckDto: {
1686
+ /** @example ADYEN */
1687
+ source: string;
1688
+ result: components["schemas"]["AvsCheckResultDto"];
1689
+ };
1690
+ RiskDataDto: {
1691
+ cvvCheck: components["schemas"]["CvvCheckDto"];
1692
+ avsCheck: components["schemas"]["AvsCheckDto"];
1693
+ };
1694
+ PrimerPaymentResponseDto: {
1695
+ /** @example KYmx2y97s */
1696
+ id: string;
1697
+ /** @example 2025-09-08T21:18:47.546807 */
1698
+ date: string;
1699
+ /** @example 2025-09-08T21:18:49.821816 */
1700
+ dateUpdated: string;
1701
+ /** @example 5359 */
1702
+ amount: number;
1703
+ /** @example EUR */
1704
+ currencyCode: string;
1705
+ /** @example 8557a01b-f88d-4154-8c50-37deab59eb71 */
1706
+ customerId: string;
1707
+ /** @example {
1708
+ * "captureAt": 1757704727,
1709
+ * "email": "nadiakraevaa@gmail.com",
1710
+ * "manualCapture": true,
1711
+ * "order_id": "8557a01b-f88d-4154-8c50-37deab59eb71-re-25092",
1712
+ * "prevPsp": "adyen",
1713
+ * "sourceId": 238256,
1714
+ * "subId": 76070,
1715
+ * "trafficSplit": 5,
1716
+ * "tx": 0,
1717
+ * "txp": 0
1718
+ * } */
1719
+ metadata: Record<string, never>;
1720
+ /** @example 8557a01b-f88d-4154-8c50-37deab59eb71-re-25092 */
1721
+ orderId: string;
1722
+ /** @example AUTHORIZED */
1723
+ status: string;
1724
+ order: components["schemas"]["OrderDto"];
1725
+ customer: components["schemas"]["CustomerDto"];
1726
+ paymentMethod: components["schemas"]["PaymentMethodDto"];
1727
+ processor: components["schemas"]["ProcessorDto"];
1728
+ transactions: components["schemas"]["TransactionDto"][];
1729
+ riskData: components["schemas"]["RiskDataDto"];
1730
+ };
1731
+ PrimerPaymentPaginatedResponseDto: {
1732
+ /** @example eyJ...== */
1733
+ nextCursor: string | null;
1734
+ /** @example null */
1735
+ prevCursor: string | null;
1736
+ data: components["schemas"]["PrimerPaymentResponseDto"][];
1737
+ };
1738
+ ActionLogResponseDto: {
1739
+ /**
1740
+ * @description The ID of the action log.
1741
+ * @example 1
1742
+ */
1743
+ id: number;
1744
+ /**
1745
+ * @description The reference ID of the action log.
1746
+ * @example some-reference-id
1747
+ */
1748
+ referenceId: Record<string, never>;
1749
+ /**
1750
+ * @description The URL of the action.
1751
+ * @example /api/v1/some-action
1752
+ */
1753
+ actionUrl: string;
1754
+ /**
1755
+ * @description The body of the action.
1756
+ * @example {
1757
+ * "key": "value"
1758
+ * }
1759
+ */
1760
+ body: Record<string, never>;
1761
+ /**
1762
+ * @description The response of the action.
1763
+ * @example {
1764
+ * "success": true
1765
+ * }
1766
+ */
1767
+ response: Record<string, never>;
1768
+ /**
1769
+ * Format: date-time
1770
+ * @description The creation date of the action log.
1771
+ * @example 2021-01-01T00:00:00.000Z
1772
+ */
1773
+ createdAt: string;
1774
+ };
1775
+ PaginatedActionLogResponseDto: {
1776
+ data: components["schemas"]["ActionLogResponseDto"][];
1777
+ /** @example 100 */
1778
+ total: number;
1779
+ /** @example 1 */
1780
+ page: number;
1781
+ /** @example 10 */
1782
+ limit: number;
1783
+ /** @example 10 */
1784
+ totalPages: number;
1785
+ };
1786
+ OrderRequestResponseDto: {
1787
+ /**
1788
+ * @description The ID of the order request.
1789
+ * @example 1
1790
+ */
1791
+ id: number;
1792
+ /**
1793
+ * @description The UUID of the order request.
1794
+ * @example f47ac10b-58cc-4372-a567-0e02b2c3d479
1795
+ */
1796
+ uuid: string;
1797
+ /**
1798
+ * @description The body of the order request.
1799
+ * @example {
1800
+ * "key": "value"
1801
+ * }
1802
+ */
1803
+ body: Record<string, never>;
1804
+ /**
1805
+ * Format: date-time
1806
+ * @description The creation date of the order request.
1807
+ * @example 2021-01-01T00:00:00.000Z
1808
+ */
1809
+ created_at: string;
1810
+ };
1811
+ PaginatedOrderRequestResponseDto: {
1812
+ data: components["schemas"]["OrderRequestResponseDto"][];
1813
+ /** @example 100 */
1814
+ total: number;
1815
+ /** @example 1 */
1816
+ page: number;
1817
+ /** @example 10 */
1818
+ limit: number;
1819
+ /** @example 10 */
1820
+ totalPages: number;
1821
+ };
1822
+ RefundsLogResponseDto: {
1823
+ /**
1824
+ * @description The ID of the refund log.
1825
+ * @example 1
1826
+ */
1827
+ id: number;
1828
+ /**
1829
+ * @description The order ID of the refund log.
1830
+ * @example some-order-id
1831
+ */
1832
+ orderId: string;
1833
+ /**
1834
+ * @description The transaction ID of the refund log.
1835
+ * @example some-transaction-id
1836
+ */
1837
+ transactionId: string;
1838
+ /**
1839
+ * @description The amount of the refund.
1840
+ * @example 100
1841
+ */
1842
+ amount: number;
1843
+ /**
1844
+ * @description The currency of the refund.
1845
+ * @example USD
1846
+ */
1847
+ currency: string;
1848
+ /**
1849
+ * @description The status of the refund.
1850
+ * @example success
1851
+ */
1852
+ status: string;
1853
+ /**
1854
+ * @description The message of the refund.
1855
+ * @example Refund successful
1856
+ */
1857
+ message: string;
1858
+ /**
1859
+ * Format: date-time
1860
+ * @description The creation date of the refund log.
1861
+ * @example 2021-01-01T00:00:00.000Z
1862
+ */
1863
+ createdAt: string;
1864
+ };
1865
+ PaginatedRefundsLogResponseDto: {
1866
+ data: components["schemas"]["RefundsLogResponseDto"][];
1867
+ /** @example 100 */
1868
+ total: number;
1869
+ /** @example 1 */
1870
+ page: number;
1871
+ /** @example 10 */
1872
+ limit: number;
1873
+ /** @example 10 */
1874
+ totalPages: number;
1875
+ };
1876
+ PayerInfoDto: {
1877
+ /** @example Z5GXXXXWTTNPS */
1878
+ account_id: string;
1879
+ /** @example johdoe@example.com */
1880
+ email_address: string;
1881
+ /** @example {
1882
+ * "country_code": "1",
1883
+ * "national_number": "4089027107"
1884
+ * } */
1885
+ phone_number?: Record<string, never>;
1886
+ /** @example N */
1887
+ address_status?: string;
1888
+ /** @example Y */
1889
+ payer_status?: string;
1890
+ /** @example {
1891
+ * "given_name": "John",
1892
+ * "surname": "Doe",
1893
+ * "alternate_full_name": "John Doe"
1894
+ * } */
1895
+ payer_name?: Record<string, never>;
1896
+ /** @example US */
1897
+ country_code?: string;
1898
+ };
1899
+ TransactionRawResponseDto: {
1900
+ /** @example 9GS00022P28620007 */
1901
+ transaction_id?: string;
1902
+ /** @example COMPLETED */
1903
+ transaction_status?: string;
1904
+ /** @example {
1905
+ * "value": "50.00",
1906
+ * "currency_code": "USD"
1907
+ * } */
1908
+ transaction_amount?: Record<string, never>;
1909
+ payer_info: components["schemas"]["PayerInfoDto"];
1910
+ };
1911
+ PaypalTransactionResponseDto: {
1912
+ /** @example 2 */
1913
+ id: number;
1914
+ /** @example 90A000009K706721B */
1915
+ transactionId: string;
1916
+ /** @example Z5G000XWTTNPS */
1917
+ accountNumber: string;
1918
+ rawResponse: components["schemas"]["TransactionRawResponseDto"];
1919
+ /** @example 2025-09-18T10:15:08.153Z */
1920
+ createdAt: string;
1921
+ };
1922
+ PaginatedTransactionResponseDto: {
1923
+ data: components["schemas"]["PaypalTransactionResponseDto"][];
1924
+ /** @example 100 */
1925
+ total: number;
1926
+ /** @example 1 */
1927
+ page: number;
1928
+ /** @example 10 */
1929
+ limit: number;
1930
+ /** @example 10 */
1931
+ totalPages: number;
1932
+ };
1933
+ PaypalFetchTransactionsDto: {
1934
+ /**
1935
+ * @description Start date (ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ)
1936
+ * @example 2025-08-01T00:00:00Z
1937
+ */
1938
+ startDate: string;
1939
+ /**
1940
+ * @description End date (ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ)
1941
+ * @example 2025-08-02T23:59:59Z
1942
+ */
1943
+ endDate: string;
1944
+ /**
1945
+ * @description Optional transaction ID to filter by
1946
+ * @example 9GS80322P28628837
1947
+ */
1948
+ transactionId?: string;
1949
+ /**
1950
+ * @description Indicates whether the response includes only balance-impacting transactions or all transactions
1951
+ * @enum {string}
1952
+ */
1953
+ balanceAffectingRecordsOnly?: "Y" | "N";
1954
+ };
1955
+ PaypalFetchTransactionsResponseDto: {
1956
+ /** @example success */
1957
+ status: string;
1958
+ /** @example Transactions fetched and stored successfully! */
1959
+ message: string;
1960
+ data: components["schemas"]["PaypalTransactionResponseDto"][] | null;
1961
+ };
1962
+ PaypalCrmPaymentResponseDto: {
1963
+ status: string;
1964
+ sourceId: string;
1965
+ processorId: string;
1966
+ date: string;
1967
+ customer: string;
1968
+ total: number;
1969
+ currency: string;
1970
+ fee: number;
1971
+ sourceType: string;
1972
+ orderId: string;
1973
+ relations: string[];
1974
+ };
1975
+ SessionsFindSessionByEmailDto: {
1976
+ /**
1977
+ * @description The unique identifier of the session.
1978
+ * @example 1
1979
+ */
1980
+ id: number;
1981
+ /**
1982
+ * @description The UUID of the session.
1983
+ * @example a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6
1984
+ */
1985
+ uuid: string;
1986
+ /**
1987
+ * @description The cookies associated with the session.
1988
+ * @example {
1989
+ * "key": "value"
1990
+ * }
1991
+ */
1992
+ cookies: Record<string, never>;
1993
+ /**
1994
+ * @description The email associated with the session.
1995
+ * @example test@example.com
1996
+ */
1997
+ email: string;
1998
+ /**
1999
+ * @description Indicates if the session resulted in a purchase.
2000
+ * @example true
2001
+ */
2002
+ isPurchased: boolean;
2003
+ /**
2004
+ * @description Extra data associated with the session.
2005
+ * @example {
2006
+ * "data": "extra"
2007
+ * }
2008
+ */
2009
+ extraData: Record<string, never>;
2010
+ };
2011
+ UpdateResult: Record<string, never>;
2012
+ FacebookCapiEventDataDto: {
2013
+ /** @example USD */
2014
+ currency?: string;
2015
+ /** @example 129.99 */
2016
+ total?: number;
2017
+ /** @example https://example.com/product/123 */
2018
+ sourceUrl: string;
2019
+ };
2020
+ CustomClientData: {
2021
+ /**
2022
+ * @description The user's email address.
2023
+ * @example joe@example.com
2024
+ */
2025
+ email?: string;
2026
+ /**
2027
+ * @description The user's IP address.
2028
+ * @example 123.123.123.123
2029
+ */
2030
+ ip?: string;
2031
+ /**
2032
+ * @description The user's browser user agent string.
2033
+ * @example Mozilla/5.0 (Windows NT 10.0; Win64; x64) ...
2034
+ */
2035
+ userAgent?: string;
2036
+ /**
2037
+ * @description The Facebook click ID.
2038
+ * @example fb.1.1554763741205.AbCdEfGhIjKlMnOp
2039
+ */
2040
+ fbc?: string;
2041
+ /**
2042
+ * @description The Facebook browser ID.
2043
+ * @example fb.1.1558571054389.1098115397
2044
+ */
2045
+ fbp?: string;
2046
+ /**
2047
+ * @description The user country.
2048
+ * @example US
2049
+ */
2050
+ country?: string;
2051
+ /**
2052
+ * @description The user state.
2053
+ * @example DE
2054
+ */
2055
+ state?: string;
2056
+ /**
2057
+ * @description The user city.
2058
+ * @example Berlin
2059
+ */
2060
+ city?: string;
2061
+ /**
2062
+ * @description The user zip code.
2063
+ * @example 19901
2064
+ */
2065
+ zip?: string;
2066
+ /**
2067
+ * @description The user phone number.
2068
+ * @example +123123231
2069
+ */
2070
+ phone?: string;
2071
+ };
2072
+ FbCapiPayloadBridge: {
2073
+ /** @example EVENT_ID_123 */
2074
+ eventId: string;
2075
+ /** @example Purchase */
2076
+ eventName: string;
2077
+ eventData: components["schemas"]["FacebookCapiEventDataDto"];
2078
+ testEventCode?: string;
2079
+ clientData?: components["schemas"]["CustomClientData"];
2080
+ };
2081
+ FbCapiPayloadSessionBridge: {
2082
+ uuid: string;
2083
+ event: components["schemas"]["FbCapiPayloadBridge"];
2084
+ };
2085
+ FbCapiCreatePixelBridgeDto: {
2086
+ /** @description Title (just for UI purposes) */
2087
+ title: string;
2088
+ /** @description Facebook Pixel ID */
2089
+ pixel: string;
2090
+ /** @description Facebook Pixel Token */
2091
+ token: string;
2092
+ /** @description Active */
2093
+ active: boolean;
2094
+ };
2095
+ FbCapiPixelResponseBridgeDto: {
2096
+ /** @description Unique Record ID */
2097
+ id: number;
2098
+ /** @description Title (just for UI purposes) */
2099
+ title: string;
2100
+ /** @description Facebook Pixel ID */
2101
+ pixel: string;
2102
+ /** @description Facebook Pixel Token */
2103
+ token: string;
2104
+ /** @description Active */
2105
+ active: boolean;
2106
+ };
2107
+ FbCapiUpdatePixelBridgeDto: {
2108
+ /** @description Title (just for UI purposes) */
2109
+ title?: string;
2110
+ /** @description Facebook Pixel ID */
2111
+ pixel?: string;
2112
+ /** @description Facebook Pixel Token */
2113
+ token?: string;
2114
+ /** @description Active */
2115
+ active?: boolean;
2116
+ };
2117
+ FbCapiEventResponseDto: {
2118
+ /** @description Unique Record ID */
2119
+ id: number;
2120
+ /**
2121
+ * Format: date-time
2122
+ * @description Created At
2123
+ */
2124
+ createdAt: string;
2125
+ /** @description Pixel ID */
2126
+ pixel: number;
2127
+ /** @description Event name */
2128
+ event: string;
2129
+ /** @description Request data */
2130
+ request: {
2131
+ [key: string]: unknown;
2132
+ };
2133
+ /** @description Response data */
2134
+ response: {
2135
+ [key: string]: unknown;
2136
+ };
2137
+ };
2138
+ FbCapiEventFullResponseDto: {
2139
+ /** @description The list events */
2140
+ data: components["schemas"]["FbCapiEventResponseDto"][];
2141
+ /**
2142
+ * @description The total number of order items
2143
+ * @example 25
2144
+ */
2145
+ total: number;
2146
+ /**
2147
+ * @description The current page number
2148
+ * @example 1
2149
+ */
2150
+ page: number;
2151
+ /**
2152
+ * @description The number of order items per page
2153
+ * @example 10
2154
+ */
2155
+ limit: number;
2156
+ /**
2157
+ * @description The total number of pages available
2158
+ * @example 3
2159
+ */
2160
+ totalPages: number;
2161
+ };
2162
+ TiktokCapiEventDataDto: {
2163
+ value: number;
2164
+ sku: string;
2165
+ /** @example USD */
2166
+ currency: string;
2167
+ /**
2168
+ * @description Content type
2169
+ * @example product
2170
+ */
2171
+ contentType: string;
2172
+ /** @example https://example.com/product/123 */
2173
+ sourceUrl: string;
2174
+ };
2175
+ TiktokCapiPayloadBridge: {
2176
+ /** @example EVENT_ID_123 */
2177
+ eventId: string;
2178
+ /** @example Purchase */
2179
+ eventName: string;
2180
+ eventData: components["schemas"]["TiktokCapiEventDataDto"];
2181
+ testEventCode?: string;
2182
+ clientData?: components["schemas"]["CustomClientData"];
2183
+ };
2184
+ TiktokCapiPayloadSessionBridge: {
2185
+ uuid: string;
2186
+ event: components["schemas"]["TiktokCapiPayloadBridge"];
2187
+ };
2188
+ ReportItemDto: {
2189
+ /**
2190
+ * @description Unique identifier for the report item
2191
+ * @example 1
2192
+ */
2193
+ id: number;
2194
+ /**
2195
+ * @description Unique order identifier
2196
+ * @example ORD-001
2197
+ */
2198
+ orderId: string;
2199
+ /**
2200
+ * @description Country where the order was placed
2201
+ * @example US
2202
+ */
2203
+ country: string;
2204
+ /**
2205
+ * @description Customer gender
2206
+ * @example male
2207
+ */
2208
+ gender: string;
2209
+ /**
2210
+ * @description Customer email
2211
+ * @example xxx@example.com
2212
+ */
2213
+ email: string;
2214
+ /**
2215
+ * @description Customer language
2216
+ * @example en
2217
+ */
2218
+ language: string;
2219
+ /**
2220
+ * @description URL-friendly identifier for the order
2221
+ * @example order-001
2222
+ */
2223
+ slug: string;
2224
+ /**
2225
+ * @description Source/origin of the order
2226
+ * @example http://example.com/
2227
+ */
2228
+ origin: string;
2229
+ };
2230
+ TrustpilotServiceReviewInvitationDto: {
2231
+ /** @example 507f191e810c19729de860ea */
2232
+ templateId: string;
2233
+ /**
2234
+ * @description Preferred send time in UTC (ISO 8601)
2235
+ * @example 2026-01-05T13:37:00Z
2236
+ */
2237
+ preferredSendTime?: string;
2238
+ /** @example http://trustpilot.com */
2239
+ redirectUri: string;
2240
+ /** @example [
2241
+ * "tag1",
2242
+ * "tag2"
2243
+ * ] */
2244
+ tags?: string[];
2245
+ };
2246
+ TrustpilotProductDto: {
2247
+ /** @example ABC-1234 */
2248
+ sku: string;
2249
+ /** @example Metal Toy Car */
2250
+ name: string;
2251
+ /** @example 7TX1641 */
2252
+ mpn: string;
2253
+ /** @example ACME */
2254
+ brand: string;
2255
+ /** @example http://www.mycompanystore.com/products/images/12345.jpg */
2256
+ imageUrl: string;
2257
+ /** @example http://www.mycompanystore.com/products/12345.htm */
2258
+ productUrl: string;
2259
+ /** @example 01234567890 */
2260
+ gtin: string;
2261
+ /** @example 1267 */
2262
+ productCategoryGoogleId: string;
2263
+ };
2264
+ TrustpilotProductReviewInvitationDto: {
2265
+ /** @example 507f191e810c19729de860ea */
2266
+ templateId: string;
2267
+ /** @example 2026-01-05T13:37:00Z */
2268
+ preferredSendTime?: string;
2269
+ /** @example http://trustpilot.com */
2270
+ redirectUri: string;
2271
+ products?: components["schemas"]["TrustpilotProductDto"][];
2272
+ };
2273
+ SendTrustpilotInvitationDto: {
2274
+ /** @example john.doe@trustpilot.com */
2275
+ replyTo?: string;
2276
+ /** @example en-US */
2277
+ locale?: string;
2278
+ /** @example John Doe */
2279
+ senderName?: string;
2280
+ /** @example john.doe@trustpilot.com */
2281
+ senderEmail?: string;
2282
+ /** @example ABC123 */
2283
+ locationId?: string;
2284
+ /** @example inv00001 */
2285
+ referenceNumber: string;
2286
+ /** @example John Doe */
2287
+ consumerName: string;
2288
+ /** @example john.doe@trustpilot.com */
2289
+ consumerEmail: string;
2290
+ /** @example email */
2291
+ type: string;
2292
+ serviceReviewInvitation?: components["schemas"]["TrustpilotServiceReviewInvitationDto"];
2293
+ productReviewInvitation?: components["schemas"]["TrustpilotProductReviewInvitationDto"];
2294
+ };
2295
+ SendTrustpilotInvitationResponseDto: {
2296
+ /** @example 200 */
2297
+ statusCode: number;
2298
+ /** @example Email invitation created successfully */
2299
+ message: string;
2300
+ };
2301
+ CreateTrustpilotInvitationLinkDto: {
2302
+ /** @description Optional Trustpilot location ID */
2303
+ locationId?: string;
2304
+ /** @example inv00001 */
2305
+ referenceId: string;
2306
+ /** @example john.doe@trustpilot.com */
2307
+ email: string;
2308
+ /** @example John Doe */
2309
+ name: string;
2310
+ /** @example en-US */
2311
+ locale: string;
2312
+ /** @example [
2313
+ * "tag1",
2314
+ * "tag2"
2315
+ * ] */
2316
+ tags?: string[];
2317
+ /** @example https://trustpilot.com */
2318
+ redirectUri: string;
2319
+ };
2320
+ CreateTrustpilotInvitationLinkResponseDto: {
2321
+ /** @description Invitation link id */
2322
+ id: string;
2323
+ /** @description Invitation link url */
2324
+ url: string;
2325
+ };
2326
+ TrustpilotTemplatesResponseDto: {
2327
+ id: string;
2328
+ name: string;
2329
+ isDefaultTemplate: boolean;
2330
+ locale?: string;
2331
+ language?: string;
2332
+ type: string;
2333
+ };
2334
+ TrustpilotInviteResponseDto: {
2335
+ /** @example 1 */
2336
+ id: number;
2337
+ /** @example ext-456 */
2338
+ externalId: string | null;
2339
+ /** @example customer@example.com */
2340
+ email: string;
2341
+ /** @example John Doe */
2342
+ name: string | null;
2343
+ /**
2344
+ * Format: date-time
2345
+ * @example 2025-09-09T10:00:00.000Z
2346
+ */
2347
+ scheduledAt: string;
2348
+ /**
2349
+ * Format: date-time
2350
+ * @example 2025-09-09T09:00:00.000Z
2351
+ */
2352
+ initialScheduledAt: string;
2353
+ /**
2354
+ * @example pending
2355
+ * @enum {string}
2356
+ */
2357
+ status: "pending" | "retry" | "sent" | "failed" | "cancelled";
2358
+ /** @example false */
2359
+ sent: boolean;
2360
+ /** @example 0 */
2361
+ attempts: number;
2362
+ /**
2363
+ * Format: date-time
2364
+ * @example 2025-09-08T12:00:00.000Z
2365
+ */
2366
+ lastAttemptAt: string | null;
2367
+ /** @example SMTP error: 550 rejected */
2368
+ lastError: string | null;
2369
+ /** @example batch-uuid-789 */
2370
+ batchId: string | null;
2371
+ /** @example 507f191e810c19729de860ea */
2372
+ templateId: string | null;
2373
+ /**
2374
+ * Format: date-time
2375
+ * @example 2025-09-08T08:00:00.000Z
2376
+ */
2377
+ createdAt: string;
2378
+ /**
2379
+ * Format: date-time
2380
+ * @example 2025-09-08T09:00:00.000Z
2381
+ */
2382
+ updatedAt: string;
2383
+ };
2384
+ PaginatedResponseDtoWithModel: {
2385
+ data: components["schemas"]["TrustpilotInviteResponseDto"][];
2386
+ /** @example 100 */
2387
+ total: number;
2388
+ /** @example 1 */
2389
+ page: number;
2390
+ /** @example 10 */
2391
+ limit: number;
2392
+ /** @example 10 */
2393
+ totalPages: number;
2394
+ };
2395
+ };
2396
+ responses: never;
2397
+ parameters: never;
2398
+ requestBodies: never;
2399
+ headers: never;
2400
+ pathItems: never;
2401
+ }
2402
+
4
2403
  type SdkRemoteFunnel = {
5
2404
  checkout: string;
6
2405
  landing: string;
@@ -31,6 +2430,9 @@ declare const server: {
31
2430
  searchParams?: next_navigation.ReadonlyURLSearchParams;
32
2431
  }) => Promise<SdkRemoteFunnel>;
33
2432
  };
2433
+ session: {
2434
+ get: (uuid: string) => Promise<components["schemas"]["SessionResponseDto"]>;
2435
+ };
34
2436
  };
35
2437
 
36
2438
  export { type SdkRemoteFunnel, server };