@vrplatform/api 1.3.1-stage.3991 → 1.3.1-stage.3993
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.
|
@@ -573,6 +573,23 @@ export interface paths {
|
|
|
573
573
|
patch?: never;
|
|
574
574
|
trace?: never;
|
|
575
575
|
};
|
|
576
|
+
"/connections/connect": {
|
|
577
|
+
parameters: {
|
|
578
|
+
query?: never;
|
|
579
|
+
header?: never;
|
|
580
|
+
path?: never;
|
|
581
|
+
cookie?: never;
|
|
582
|
+
};
|
|
583
|
+
get?: never;
|
|
584
|
+
put?: never;
|
|
585
|
+
/** @description Connect or reconnect an app and create the connection. */
|
|
586
|
+
post: operations["connectAppConnection"];
|
|
587
|
+
delete?: never;
|
|
588
|
+
options?: never;
|
|
589
|
+
head?: never;
|
|
590
|
+
patch?: never;
|
|
591
|
+
trace?: never;
|
|
592
|
+
};
|
|
576
593
|
"/connections/extract": {
|
|
577
594
|
parameters: {
|
|
578
595
|
query?: never;
|
|
@@ -673,7 +690,8 @@ export interface paths {
|
|
|
673
690
|
delete: operations["deleteConnection"];
|
|
674
691
|
options?: never;
|
|
675
692
|
head?: never;
|
|
676
|
-
|
|
693
|
+
/** @description Update connection settings. */
|
|
694
|
+
patch: operations["updateConnection"];
|
|
677
695
|
trace?: never;
|
|
678
696
|
};
|
|
679
697
|
"/connections/{id}/sync": {
|
|
@@ -11358,6 +11376,194 @@ export interface operations {
|
|
|
11358
11376
|
};
|
|
11359
11377
|
};
|
|
11360
11378
|
};
|
|
11379
|
+
connectAppConnection: {
|
|
11380
|
+
parameters: {
|
|
11381
|
+
query?: never;
|
|
11382
|
+
header?: never;
|
|
11383
|
+
path?: never;
|
|
11384
|
+
cookie?: never;
|
|
11385
|
+
};
|
|
11386
|
+
requestBody?: {
|
|
11387
|
+
content: {
|
|
11388
|
+
"application/json": {
|
|
11389
|
+
appId?: string;
|
|
11390
|
+
/** Format: uuid */
|
|
11391
|
+
connectionId?: string;
|
|
11392
|
+
name?: string;
|
|
11393
|
+
/** @default true */
|
|
11394
|
+
autoExtract?: boolean;
|
|
11395
|
+
sessionKey?: string;
|
|
11396
|
+
/** @default {} */
|
|
11397
|
+
params?: {
|
|
11398
|
+
[key: string]: unknown;
|
|
11399
|
+
};
|
|
11400
|
+
};
|
|
11401
|
+
};
|
|
11402
|
+
};
|
|
11403
|
+
responses: {
|
|
11404
|
+
/** @description Successful response */
|
|
11405
|
+
200: {
|
|
11406
|
+
headers: {
|
|
11407
|
+
[name: string]: unknown;
|
|
11408
|
+
};
|
|
11409
|
+
content: {
|
|
11410
|
+
"application/json": {
|
|
11411
|
+
/** @enum {string} */
|
|
11412
|
+
type: "success" | "issue" | "error";
|
|
11413
|
+
/** Format: uuid */
|
|
11414
|
+
id?: string;
|
|
11415
|
+
connection?: {
|
|
11416
|
+
/** Format: uuid */
|
|
11417
|
+
id: string;
|
|
11418
|
+
name: string;
|
|
11419
|
+
/** @enum {string} */
|
|
11420
|
+
status: "active" | "inactive";
|
|
11421
|
+
accountingStartAt?: string | null;
|
|
11422
|
+
accountingEndAt?: string | null;
|
|
11423
|
+
uniqueRef?: string | null;
|
|
11424
|
+
app: {
|
|
11425
|
+
id: string;
|
|
11426
|
+
/** @enum {string} */
|
|
11427
|
+
type: "paymentGateway" | "accountingPlatform" | "propertyManagementSystem" | "bookingChannel" | "service";
|
|
11428
|
+
name: string;
|
|
11429
|
+
icon?: string | null;
|
|
11430
|
+
importers?: string[] | null;
|
|
11431
|
+
extractors?: string[] | null;
|
|
11432
|
+
};
|
|
11433
|
+
/**
|
|
11434
|
+
* Format: date-time
|
|
11435
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11436
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11437
|
+
*/
|
|
11438
|
+
createdAt: string;
|
|
11439
|
+
/**
|
|
11440
|
+
* Format: date-time
|
|
11441
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11442
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11443
|
+
*/
|
|
11444
|
+
updatedAt: string;
|
|
11445
|
+
isErrorState: boolean;
|
|
11446
|
+
currentSync?: {
|
|
11447
|
+
/** @enum {string} */
|
|
11448
|
+
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
11449
|
+
/**
|
|
11450
|
+
* Format: date-time
|
|
11451
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11452
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11453
|
+
*/
|
|
11454
|
+
createdAt: string;
|
|
11455
|
+
/**
|
|
11456
|
+
* Format: date-time
|
|
11457
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
11458
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
11459
|
+
*/
|
|
11460
|
+
updatedAt: string;
|
|
11461
|
+
message?: string | null;
|
|
11462
|
+
} | null;
|
|
11463
|
+
enabledFlows: {
|
|
11464
|
+
/** Format: uuid */
|
|
11465
|
+
id: string;
|
|
11466
|
+
title: string;
|
|
11467
|
+
isPublic: boolean;
|
|
11468
|
+
type: ("push" | "pull") | null;
|
|
11469
|
+
}[];
|
|
11470
|
+
};
|
|
11471
|
+
code?: string;
|
|
11472
|
+
message?: string;
|
|
11473
|
+
state?: {
|
|
11474
|
+
sessionKey?: string;
|
|
11475
|
+
expiresIn: number;
|
|
11476
|
+
};
|
|
11477
|
+
action?: {
|
|
11478
|
+
/** @enum {string} */
|
|
11479
|
+
type: "extension" | "form" | "link" | "oauth";
|
|
11480
|
+
value?: unknown;
|
|
11481
|
+
};
|
|
11482
|
+
};
|
|
11483
|
+
};
|
|
11484
|
+
};
|
|
11485
|
+
/** @description Bad request */
|
|
11486
|
+
400: {
|
|
11487
|
+
headers: {
|
|
11488
|
+
[name: string]: unknown;
|
|
11489
|
+
};
|
|
11490
|
+
content: {
|
|
11491
|
+
"application/json": {
|
|
11492
|
+
code: string;
|
|
11493
|
+
message: string;
|
|
11494
|
+
issues?: {
|
|
11495
|
+
message: string;
|
|
11496
|
+
}[];
|
|
11497
|
+
context?: unknown;
|
|
11498
|
+
};
|
|
11499
|
+
};
|
|
11500
|
+
};
|
|
11501
|
+
/** @description Unauthorized */
|
|
11502
|
+
401: {
|
|
11503
|
+
headers: {
|
|
11504
|
+
[name: string]: unknown;
|
|
11505
|
+
};
|
|
11506
|
+
content: {
|
|
11507
|
+
"application/json": {
|
|
11508
|
+
code: string;
|
|
11509
|
+
message: string;
|
|
11510
|
+
issues?: {
|
|
11511
|
+
message: string;
|
|
11512
|
+
}[];
|
|
11513
|
+
context?: unknown;
|
|
11514
|
+
};
|
|
11515
|
+
};
|
|
11516
|
+
};
|
|
11517
|
+
/** @description Forbidden */
|
|
11518
|
+
403: {
|
|
11519
|
+
headers: {
|
|
11520
|
+
[name: string]: unknown;
|
|
11521
|
+
};
|
|
11522
|
+
content: {
|
|
11523
|
+
"application/json": {
|
|
11524
|
+
code: string;
|
|
11525
|
+
message: string;
|
|
11526
|
+
issues?: {
|
|
11527
|
+
message: string;
|
|
11528
|
+
}[];
|
|
11529
|
+
context?: unknown;
|
|
11530
|
+
};
|
|
11531
|
+
};
|
|
11532
|
+
};
|
|
11533
|
+
/** @description Not found */
|
|
11534
|
+
404: {
|
|
11535
|
+
headers: {
|
|
11536
|
+
[name: string]: unknown;
|
|
11537
|
+
};
|
|
11538
|
+
content: {
|
|
11539
|
+
"application/json": {
|
|
11540
|
+
code: string;
|
|
11541
|
+
message: string;
|
|
11542
|
+
issues?: {
|
|
11543
|
+
message: string;
|
|
11544
|
+
}[];
|
|
11545
|
+
context?: unknown;
|
|
11546
|
+
};
|
|
11547
|
+
};
|
|
11548
|
+
};
|
|
11549
|
+
/** @description Internal server error */
|
|
11550
|
+
500: {
|
|
11551
|
+
headers: {
|
|
11552
|
+
[name: string]: unknown;
|
|
11553
|
+
};
|
|
11554
|
+
content: {
|
|
11555
|
+
"application/json": {
|
|
11556
|
+
code: string;
|
|
11557
|
+
message: string;
|
|
11558
|
+
issues?: {
|
|
11559
|
+
message: string;
|
|
11560
|
+
}[];
|
|
11561
|
+
context?: unknown;
|
|
11562
|
+
};
|
|
11563
|
+
};
|
|
11564
|
+
};
|
|
11565
|
+
};
|
|
11566
|
+
};
|
|
11361
11567
|
extractConnections: {
|
|
11362
11568
|
parameters: {
|
|
11363
11569
|
query?: never;
|
|
@@ -12320,6 +12526,173 @@ export interface operations {
|
|
|
12320
12526
|
};
|
|
12321
12527
|
};
|
|
12322
12528
|
};
|
|
12529
|
+
updateConnection: {
|
|
12530
|
+
parameters: {
|
|
12531
|
+
query?: never;
|
|
12532
|
+
header?: never;
|
|
12533
|
+
path: {
|
|
12534
|
+
id: string;
|
|
12535
|
+
};
|
|
12536
|
+
cookie?: never;
|
|
12537
|
+
};
|
|
12538
|
+
requestBody?: {
|
|
12539
|
+
content: {
|
|
12540
|
+
"application/json": {
|
|
12541
|
+
name?: string;
|
|
12542
|
+
/** @enum {string} */
|
|
12543
|
+
status?: "active" | "inactive";
|
|
12544
|
+
accountingStartAt?: string | null;
|
|
12545
|
+
accountingEndAt?: string | null;
|
|
12546
|
+
};
|
|
12547
|
+
};
|
|
12548
|
+
};
|
|
12549
|
+
responses: {
|
|
12550
|
+
/** @description Successful response */
|
|
12551
|
+
200: {
|
|
12552
|
+
headers: {
|
|
12553
|
+
[name: string]: unknown;
|
|
12554
|
+
};
|
|
12555
|
+
content: {
|
|
12556
|
+
"application/json": {
|
|
12557
|
+
/** Format: uuid */
|
|
12558
|
+
id: string;
|
|
12559
|
+
name: string;
|
|
12560
|
+
/** @enum {string} */
|
|
12561
|
+
status: "active" | "inactive";
|
|
12562
|
+
accountingStartAt?: string | null;
|
|
12563
|
+
accountingEndAt?: string | null;
|
|
12564
|
+
uniqueRef?: string | null;
|
|
12565
|
+
app: {
|
|
12566
|
+
id: string;
|
|
12567
|
+
/** @enum {string} */
|
|
12568
|
+
type: "paymentGateway" | "accountingPlatform" | "propertyManagementSystem" | "bookingChannel" | "service";
|
|
12569
|
+
name: string;
|
|
12570
|
+
icon?: string | null;
|
|
12571
|
+
importers?: string[] | null;
|
|
12572
|
+
extractors?: string[] | null;
|
|
12573
|
+
};
|
|
12574
|
+
/**
|
|
12575
|
+
* Format: date-time
|
|
12576
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
12577
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
12578
|
+
*/
|
|
12579
|
+
createdAt: string;
|
|
12580
|
+
/**
|
|
12581
|
+
* Format: date-time
|
|
12582
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
12583
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
12584
|
+
*/
|
|
12585
|
+
updatedAt: string;
|
|
12586
|
+
isErrorState: boolean;
|
|
12587
|
+
currentSync?: {
|
|
12588
|
+
/** @enum {string} */
|
|
12589
|
+
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
12590
|
+
/**
|
|
12591
|
+
* Format: date-time
|
|
12592
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
12593
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
12594
|
+
*/
|
|
12595
|
+
createdAt: string;
|
|
12596
|
+
/**
|
|
12597
|
+
* Format: date-time
|
|
12598
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
12599
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
12600
|
+
*/
|
|
12601
|
+
updatedAt: string;
|
|
12602
|
+
message?: string | null;
|
|
12603
|
+
} | null;
|
|
12604
|
+
enabledFlows: {
|
|
12605
|
+
/** Format: uuid */
|
|
12606
|
+
id: string;
|
|
12607
|
+
title: string;
|
|
12608
|
+
isPublic: boolean;
|
|
12609
|
+
type: ("push" | "pull") | null;
|
|
12610
|
+
}[];
|
|
12611
|
+
};
|
|
12612
|
+
};
|
|
12613
|
+
};
|
|
12614
|
+
/** @description Bad request */
|
|
12615
|
+
400: {
|
|
12616
|
+
headers: {
|
|
12617
|
+
[name: string]: unknown;
|
|
12618
|
+
};
|
|
12619
|
+
content: {
|
|
12620
|
+
"application/json": {
|
|
12621
|
+
code: string;
|
|
12622
|
+
message: string;
|
|
12623
|
+
issues?: {
|
|
12624
|
+
message: string;
|
|
12625
|
+
}[];
|
|
12626
|
+
context?: unknown;
|
|
12627
|
+
};
|
|
12628
|
+
};
|
|
12629
|
+
};
|
|
12630
|
+
/** @description Unauthorized */
|
|
12631
|
+
401: {
|
|
12632
|
+
headers: {
|
|
12633
|
+
[name: string]: unknown;
|
|
12634
|
+
};
|
|
12635
|
+
content: {
|
|
12636
|
+
"application/json": {
|
|
12637
|
+
code: string;
|
|
12638
|
+
message: string;
|
|
12639
|
+
issues?: {
|
|
12640
|
+
message: string;
|
|
12641
|
+
}[];
|
|
12642
|
+
context?: unknown;
|
|
12643
|
+
};
|
|
12644
|
+
};
|
|
12645
|
+
};
|
|
12646
|
+
/** @description Forbidden */
|
|
12647
|
+
403: {
|
|
12648
|
+
headers: {
|
|
12649
|
+
[name: string]: unknown;
|
|
12650
|
+
};
|
|
12651
|
+
content: {
|
|
12652
|
+
"application/json": {
|
|
12653
|
+
code: string;
|
|
12654
|
+
message: string;
|
|
12655
|
+
issues?: {
|
|
12656
|
+
message: string;
|
|
12657
|
+
}[];
|
|
12658
|
+
context?: unknown;
|
|
12659
|
+
};
|
|
12660
|
+
};
|
|
12661
|
+
};
|
|
12662
|
+
/** @description Not found */
|
|
12663
|
+
404: {
|
|
12664
|
+
headers: {
|
|
12665
|
+
[name: string]: unknown;
|
|
12666
|
+
};
|
|
12667
|
+
content: {
|
|
12668
|
+
"application/json": {
|
|
12669
|
+
code: string;
|
|
12670
|
+
message: string;
|
|
12671
|
+
issues?: {
|
|
12672
|
+
message: string;
|
|
12673
|
+
}[];
|
|
12674
|
+
context?: unknown;
|
|
12675
|
+
};
|
|
12676
|
+
};
|
|
12677
|
+
};
|
|
12678
|
+
/** @description Internal server error */
|
|
12679
|
+
500: {
|
|
12680
|
+
headers: {
|
|
12681
|
+
[name: string]: unknown;
|
|
12682
|
+
};
|
|
12683
|
+
content: {
|
|
12684
|
+
"application/json": {
|
|
12685
|
+
code: string;
|
|
12686
|
+
message: string;
|
|
12687
|
+
issues?: {
|
|
12688
|
+
message: string;
|
|
12689
|
+
}[];
|
|
12690
|
+
context?: unknown;
|
|
12691
|
+
};
|
|
12692
|
+
};
|
|
12693
|
+
};
|
|
12694
|
+
};
|
|
12695
|
+
};
|
|
12323
12696
|
syncConnection: {
|
|
12324
12697
|
parameters: {
|
|
12325
12698
|
query?: never;
|