@vrplatform/api 1.3.1-stage.4840 → 1.3.1-stage.4843
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.
|
@@ -1705,6 +1705,23 @@ export interface paths {
|
|
|
1705
1705
|
patch?: never;
|
|
1706
1706
|
trace?: never;
|
|
1707
1707
|
};
|
|
1708
|
+
"/internal/memberships/{membershipId}": {
|
|
1709
|
+
parameters: {
|
|
1710
|
+
query?: never;
|
|
1711
|
+
header?: never;
|
|
1712
|
+
path?: never;
|
|
1713
|
+
cookie?: never;
|
|
1714
|
+
};
|
|
1715
|
+
/** @description Get one membership with its user and team from the selected regional data partition. Select the partition with x-data-region. */
|
|
1716
|
+
get: operations["getInternalMembershipsByMembershipId"];
|
|
1717
|
+
put?: never;
|
|
1718
|
+
post?: never;
|
|
1719
|
+
delete?: never;
|
|
1720
|
+
options?: never;
|
|
1721
|
+
head?: never;
|
|
1722
|
+
patch?: never;
|
|
1723
|
+
trace?: never;
|
|
1724
|
+
};
|
|
1708
1725
|
"/internal/message-overwrites": {
|
|
1709
1726
|
parameters: {
|
|
1710
1727
|
query?: never;
|
|
@@ -2171,7 +2188,7 @@ export interface paths {
|
|
|
2171
2188
|
*/
|
|
2172
2189
|
get: operations["getMe"];
|
|
2173
2190
|
/**
|
|
2174
|
-
* @description Update the authenticated user's first and/or last name.
|
|
2191
|
+
* @description Update the authenticated user's first and/or last name and/or set lastSeen to the server's current time. Names are trimmed, changes are persisted synchronously to the control plane, and the existing GET /me user shape is returned.
|
|
2175
2192
|
*
|
|
2176
2193
|
* Required scope: self:write
|
|
2177
2194
|
*/
|
|
@@ -42475,6 +42492,278 @@ export interface operations {
|
|
|
42475
42492
|
};
|
|
42476
42493
|
};
|
|
42477
42494
|
};
|
|
42495
|
+
getInternalMembershipsByMembershipId: {
|
|
42496
|
+
parameters: {
|
|
42497
|
+
query?: never;
|
|
42498
|
+
header?: {
|
|
42499
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
42500
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
42501
|
+
};
|
|
42502
|
+
path: {
|
|
42503
|
+
/** @description Stable membership ID */
|
|
42504
|
+
membershipId: string;
|
|
42505
|
+
};
|
|
42506
|
+
cookie?: never;
|
|
42507
|
+
};
|
|
42508
|
+
requestBody?: never;
|
|
42509
|
+
responses: {
|
|
42510
|
+
/** @description Successful response */
|
|
42511
|
+
200: {
|
|
42512
|
+
headers: {
|
|
42513
|
+
[name: string]: unknown;
|
|
42514
|
+
};
|
|
42515
|
+
content: {
|
|
42516
|
+
"application/json": {
|
|
42517
|
+
/** Format: uuid */
|
|
42518
|
+
id: string;
|
|
42519
|
+
role: string | null;
|
|
42520
|
+
status: ("active" | "inactive" | "unconfirmed") | null;
|
|
42521
|
+
lastInvitedAt: string | null;
|
|
42522
|
+
user: {
|
|
42523
|
+
/** Format: uuid */
|
|
42524
|
+
id: string;
|
|
42525
|
+
/** Format: email */
|
|
42526
|
+
email: string;
|
|
42527
|
+
firstName: string | null;
|
|
42528
|
+
lastName: string | null;
|
|
42529
|
+
};
|
|
42530
|
+
team: {
|
|
42531
|
+
/** Format: uuid */
|
|
42532
|
+
id: string;
|
|
42533
|
+
name: string;
|
|
42534
|
+
/** @enum {string} */
|
|
42535
|
+
type: "partner" | "admin" | "propertyManager";
|
|
42536
|
+
};
|
|
42537
|
+
};
|
|
42538
|
+
};
|
|
42539
|
+
};
|
|
42540
|
+
/** @description Bad request */
|
|
42541
|
+
400: {
|
|
42542
|
+
headers: {
|
|
42543
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42544
|
+
"Retry-After"?: number;
|
|
42545
|
+
[name: string]: unknown;
|
|
42546
|
+
};
|
|
42547
|
+
content: {
|
|
42548
|
+
"application/json": {
|
|
42549
|
+
code: string;
|
|
42550
|
+
message: string;
|
|
42551
|
+
links?: {
|
|
42552
|
+
docs: string;
|
|
42553
|
+
schema: string;
|
|
42554
|
+
};
|
|
42555
|
+
issues?: {
|
|
42556
|
+
message: string;
|
|
42557
|
+
path?: (string | number)[];
|
|
42558
|
+
schema?: string;
|
|
42559
|
+
}[];
|
|
42560
|
+
retryable?: boolean;
|
|
42561
|
+
context?: unknown;
|
|
42562
|
+
};
|
|
42563
|
+
};
|
|
42564
|
+
};
|
|
42565
|
+
/** @description Unauthorized */
|
|
42566
|
+
401: {
|
|
42567
|
+
headers: {
|
|
42568
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42569
|
+
"Retry-After"?: number;
|
|
42570
|
+
[name: string]: unknown;
|
|
42571
|
+
};
|
|
42572
|
+
content: {
|
|
42573
|
+
"application/json": {
|
|
42574
|
+
code: string;
|
|
42575
|
+
message: string;
|
|
42576
|
+
links?: {
|
|
42577
|
+
docs: string;
|
|
42578
|
+
schema: string;
|
|
42579
|
+
};
|
|
42580
|
+
issues?: {
|
|
42581
|
+
message: string;
|
|
42582
|
+
path?: (string | number)[];
|
|
42583
|
+
schema?: string;
|
|
42584
|
+
}[];
|
|
42585
|
+
retryable?: boolean;
|
|
42586
|
+
context?: unknown;
|
|
42587
|
+
};
|
|
42588
|
+
};
|
|
42589
|
+
};
|
|
42590
|
+
/** @description Forbidden */
|
|
42591
|
+
403: {
|
|
42592
|
+
headers: {
|
|
42593
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42594
|
+
"Retry-After"?: number;
|
|
42595
|
+
[name: string]: unknown;
|
|
42596
|
+
};
|
|
42597
|
+
content: {
|
|
42598
|
+
"application/json": {
|
|
42599
|
+
code: string;
|
|
42600
|
+
message: string;
|
|
42601
|
+
links?: {
|
|
42602
|
+
docs: string;
|
|
42603
|
+
schema: string;
|
|
42604
|
+
};
|
|
42605
|
+
issues?: {
|
|
42606
|
+
message: string;
|
|
42607
|
+
path?: (string | number)[];
|
|
42608
|
+
schema?: string;
|
|
42609
|
+
}[];
|
|
42610
|
+
retryable?: boolean;
|
|
42611
|
+
context?: unknown;
|
|
42612
|
+
};
|
|
42613
|
+
};
|
|
42614
|
+
};
|
|
42615
|
+
/** @description Not found */
|
|
42616
|
+
404: {
|
|
42617
|
+
headers: {
|
|
42618
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42619
|
+
"Retry-After"?: number;
|
|
42620
|
+
[name: string]: unknown;
|
|
42621
|
+
};
|
|
42622
|
+
content: {
|
|
42623
|
+
"application/json": {
|
|
42624
|
+
code: string;
|
|
42625
|
+
message: string;
|
|
42626
|
+
links?: {
|
|
42627
|
+
docs: string;
|
|
42628
|
+
schema: string;
|
|
42629
|
+
};
|
|
42630
|
+
issues?: {
|
|
42631
|
+
message: string;
|
|
42632
|
+
path?: (string | number)[];
|
|
42633
|
+
schema?: string;
|
|
42634
|
+
}[];
|
|
42635
|
+
retryable?: boolean;
|
|
42636
|
+
context?: unknown;
|
|
42637
|
+
};
|
|
42638
|
+
};
|
|
42639
|
+
};
|
|
42640
|
+
/** @description Conflict */
|
|
42641
|
+
409: {
|
|
42642
|
+
headers: {
|
|
42643
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42644
|
+
"Retry-After"?: number;
|
|
42645
|
+
[name: string]: unknown;
|
|
42646
|
+
};
|
|
42647
|
+
content: {
|
|
42648
|
+
"application/json": {
|
|
42649
|
+
code: string;
|
|
42650
|
+
message: string;
|
|
42651
|
+
links?: {
|
|
42652
|
+
docs: string;
|
|
42653
|
+
schema: string;
|
|
42654
|
+
};
|
|
42655
|
+
issues?: {
|
|
42656
|
+
message: string;
|
|
42657
|
+
path?: (string | number)[];
|
|
42658
|
+
schema?: string;
|
|
42659
|
+
}[];
|
|
42660
|
+
retryable?: boolean;
|
|
42661
|
+
context?: unknown;
|
|
42662
|
+
};
|
|
42663
|
+
};
|
|
42664
|
+
};
|
|
42665
|
+
/** @description Gone */
|
|
42666
|
+
410: {
|
|
42667
|
+
headers: {
|
|
42668
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42669
|
+
"Retry-After"?: number;
|
|
42670
|
+
[name: string]: unknown;
|
|
42671
|
+
};
|
|
42672
|
+
content: {
|
|
42673
|
+
"application/json": {
|
|
42674
|
+
code: string;
|
|
42675
|
+
message: string;
|
|
42676
|
+
links?: {
|
|
42677
|
+
docs: string;
|
|
42678
|
+
schema: string;
|
|
42679
|
+
};
|
|
42680
|
+
issues?: {
|
|
42681
|
+
message: string;
|
|
42682
|
+
path?: (string | number)[];
|
|
42683
|
+
schema?: string;
|
|
42684
|
+
}[];
|
|
42685
|
+
retryable?: boolean;
|
|
42686
|
+
context?: unknown;
|
|
42687
|
+
};
|
|
42688
|
+
};
|
|
42689
|
+
};
|
|
42690
|
+
/** @description Unprocessable content */
|
|
42691
|
+
422: {
|
|
42692
|
+
headers: {
|
|
42693
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42694
|
+
"Retry-After"?: number;
|
|
42695
|
+
[name: string]: unknown;
|
|
42696
|
+
};
|
|
42697
|
+
content: {
|
|
42698
|
+
"application/json": {
|
|
42699
|
+
code: string;
|
|
42700
|
+
message: string;
|
|
42701
|
+
links?: {
|
|
42702
|
+
docs: string;
|
|
42703
|
+
schema: string;
|
|
42704
|
+
};
|
|
42705
|
+
issues?: {
|
|
42706
|
+
message: string;
|
|
42707
|
+
path?: (string | number)[];
|
|
42708
|
+
schema?: string;
|
|
42709
|
+
}[];
|
|
42710
|
+
retryable?: boolean;
|
|
42711
|
+
context?: unknown;
|
|
42712
|
+
};
|
|
42713
|
+
};
|
|
42714
|
+
};
|
|
42715
|
+
/** @description Internal server error */
|
|
42716
|
+
500: {
|
|
42717
|
+
headers: {
|
|
42718
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42719
|
+
"Retry-After"?: number;
|
|
42720
|
+
[name: string]: unknown;
|
|
42721
|
+
};
|
|
42722
|
+
content: {
|
|
42723
|
+
"application/json": {
|
|
42724
|
+
code: string;
|
|
42725
|
+
message: string;
|
|
42726
|
+
links?: {
|
|
42727
|
+
docs: string;
|
|
42728
|
+
schema: string;
|
|
42729
|
+
};
|
|
42730
|
+
issues?: {
|
|
42731
|
+
message: string;
|
|
42732
|
+
path?: (string | number)[];
|
|
42733
|
+
schema?: string;
|
|
42734
|
+
}[];
|
|
42735
|
+
retryable?: boolean;
|
|
42736
|
+
context?: unknown;
|
|
42737
|
+
};
|
|
42738
|
+
};
|
|
42739
|
+
};
|
|
42740
|
+
/** @description Service unavailable */
|
|
42741
|
+
503: {
|
|
42742
|
+
headers: {
|
|
42743
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42744
|
+
"Retry-After"?: number;
|
|
42745
|
+
[name: string]: unknown;
|
|
42746
|
+
};
|
|
42747
|
+
content: {
|
|
42748
|
+
"application/json": {
|
|
42749
|
+
code: string;
|
|
42750
|
+
message: string;
|
|
42751
|
+
links?: {
|
|
42752
|
+
docs: string;
|
|
42753
|
+
schema: string;
|
|
42754
|
+
};
|
|
42755
|
+
issues?: {
|
|
42756
|
+
message: string;
|
|
42757
|
+
path?: (string | number)[];
|
|
42758
|
+
schema?: string;
|
|
42759
|
+
}[];
|
|
42760
|
+
retryable?: boolean;
|
|
42761
|
+
context?: unknown;
|
|
42762
|
+
};
|
|
42763
|
+
};
|
|
42764
|
+
};
|
|
42765
|
+
};
|
|
42766
|
+
};
|
|
42478
42767
|
getInternalMessageOverwrites: {
|
|
42479
42768
|
parameters: {
|
|
42480
42769
|
query?: {
|
|
@@ -45210,8 +45499,10 @@ export interface operations {
|
|
|
45210
45499
|
getInternalUsers: {
|
|
45211
45500
|
parameters: {
|
|
45212
45501
|
query?: {
|
|
45213
|
-
/** @description Filter by email, secondary email, first name, last name, or full name */
|
|
45502
|
+
/** @description Filter by email, secondary email, first name, last name, or full name. Cannot be combined with userId. */
|
|
45214
45503
|
search?: string;
|
|
45504
|
+
/** @description Filter by an exact user ID. Cannot be combined with search. */
|
|
45505
|
+
userId?: string;
|
|
45215
45506
|
limit?: number;
|
|
45216
45507
|
page?: number;
|
|
45217
45508
|
offset?: number;
|
|
@@ -45250,6 +45541,8 @@ export interface operations {
|
|
|
45250
45541
|
teamName: string;
|
|
45251
45542
|
role?: string | null;
|
|
45252
45543
|
status?: string | null;
|
|
45544
|
+
/** Format: uuid */
|
|
45545
|
+
id: string;
|
|
45253
45546
|
lastInvitedAt: string | null;
|
|
45254
45547
|
}[];
|
|
45255
45548
|
ownerAccesses: {
|
|
@@ -53986,6 +54279,8 @@ export interface operations {
|
|
|
53986
54279
|
"application/json": {
|
|
53987
54280
|
firstName?: string;
|
|
53988
54281
|
lastName?: string;
|
|
54282
|
+
/** @constant */
|
|
54283
|
+
touchLastSeen?: true;
|
|
53989
54284
|
};
|
|
53990
54285
|
};
|
|
53991
54286
|
};
|