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