@vrplatform/api 1.3.1-stage.4711 → 1.3.1-stage.4717
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
package/src/generated/v1.ts
CHANGED
|
@@ -2628,6 +2628,27 @@ export interface paths {
|
|
|
2628
2628
|
patch?: never;
|
|
2629
2629
|
trace?: never;
|
|
2630
2630
|
};
|
|
2631
|
+
"/partner/connections": {
|
|
2632
|
+
parameters: {
|
|
2633
|
+
query?: never;
|
|
2634
|
+
header?: never;
|
|
2635
|
+
path?: never;
|
|
2636
|
+
cookie?: never;
|
|
2637
|
+
};
|
|
2638
|
+
/**
|
|
2639
|
+
* @description List managed teams in one regional partition of the partner portfolio with active connections and current sync state. Supports team and company search, lifecycle, app, and connection error-state filters, pagination, and team ordering. Select the partition with x-data-region.
|
|
2640
|
+
*
|
|
2641
|
+
* Required scope: teams:read
|
|
2642
|
+
*/
|
|
2643
|
+
get: operations["getPartnerConnections"];
|
|
2644
|
+
put?: never;
|
|
2645
|
+
post?: never;
|
|
2646
|
+
delete?: never;
|
|
2647
|
+
options?: never;
|
|
2648
|
+
head?: never;
|
|
2649
|
+
patch?: never;
|
|
2650
|
+
trace?: never;
|
|
2651
|
+
};
|
|
2631
2652
|
"/partner/embed-sessions": {
|
|
2632
2653
|
parameters: {
|
|
2633
2654
|
query?: never;
|
|
@@ -4466,7 +4487,7 @@ export interface paths {
|
|
|
4466
4487
|
cookie?: never;
|
|
4467
4488
|
};
|
|
4468
4489
|
/**
|
|
4469
|
-
* @description Get the current team (singleton: the team in scope via the x-team-id header). Cross-team access uses the plural /teams collection.
|
|
4490
|
+
* @description Get the current team and its dashboard aggregates (singleton: the team in scope via the x-team-id header). Cross-team access uses the plural /teams collection.
|
|
4470
4491
|
*
|
|
4471
4492
|
* Required scope: teams:read
|
|
4472
4493
|
*/
|
|
@@ -4660,7 +4681,7 @@ export interface paths {
|
|
|
4660
4681
|
cookie?: never;
|
|
4661
4682
|
};
|
|
4662
4683
|
/**
|
|
4663
|
-
* @description List accessible teams in one regional data partition. Partner callers can select the partition with x-data-region.
|
|
4684
|
+
* @description List and filter accessible teams in one regional data partition. Billability is always present; includeAggregates opt-in adds partner-dashboard counts. Partner callers can select the partition with x-data-region.
|
|
4664
4685
|
*
|
|
4665
4686
|
* Required scope: teams:read
|
|
4666
4687
|
*/
|
|
@@ -31420,6 +31441,14 @@ export interface operations {
|
|
|
31420
31441
|
/** @enum {string} */
|
|
31421
31442
|
status: "all" | "disabled" | "partially";
|
|
31422
31443
|
}[];
|
|
31444
|
+
isBillable: boolean;
|
|
31445
|
+
aggregates: {
|
|
31446
|
+
activeListings: number;
|
|
31447
|
+
members: number;
|
|
31448
|
+
activeConnections: number;
|
|
31449
|
+
connectionIssues: number;
|
|
31450
|
+
childTeams: number;
|
|
31451
|
+
};
|
|
31423
31452
|
};
|
|
31424
31453
|
};
|
|
31425
31454
|
};
|
|
@@ -31746,6 +31775,14 @@ export interface operations {
|
|
|
31746
31775
|
/** @enum {string} */
|
|
31747
31776
|
status: "all" | "disabled" | "partially";
|
|
31748
31777
|
}[];
|
|
31778
|
+
isBillable: boolean;
|
|
31779
|
+
aggregates: {
|
|
31780
|
+
activeListings: number;
|
|
31781
|
+
members: number;
|
|
31782
|
+
activeConnections: number;
|
|
31783
|
+
connectionIssues: number;
|
|
31784
|
+
childTeams: number;
|
|
31785
|
+
};
|
|
31749
31786
|
};
|
|
31750
31787
|
};
|
|
31751
31788
|
};
|
|
@@ -42488,6 +42525,231 @@ export interface operations {
|
|
|
42488
42525
|
};
|
|
42489
42526
|
};
|
|
42490
42527
|
};
|
|
42528
|
+
getPartnerConnections: {
|
|
42529
|
+
parameters: {
|
|
42530
|
+
query?: {
|
|
42531
|
+
/** @description Filter by team or company name */
|
|
42532
|
+
search?: string;
|
|
42533
|
+
status?: "active" | "inactive" | "onboarding";
|
|
42534
|
+
/** @description Filter teams with an active connection to this app */
|
|
42535
|
+
appId?: string;
|
|
42536
|
+
/** @description Filter teams by whether an active connection is in error */
|
|
42537
|
+
isErrorState?: boolean;
|
|
42538
|
+
/** @description Team field to sort by; defaults to createdAt */
|
|
42539
|
+
sortBy?: "name" | "createdAt";
|
|
42540
|
+
/** @description Sort direction; defaults to desc for createdAt and asc for name */
|
|
42541
|
+
sortDirection?: "asc" | "desc";
|
|
42542
|
+
limit?: number;
|
|
42543
|
+
page?: number;
|
|
42544
|
+
offset?: number;
|
|
42545
|
+
};
|
|
42546
|
+
header?: {
|
|
42547
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
42548
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
42549
|
+
};
|
|
42550
|
+
path?: never;
|
|
42551
|
+
cookie?: never;
|
|
42552
|
+
};
|
|
42553
|
+
requestBody?: never;
|
|
42554
|
+
responses: {
|
|
42555
|
+
/** @description Successful response */
|
|
42556
|
+
200: {
|
|
42557
|
+
headers: {
|
|
42558
|
+
[name: string]: unknown;
|
|
42559
|
+
};
|
|
42560
|
+
content: {
|
|
42561
|
+
"application/json": {
|
|
42562
|
+
data: {
|
|
42563
|
+
/** Format: uuid */
|
|
42564
|
+
id: string;
|
|
42565
|
+
name: string;
|
|
42566
|
+
logo?: string;
|
|
42567
|
+
/**
|
|
42568
|
+
* Format: date-time
|
|
42569
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
42570
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
42571
|
+
*/
|
|
42572
|
+
createdAt: string;
|
|
42573
|
+
/** @enum {string} */
|
|
42574
|
+
status: "active" | "inactive";
|
|
42575
|
+
isOnboarding: boolean;
|
|
42576
|
+
connections: {
|
|
42577
|
+
/** Format: uuid */
|
|
42578
|
+
id: string;
|
|
42579
|
+
name: string;
|
|
42580
|
+
isErrorState: boolean;
|
|
42581
|
+
app: {
|
|
42582
|
+
id: string;
|
|
42583
|
+
name: string;
|
|
42584
|
+
icon: string | null;
|
|
42585
|
+
/** @enum {string} */
|
|
42586
|
+
category: "paymentGateway" | "accountingPlatform" | "propertyManagementSystem" | "bookingChannel" | "service";
|
|
42587
|
+
};
|
|
42588
|
+
currentSync: {
|
|
42589
|
+
/** @enum {string} */
|
|
42590
|
+
status: "queued" | "started" | "completed" | "failed" | "canceled";
|
|
42591
|
+
/**
|
|
42592
|
+
* Format: date-time
|
|
42593
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
42594
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
42595
|
+
*/
|
|
42596
|
+
createdAt: string;
|
|
42597
|
+
/**
|
|
42598
|
+
* Format: date-time
|
|
42599
|
+
* @description Timestamp string with date, time, milliseconds, and timezone.
|
|
42600
|
+
* @example 2024-01-15T12:30:00.000+00:00
|
|
42601
|
+
*/
|
|
42602
|
+
updatedAt: string;
|
|
42603
|
+
message?: string | null;
|
|
42604
|
+
} | null;
|
|
42605
|
+
}[];
|
|
42606
|
+
}[];
|
|
42607
|
+
pagination: {
|
|
42608
|
+
/** @default 100 */
|
|
42609
|
+
limit: number;
|
|
42610
|
+
/** @default 1 */
|
|
42611
|
+
page: number;
|
|
42612
|
+
total: number;
|
|
42613
|
+
totalPage: number;
|
|
42614
|
+
nextPage?: number;
|
|
42615
|
+
};
|
|
42616
|
+
};
|
|
42617
|
+
};
|
|
42618
|
+
};
|
|
42619
|
+
/** @description Bad request */
|
|
42620
|
+
400: {
|
|
42621
|
+
headers: {
|
|
42622
|
+
[name: string]: unknown;
|
|
42623
|
+
};
|
|
42624
|
+
content: {
|
|
42625
|
+
"application/json": {
|
|
42626
|
+
code: string;
|
|
42627
|
+
message: string;
|
|
42628
|
+
links?: {
|
|
42629
|
+
docs: string;
|
|
42630
|
+
schema: string;
|
|
42631
|
+
};
|
|
42632
|
+
issues?: {
|
|
42633
|
+
message: string;
|
|
42634
|
+
path?: (string | number)[];
|
|
42635
|
+
schema?: string;
|
|
42636
|
+
}[];
|
|
42637
|
+
context?: unknown;
|
|
42638
|
+
};
|
|
42639
|
+
};
|
|
42640
|
+
};
|
|
42641
|
+
/** @description Unauthorized */
|
|
42642
|
+
401: {
|
|
42643
|
+
headers: {
|
|
42644
|
+
[name: string]: unknown;
|
|
42645
|
+
};
|
|
42646
|
+
content: {
|
|
42647
|
+
"application/json": {
|
|
42648
|
+
code: string;
|
|
42649
|
+
message: string;
|
|
42650
|
+
links?: {
|
|
42651
|
+
docs: string;
|
|
42652
|
+
schema: string;
|
|
42653
|
+
};
|
|
42654
|
+
issues?: {
|
|
42655
|
+
message: string;
|
|
42656
|
+
path?: (string | number)[];
|
|
42657
|
+
schema?: string;
|
|
42658
|
+
}[];
|
|
42659
|
+
context?: unknown;
|
|
42660
|
+
};
|
|
42661
|
+
};
|
|
42662
|
+
};
|
|
42663
|
+
/** @description Forbidden */
|
|
42664
|
+
403: {
|
|
42665
|
+
headers: {
|
|
42666
|
+
[name: string]: unknown;
|
|
42667
|
+
};
|
|
42668
|
+
content: {
|
|
42669
|
+
"application/json": {
|
|
42670
|
+
code: string;
|
|
42671
|
+
message: string;
|
|
42672
|
+
links?: {
|
|
42673
|
+
docs: string;
|
|
42674
|
+
schema: string;
|
|
42675
|
+
};
|
|
42676
|
+
issues?: {
|
|
42677
|
+
message: string;
|
|
42678
|
+
path?: (string | number)[];
|
|
42679
|
+
schema?: string;
|
|
42680
|
+
}[];
|
|
42681
|
+
context?: unknown;
|
|
42682
|
+
};
|
|
42683
|
+
};
|
|
42684
|
+
};
|
|
42685
|
+
/** @description Not found */
|
|
42686
|
+
404: {
|
|
42687
|
+
headers: {
|
|
42688
|
+
[name: string]: unknown;
|
|
42689
|
+
};
|
|
42690
|
+
content: {
|
|
42691
|
+
"application/json": {
|
|
42692
|
+
code: string;
|
|
42693
|
+
message: string;
|
|
42694
|
+
links?: {
|
|
42695
|
+
docs: string;
|
|
42696
|
+
schema: string;
|
|
42697
|
+
};
|
|
42698
|
+
issues?: {
|
|
42699
|
+
message: string;
|
|
42700
|
+
path?: (string | number)[];
|
|
42701
|
+
schema?: string;
|
|
42702
|
+
}[];
|
|
42703
|
+
context?: unknown;
|
|
42704
|
+
};
|
|
42705
|
+
};
|
|
42706
|
+
};
|
|
42707
|
+
/** @description Internal server error */
|
|
42708
|
+
500: {
|
|
42709
|
+
headers: {
|
|
42710
|
+
[name: string]: unknown;
|
|
42711
|
+
};
|
|
42712
|
+
content: {
|
|
42713
|
+
"application/json": {
|
|
42714
|
+
code: string;
|
|
42715
|
+
message: string;
|
|
42716
|
+
links?: {
|
|
42717
|
+
docs: string;
|
|
42718
|
+
schema: string;
|
|
42719
|
+
};
|
|
42720
|
+
issues?: {
|
|
42721
|
+
message: string;
|
|
42722
|
+
path?: (string | number)[];
|
|
42723
|
+
schema?: string;
|
|
42724
|
+
}[];
|
|
42725
|
+
context?: unknown;
|
|
42726
|
+
};
|
|
42727
|
+
};
|
|
42728
|
+
};
|
|
42729
|
+
/** @description Service unavailable */
|
|
42730
|
+
503: {
|
|
42731
|
+
headers: {
|
|
42732
|
+
[name: string]: unknown;
|
|
42733
|
+
};
|
|
42734
|
+
content: {
|
|
42735
|
+
"application/json": {
|
|
42736
|
+
code: string;
|
|
42737
|
+
message: string;
|
|
42738
|
+
links?: {
|
|
42739
|
+
docs: string;
|
|
42740
|
+
schema: string;
|
|
42741
|
+
};
|
|
42742
|
+
issues?: {
|
|
42743
|
+
message: string;
|
|
42744
|
+
path?: (string | number)[];
|
|
42745
|
+
schema?: string;
|
|
42746
|
+
}[];
|
|
42747
|
+
context?: unknown;
|
|
42748
|
+
};
|
|
42749
|
+
};
|
|
42750
|
+
};
|
|
42751
|
+
};
|
|
42752
|
+
};
|
|
42491
42753
|
createEmbedSession: {
|
|
42492
42754
|
parameters: {
|
|
42493
42755
|
query?: never;
|
|
@@ -78309,6 +78571,14 @@ export interface operations {
|
|
|
78309
78571
|
/** @enum {string} */
|
|
78310
78572
|
status: "all" | "disabled" | "partially";
|
|
78311
78573
|
}[];
|
|
78574
|
+
isBillable: boolean;
|
|
78575
|
+
aggregates: {
|
|
78576
|
+
activeListings: number;
|
|
78577
|
+
members: number;
|
|
78578
|
+
activeConnections: number;
|
|
78579
|
+
connectionIssues: number;
|
|
78580
|
+
childTeams: number;
|
|
78581
|
+
};
|
|
78312
78582
|
};
|
|
78313
78583
|
};
|
|
78314
78584
|
};
|
|
@@ -78699,6 +78969,14 @@ export interface operations {
|
|
|
78699
78969
|
/** @enum {string} */
|
|
78700
78970
|
status: "all" | "disabled" | "partially";
|
|
78701
78971
|
}[];
|
|
78972
|
+
isBillable: boolean;
|
|
78973
|
+
aggregates: {
|
|
78974
|
+
activeListings: number;
|
|
78975
|
+
members: number;
|
|
78976
|
+
activeConnections: number;
|
|
78977
|
+
connectionIssues: number;
|
|
78978
|
+
childTeams: number;
|
|
78979
|
+
};
|
|
78702
78980
|
};
|
|
78703
78981
|
};
|
|
78704
78982
|
};
|
|
@@ -79969,6 +80247,14 @@ export interface operations {
|
|
|
79969
80247
|
/** @enum {string} */
|
|
79970
80248
|
status: "all" | "disabled" | "partially";
|
|
79971
80249
|
}[];
|
|
80250
|
+
isBillable: boolean;
|
|
80251
|
+
aggregates: {
|
|
80252
|
+
activeListings: number;
|
|
80253
|
+
members: number;
|
|
80254
|
+
activeConnections: number;
|
|
80255
|
+
connectionIssues: number;
|
|
80256
|
+
childTeams: number;
|
|
80257
|
+
};
|
|
79972
80258
|
};
|
|
79973
80259
|
};
|
|
79974
80260
|
};
|
|
@@ -81135,8 +81421,18 @@ export interface operations {
|
|
|
81135
81421
|
/** @description Comma-separated team IDs. */
|
|
81136
81422
|
ids?: string;
|
|
81137
81423
|
status?: "active" | "inactive";
|
|
81424
|
+
/** @description Filter by onboarding state. */
|
|
81425
|
+
isOnboarding?: boolean;
|
|
81138
81426
|
search?: string;
|
|
81139
81427
|
partnerId?: string;
|
|
81428
|
+
billingPartnerId?: string;
|
|
81429
|
+
billingSubscriptionStatus?: "active" | "pending" | "paused" | "cancelled" | "pendingCancellation" | "draft" | "voided" | "errored" | "missing" | "viaPartner";
|
|
81430
|
+
billingPlan?: string;
|
|
81431
|
+
product?: "vrtrust" | "vrintegrations";
|
|
81432
|
+
/** @description Comma-separated enabled feature IDs. */
|
|
81433
|
+
featureIds?: string;
|
|
81434
|
+
/** @description Include partner-dashboard listing, member, connection, issue, and child-team counts. */
|
|
81435
|
+
includeAggregates?: boolean;
|
|
81140
81436
|
type?: "partner" | "propertyManager";
|
|
81141
81437
|
/** @description Field to sort by */
|
|
81142
81438
|
sortBy?: "created" | "name" | "type";
|
|
@@ -81321,6 +81617,14 @@ export interface operations {
|
|
|
81321
81617
|
/** @enum {string} */
|
|
81322
81618
|
status: "all" | "disabled" | "partially";
|
|
81323
81619
|
}[];
|
|
81620
|
+
isBillable: boolean;
|
|
81621
|
+
aggregates?: {
|
|
81622
|
+
activeListings: number;
|
|
81623
|
+
members: number;
|
|
81624
|
+
activeConnections: number;
|
|
81625
|
+
connectionIssues: number;
|
|
81626
|
+
childTeams: number;
|
|
81627
|
+
};
|
|
81324
81628
|
}[];
|
|
81325
81629
|
pagination: {
|
|
81326
81630
|
/** @default 100 */
|
|
@@ -81706,6 +82010,14 @@ export interface operations {
|
|
|
81706
82010
|
/** @enum {string} */
|
|
81707
82011
|
status: "all" | "disabled" | "partially";
|
|
81708
82012
|
}[];
|
|
82013
|
+
isBillable: boolean;
|
|
82014
|
+
aggregates: {
|
|
82015
|
+
activeListings: number;
|
|
82016
|
+
members: number;
|
|
82017
|
+
activeConnections: number;
|
|
82018
|
+
connectionIssues: number;
|
|
82019
|
+
childTeams: number;
|
|
82020
|
+
};
|
|
81709
82021
|
};
|
|
81710
82022
|
};
|
|
81711
82023
|
};
|
|
@@ -82884,6 +83196,14 @@ export interface operations {
|
|
|
82884
83196
|
/** @enum {string} */
|
|
82885
83197
|
status: "all" | "disabled" | "partially";
|
|
82886
83198
|
}[];
|
|
83199
|
+
isBillable: boolean;
|
|
83200
|
+
aggregates?: {
|
|
83201
|
+
activeListings: number;
|
|
83202
|
+
members: number;
|
|
83203
|
+
activeConnections: number;
|
|
83204
|
+
connectionIssues: number;
|
|
83205
|
+
childTeams: number;
|
|
83206
|
+
};
|
|
82887
83207
|
}[];
|
|
82888
83208
|
pagination: {
|
|
82889
83209
|
/** @default 100 */
|
|
@@ -83204,6 +83524,14 @@ export interface operations {
|
|
|
83204
83524
|
/** @enum {string} */
|
|
83205
83525
|
status: "all" | "disabled" | "partially";
|
|
83206
83526
|
}[];
|
|
83527
|
+
isBillable: boolean;
|
|
83528
|
+
aggregates?: {
|
|
83529
|
+
activeListings: number;
|
|
83530
|
+
members: number;
|
|
83531
|
+
activeConnections: number;
|
|
83532
|
+
connectionIssues: number;
|
|
83533
|
+
childTeams: number;
|
|
83534
|
+
};
|
|
83207
83535
|
/** Format: uri */
|
|
83208
83536
|
apiBaseUrl: string;
|
|
83209
83537
|
};
|