@vrplatform/api 1.3.1-stage.4542 → 1.3.1-stage.4550

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.
@@ -1839,7 +1839,7 @@ export interface paths {
1839
1839
  path?: never;
1840
1840
  cookie?: never;
1841
1841
  };
1842
- /** @description UI bootstrap call: the authenticated user plus the resolved team (embedded-session team, x-team-id header, or the oldest active membership), including membership, owner access, effective feature IDs, issue counts, and frontend setup context. Embedded identities use sub instead of email, so user.email is null for them. */
1842
+ /** @description UI bootstrap call: the authenticated user plus the resolved team (embedded-session team, x-team-id header, or the oldest active membership), including placement, partner managed-team region discovery, membership, owner access, effective feature IDs, issue counts, and frontend setup context. Embedded identities use sub instead of email, so user.email is null for them. */
1843
1843
  get: operations["getMe"];
1844
1844
  put?: never;
1845
1845
  post?: never;
@@ -2289,6 +2289,23 @@ export interface paths {
2289
2289
  patch?: never;
2290
2290
  trace?: never;
2291
2291
  };
2292
+ "/partner/owner-statements": {
2293
+ parameters: {
2294
+ query?: never;
2295
+ header?: never;
2296
+ path?: never;
2297
+ cookie?: never;
2298
+ };
2299
+ /** @description List VRT teams in one regional partition of the partner portfolio with owner statement counts by status. Select the partition with x-data-region. */
2300
+ get: operations["getPartnerOwnerStatements"];
2301
+ put?: never;
2302
+ post?: never;
2303
+ delete?: never;
2304
+ options?: never;
2305
+ head?: never;
2306
+ patch?: never;
2307
+ trace?: never;
2308
+ };
2292
2309
  "/partner/users": {
2293
2310
  parameters: {
2294
2311
  query?: never;
@@ -2296,7 +2313,7 @@ export interface paths {
2296
2313
  path?: never;
2297
2314
  cookie?: never;
2298
2315
  };
2299
- /** @description List users across the partner portfolio (the partner and all of its teams) with their team memberships and owner accesses */
2316
+ /** @description List users across one regional partition of the partner portfolio with their team memberships and owner accesses. Select the partition with x-data-region. */
2300
2317
  get: operations["getPartnerUsers"];
2301
2318
  put?: never;
2302
2319
  post?: never;
@@ -2313,7 +2330,7 @@ export interface paths {
2313
2330
  path?: never;
2314
2331
  cookie?: never;
2315
2332
  };
2316
- /** @description Get a single portfolio user with their memberships across the partner and all of its teams, plus owner accesses */
2333
+ /** @description Get a single portfolio user with memberships and owner accesses from one regional partition. Select the partition with x-data-region. */
2317
2334
  get: operations["getPartnerUser"];
2318
2335
  put?: never;
2319
2336
  post?: never;
@@ -3870,7 +3887,7 @@ export interface paths {
3870
3887
  path?: never;
3871
3888
  cookie?: never;
3872
3889
  };
3873
- /** @description Get List of all Teams */
3890
+ /** @description List accessible teams in one regional data partition. Partner callers can select the partition with x-data-region. */
3874
3891
  get: operations["getTeams"];
3875
3892
  put?: never;
3876
3893
  /** @description Create team */
@@ -3888,7 +3905,7 @@ export interface paths {
3888
3905
  path?: never;
3889
3906
  cookie?: never;
3890
3907
  };
3891
- /** @description List cursor-paginated materialized issue summaries across accessible teams. */
3908
+ /** @description List cursor-paginated materialized issue summaries across accessible teams in one regional data partition. Partner callers can select the partition with x-data-region. */
3892
3909
  get: operations["getTeamsIssues"];
3893
3910
  put?: never;
3894
3911
  post?: never;
@@ -3905,7 +3922,7 @@ export interface paths {
3905
3922
  path?: never;
3906
3923
  cookie?: never;
3907
3924
  };
3908
- /** @description Look up teams by name */
3925
+ /** @description Look up accessible teams by name in one regional data partition. Partner callers can select the partition with x-data-region. */
3909
3926
  get: operations["getTeamsLookup"];
3910
3927
  put?: never;
3911
3928
  post?: never;
@@ -35301,6 +35318,10 @@ export interface operations {
35301
35318
  name: string | null;
35302
35319
  slug: string;
35303
35320
  /** @enum {string} */
35321
+ dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
35322
+ /** Format: uri */
35323
+ apiBaseUrl: string;
35324
+ /** @enum {string} */
35304
35325
  type: "propertyManager" | "partner";
35305
35326
  partnerId: string | null;
35306
35327
  isGeneralLedger: boolean;
@@ -35374,6 +35395,18 @@ export interface operations {
35374
35395
  ownerNeedsReviewId: string | null;
35375
35396
  guideOnboardingStatus: ("skipped" | "completed") | null;
35376
35397
  } | null;
35398
+ partnerContext: {
35399
+ managedTeamRegions: {
35400
+ /** @enum {string} */
35401
+ dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
35402
+ /** Format: uri */
35403
+ apiBaseUrl: string;
35404
+ counts: {
35405
+ active: number;
35406
+ inactive: number;
35407
+ };
35408
+ }[];
35409
+ } | null;
35377
35410
  };
35378
35411
  };
35379
35412
  };
