@vrplatform/api 1.3.1-6394 → 1.3.1-6399
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.
|
@@ -3604,6 +3604,27 @@ export interface paths {
|
|
|
3604
3604
|
patch?: never;
|
|
3605
3605
|
trace?: never;
|
|
3606
3606
|
};
|
|
3607
|
+
"/partner/teams": {
|
|
3608
|
+
parameters: {
|
|
3609
|
+
query?: never;
|
|
3610
|
+
header?: never;
|
|
3611
|
+
path?: never;
|
|
3612
|
+
cookie?: never;
|
|
3613
|
+
};
|
|
3614
|
+
/**
|
|
3615
|
+
* @description List property-manager teams managed by the authenticated partner across all data regions. Supports team IDs, name search, lifecycle filtering, deterministic sorting, and pagination.
|
|
3616
|
+
*
|
|
3617
|
+
* Required scope: teams:read
|
|
3618
|
+
*/
|
|
3619
|
+
get: operations["getPartnerTeams"];
|
|
3620
|
+
put?: never;
|
|
3621
|
+
post?: never;
|
|
3622
|
+
delete?: never;
|
|
3623
|
+
options?: never;
|
|
3624
|
+
head?: never;
|
|
3625
|
+
patch?: never;
|
|
3626
|
+
trace?: never;
|
|
3627
|
+
};
|
|
3607
3628
|
"/partner/users": {
|
|
3608
3629
|
parameters: {
|
|
3609
3630
|
query?: never;
|
|
@@ -5956,7 +5977,7 @@ export interface paths {
|
|
|
5956
5977
|
get: operations["getTeams"];
|
|
5957
5978
|
put?: never;
|
|
5958
5979
|
/**
|
|
5959
|
-
* @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /teams/
|
|
5980
|
+
* @description Create team. The generic gateway forwards an explicit dataRegion to that regional cell; an omitted region uses the receiving cell. Partner provisioning requires a uniqueRef. An exact repeat of a completed provision fails with 409 and context.existingTeamId identifies the existing team; changed retry payloads fail without it. Fetch that team with GET /me/teams or GET /partner/teams instead of creating it again. Retrying a provisioning request that failed before completing is safe. migratedFromTenantId atomically links a new GL team to a non-GL VRI source managed by the same partner; it is rejected for non-GL targets, GL sources, and sources managed by another partner. Generated and explicit slugs are checked against the global tenant registry before the regional tenant is written. defaultCurrency must exist in the target region currency catalog; unsupported values return 400 before creation. An explicit General Ledger copyFromTeamId must use the target data region; a mismatch returns 400 before either tenant registry is written. useCentralDefaults explicitly opts into the published Control Plane bootstrap and cannot be combined with either copy source.
|
|
5960
5981
|
*
|
|
5961
5982
|
* Required scope: teams:provision
|
|
5962
5983
|
*/
|
|
@@ -5996,7 +6017,8 @@ export interface paths {
|
|
|
5996
6017
|
cookie?: never;
|
|
5997
6018
|
};
|
|
5998
6019
|
/**
|
|
5999
|
-
* @
|
|
6020
|
+
* @deprecated
|
|
6021
|
+
* @description Deprecated: use GET /teams?search= for regional inventory, GET /me/teams for OAuth discovery, or GET /partner/teams for Partner API token discovery. This compatibility route searches accessible team names in one regional data partition; x-team-id is optional and Partner callers can select the partition with x-data-region.
|
|
6000
6022
|
*
|
|
6001
6023
|
* Required scope: teams:read
|
|
6002
6024
|
*/
|
|
@@ -73546,6 +73568,291 @@ export interface operations {
|
|
|
73546
73568
|
};
|
|
73547
73569
|
};
|
|
73548
73570
|
};
|
|
73571
|
+
getPartnerTeams: {
|
|
73572
|
+
parameters: {
|
|
73573
|
+
query?: {
|
|
73574
|
+
/** @description Comma-separated team IDs. */
|
|
73575
|
+
ids?: string;
|
|
73576
|
+
search?: string;
|
|
73577
|
+
status?: "active" | "inactive";
|
|
73578
|
+
/** @description Sort field; prefix with - for descending order */
|
|
73579
|
+
sort?: "created" | "-created" | "name" | "-name" | "type" | "-type";
|
|
73580
|
+
limit?: number;
|
|
73581
|
+
page?: number;
|
|
73582
|
+
offset?: number;
|
|
73583
|
+
};
|
|
73584
|
+
header?: never;
|
|
73585
|
+
path?: never;
|
|
73586
|
+
cookie?: never;
|
|
73587
|
+
};
|
|
73588
|
+
requestBody?: never;
|
|
73589
|
+
responses: {
|
|
73590
|
+
/** @description Successful response */
|
|
73591
|
+
200: {
|
|
73592
|
+
headers: {
|
|
73593
|
+
[name: string]: unknown;
|
|
73594
|
+
};
|
|
73595
|
+
content: {
|
|
73596
|
+
"application/json": {
|
|
73597
|
+
data: {
|
|
73598
|
+
/** Format: uuid */
|
|
73599
|
+
id: string;
|
|
73600
|
+
name: string;
|
|
73601
|
+
slug: string;
|
|
73602
|
+
/** @enum {string} */
|
|
73603
|
+
dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
73604
|
+
/** Format: uri */
|
|
73605
|
+
apiBaseUrl: string;
|
|
73606
|
+
/** @constant */
|
|
73607
|
+
type: "propertyManager";
|
|
73608
|
+
/** Format: uuid */
|
|
73609
|
+
partnerId: string;
|
|
73610
|
+
/** @description Effective billing partner ID: the explicit billing partner, otherwise the accounting partner. */
|
|
73611
|
+
billingPartnerId: string | null;
|
|
73612
|
+
/** @enum {string} */
|
|
73613
|
+
status: "active" | "inactive";
|
|
73614
|
+
/** @description Whether the team uses General Ledger, derived from its authoritative control-plane storage realm. */
|
|
73615
|
+
isGeneralLedger: boolean;
|
|
73616
|
+
}[];
|
|
73617
|
+
pagination: {
|
|
73618
|
+
/** @default 100 */
|
|
73619
|
+
limit: number;
|
|
73620
|
+
/** @default 1 */
|
|
73621
|
+
page: number;
|
|
73622
|
+
total: number;
|
|
73623
|
+
totalPage: number;
|
|
73624
|
+
nextPage?: number;
|
|
73625
|
+
};
|
|
73626
|
+
};
|
|
73627
|
+
};
|
|
73628
|
+
};
|
|
73629
|
+
/** @description Bad request */
|
|
73630
|
+
400: {
|
|
73631
|
+
headers: {
|
|
73632
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73633
|
+
"Retry-After"?: number;
|
|
73634
|
+
[name: string]: unknown;
|
|
73635
|
+
};
|
|
73636
|
+
content: {
|
|
73637
|
+
"application/json": {
|
|
73638
|
+
code: string;
|
|
73639
|
+
message: string;
|
|
73640
|
+
links?: {
|
|
73641
|
+
docs: string;
|
|
73642
|
+
schema: string;
|
|
73643
|
+
};
|
|
73644
|
+
issues?: {
|
|
73645
|
+
message: string;
|
|
73646
|
+
path?: (string | number)[];
|
|
73647
|
+
schema?: string;
|
|
73648
|
+
}[];
|
|
73649
|
+
retryable?: boolean;
|
|
73650
|
+
context?: unknown;
|
|
73651
|
+
};
|
|
73652
|
+
};
|
|
73653
|
+
};
|
|
73654
|
+
/** @description Unauthorized */
|
|
73655
|
+
401: {
|
|
73656
|
+
headers: {
|
|
73657
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73658
|
+
"Retry-After"?: number;
|
|
73659
|
+
[name: string]: unknown;
|
|
73660
|
+
};
|
|
73661
|
+
content: {
|
|
73662
|
+
"application/json": {
|
|
73663
|
+
code: string;
|
|
73664
|
+
message: string;
|
|
73665
|
+
links?: {
|
|
73666
|
+
docs: string;
|
|
73667
|
+
schema: string;
|
|
73668
|
+
};
|
|
73669
|
+
issues?: {
|
|
73670
|
+
message: string;
|
|
73671
|
+
path?: (string | number)[];
|
|
73672
|
+
schema?: string;
|
|
73673
|
+
}[];
|
|
73674
|
+
retryable?: boolean;
|
|
73675
|
+
context?: unknown;
|
|
73676
|
+
};
|
|
73677
|
+
};
|
|
73678
|
+
};
|
|
73679
|
+
/** @description Forbidden */
|
|
73680
|
+
403: {
|
|
73681
|
+
headers: {
|
|
73682
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73683
|
+
"Retry-After"?: number;
|
|
73684
|
+
[name: string]: unknown;
|
|
73685
|
+
};
|
|
73686
|
+
content: {
|
|
73687
|
+
"application/json": {
|
|
73688
|
+
code: string;
|
|
73689
|
+
message: string;
|
|
73690
|
+
links?: {
|
|
73691
|
+
docs: string;
|
|
73692
|
+
schema: string;
|
|
73693
|
+
};
|
|
73694
|
+
issues?: {
|
|
73695
|
+
message: string;
|
|
73696
|
+
path?: (string | number)[];
|
|
73697
|
+
schema?: string;
|
|
73698
|
+
}[];
|
|
73699
|
+
retryable?: boolean;
|
|
73700
|
+
context?: unknown;
|
|
73701
|
+
};
|
|
73702
|
+
};
|
|
73703
|
+
};
|
|
73704
|
+
/** @description Not found */
|
|
73705
|
+
404: {
|
|
73706
|
+
headers: {
|
|
73707
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73708
|
+
"Retry-After"?: number;
|
|
73709
|
+
[name: string]: unknown;
|
|
73710
|
+
};
|
|
73711
|
+
content: {
|
|
73712
|
+
"application/json": {
|
|
73713
|
+
code: string;
|
|
73714
|
+
message: string;
|
|
73715
|
+
links?: {
|
|
73716
|
+
docs: string;
|
|
73717
|
+
schema: string;
|
|
73718
|
+
};
|
|
73719
|
+
issues?: {
|
|
73720
|
+
message: string;
|
|
73721
|
+
path?: (string | number)[];
|
|
73722
|
+
schema?: string;
|
|
73723
|
+
}[];
|
|
73724
|
+
retryable?: boolean;
|
|
73725
|
+
context?: unknown;
|
|
73726
|
+
};
|
|
73727
|
+
};
|
|
73728
|
+
};
|
|
73729
|
+
/** @description Conflict */
|
|
73730
|
+
409: {
|
|
73731
|
+
headers: {
|
|
73732
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73733
|
+
"Retry-After"?: number;
|
|
73734
|
+
[name: string]: unknown;
|
|
73735
|
+
};
|
|
73736
|
+
content: {
|
|
73737
|
+
"application/json": {
|
|
73738
|
+
code: string;
|
|
73739
|
+
message: string;
|
|
73740
|
+
links?: {
|
|
73741
|
+
docs: string;
|
|
73742
|
+
schema: string;
|
|
73743
|
+
};
|
|
73744
|
+
issues?: {
|
|
73745
|
+
message: string;
|
|
73746
|
+
path?: (string | number)[];
|
|
73747
|
+
schema?: string;
|
|
73748
|
+
}[];
|
|
73749
|
+
retryable?: boolean;
|
|
73750
|
+
context?: unknown;
|
|
73751
|
+
};
|
|
73752
|
+
};
|
|
73753
|
+
};
|
|
73754
|
+
/** @description Gone */
|
|
73755
|
+
410: {
|
|
73756
|
+
headers: {
|
|
73757
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73758
|
+
"Retry-After"?: number;
|
|
73759
|
+
[name: string]: unknown;
|
|
73760
|
+
};
|
|
73761
|
+
content: {
|
|
73762
|
+
"application/json": {
|
|
73763
|
+
code: string;
|
|
73764
|
+
message: string;
|
|
73765
|
+
links?: {
|
|
73766
|
+
docs: string;
|
|
73767
|
+
schema: string;
|
|
73768
|
+
};
|
|
73769
|
+
issues?: {
|
|
73770
|
+
message: string;
|
|
73771
|
+
path?: (string | number)[];
|
|
73772
|
+
schema?: string;
|
|
73773
|
+
}[];
|
|
73774
|
+
retryable?: boolean;
|
|
73775
|
+
context?: unknown;
|
|
73776
|
+
};
|
|
73777
|
+
};
|
|
73778
|
+
};
|
|
73779
|
+
/** @description Unprocessable content */
|
|
73780
|
+
422: {
|
|
73781
|
+
headers: {
|
|
73782
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73783
|
+
"Retry-After"?: number;
|
|
73784
|
+
[name: string]: unknown;
|
|
73785
|
+
};
|
|
73786
|
+
content: {
|
|
73787
|
+
"application/json": {
|
|
73788
|
+
code: string;
|
|
73789
|
+
message: string;
|
|
73790
|
+
links?: {
|
|
73791
|
+
docs: string;
|
|
73792
|
+
schema: string;
|
|
73793
|
+
};
|
|
73794
|
+
issues?: {
|
|
73795
|
+
message: string;
|
|
73796
|
+
path?: (string | number)[];
|
|
73797
|
+
schema?: string;
|
|
73798
|
+
}[];
|
|
73799
|
+
retryable?: boolean;
|
|
73800
|
+
context?: unknown;
|
|
73801
|
+
};
|
|
73802
|
+
};
|
|
73803
|
+
};
|
|
73804
|
+
/** @description Internal server error */
|
|
73805
|
+
500: {
|
|
73806
|
+
headers: {
|
|
73807
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73808
|
+
"Retry-After"?: number;
|
|
73809
|
+
[name: string]: unknown;
|
|
73810
|
+
};
|
|
73811
|
+
content: {
|
|
73812
|
+
"application/json": {
|
|
73813
|
+
code: string;
|
|
73814
|
+
message: string;
|
|
73815
|
+
links?: {
|
|
73816
|
+
docs: string;
|
|
73817
|
+
schema: string;
|
|
73818
|
+
};
|
|
73819
|
+
issues?: {
|
|
73820
|
+
message: string;
|
|
73821
|
+
path?: (string | number)[];
|
|
73822
|
+
schema?: string;
|
|
73823
|
+
}[];
|
|
73824
|
+
retryable?: boolean;
|
|
73825
|
+
context?: unknown;
|
|
73826
|
+
};
|
|
73827
|
+
};
|
|
73828
|
+
};
|
|
73829
|
+
/** @description Service unavailable */
|
|
73830
|
+
503: {
|
|
73831
|
+
headers: {
|
|
73832
|
+
/** @description Seconds to wait when retryable=true and the server supplies a delay. */
|
|
73833
|
+
"Retry-After"?: number;
|
|
73834
|
+
[name: string]: unknown;
|
|
73835
|
+
};
|
|
73836
|
+
content: {
|
|
73837
|
+
"application/json": {
|
|
73838
|
+
code: string;
|
|
73839
|
+
message: string;
|
|
73840
|
+
links?: {
|
|
73841
|
+
docs: string;
|
|
73842
|
+
schema: string;
|
|
73843
|
+
};
|
|
73844
|
+
issues?: {
|
|
73845
|
+
message: string;
|
|
73846
|
+
path?: (string | number)[];
|
|
73847
|
+
schema?: string;
|
|
73848
|
+
}[];
|
|
73849
|
+
retryable?: boolean;
|
|
73850
|
+
context?: unknown;
|
|
73851
|
+
};
|
|
73852
|
+
};
|
|
73853
|
+
};
|
|
73854
|
+
};
|
|
73855
|
+
};
|
|
73549
73856
|
getPartnerUsers: {
|
|
73550
73857
|
parameters: {
|
|
73551
73858
|
query?: {
|