@vrplatform/api 1.3.1-stage.4717 → 1.3.1-stage.4720
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.
|
@@ -2627,6 +2627,27 @@ export interface paths {
|
|
|
2627
2627
|
patch?: never;
|
|
2628
2628
|
trace?: never;
|
|
2629
2629
|
};
|
|
2630
|
+
"/partner/billing": {
|
|
2631
|
+
parameters: {
|
|
2632
|
+
query?: never;
|
|
2633
|
+
header?: never;
|
|
2634
|
+
path?: never;
|
|
2635
|
+
cookie?: never;
|
|
2636
|
+
};
|
|
2637
|
+
/**
|
|
2638
|
+
* @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 per team, including deleted teams; the current month uses live active-listing counts. Filters run before deterministic sorting, totals, and pagination. Select the partition with x-data-region.
|
|
2639
|
+
*
|
|
2640
|
+
* Required scope: teams:read
|
|
2641
|
+
*/
|
|
2642
|
+
get: operations["getPartnerBilling"];
|
|
2643
|
+
put?: never;
|
|
2644
|
+
post?: never;
|
|
2645
|
+
delete?: never;
|
|
2646
|
+
options?: never;
|
|
2647
|
+
head?: never;
|
|
2648
|
+
patch?: never;
|
|
2649
|
+
trace?: never;
|
|
2650
|
+
};
|
|
2630
2651
|
"/partner/connections": {
|
|
2631
2652
|
parameters: {
|
|
2632
2653
|
query?: never;
|
|
@@ -3828,7 +3849,7 @@ export interface paths {
|
|
|
3828
3849
|
cookie?: never;
|
|
3829
3850
|
};
|
|
3830
3851
|
/**
|
|
3831
|
-
* @description Get reservation
|
|
3852
|
+
* @description Get reservation detail with financial totals, inactive lines, locks, and issues. Pre-start rows return priorToStartDate.
|
|
3832
3853
|
*
|
|
3833
3854
|
* Required scope: reservations:read
|
|
3834
3855
|
*/
|
|
@@ -42524,6 +42545,218 @@ export interface operations {
|
|
|
42524
42545
|
};
|
|
42525
42546
|
};
|
|
42526
42547
|
};
|
|
42548
|
+
getPartnerBilling: {
|
|
42549
|
+
parameters: {
|
|
42550
|
+
query: {
|
|
42551
|
+
/** @description Month string in format `YYYY-MM`. */
|
|
42552
|
+
month: string;
|
|
42553
|
+
/** @description Filter by team or company name */
|
|
42554
|
+
search?: string;
|
|
42555
|
+
status?: "active" | "inactive" | "onboarding";
|
|
42556
|
+
partnerId?: string;
|
|
42557
|
+
product?: "vrtrust" | "vrintegrations";
|
|
42558
|
+
billingPlan?: string;
|
|
42559
|
+
/** @description Field to sort by, defaults to created */
|
|
42560
|
+
sortBy?: "name" | "created" | "partnerName" | "product" | "activeListings" | "billingPlan";
|
|
42561
|
+
/** @description Sort direction, defaults to desc */
|
|
42562
|
+
sortDirection?: "asc" | "desc";
|
|
42563
|
+
limit?: number;
|
|
42564
|
+
page?: number;
|
|
42565
|
+
offset?: number;
|
|
42566
|
+
};
|
|
42567
|
+
header?: {
|
|
42568
|
+
/** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
|
|
42569
|
+
"x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
|
|
42570
|
+
};
|
|
42571
|
+
path?: never;
|
|
42572
|
+
cookie?: never;
|
|
42573
|
+
};
|
|
42574
|
+
requestBody?: never;
|
|
42575
|
+
responses: {
|
|
42576
|
+
/** @description Successful response */
|
|
42577
|
+
200: {
|
|
42578
|
+
headers: {
|
|
42579
|
+
[name: string]: unknown;
|
|
42580
|
+
};
|
|
42581
|
+
content: {
|
|
42582
|
+
"application/json": {
|
|
42583
|
+
data: {
|
|
42584
|
+
/** Format: uuid */
|
|
42585
|
+
id: string;
|
|
42586
|
+
name: string | null;
|
|
42587
|
+
logo: string | null;
|
|
42588
|
+
/** @enum {string} */
|
|
42589
|
+
status: "active" | "inactive" | "deleted";
|
|
42590
|
+
/** @constant */
|
|
42591
|
+
type: "propertyManager";
|
|
42592
|
+
isOnboarding: boolean;
|
|
42593
|
+
isBillable: boolean | null;
|
|
42594
|
+
isGeneralLedger: boolean | null;
|
|
42595
|
+
partner: {
|
|
42596
|
+
/** Format: uuid */
|
|
42597
|
+
id: string;
|
|
42598
|
+
name: string;
|
|
42599
|
+
} | null;
|
|
42600
|
+
billingPartner: {
|
|
42601
|
+
/** Format: uuid */
|
|
42602
|
+
id: string;
|
|
42603
|
+
name: string;
|
|
42604
|
+
} | null;
|
|
42605
|
+
billingCustomerId: string | null;
|
|
42606
|
+
billingSubscriptionStatus: string | null;
|
|
42607
|
+
intercomId: string | null;
|
|
42608
|
+
billingPlan: string | null;
|
|
42609
|
+
migratedFromTenantId: string | null;
|
|
42610
|
+
createdAt: string | null;
|
|
42611
|
+
cancelledAt: string | null;
|
|
42612
|
+
activeListings: number;
|
|
42613
|
+
}[];
|
|
42614
|
+
pagination: {
|
|
42615
|
+
/** @default 100 */
|
|
42616
|
+
limit: number;
|
|
42617
|
+
/** @default 1 */
|
|
42618
|
+
page: number;
|
|
42619
|
+
total: number;
|
|
42620
|
+
totalPage: number;
|
|
42621
|
+
nextPage?: number;
|
|
42622
|
+
};
|
|
42623
|
+
};
|
|
42624
|
+
};
|
|
42625
|
+
};
|
|
42626
|
+
/** @description Bad request */
|
|
42627
|
+
400: {
|
|
42628
|
+
headers: {
|
|
42629
|
+
[name: string]: unknown;
|
|
42630
|
+
};
|
|
42631
|
+
content: {
|
|
42632
|
+
"application/json": {
|
|
42633
|
+
code: string;
|
|
42634
|
+
message: string;
|
|
42635
|
+
links?: {
|
|
42636
|
+
docs: string;
|
|
42637
|
+
schema: string;
|
|
42638
|
+
};
|
|
42639
|
+
issues?: {
|
|
42640
|
+
message: string;
|
|
42641
|
+
path?: (string | number)[];
|
|
42642
|
+
schema?: string;
|
|
42643
|
+
}[];
|
|
42644
|
+
context?: unknown;
|
|
42645
|
+
};
|
|
42646
|
+
};
|
|
42647
|
+
};
|
|
42648
|
+
/** @description Unauthorized */
|
|
42649
|
+
401: {
|
|
42650
|
+
headers: {
|
|
42651
|
+
[name: string]: unknown;
|
|
42652
|
+
};
|
|
42653
|
+
content: {
|
|
42654
|
+
"application/json": {
|
|
42655
|
+
code: string;
|
|
42656
|
+
message: string;
|
|
42657
|
+
links?: {
|
|
42658
|
+
docs: string;
|
|
42659
|
+
schema: string;
|
|
42660
|
+
};
|
|
42661
|
+
issues?: {
|
|
42662
|
+
message: string;
|
|
42663
|
+
path?: (string | number)[];
|
|
42664
|
+
schema?: string;
|
|
42665
|
+
}[];
|
|
42666
|
+
context?: unknown;
|
|
42667
|
+
};
|
|
42668
|
+
};
|
|
42669
|
+
};
|
|
42670
|
+
/** @description Forbidden */
|
|
42671
|
+
403: {
|
|
42672
|
+
headers: {
|
|
42673
|
+
[name: string]: unknown;
|
|
42674
|
+
};
|
|
42675
|
+
content: {
|
|
42676
|
+
"application/json": {
|
|
42677
|
+
code: string;
|
|
42678
|
+
message: string;
|
|
42679
|
+
links?: {
|
|
42680
|
+
docs: string;
|
|
42681
|
+
schema: string;
|
|
42682
|
+
};
|
|
42683
|
+
issues?: {
|
|
42684
|
+
message: string;
|
|
42685
|
+
path?: (string | number)[];
|
|
42686
|
+
schema?: string;
|
|
42687
|
+
}[];
|
|
42688
|
+
context?: unknown;
|
|
42689
|
+
};
|
|
42690
|
+
};
|
|
42691
|
+
};
|
|
42692
|
+
/** @description Not found */
|
|
42693
|
+
404: {
|
|
42694
|
+
headers: {
|
|
42695
|
+
[name: string]: unknown;
|
|
42696
|
+
};
|
|
42697
|
+
content: {
|
|
42698
|
+
"application/json": {
|
|
42699
|
+
code: string;
|
|
42700
|
+
message: string;
|
|
42701
|
+
links?: {
|
|
42702
|
+
docs: string;
|
|
42703
|
+
schema: string;
|
|
42704
|
+
};
|
|
42705
|
+
issues?: {
|
|
42706
|
+
message: string;
|
|
42707
|
+
path?: (string | number)[];
|
|
42708
|
+
schema?: string;
|
|
42709
|
+
}[];
|
|
42710
|
+
context?: unknown;
|
|
42711
|
+
};
|
|
42712
|
+
};
|
|
42713
|
+
};
|
|
42714
|
+
/** @description Internal server error */
|
|
42715
|
+
500: {
|
|
42716
|
+
headers: {
|
|
42717
|
+
[name: string]: unknown;
|
|
42718
|
+
};
|
|
42719
|
+
content: {
|
|
42720
|
+
"application/json": {
|
|
42721
|
+
code: string;
|
|
42722
|
+
message: string;
|
|
42723
|
+
links?: {
|
|
42724
|
+
docs: string;
|
|
42725
|
+
schema: string;
|
|
42726
|
+
};
|
|
42727
|
+
issues?: {
|
|
42728
|
+
message: string;
|
|
42729
|
+
path?: (string | number)[];
|
|
42730
|
+
schema?: string;
|
|
42731
|
+
}[];
|
|
42732
|
+
context?: unknown;
|
|
42733
|
+
};
|
|
42734
|
+
};
|
|
42735
|
+
};
|
|
42736
|
+
/** @description Service unavailable */
|
|
42737
|
+
503: {
|
|
42738
|
+
headers: {
|
|
42739
|
+
[name: string]: unknown;
|
|
42740
|
+
};
|
|
42741
|
+
content: {
|
|
42742
|
+
"application/json": {
|
|
42743
|
+
code: string;
|
|
42744
|
+
message: string;
|
|
42745
|
+
links?: {
|
|
42746
|
+
docs: string;
|
|
42747
|
+
schema: string;
|
|
42748
|
+
};
|
|
42749
|
+
issues?: {
|
|
42750
|
+
message: string;
|
|
42751
|
+
path?: (string | number)[];
|
|
42752
|
+
schema?: string;
|
|
42753
|
+
}[];
|
|
42754
|
+
context?: unknown;
|
|
42755
|
+
};
|
|
42756
|
+
};
|
|
42757
|
+
};
|
|
42758
|
+
};
|
|
42759
|
+
};
|
|
42527
42760
|
getPartnerConnections: {
|
|
42528
42761
|
parameters: {
|
|
42529
42762
|
query?: {
|