@@ -39756,6 +39789,179 @@ export interface operations {
39756
39789
  };
39757
39790
  };
39758
39791
  };
39792
+ getPartnerOwnerStatements: {
39793
+ parameters: {
39794
+ query?: never;
39795
+ header?: {
39796
+ /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
39797
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
39798
+ };
39799
+ path?: never;
39800
+ cookie?: never;
39801
+ };
39802
+ requestBody?: never;
39803
+ responses: {
39804
+ /** @description Successful response */
39805
+ 200: {
39806
+ headers: {
39807
+ [name: string]: unknown;
39808
+ };
39809
+ content: {
39810
+ "application/json": {
39811
+ data: {
39812
+ /** Format: uuid */
39813
+ id: string;
39814
+ name: string;
39815
+ logo?: string;
39816
+ /**
39817
+ * Format: date-time
39818
+ * @description Timestamp string with date, time, milliseconds, and timezone.
39819
+ * @example 2024-01-15T12:30:00.000+00:00
39820
+ */
39821
+ createdAt: string;
39822
+ ownerStatements: {
39823
+ draft: number;
39824
+ inReview: number;
39825
+ published: number;
39826
+ };
39827
+ }[];
39828
+ };
39829
+ };
39830
+ };
39831
+ /** @description Bad request */
39832
+ 400: {
39833
+ headers: {
39834
+ [name: string]: unknown;
39835
+ };
39836
+ content: {
39837
+ "application/json": {
39838
+ code: string;
39839
+ message: string;
39840
+ links?: {
39841
+ docs: string;
39842
+ schema: string;
39843
+ };
39844
+ issues?: {
39845
+ message: string;
39846
+ path?: (string | number)[];
39847
+ schema?: string;
39848
+ }[];
39849
+ context?: unknown;
39850
+ };
39851
+ };
39852
+ };
39853
+ /** @description Unauthorized */
39854
+ 401: {
39855
+ headers: {
39856
+ [name: string]: unknown;
39857
+ };
39858
+ content: {
39859
+ "application/json": {
39860
+ code: string;
39861
+ message: string;
39862
+ links?: {
39863
+ docs: string;
39864
+ schema: string;
39865
+ };
39866
+ issues?: {
39867
+ message: string;
39868
+ path?: (string | number)[];
39869
+ schema?: string;
39870
+ }[];
39871
+ context?: unknown;
39872
+ };
39873
+ };
39874
+ };
39875
+ /** @description Forbidden */
39876
+ 403: {
39877
+ headers: {
39878
+ [name: string]: unknown;
39879
+ };
39880
+ content: {
39881
+ "application/json": {
39882
+ code: string;
39883
+ message: string;
39884
+ links?: {
39885
+ docs: string;
39886
+ schema: string;
39887
+ };
39888
+ issues?: {
39889
+ message: string;
39890
+ path?: (string | number)[];
39891
+ schema?: string;
39892
+ }[];
39893
+ context?: unknown;
39894
+ };
39895
+ };
39896
+ };
39897
+ /** @description Not found */
39898
+ 404: {
39899
+ headers: {
39900
+ [name: string]: unknown;
39901
+ };
39902
+ content: {
39903
+ "application/json": {
39904
+ code: string;
39905
+ message: string;
39906
+ links?: {
39907
+ docs: string;
39908
+ schema: string;
39909
+ };
39910
+ issues?: {
39911
+ message: string;
39912
+ path?: (string | number)[];
39913
+ schema?: string;
39914
+ }[];
39915
+ context?: unknown;
39916
+ };
39917
+ };
39918
+ };
39919
+ /** @description Internal server error */
39920
+ 500: {
39921
+ headers: {
39922
+ [name: string]: unknown;
39923
+ };
39924
+ content: {
39925
+ "application/json": {
39926
+ code: string;
39927
+ message: string;
39928
+ links?: {
39929
+ docs: string;
39930
+ schema: string;
39931
+ };
39932
+ issues?: {
39933
+ message: string;
39934
+ path?: (string | number)[];
39935
+ schema?: string;
39936
+ }[];
39937
+ context?: unknown;
39938
+ };
39939
+ };
39940
+ };
39941
+ /** @description Service unavailable */
39942
+ 503: {
39943
+ headers: {
39944
+ [name: string]: unknown;
39945
+ };
39946
+ content: {
39947
+ "application/json": {
39948
+ code: string;
39949
+ message: string;
39950
+ links?: {
39951
+ docs: string;
39952
+ schema: string;
39953
+ };
39954
+ issues?: {
39955
+ message: string;
39956
+ path?: (string | number)[];
39957
+ schema?: string;
39958
+ }[];
39959
+ context?: unknown;
39960
+ };
39961
+ };
39962
+ };
39963
+ };
39964
+ };
39759
39965
  getPartnerUsers: {
39760
39966
  parameters: {
39761
39967
  query?: {
@@ -39775,7 +39981,10 @@ export interface operations {
39775
39981
  page?: number;
39776
39982
  offset?: number;
39777
39983
  };
39778
- header?: never;
39984
+ header?: {
39985
+ /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
39986
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
39987
+ };
39779
39988
  path?: never;
39780
39989
  cookie?: never;
39781
39990
  };
@@ -39967,7 +40176,10 @@ export interface operations {
39967
40176
  getPartnerUser: {
39968
40177
  parameters: {
39969
40178
  query?: never;
39970
- header?: never;
40179
+ header?: {
40180
+ /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
40181
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
40182
+ };
39971
40183
  path: {
39972
40184
  id: string;
39973
40185
  };
@@ -77309,7 +77521,10 @@ export interface operations {
77309
77521
  page?: number;
77310
77522
  offset?: number;
77311
77523
  };
77312
- header?: never;
77524
+ header?: {
77525
+ /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
77526
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
77527
+ };
77313
77528
  path?: never;
77314
77529
  cookie?: never;
77315
77530
  };
@@ -78011,7 +78226,10 @@ export interface operations {
78011
78226
  /** @description Opaque pagination cursor returned by a previous response. Pass it back unchanged. */
78012
78227
  cursor?: string;
78013
78228
  };
78014
- header?: never;
78229
+ header?: {
78230
+ /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
78231
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
78232
+ };
78015
78233
  path?: never;
78016
78234
  cookie?: never;
78017
78235
  };
@@ -78863,7 +79081,10 @@ export interface operations {
78863
79081
  page?: number;
78864
79082
  offset?: number;
78865
79083
  };
78866
- header?: never;
79084
+ header?: {
79085
+ /** @description Selects the regional data partition for this partner portfolio read. It does not change the authenticated team context. */
79086
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
79087
+ };
78867
79088
  path?: never;
78868
79089
  cookie?: never;
78869
79090
  };