@vrplatform/api 1.3.1-stage.4555 → 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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.4555",
6
+ "version": "1.3.1-stage.4559",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -1558,7 +1558,8 @@ export interface paths {
1558
1558
  path?: never;
1559
1559
  cookie?: never;
1560
1560
  };
1561
- get?: never;
1561
+ /** @description List users in one regional data partition with their team memberships and owner accesses. Select the partition with x-data-region. */
1562
+ get: operations["getInternalUsers"];
1562
1563
  put?: never;
1563
1564
  /** @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. */
1564
1565
  post: operations["postInternalUsers"];
@@ -2246,7 +2247,7 @@ export interface paths {
2246
2247
  path?: never;
2247
2248
  cookie?: never;
2248
2249
  };
2249
- /** @description List members of the partner itself with their child-team memberships */
2250
+ /** @description List members of the partner itself with their partner-team role, status, invitation timestamp, and child-team memberships */
2250
2251
  get: operations["getPartnerMembers"];
2251
2252
  put?: never;
2252
2253
  post?: never;
@@ -29584,6 +29585,207 @@ export interface operations {
29584
29585
  };
29585
29586
  };
29586
29587
  };
29588
+ getInternalUsers: {
29589
+ parameters: {
29590
+ query?: {
29591
+ /** @description Filter by email, secondary email, first name, last name, or full name */
29592
+ search?: string;
29593
+ limit?: number;
29594
+ page?: number;
29595
+ offset?: number;
29596
+ };
29597
+ header?: {
29598
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
29599
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
29600
+ };
29601
+ path?: never;
29602
+ cookie?: never;
29603
+ };
29604
+ requestBody?: never;
29605
+ responses: {
29606
+ /** @description Successful response */
29607
+ 200: {
29608
+ headers: {
29609
+ [name: string]: unknown;
29610
+ };
29611
+ content: {
29612
+ "application/json": {
29613
+ data: {
29614
+ /** Format: uuid */
29615
+ id: string;
29616
+ firstName: string | null;
29617
+ lastName: string | null;
29618
+ /** Format: email */
29619
+ email: string;
29620
+ secondaryEmails: string[];
29621
+ /** @description User kind (e.g. user, owner) */
29622
+ type?: string | null;
29623
+ lastSeen: string | null;
29624
+ createdAt: string | null;
29625
+ memberships: {
29626
+ /** Format: uuid */
29627
+ teamId: string;
29628
+ teamName: string;
29629
+ role?: string | null;
29630
+ status?: string | null;
29631
+ lastInvitedAt: string | null;
29632
+ }[];
29633
+ ownerAccesses: {
29634
+ /** Format: uuid */
29635
+ teamId: string;
29636
+ contactId: string | null;
29637
+ ownerId: string | null;
29638
+ role?: string | null;
29639
+ /** @description Owner contact name */
29640
+ name?: string | null;
29641
+ }[];
29642
+ }[];
29643
+ pagination: {
29644
+ /** @default 100 */
29645
+ limit: number;
29646
+ /** @default 1 */
29647
+ page: number;
29648
+ total: number;
29649
+ totalPage: number;
29650
+ nextPage?: number;
29651
+ };
29652
+ };
29653
+ };
29654
+ };
29655
+ /** @description Bad request */
29656
+ 400: {
29657
+ headers: {
29658
+ [name: string]: unknown;
29659
+ };
29660
+ content: {
29661
+ "application/json": {
29662
+ code: string;
29663
+ message: string;
29664
+ links?: {
29665
+ docs: string;
29666
+ schema: string;
29667
+ };
29668
+ issues?: {
29669
+ message: string;
29670
+ path?: (string | number)[];
29671
+ schema?: string;
29672
+ }[];
29673
+ context?: unknown;
29674
+ };
29675
+ };
29676
+ };
29677
+ /** @description Unauthorized */
29678
+ 401: {
29679
+ headers: {
29680
+ [name: string]: unknown;
29681
+ };
29682
+ content: {
29683
+ "application/json": {
29684
+ code: string;
29685
+ message: string;
29686
+ links?: {
29687
+ docs: string;
29688
+ schema: string;
29689
+ };
29690
+ issues?: {
29691
+ message: string;
29692
+ path?: (string | number)[];
29693
+ schema?: string;
29694
+ }[];
29695
+ context?: unknown;
29696
+ };
29697
+ };
29698
+ };
29699
+ /** @description Forbidden */
29700
+ 403: {
29701
+ headers: {
29702
+ [name: string]: unknown;
29703
+ };
29704
+ content: {
29705
+ "application/json": {
29706
+ code: string;
29707
+ message: string;
29708
+ links?: {
29709
+ docs: string;
29710
+ schema: string;
29711
+ };
29712
+ issues?: {
29713
+ message: string;
29714
+ path?: (string | number)[];
29715
+ schema?: string;
29716
+ }[];
29717
+ context?: unknown;
29718
+ };
29719
+ };
29720
+ };
29721
+ /** @description Not found */
29722
+ 404: {
29723
+ headers: {
29724
+ [name: string]: unknown;
29725
+ };
29726
+ content: {
29727
+ "application/json": {
29728
+ code: string;
29729
+ message: string;
29730
+ links?: {
29731
+ docs: string;
29732
+ schema: string;
29733
+ };
29734
+ issues?: {
29735
+ message: string;
29736
+ path?: (string | number)[];
29737
+ schema?: string;
29738
+ }[];
29739
+ context?: unknown;
29740
+ };
29741
+ };
29742
+ };
29743
+ /** @description Internal server error */
29744
+ 500: {
29745
+ headers: {
29746
+ [name: string]: unknown;
29747
+ };
29748
+ content: {
29749
+ "application/json": {
29750
+ code: string;
29751
+ message: string;
29752
+ links?: {
29753
+ docs: string;
29754
+ schema: string;
29755
+ };
29756
+ issues?: {
29757
+ message: string;
29758
+ path?: (string | number)[];
29759
+ schema?: string;
29760
+ }[];
29761
+ context?: unknown;
29762
+ };
29763
+ };
29764
+ };
29765
+ /** @description Service unavailable */
29766
+ 503: {
29767
+ headers: {
29768
+ [name: string]: unknown;
29769
+ };
29770
+ content: {
29771
+ "application/json": {
29772
+ code: string;
29773
+ message: string;
29774
+ links?: {
29775
+ docs: string;
29776
+ schema: string;
29777
+ };
29778
+ issues?: {
29779
+ message: string;
29780
+ path?: (string | number)[];
29781
+ schema?: string;
29782
+ }[];
29783
+ context?: unknown;
29784
+ };
29785
+ };
29786
+ };
29787
+ };
29788
+ };
29587
29789
  postInternalUsers: {
29588
29790
  parameters: {
29589
29791
  query?: never;
@@ -39304,6 +39506,10 @@ export interface operations {
39304
39506
  /** Format: email */
39305
39507
  email: string;
39306
39508
  secondaryEmails: string[];
39509
+ /** @enum {string} */
39510
+ role: "admin" | "user";
39511
+ status: ("active" | "inactive" | "unconfirmed") | null;
39512
+ lastInvitedAt: string | null;
39307
39513
  partnerId: string | null;
39308
39514
  name: string | null;
39309
39515
  firstName: string | null;
@@ -39804,7 +40010,7 @@ export interface operations {
39804
40010
  offset?: number;
39805
40011
  };
39806
40012
  header?: {
39807
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
40013
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
39808
40014
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
39809
40015
  };
39810
40016
  path?: never;
@@ -40002,7 +40208,7 @@ export interface operations {
40002
40208
  offset?: number;
40003
40209
  };
40004
40210
  header?: {
40005
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
40211
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
40006
40212
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
40007
40213
  };
40008
40214
  path?: never;
@@ -40197,7 +40403,7 @@ export interface operations {
40197
40403
  parameters: {
40198
40404
  query?: never;
40199
40405
  header?: {
40200
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
40406
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
40201
40407
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
40202
40408
  };
40203
40409
  path: {
@@ -77542,7 +77748,7 @@ export interface operations {
77542
77748
  offset?: number;
77543
77749
  };
77544
77750
  header?: {
77545
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
77751
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
77546
77752
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
77547
77753
  };
77548
77754
  path?: never;
@@ -78247,7 +78453,7 @@ export interface operations {
78247
78453
  cursor?: string;
78248
78454
  };
78249
78455
  header?: {
78250
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
78456
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
78251
78457
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
78252
78458
  };
78253
78459
  path?: never;
@@ -79102,7 +79308,7 @@ export interface operations {
79102
79308
  offset?: number;
79103
79309
  };
79104
79310
  header?: {
79105
- /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
79311
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
79106
79312
  "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
79107
79313
  };
79108
79314
  path?: never;