@vrplatform/api 1.3.1-stage.5388 → 1.3.1-stage.5398

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.
@@ -1142,7 +1142,7 @@ export interface paths {
1142
1142
  get?: never;
1143
1143
  put?: never;
1144
1144
  /**
1145
- * @description Send owner ACH details to the single active Ramp push-vendor flow for verification. The server resolves the connection; clients do not select one. Raw routing and account numbers are write-only and are never stored by VRPlatform. The contact becomes ready only after Ramp confirms the account.
1145
+ * @description Send owner ACH details to the single eligible Ramp push-vendor flow for verification. The server resolves the connection; clients do not select one. First use activates a flow that has never been configured, while an explicitly inactive flow remains unavailable. Raw routing and account numbers are write-only and are never stored by VRPlatform. The contact becomes ready only after Ramp confirms the account.
1146
1146
  *
1147
1147
  * Required scope: contacts:write
1148
1148
  */
@@ -2115,6 +2115,23 @@ export interface paths {
2115
2115
  patch?: never;
2116
2116
  trace?: never;
2117
2117
  };
2118
+ "/internal/teams/billing": {
2119
+ parameters: {
2120
+ query?: never;
2121
+ header?: never;
2122
+ path?: never;
2123
+ cookie?: never;
2124
+ };
2125
+ /** @description List current VRP Billing data for either property-manager or partner teams in a regional partition. Property-manager rows expose active PMS names and direct live listing counts. Partner rows expose the active property-manager client count plus live listings owned by the partner and its effective billing clients. Tracking events are write-only and are never read by this endpoint. Filters are applied before deterministic name or creation-date sorting, totals, and page/limit pagination. Select the partition with x-data-region. */
2126
+ get: operations["getInternalTeamsBilling"];
2127
+ put?: never;
2128
+ post?: never;
2129
+ delete?: never;
2130
+ options?: never;
2131
+ head?: never;
2132
+ patch?: never;
2133
+ trace?: never;
2134
+ };
2118
2135
  "/internal/teams/{teamId}/billing": {
2119
2136
  parameters: {
2120
2137
  query?: never;
@@ -46615,6 +46632,329 @@ export interface operations {
46615
46632
  };
46616
46633
  };
46617
46634
  };
46635
+ getInternalTeamsBilling: {
46636
+ parameters: {
46637
+ query: {
46638
+ /** @description Select exactly one VRP Billing tab. */
46639
+ type: "propertyManager" | "partner";
46640
+ /** @description Filter by team name; property-manager searches also include company name. */
46641
+ search?: string;
46642
+ status?: "active" | "inactive" | "onboarding" | "trial";
46643
+ billingSubscriptionStatus?: ("active" | "pending" | "paused" | "cancelled" | "pendingCancellation" | "draft" | "voided" | "errored" | "missing" | "viaPartner") | ("testTeam" | "demoTeam");
46644
+ billingPlan?: string;
46645
+ product?: "vrtrust" | "vrintegrations";
46646
+ paymentMethod?: "card" | "direct_debit" | "direct_debit_ach" | "external" | "missing";
46647
+ /** @description Require an active PMS connection on the property manager or on a partner billing client. */
46648
+ appId?: string;
46649
+ partnerId?: string;
46650
+ billingPartnerId?: string;
46651
+ /** @description Sort field; prefix with - for descending order */
46652
+ sort?: "name" | "-name" | "created" | "-created";
46653
+ /** @description Comma-separated enabled feature IDs. */
46654
+ featureIds?: string;
46655
+ limit?: number;
46656
+ page?: number;
46657
+ offset?: number;
46658
+ };
46659
+ header?: {
46660
+ /** @description Selects the regional data partition for this regional collection read. It does not change the authenticated team context. */
46661
+ "x-data-region"?: "ap" | "crunchy" | "eu" | "hostaway" | "us";
46662
+ };
46663
+ path?: never;
46664
+ cookie?: never;
46665
+ };
46666
+ requestBody?: never;
46667
+ responses: {
46668
+ /** @description Successful response */
46669
+ 200: {
46670
+ headers: {
46671
+ [name: string]: unknown;
46672
+ };
46673
+ content: {
46674
+ "application/json": {
46675
+ data: {
46676
+ /** Format: uuid */
46677
+ id: string;
46678
+ name: string;
46679
+ logo: string | null;
46680
+ /** @enum {string} */
46681
+ status: "active" | "inactive";
46682
+ capabilities: {
46683
+ activate: {
46684
+ enabled: boolean;
46685
+ disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
46686
+ };
46687
+ };
46688
+ isOnboarding: boolean;
46689
+ isBillable: boolean | null;
46690
+ isGeneralLedger: boolean | null;
46691
+ partner: {
46692
+ /** Format: uuid */
46693
+ id: string;
46694
+ name: string;
46695
+ } | null;
46696
+ billingPartner: {
46697
+ /** Format: uuid */
46698
+ id: string;
46699
+ name: string;
46700
+ } | null;
46701
+ billingCustomerId: string | null;
46702
+ billingSubscriptionStatus: string | null;
46703
+ intercomId: string | null;
46704
+ billingPlan: string | null;
46705
+ billingPaymentMethodType: string | null;
46706
+ defaultCurrency: string | null;
46707
+ migratedFromTenantId: string | null;
46708
+ createdAt: string | null;
46709
+ trialUntil: string | null;
46710
+ cancelledAt: string | null;
46711
+ activeListings: number;
46712
+ /** @enum {string} */
46713
+ type: "propertyManager" | "partner";
46714
+ /** @description Distinct active PMS names; property-manager rows only. */
46715
+ pmsNames?: string[];
46716
+ /** @description Active property-manager billing clients; partner rows only. */
46717
+ teamCount?: number;
46718
+ }[];
46719
+ pagination: {
46720
+ /** @default 100 */
46721
+ limit: number;
46722
+ /** @default 1 */
46723
+ page: number;
46724
+ total: number;
46725
+ totalPage: number;
46726
+ nextPage?: number;
46727
+ };
46728
+ };
46729
+ };
46730
+ };
46731
+ /** @description Bad request */
46732
+ 400: {
46733
+ headers: {
46734
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46735
+ "Retry-After"?: number;
46736
+ [name: string]: unknown;
46737
+ };
46738
+ content: {
46739
+ "application/json": {
46740
+ code: string;
46741
+ message: string;
46742
+ links?: {
46743
+ docs: string;
46744
+ schema: string;
46745
+ };
46746
+ issues?: {
46747
+ message: string;
46748
+ path?: (string | number)[];
46749
+ schema?: string;
46750
+ }[];
46751
+ retryable?: boolean;
46752
+ context?: unknown;
46753
+ };
46754
+ };
46755
+ };
46756
+ /** @description Unauthorized */
46757
+ 401: {
46758
+ headers: {
46759
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46760
+ "Retry-After"?: number;
46761
+ [name: string]: unknown;
46762
+ };
46763
+ content: {
46764
+ "application/json": {
46765
+ code: string;
46766
+ message: string;
46767
+ links?: {
46768
+ docs: string;
46769
+ schema: string;
46770
+ };
46771
+ issues?: {
46772
+ message: string;
46773
+ path?: (string | number)[];
46774
+ schema?: string;
46775
+ }[];
46776
+ retryable?: boolean;
46777
+ context?: unknown;
46778
+ };
46779
+ };
46780
+ };
46781
+ /** @description Forbidden */
46782
+ 403: {
46783
+ headers: {
46784
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46785
+ "Retry-After"?: number;
46786
+ [name: string]: unknown;
46787
+ };
46788
+ content: {
46789
+ "application/json": {
46790
+ code: string;
46791
+ message: string;
46792
+ links?: {
46793
+ docs: string;
46794
+ schema: string;
46795
+ };
46796
+ issues?: {
46797
+ message: string;
46798
+ path?: (string | number)[];
46799
+ schema?: string;
46800
+ }[];
46801
+ retryable?: boolean;
46802
+ context?: unknown;
46803
+ };
46804
+ };
46805
+ };
46806
+ /** @description Not found */
46807
+ 404: {
46808
+ headers: {
46809
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46810
+ "Retry-After"?: number;
46811
+ [name: string]: unknown;
46812
+ };
46813
+ content: {
46814
+ "application/json": {
46815
+ code: string;
46816
+ message: string;
46817
+ links?: {
46818
+ docs: string;
46819
+ schema: string;
46820
+ };
46821
+ issues?: {
46822
+ message: string;
46823
+ path?: (string | number)[];
46824
+ schema?: string;
46825
+ }[];
46826
+ retryable?: boolean;
46827
+ context?: unknown;
46828
+ };
46829
+ };
46830
+ };
46831
+ /** @description Conflict */
46832
+ 409: {
46833
+ headers: {
46834
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46835
+ "Retry-After"?: number;
46836
+ [name: string]: unknown;
46837
+ };
46838
+ content: {
46839
+ "application/json": {
46840
+ code: string;
46841
+ message: string;
46842
+ links?: {
46843
+ docs: string;
46844
+ schema: string;
46845
+ };
46846
+ issues?: {
46847
+ message: string;
46848
+ path?: (string | number)[];
46849
+ schema?: string;
46850
+ }[];
46851
+ retryable?: boolean;
46852
+ context?: unknown;
46853
+ };
46854
+ };
46855
+ };
46856
+ /** @description Gone */
46857
+ 410: {
46858
+ headers: {
46859
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46860
+ "Retry-After"?: number;
46861
+ [name: string]: unknown;
46862
+ };
46863
+ content: {
46864
+ "application/json": {
46865
+ code: string;
46866
+ message: string;
46867
+ links?: {
46868
+ docs: string;
46869
+ schema: string;
46870
+ };
46871
+ issues?: {
46872
+ message: string;
46873
+ path?: (string | number)[];
46874
+ schema?: string;
46875
+ }[];
46876
+ retryable?: boolean;
46877
+ context?: unknown;
46878
+ };
46879
+ };
46880
+ };
46881
+ /** @description Unprocessable content */
46882
+ 422: {
46883
+ headers: {
46884
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46885
+ "Retry-After"?: number;
46886
+ [name: string]: unknown;
46887
+ };
46888
+ content: {
46889
+ "application/json": {
46890
+ code: string;
46891
+ message: string;
46892
+ links?: {
46893
+ docs: string;
46894
+ schema: string;
46895
+ };
46896
+ issues?: {
46897
+ message: string;
46898
+ path?: (string | number)[];
46899
+ schema?: string;
46900
+ }[];
46901
+ retryable?: boolean;
46902
+ context?: unknown;
46903
+ };
46904
+ };
46905
+ };
46906
+ /** @description Internal server error */
46907
+ 500: {
46908
+ headers: {
46909
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46910
+ "Retry-After"?: number;
46911
+ [name: string]: unknown;
46912
+ };
46913
+ content: {
46914
+ "application/json": {
46915
+ code: string;
46916
+ message: string;
46917
+ links?: {
46918
+ docs: string;
46919
+ schema: string;
46920
+ };
46921
+ issues?: {
46922
+ message: string;
46923
+ path?: (string | number)[];
46924
+ schema?: string;
46925
+ }[];
46926
+ retryable?: boolean;
46927
+ context?: unknown;
46928
+ };
46929
+ };
46930
+ };
46931
+ /** @description Service unavailable */
46932
+ 503: {
46933
+ headers: {
46934
+ /** @description Seconds to wait when retryable=true and the server supplies a delay. */
46935
+ "Retry-After"?: number;
46936
+ [name: string]: unknown;
46937
+ };
46938
+ content: {
46939
+ "application/json": {
46940
+ code: string;
46941
+ message: string;
46942
+ links?: {
46943
+ docs: string;
46944
+ schema: string;
46945
+ };
46946
+ issues?: {
46947
+ message: string;
46948
+ path?: (string | number)[];
46949
+ schema?: string;
46950
+ }[];
46951
+ retryable?: boolean;
46952
+ context?: unknown;
46953
+ };
46954
+ };
46955
+ };
46956
+ };
46957
+ };
46618
46958
  putInternalTeamsByTeamIdBilling: {
46619
46959
  parameters: {
46620
46960
  query?: never;