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