@vrplatform/api 1.3.1-preview.4560 → 1.3.1-preview.4563
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.
|
@@ -1625,7 +1625,8 @@ export interface paths {
|
|
|
1625
1625
|
path?: never;
|
|
1626
1626
|
cookie?: never;
|
|
1627
1627
|
};
|
|
1628
|
-
|
|
1628
|
+
/** @description List users in one regional data partition with their team memberships and owner accesses. Select the partition with x-data-region. */
|
|
1629
|
+
get: operations["getInternalUsers"];
|
|
1629
1630
|
put?: never;
|
|
1630
1631
|
/** @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. */
|
|
1631
1632
|
post: operations["postInternalUsers"];
|
|
@@ -42523,6 +42524,300 @@ export interface operations {
|
|
|
42523
42524
|
};
|
|
42524
42525
|
};
|
|
42525
42526
|
};
|
|
42527
|
+
getInternalUsers: {
|
|
42528
|
+
parameters: {
|
|
42529
|
+
query?: {
|
|
42530
|
+
/** @description Filter by email, secondary email, first name, last name, or full name */
|
|
42531
|
+
search?: string;
|
|
42532
|
+
limit?: number;
|
|
42533
|
+
page?: number;
|
|
42534
|
+
offset?: number;
|
|
42535
|
+
};
|
|
42536
|
+
header?: {
|
|
42537
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
42538
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
42539
|
+
};
|
|
42540
|
+
path?: never;
|
|
42541
|
+
cookie?: never;
|
|
42542
|
+
};
|
|
42543
|
+
requestBody?: never;
|
|
42544
|
+
responses: {
|
|
42545
|
+
/** @description Successful response */
|
|
42546
|
+
200: {
|
|
42547
|
+
headers: {
|
|
42548
|
+
[name: string]: unknown;
|
|
42549
|
+
};
|
|
42550
|
+
content: {
|
|
42551
|
+
"application/json": {
|
|
42552
|
+
data: {
|
|
42553
|
+
/** Format: uuid */
|
|
42554
|
+
id: string;
|
|
42555
|
+
firstName: string | null;
|
|
42556
|
+
lastName: string | null;
|
|
42557
|
+
/** Format: email */
|
|
42558
|
+
email: string;
|
|
42559
|
+
secondaryEmails: string[];
|
|
42560
|
+
/** @description User kind (e.g. user, owner) */
|
|
42561
|
+
type?: string | null;
|
|
42562
|
+
lastSeen: string | null;
|
|
42563
|
+
createdAt: string | null;
|
|
42564
|
+
memberships: {
|
|
42565
|
+
/** Format: uuid */
|
|
42566
|
+
teamId: string;
|
|
42567
|
+
teamName: string;
|
|
42568
|
+
role?: string | null;
|
|
42569
|
+
status?: string | null;
|
|
42570
|
+
lastInvitedAt: string | null;
|
|
42571
|
+
}[];
|
|
42572
|
+
ownerAccesses: {
|
|
42573
|
+
/** Format: uuid */
|
|
42574
|
+
teamId: string;
|
|
42575
|
+
contactId: string | null;
|
|
42576
|
+
ownerId: string | null;
|
|
42577
|
+
role?: string | null;
|
|
42578
|
+
/** @description Owner contact name */
|
|
42579
|
+
name?: string | null;
|
|
42580
|
+
}[];
|
|
42581
|
+
}[];
|
|
42582
|
+
pagination: {
|
|
42583
|
+
/** @default 100 */
|
|
42584
|
+
limit: number;
|
|
42585
|
+
/** @default 1 */
|
|
42586
|
+
page: number;
|
|
42587
|
+
total: number;
|
|
42588
|
+
totalPage: number;
|
|
42589
|
+
nextPage?: number;
|
|
42590
|
+
};
|
|
42591
|
+
};
|
|
42592
|
+
};
|
|
42593
|
+
};
|
|
42594
|
+
/** @description Bad request */
|
|
42595
|
+
400: {
|
|
42596
|
+
headers: {
|
|
42597
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42598
|
+
"Retry-After"?: number;
|
|
42599
|
+
[name: string]: unknown;
|
|
42600
|
+
};
|
|
42601
|
+
content: {
|
|
42602
|
+
"application/json": {
|
|
42603
|
+
code: string;
|
|
42604
|
+
message: string;
|
|
42605
|
+
links?: {
|
|
42606
|
+
docs: string;
|
|
42607
|
+
schema: string;
|
|
42608
|
+
};
|
|
42609
|
+
issues?: {
|
|
42610
|
+
message: string;
|
|
42611
|
+
path?: (string | number)[];
|
|
42612
|
+
schema?: string;
|
|
42613
|
+
}[];
|
|
42614
|
+
retryable?: boolean;
|
|
42615
|
+
context?: unknown;
|
|
42616
|
+
};
|
|
42617
|
+
};
|
|
42618
|
+
};
|
|
42619
|
+
/** @description Unauthorized */
|
|
42620
|
+
401: {
|
|
42621
|
+
headers: {
|
|
42622
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42623
|
+
"Retry-After"?: number;
|
|
42624
|
+
[name: string]: unknown;
|
|
42625
|
+
};
|
|
42626
|
+
content: {
|
|
42627
|
+
"application/json": {
|
|
42628
|
+
code: string;
|
|
42629
|
+
message: string;
|
|
42630
|
+
links?: {
|
|
42631
|
+
docs: string;
|
|
42632
|
+
schema: string;
|
|
42633
|
+
};
|
|
42634
|
+
issues?: {
|
|
42635
|
+
message: string;
|
|
42636
|
+
path?: (string | number)[];
|
|
42637
|
+
schema?: string;
|
|
42638
|
+
}[];
|
|
42639
|
+
retryable?: boolean;
|
|
42640
|
+
context?: unknown;
|
|
42641
|
+
};
|
|
42642
|
+
};
|
|
42643
|
+
};
|
|
42644
|
+
/** @description Forbidden */
|
|
42645
|
+
403: {
|
|
42646
|
+
headers: {
|
|
42647
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42648
|
+
"Retry-After"?: number;
|
|
42649
|
+
[name: string]: unknown;
|
|
42650
|
+
};
|
|
42651
|
+
content: {
|
|
42652
|
+
"application/json": {
|
|
42653
|
+
code: string;
|
|
42654
|
+
message: string;
|
|
42655
|
+
links?: {
|
|
42656
|
+
docs: string;
|
|
42657
|
+
schema: string;
|
|
42658
|
+
};
|
|
42659
|
+
issues?: {
|
|
42660
|
+
message: string;
|
|
42661
|
+
path?: (string | number)[];
|
|
42662
|
+
schema?: string;
|
|
42663
|
+
}[];
|
|
42664
|
+
retryable?: boolean;
|
|
42665
|
+
context?: unknown;
|
|
42666
|
+
};
|
|
42667
|
+
};
|
|
42668
|
+
};
|
|
42669
|
+
/** @description Not found */
|
|
42670
|
+
404: {
|
|
42671
|
+
headers: {
|
|
42672
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42673
|
+
"Retry-After"?: number;
|
|
42674
|
+
[name: string]: unknown;
|
|
42675
|
+
};
|
|
42676
|
+
content: {
|
|
42677
|
+
"application/json": {
|
|
42678
|
+
code: string;
|
|
42679
|
+
message: string;
|
|
42680
|
+
links?: {
|
|
42681
|
+
docs: string;
|
|
42682
|
+
schema: string;
|
|
42683
|
+
};
|
|
42684
|
+
issues?: {
|
|
42685
|
+
message: string;
|
|
42686
|
+
path?: (string | number)[];
|
|
42687
|
+
schema?: string;
|
|
42688
|
+
}[];
|
|
42689
|
+
retryable?: boolean;
|
|
42690
|
+
context?: unknown;
|
|
42691
|
+
};
|
|
42692
|
+
};
|
|
42693
|
+
};
|
|
42694
|
+
/** @description Conflict */
|
|
42695
|
+
409: {
|
|
42696
|
+
headers: {
|
|
42697
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42698
|
+
"Retry-After"?: number;
|
|
42699
|
+
[name: string]: unknown;
|
|
42700
|
+
};
|
|
42701
|
+
content: {
|
|
42702
|
+
"application/json": {
|
|
42703
|
+
code: string;
|
|
42704
|
+
message: string;
|
|
42705
|
+
links?: {
|
|
42706
|
+
docs: string;
|
|
42707
|
+
schema: string;
|
|
42708
|
+
};
|
|
42709
|
+
issues?: {
|
|
42710
|
+
message: string;
|
|
42711
|
+
path?: (string | number)[];
|
|
42712
|
+
schema?: string;
|
|
42713
|
+
}[];
|
|
42714
|
+
retryable?: boolean;
|
|
42715
|
+
context?: unknown;
|
|
42716
|
+
};
|
|
42717
|
+
};
|
|
42718
|
+
};
|
|
42719
|
+
/** @description Gone */
|
|
42720
|
+
410: {
|
|
42721
|
+
headers: {
|
|
42722
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42723
|
+
"Retry-After"?: number;
|
|
42724
|
+
[name: string]: unknown;
|
|
42725
|
+
};
|
|
42726
|
+
content: {
|
|
42727
|
+
"application/json": {
|
|
42728
|
+
code: string;
|
|
42729
|
+
message: string;
|
|
42730
|
+
links?: {
|
|
42731
|
+
docs: string;
|
|
42732
|
+
schema: string;
|
|
42733
|
+
};
|
|
42734
|
+
issues?: {
|
|
42735
|
+
message: string;
|
|
42736
|
+
path?: (string | number)[];
|
|
42737
|
+
schema?: string;
|
|
42738
|
+
}[];
|
|
42739
|
+
retryable?: boolean;
|
|
42740
|
+
context?: unknown;
|
|
42741
|
+
};
|
|
42742
|
+
};
|
|
42743
|
+
};
|
|
42744
|
+
/** @description Unprocessable content */
|
|
42745
|
+
422: {
|
|
42746
|
+
headers: {
|
|
42747
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42748
|
+
"Retry-After"?: number;
|
|
42749
|
+
[name: string]: unknown;
|
|
42750
|
+
};
|
|
42751
|
+
content: {
|
|
42752
|
+
"application/json": {
|
|
42753
|
+
code: string;
|
|
42754
|
+
message: string;
|
|
42755
|
+
links?: {
|
|
42756
|
+
docs: string;
|
|
42757
|
+
schema: string;
|
|
42758
|
+
};
|
|
42759
|
+
issues?: {
|
|
42760
|
+
message: string;
|
|
42761
|
+
path?: (string | number)[];
|
|
42762
|
+
schema?: string;
|
|
42763
|
+
}[];
|
|
42764
|
+
retryable?: boolean;
|
|
42765
|
+
context?: unknown;
|
|
42766
|
+
};
|
|
42767
|
+
};
|
|
42768
|
+
};
|
|
42769
|
+
/** @description Internal server error */
|
|
42770
|
+
500: {
|
|
42771
|
+
headers: {
|
|
42772
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42773
|
+
"Retry-After"?: number;
|
|
42774
|
+
[name: string]: unknown;
|
|
42775
|
+
};
|
|
42776
|
+
content: {
|
|
42777
|
+
"application/json": {
|
|
42778
|
+
code: string;
|
|
42779
|
+
message: string;
|
|
42780
|
+
links?: {
|
|
42781
|
+
docs: string;
|
|
42782
|
+
schema: string;
|
|
42783
|
+
};
|
|
42784
|
+
issues?: {
|
|
42785
|
+
message: string;
|
|
42786
|
+
path?: (string | number)[];
|
|
42787
|
+
schema?: string;
|
|
42788
|
+
}[];
|
|
42789
|
+
retryable?: boolean;
|
|
42790
|
+
context?: unknown;
|
|
42791
|
+
};
|
|
42792
|
+
};
|
|
42793
|
+
};
|
|
42794
|
+
/** @description Service unavailable */
|
|
42795
|
+
503: {
|
|
42796
|
+
headers: {
|
|
42797
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
42798
|
+
"Retry-After"?: number;
|
|
42799
|
+
[name: string]: unknown;
|
|
42800
|
+
};
|
|
42801
|
+
content: {
|
|
42802
|
+
"application/json": {
|
|
42803
|
+
code: string;
|
|
42804
|
+
message: string;
|
|
42805
|
+
links?: {
|
|
42806
|
+
docs: string;
|
|
42807
|
+
schema: string;
|
|
42808
|
+
};
|
|
42809
|
+
issues?: {
|
|
42810
|
+
message: string;
|
|
42811
|
+
path?: (string | number)[];
|
|
42812
|
+
schema?: string;
|
|
42813
|
+
}[];
|
|
42814
|
+
retryable?: boolean;
|
|
42815
|
+
context?: unknown;
|
|
42816
|
+
};
|
|
42817
|
+
};
|
|
42818
|
+
};
|
|
42819
|
+
};
|
|
42820
|
+
};
|
|
42526
42821
|
postInternalUsers: {
|
|
42527
42822
|
parameters: {
|
|
42528
42823
|
query?: never;
|
|
@@ -57583,7 +57878,7 @@ export interface operations {
|
|
|
57583
57878
|
offset?: number;
|
|
57584
57879
|
};
|
|
57585
57880
|
header?: {
|
|
57586
|
-
/** @description Selects the regional data partition for this
|
|
57881
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
57587
57882
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
57588
57883
|
};
|
|
57589
57884
|
path?: never;
|
|
@@ -57874,7 +58169,7 @@ export interface operations {
|
|
|
57874
58169
|
offset?: number;
|
|
57875
58170
|
};
|
|
57876
58171
|
header?: {
|
|
57877
|
-
/** @description Selects the regional data partition for this
|
|
58172
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
57878
58173
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
57879
58174
|
};
|
|
57880
58175
|
path?: never;
|
|
@@ -58162,7 +58457,7 @@ export interface operations {
|
|
|
58162
58457
|
parameters: {
|
|
58163
58458
|
query?: never;
|
|
58164
58459
|
header?: {
|
|
58165
|
-
/** @description Selects the regional data partition for this
|
|
58460
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
58166
58461
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
58167
58462
|
};
|
|
58168
58463
|
path: {
|
|
@@ -110625,7 +110920,7 @@ export interface operations {
|
|
|
110625
110920
|
offset?: number;
|
|
110626
110921
|
};
|
|
110627
110922
|
header?: {
|
|
110628
|
-
/** @description Selects the regional data partition for this
|
|
110923
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
110629
110924
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
110630
110925
|
};
|
|
110631
110926
|
path?: never;
|
|
@@ -111516,7 +111811,7 @@ export interface operations {
|
|
|
111516
111811
|
cursor?: string;
|
|
111517
111812
|
};
|
|
111518
111813
|
header?: {
|
|
111519
|
-
/** @description Selects the regional data partition for this
|
|
111814
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
111520
111815
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
111521
111816
|
};
|
|
111522
111817
|
path?: never;
|
|
@@ -112464,7 +112759,7 @@ export interface operations {
|
|
|
112464
112759
|
offset?: number;
|
|
112465
112760
|
};
|
|
112466
112761
|
header?: {
|
|
112467
|
-
/** @description Selects the regional data partition for this
|
|
112762
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
112468
112763
|
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
112469
112764
|
};
|
|
112470
112765
|
path?: never;
|