@vrplatform/api 1.3.1-stage.4556 → 1.3.1-stage.4559
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.
|
@@ -1557,7 +1557,8 @@ export interface paths {
|
|
|
1557
1557
|
path?: never;
|
|
1558
1558
|
cookie?: never;
|
|
1559
1559
|
};
|
|
1560
|
-
|
|
1560
|
+
/** @description List users in one regional data partition with their team memberships and owner accesses. Select the partition with x-data-region. */
|
|
1561
|
+
get: operations["getInternalUsers"];
|
|
1561
1562
|
put?: never;
|
|
1562
1563
|
/** @description Create or update a platform user by email, optionally granting an initial team membership. Used by the identity provider signup hooks. A duplicate email belonging to another user is rejected as a user error. */
|
|
1563
1564
|
post: operations["postInternalUsers"];
|
|
@@ -29583,6 +29584,207 @@ export interface operations {
|
|
|
29583
29584
|
};
|
|
29584
29585
|
};
|
|
29585
29586
|
};
|
|
29587
|
+
getInternalUsers: {
|
|
29588
|
+
parameters: {
|
|
29589
|
+
query?: {
|
|
29590
|
+
/** @description Filter by email, secondary email, first name, last name, or full name */
|
|
29591
|
+
search?: string;
|
|
29592
|
+
limit?: number;
|
|
29593
|
+
page?: number;
|
|
29594
|
+
offset?: number;
|
|
29595
|
+
};
|
|
29596
|
+
header?: {
|
|
29597
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
29598
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
29599
|
+
};
|
|
29600
|
+
path?: never;
|
|
29601
|
+
cookie?: never;
|
|
29602
|
+
};
|
|
29603
|
+
requestBody?: never;
|
|
29604
|
+
responses: {
|
|
29605
|
+
/** @description Successful response */
|
|
29606
|
+
200: {
|
|
29607
|
+
headers: {
|
|
29608
|
+
[name: string]: unknown;
|
|
29609
|
+
};
|
|
29610
|
+
content: {
|
|
29611
|
+
"application/json": {
|
|
29612
|
+
data: {
|
|
29613
|
+
/** Format: uuid */
|
|
29614
|
+
id: string;
|
|
29615
|
+
firstName: string | null;
|
|
29616
|
+
lastName: string | null;
|
|
29617
|
+
/** Format: email */
|
|
29618
|
+
email: string;
|
|
29619
|
+
secondaryEmails: string[];
|
|
29620
|
+
/** @description User kind (e.g. user, owner) */
|
|
29621
|
+
type?: string | null;
|
|
29622
|
+
lastSeen: string | null;
|
|
29623
|
+
createdAt: string | null;
|
|
29624
|
+
memberships: {
|
|
29625
|
+
/** Format: uuid */
|
|
29626
|
+
teamId: string;
|
|
29627
|
+
teamName: string;
|
|
29628
|
+
role?: string | null;
|
|
29629
|
+
status?: string | null;
|
|
29630
|
+
lastInvitedAt: string | null;
|
|
29631
|
+
}[];
|
|
29632
|
+
ownerAccesses: {
|
|
29633
|
+
/** Format: uuid */
|
|
29634
|
+
teamId: string;
|
|
29635
|
+
contactId: string | null;
|
|
29636
|
+
ownerId: string | null;
|
|
29637
|
+
role?: string | null;
|
|
29638
|
+
/** @description Owner contact name */
|
|
29639
|
+
name?: string | null;
|
|
29640
|
+
}[];
|
|
29641
|
+
}[];
|
|
29642
|
+
pagination: {
|
|
29643
|
+
/** @default 100 */
|
|
29644
|
+
limit: number;
|
|
29645
|
+
/** @default 1 */
|
|
29646
|
+
page: number;
|
|
29647
|
+
total: number;
|
|
29648
|
+
totalPage: number;
|
|
29649
|
+
nextPage?: number;
|
|
29650
|
+
};
|
|
29651
|
+
};
|
|
29652
|
+
};
|
|
29653
|
+
};
|
|
29654
|
+
/** @description Bad request */
|
|
29655
|
+
400: {
|
|
29656
|
+
headers: {
|
|
29657
|
+
[name: string]: unknown;
|
|
29658
|
+
};
|
|
29659
|
+
content: {
|
|
29660
|
+
"application/json": {
|
|
29661
|
+
code: string;
|
|
29662
|
+
message: string;
|
|
29663
|
+
links?: {
|
|
29664
|
+
docs: string;
|
|
29665
|
+
schema: string;
|
|
29666
|
+
};
|
|
29667
|
+
issues?: {
|
|
29668
|
+
message: string;
|
|
29669
|
+
path?: (string | number)[];
|
|
29670
|
+
schema?: string;
|
|
29671
|
+
}[];
|
|
29672
|
+
context?: unknown;
|
|
29673
|
+
};
|
|
29674
|
+
};
|
|
29675
|
+
};
|
|
29676
|
+
/** @description Unauthorized */
|
|
29677
|
+
401: {
|
|
29678
|
+
headers: {
|
|
29679
|
+
[name: string]: unknown;
|
|
29680
|
+
};
|
|
29681
|
+
content: {
|
|
29682
|
+
"application/json": {
|
|
29683
|
+
code: string;
|
|
29684
|
+
message: string;
|
|
29685
|
+
links?: {
|
|
29686
|
+
docs: string;
|
|
29687
|
+
schema: string;
|
|
29688
|
+
};
|
|
29689
|
+
issues?: {
|
|
29690
|
+
message: string;
|
|
29691
|
+
path?: (string | number)[];
|
|
29692
|
+
schema?: string;
|
|
29693
|
+
}[];
|
|
29694
|
+
context?: unknown;
|
|
29695
|
+
};
|
|
29696
|
+
};
|
|
29697
|
+
};
|
|
29698
|
+
/** @description Forbidden */
|
|
29699
|
+
403: {
|
|
29700
|
+
headers: {
|
|
29701
|
+
[name: string]: unknown;
|
|
29702
|
+
};
|
|
29703
|
+
content: {
|
|
29704
|
+
"application/json": {
|
|
29705
|
+
code: string;
|
|
29706
|
+
message: string;
|
|
29707
|
+
links?: {
|
|
29708
|
+
docs: string;
|
|
29709
|
+
schema: string;
|
|
29710
|
+
};
|
|
29711
|
+
issues?: {
|
|
29712
|
+
message: string;
|
|
29713
|
+
path?: (string | number)[];
|
|
29714
|
+
schema?: string;
|
|
29715
|
+
}[];
|
|
29716
|
+
context?: unknown;
|
|
29717
|
+
};
|
|
29718
|
+
};
|
|
29719
|
+
};
|
|
29720
|
+
/** @description Not found */
|
|
29721
|
+
404: {
|
|
29722
|
+
headers: {
|
|
29723
|
+
[name: string]: unknown;
|
|
29724
|
+
};
|
|
29725
|
+
content: {
|
|
29726
|
+
"application/json": {
|
|
29727
|
+
code: string;
|
|
29728
|
+
message: string;
|
|
29729
|
+
links?: {
|
|
29730
|
+
docs: string;
|
|
29731
|
+
schema: string;
|
|
29732
|
+
};
|
|
29733
|
+
issues?: {
|
|
29734
|
+
message: string;
|
|
29735
|
+
path?: (string | number)[];
|
|
29736
|
+
schema?: string;
|
|
29737
|
+
}[];
|
|
29738
|
+
context?: unknown;
|
|
29739
|
+
};
|
|
29740
|
+
};
|
|
29741
|
+
};
|
|
29742
|
+
/** @description Internal server error */
|
|
29743
|
+
500: {
|
|
29744
|
+
headers: {
|
|
29745
|
+
[name: string]: unknown;
|
|
29746
|
+
};
|
|
29747
|
+
content: {
|
|
29748
|
+
"application/json": {
|
|
29749
|
+
code: string;
|
|
29750
|
+
message: string;
|
|
29751
|
+
links?: {
|
|
29752
|
+
docs: string;
|
|
29753
|
+
schema: string;
|
|
29754
|
+
};
|
|
29755
|
+
issues?: {
|
|
29756
|
+
message: string;
|
|
29757
|
+
path?: (string | number)[];
|
|
29758
|
+
schema?: string;
|
|
29759
|
+
}[];
|
|
29760
|
+
context?: unknown;
|
|
29761
|
+
};
|
|
29762
|
+
};
|
|
29763
|
+
};
|
|
29764
|
+
/** @description Service unavailable */
|
|
29765
|
+
503: {
|
|
29766
|
+
headers: {
|
|
29767
|
+
[name: string]: unknown;
|
|
29768
|
+
};
|
|
29769
|
+
content: {
|
|
29770
|
+
"application/json": {
|
|
29771
|
+
code: string;
|
|
29772
|
+
message: string;
|
|
29773
|
+
links?: {
|
|
29774
|
+
docs: string;
|
|
29775
|
+
schema: string;
|
|
29776
|
+
};
|
|
29777
|
+
issues?: {
|
|
29778
|
+
message: string;
|
|
29779
|
+
path?: (string | number)[];
|
|
29780
|
+
schema?: string;
|
|
29781
|
+
}[];
|
|
29782
|
+
context?: unknown;
|
|
29783
|
+
};
|
|
29784
|
+
};
|
|
29785
|
+
};
|
|
29786
|
+
};
|
|
29787
|
+
};
|
|
29586
29788
|
postInternalUsers: {
|
|
29587
29789
|
parameters: {
|
|
29588
29790
|
query?: never;
|
|
@@ -39807,7 +40009,7 @@ export interface operations {
|
|
|
39807
40009
|
offset?: number;
|
|
39808
40010
|
};
|
|
39809
40011
|
header?: {
|
|
39810
|
-
/** @description Selects the regional data partition for this
|
|
40012
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
39811
40013
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
39812
40014
|
};
|
|
39813
40015
|
path?: never;
|
|
@@ -40005,7 +40207,7 @@ export interface operations {
|
|
|
40005
40207
|
offset?: number;
|
|
40006
40208
|
};
|
|
40007
40209
|
header?: {
|
|
40008
|
-
/** @description Selects the regional data partition for this
|
|
40210
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
40009
40211
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
40010
40212
|
};
|
|
40011
40213
|
path?: never;
|
|
@@ -40200,7 +40402,7 @@ export interface operations {
|
|
|
40200
40402
|
parameters: {
|
|
40201
40403
|
query?: never;
|
|
40202
40404
|
header?: {
|
|
40203
|
-
/** @description Selects the regional data partition for this
|
|
40405
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
40204
40406
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
40205
40407
|
};
|
|
40206
40408
|
path: {
|
|
@@ -77545,7 +77747,7 @@ export interface operations {
|
|
|
77545
77747
|
offset?: number;
|
|
77546
77748
|
};
|
|
77547
77749
|
header?: {
|
|
77548
|
-
/** @description Selects the regional data partition for this
|
|
77750
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
77549
77751
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
77550
77752
|
};
|
|
77551
77753
|
path?: never;
|
|
@@ -78250,7 +78452,7 @@ export interface operations {
|
|
|
78250
78452
|
cursor?: string;
|
|
78251
78453
|
};
|
|
78252
78454
|
header?: {
|
|
78253
|
-
/** @description Selects the regional data partition for this
|
|
78455
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
78254
78456
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
78255
78457
|
};
|
|
78256
78458
|
path?: never;
|
|
@@ -79105,7 +79307,7 @@ export interface operations {
|
|
|
79105
79307
|
offset?: number;
|
|
79106
79308
|
};
|
|
79107
79309
|
header?: {
|
|
79108
|
-
/** @description Selects the regional data partition for this
|
|
79310
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
79109
79311
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
79110
79312
|
};
|
|
79111
79313
|
path?: never;
|