@vrplatform/api 1.3.1-stage.4736 → 1.3.1-stage.4738
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.
|
@@ -2584,7 +2584,7 @@ export interface paths {
|
|
|
2584
2584
|
cookie?: never;
|
|
2585
2585
|
};
|
|
2586
2586
|
/**
|
|
2587
|
-
* @description List property-manager teams billed by the authenticated partner for one month in a regional partition. Completed months use the latest retained listings_reported event
|
|
2587
|
+
* @description List property-manager teams billed by the authenticated partner for one month in a regional partition. Completed months use the latest retained listings_reported event explicitly attributed to the partner through the legacy date-only month-end cutoff. A currently billed team without an attributed event uses its live count only when it has another listing report in that historical window. Current months use live active-listing counts. Live non-GL counts use calculated listing status, while GL counts use ownership-period deactivation. Filters run before deterministic sorting, totals, and pagination. Select the partition with x-data-region.
|
|
2588
2588
|
*
|
|
2589
2589
|
* Required scope: teams:read
|
|
2590
2590
|
*/
|
|
@@ -2660,6 +2660,27 @@ export interface paths {
|
|
|
2660
2660
|
patch?: never;
|
|
2661
2661
|
trace?: never;
|
|
2662
2662
|
};
|
|
2663
|
+
"/partner/listings": {
|
|
2664
|
+
parameters: {
|
|
2665
|
+
query?: never;
|
|
2666
|
+
header?: never;
|
|
2667
|
+
path?: never;
|
|
2668
|
+
cookie?: never;
|
|
2669
|
+
};
|
|
2670
|
+
/**
|
|
2671
|
+
* @description List active property-manager listings for the authorized partner portfolio in one regional partition. Team, company, lifecycle, accounting-partner, effective billing-partner, subscription, billing-plan, product, and feature filters run before totals and pagination. Rows are ordered deterministically by team name and calculated listing name and include structured and full addresses. Select the partition with x-data-region.
|
|
2672
|
+
*
|
|
2673
|
+
* Required scope: teams:read
|
|
2674
|
+
*/
|
|
2675
|
+
get: operations["getPartnerListings"];
|
|
2676
|
+
put?: never;
|
|
2677
|
+
post?: never;
|
|
2678
|
+
delete?: never;
|
|
2679
|
+
options?: never;
|
|
2680
|
+
head?: never;
|
|
2681
|
+
patch?: never;
|
|
2682
|
+
trace?: never;
|
|
2683
|
+
};
|
|
2663
2684
|
"/partner/members": {
|
|
2664
2685
|
parameters: {
|
|
2665
2686
|
query?: never;
|
|
@@ -42783,6 +42804,207 @@ export interface operations {
|
|
|
42783
42804
|
};
|
|
42784
42805
|
};
|
|
42785
42806
|
};
|
|
42807
|
+
getPartnerListings: {
|
|
42808
|
+
parameters: {
|
|
42809
|
+
query?: {
|
|
42810
|
+
search?: string;
|
|
42811
|
+
partnerId?: string;
|
|
42812
|
+
billingPartnerId?: string;
|
|
42813
|
+
billingSubscriptionStatus?: "active" | "pending" | "paused" | "cancelled" | "pendingCancellation" | "draft" | "voided" | "errored" | "missing" | "viaPartner";
|
|
42814
|
+
billingPlan?: string;
|
|
42815
|
+
product?: "vrtrust" | "vrintegrations";
|
|
42816
|
+
/** @description Comma-separated team IDs. */
|
|
42817
|
+
ids?: string;
|
|
42818
|
+
status?: "active" | "inactive";
|
|
42819
|
+
/** @description Filter by team onboarding state. */
|
|
42820
|
+
isOnboarding?: boolean;
|
|
42821
|
+
/** @description Comma-separated enabled feature IDs. */
|
|
42822
|
+
featureIds?: string;
|
|
42823
|
+
limit?: number;
|
|
42824
|
+
page?: number;
|
|
42825
|
+
offset?: number;
|
|
42826
|
+
};
|
|
42827
|
+
header?: {
|
|
42828
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
42829
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
42830
|
+
};
|
|
42831
|
+
path?: never;
|
|
42832
|
+
cookie?: never;
|
|
42833
|
+
};
|
|
42834
|
+
requestBody?: never;
|
|
42835
|
+
responses: {
|
|
42836
|
+
/** @description Successful response */
|
|
42837
|
+
200: {
|
|
42838
|
+
headers: {
|
|
42839
|
+
[name: string]: unknown;
|
|
42840
|
+
};
|
|
42841
|
+
content: {
|
|
42842
|
+
"application/json": {
|
|
42843
|
+
data: {
|
|
42844
|
+
/** Format: uuid */
|
|
42845
|
+
id: string;
|
|
42846
|
+
name: string;
|
|
42847
|
+
team: {
|
|
42848
|
+
/** Format: uuid */
|
|
42849
|
+
id: string;
|
|
42850
|
+
name: string;
|
|
42851
|
+
};
|
|
42852
|
+
address: {
|
|
42853
|
+
line1: string | null;
|
|
42854
|
+
line2: string | null;
|
|
42855
|
+
city: string | null;
|
|
42856
|
+
postcode: string | null;
|
|
42857
|
+
stateCode: string | null;
|
|
42858
|
+
countryCode: string | null;
|
|
42859
|
+
full: string | null;
|
|
42860
|
+
};
|
|
42861
|
+
}[];
|
|
42862
|
+
pagination: {
|
|
42863
|
+
/** @default 100 */
|
|
42864
|
+
limit: number;
|
|
42865
|
+
/** @default 1 */
|
|
42866
|
+
page: number;
|
|
42867
|
+
total: number;
|
|
42868
|
+
totalPage: number;
|
|
42869
|
+
nextPage?: number;
|
|
42870
|
+
};
|
|
42871
|
+
};
|
|
42872
|
+
};
|
|
42873
|
+
};
|
|
42874
|
+
/** @description Bad request */
|
|
42875
|
+
400: {
|
|
42876
|
+
headers: {
|
|
42877
|
+
[name: string]: unknown;
|
|
42878
|
+
};
|
|
42879
|
+
content: {
|
|
42880
|
+
"application/json": {
|
|
42881
|
+
code: string;
|
|
42882
|
+
message: string;
|
|
42883
|
+
links?: {
|
|
42884
|
+
docs: string;
|
|
42885
|
+
schema: string;
|
|
42886
|
+
};
|
|
42887
|
+
issues?: {
|
|
42888
|
+
message: string;
|
|
42889
|
+
path?: (string | number)[];
|
|
42890
|
+
schema?: string;
|
|
42891
|
+
}[];
|
|
42892
|
+
context?: unknown;
|
|
42893
|
+
};
|
|
42894
|
+
};
|
|
42895
|
+
};
|
|
42896
|
+
/** @description Unauthorized */
|
|
42897
|
+
401: {
|
|
42898
|
+
headers: {
|
|
42899
|
+
[name: string]: unknown;
|
|
42900
|
+
};
|
|
42901
|
+
content: {
|
|
42902
|
+
"application/json": {
|
|
42903
|
+
code: string;
|
|
42904
|
+
message: string;
|
|
42905
|
+
links?: {
|
|
42906
|
+
docs: string;
|
|
42907
|
+
schema: string;
|
|
42908
|
+
};
|
|
42909
|
+
issues?: {
|
|
42910
|
+
message: string;
|
|
42911
|
+
path?: (string | number)[];
|
|
42912
|
+
schema?: string;
|
|
42913
|
+
}[];
|
|
42914
|
+
context?: unknown;
|
|
42915
|
+
};
|
|
42916
|
+
};
|
|
42917
|
+
};
|
|
42918
|
+
/** @description Forbidden */
|
|
42919
|
+
403: {
|
|
42920
|
+
headers: {
|
|
42921
|
+
[name: string]: unknown;
|
|
42922
|
+
};
|
|
42923
|
+
content: {
|
|
42924
|
+
"application/json": {
|
|
42925
|
+
code: string;
|
|
42926
|
+
message: string;
|
|
42927
|
+
links?: {
|
|
42928
|
+
docs: string;
|
|
42929
|
+
schema: string;
|
|
42930
|
+
};
|
|
42931
|
+
issues?: {
|
|
42932
|
+
message: string;
|
|
42933
|
+
path?: (string | number)[];
|
|
42934
|
+
schema?: string;
|
|
42935
|
+
}[];
|
|
42936
|
+
context?: unknown;
|
|
42937
|
+
};
|
|
42938
|
+
};
|
|
42939
|
+
};
|
|
42940
|
+
/** @description Not found */
|
|
42941
|
+
404: {
|
|
42942
|
+
headers: {
|
|
42943
|
+
[name: string]: unknown;
|
|
42944
|
+
};
|
|
42945
|
+
content: {
|
|
42946
|
+
"application/json": {
|
|
42947
|
+
code: string;
|
|
42948
|
+
message: string;
|
|
42949
|
+
links?: {
|
|
42950
|
+
docs: string;
|
|
42951
|
+
schema: string;
|
|
42952
|
+
};
|
|
42953
|
+
issues?: {
|
|
42954
|
+
message: string;
|
|
42955
|
+
path?: (string | number)[];
|
|
42956
|
+
schema?: string;
|
|
42957
|
+
}[];
|
|
42958
|
+
context?: unknown;
|
|
42959
|
+
};
|
|
42960
|
+
};
|
|
42961
|
+
};
|
|
42962
|
+
/** @description Internal server error */
|
|
42963
|
+
500: {
|
|
42964
|
+
headers: {
|
|
42965
|
+
[name: string]: unknown;
|
|
42966
|
+
};
|
|
42967
|
+
content: {
|
|
42968
|
+
"application/json": {
|
|
42969
|
+
code: string;
|
|
42970
|
+
message: string;
|
|
42971
|
+
links?: {
|
|
42972
|
+
docs: string;
|
|
42973
|
+
schema: string;
|
|
42974
|
+
};
|
|
42975
|
+
issues?: {
|
|
42976
|
+
message: string;
|
|
42977
|
+
path?: (string | number)[];
|
|
42978
|
+
schema?: string;
|
|
42979
|
+
}[];
|
|
42980
|
+
context?: unknown;
|
|
42981
|
+
};
|
|
42982
|
+
};
|
|
42983
|
+
};
|
|
42984
|
+
/** @description Service unavailable */
|
|
42985
|
+
503: {
|
|
42986
|
+
headers: {
|
|
42987
|
+
[name: string]: unknown;
|
|
42988
|
+
};
|
|
42989
|
+
content: {
|
|
42990
|
+
"application/json": {
|
|
42991
|
+
code: string;
|
|
42992
|
+
message: string;
|
|
42993
|
+
links?: {
|
|
42994
|
+
docs: string;
|
|
42995
|
+
schema: string;
|
|
42996
|
+
};
|
|
42997
|
+
issues?: {
|
|
42998
|
+
message: string;
|
|
42999
|
+
path?: (string | number)[];
|
|
43000
|
+
schema?: string;
|
|
43001
|
+
}[];
|
|
43002
|
+
context?: unknown;
|
|
43003
|
+
};
|
|
43004
|
+
};
|
|
43005
|
+
};
|
|
43006
|
+
};
|
|
43007
|
+
};
|
|
42786
43008
|
getPartnerMembers: {
|
|
42787
43009
|
parameters: {
|
|
42788
43010
|
query?: never;
|