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