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