@vrplatform/api 1.3.1-stage.6101 → 1.3.1-stage.6104

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.
@@ -2740,7 +2740,7 @@ export interface paths {
2740
2740
  *
2741
2741
  * Required scope: metrics:read
2742
2742
  */
2743
- get: operations["getMetricActiveListings"];
2743
+ get: operations["getMetricsActiveListings"];
2744
2744
  put?: never;
2745
2745
  post?: never;
2746
2746
  delete?: never;
@@ -2761,7 +2761,7 @@ export interface paths {
2761
2761
  *
2762
2762
  * Required scope: metrics:read
2763
2763
  */
2764
- get: operations["getMetricAverageDailyRate"];
2764
+ get: operations["getMetricsAverageDailyRate"];
2765
2765
  put?: never;
2766
2766
  post?: never;
2767
2767
  delete?: never;
@@ -2782,7 +2782,7 @@ export interface paths {
2782
2782
  *
2783
2783
  * Required scope: metrics:read
2784
2784
  */
2785
- get: operations["getMetricCashFlow"];
2785
+ get: operations["getMetricsCashFlow"];
2786
2786
  put?: never;
2787
2787
  post?: never;
2788
2788
  delete?: never;
@@ -2803,7 +2803,7 @@ export interface paths {
2803
2803
  *
2804
2804
  * Required scope: metrics:read
2805
2805
  */
2806
- get: operations["getMetricCheckinCounts"];
2806
+ get: operations["getMetricsCheckinCounts"];
2807
2807
  put?: never;
2808
2808
  post?: never;
2809
2809
  delete?: never;
@@ -2824,7 +2824,7 @@ export interface paths {
2824
2824
  *
2825
2825
  * Required scope: metrics:read
2826
2826
  */
2827
- get: operations["getMetricFutureBookedRevenue"];
2827
+ get: operations["getMetricsFutureBookedRevenue"];
2828
2828
  put?: never;
2829
2829
  post?: never;
2830
2830
  delete?: never;
@@ -2845,7 +2845,7 @@ export interface paths {
2845
2845
  *
2846
2846
  * Required scope: metrics:read
2847
2847
  */
2848
- get: operations["getMetricJournalEntryTotalsByRecurringFee"];
2848
+ get: operations["getMetricsJournalEntryTotalsByRecurringFee"];
2849
2849
  put?: never;
2850
2850
  post?: never;
2851
2851
  delete?: never;
@@ -2867,7 +2867,7 @@ export interface paths {
2867
2867
  *
2868
2868
  * Required scope: metrics:read
2869
2869
  */
2870
- get: operations["getMetricLegacyActiveListingCreated"];
2870
+ get: operations["getMetricsLegacyActiveListingCreated"];
2871
2871
  put?: never;
2872
2872
  post?: never;
2873
2873
  delete?: never;
@@ -2889,7 +2889,7 @@ export interface paths {
2889
2889
  *
2890
2890
  * Required scope: metrics:read
2891
2891
  */
2892
- get: operations["getMetricLegacyCurrencies"];
2892
+ get: operations["getMetricsLegacyCurrencies"];
2893
2893
  put?: never;
2894
2894
  post?: never;
2895
2895
  delete?: never;
@@ -2911,7 +2911,7 @@ export interface paths {
2911
2911
  *
2912
2912
  * Required scope: metrics:read
2913
2913
  */
2914
- get: operations["getMetricLegacyPaymentVolume"];
2914
+ get: operations["getMetricsLegacyPaymentVolume"];
2915
2915
  put?: never;
2916
2916
  post?: never;
2917
2917
  delete?: never;
@@ -2933,7 +2933,7 @@ export interface paths {
2933
2933
  *
2934
2934
  * Required scope: metrics:read
2935
2935
  */
2936
- get: operations["getMetricLegacyReservationDailyRate"];
2936
+ get: operations["getMetricsLegacyReservationDailyRate"];
2937
2937
  put?: never;
2938
2938
  post?: never;
2939
2939
  delete?: never;
@@ -2955,7 +2955,7 @@ export interface paths {
2955
2955
  *
2956
2956
  * Required scope: metrics:read
2957
2957
  */
2958
- get: operations["getMetricLegacyReservationVolume"];
2958
+ get: operations["getMetricsLegacyReservationVolume"];
2959
2959
  put?: never;
2960
2960
  post?: never;
2961
2961
  delete?: never;
@@ -2976,7 +2976,7 @@ export interface paths {
2976
2976
  *
2977
2977
  * Required scope: metrics:read
2978
2978
  */
2979
- get: operations["getMetricListingRevenue"];
2979
+ get: operations["getMetricsListingRevenue"];
2980
2980
  put?: never;
2981
2981
  post?: never;
2982
2982
  delete?: never;
@@ -2997,7 +2997,7 @@ export interface paths {
2997
2997
  *
2998
2998
  * Required scope: metrics:read
2999
2999
  */
3000
- get: operations["getMetricOccupancyRateOverTime"];
3000
+ get: operations["getMetricsOccupancyRateOverTime"];
3001
3001
  put?: never;
3002
3002
  post?: never;
3003
3003
  delete?: never;
@@ -3018,7 +3018,7 @@ export interface paths {
3018
3018
  *
3019
3019
  * Required scope: metrics:read
3020
3020
  */
3021
- get: operations["getMetricOwnerRevenue"];
3021
+ get: operations["getMetricsOwnerRevenue"];
3022
3022
  put?: never;
3023
3023
  post?: never;
3024
3024
  delete?: never;
@@ -3039,7 +3039,7 @@ export interface paths {
3039
3039
  *
3040
3040
  * Required scope: metrics:read
3041
3041
  */
3042
- get: operations["getMetricReservationCount"];
3042
+ get: operations["getMetricsReservationCount"];
3043
3043
  put?: never;
3044
3044
  post?: never;
3045
3045
  delete?: never;
@@ -3060,7 +3060,7 @@ export interface paths {
3060
3060
  *
3061
3061
  * Required scope: metrics:read
3062
3062
  */
3063
- get: operations["getMetricReservationVolume"];
3063
+ get: operations["getMetricsReservationVolume"];
3064
3064
  put?: never;
3065
3065
  post?: never;
3066
3066
  delete?: never;
@@ -3081,7 +3081,7 @@ export interface paths {
3081
3081
  *
3082
3082
  * Required scope: metrics:read
3083
3083
  */
3084
- get: operations["getMetricRevenue"];
3084
+ get: operations["getMetricsRevenue"];
3085
3085
  put?: never;
3086
3086
  post?: never;
3087
3087
  delete?: never;
@@ -3102,7 +3102,7 @@ export interface paths {
3102
3102
  *
3103
3103
  * Required scope: metrics:read
3104
3104
  */
3105
- get: operations["getSyncMetricsByStatus"];
3105
+ get: operations["getMetricsSyncByStatus"];
3106
3106
  put?: never;
3107
3107
  post?: never;
3108
3108
  delete?: never;
@@ -3123,7 +3123,7 @@ export interface paths {
3123
3123
  *
3124
3124
  * Required scope: metrics:read
3125
3125
  */
3126
- get: operations["getMetricTakeRate"];
3126
+ get: operations["getMetricsTakeRate"];
3127
3127
  put?: never;
3128
3128
  post?: never;
3129
3129
  delete?: never;
@@ -3504,7 +3504,7 @@ export interface paths {
3504
3504
  get?: never;
3505
3505
  put?: never;
3506
3506
  /**
3507
- * @description Import historical VRI statements into an existing migrated GL-enabled team after resolving and validating statement and reservation listing targets
3507
+ * @description Queue a tracked, rerunnable Trigger.dev job that imports historical VRI statements into an existing migrated GL-enabled team after resolving account paths and validating statement and reservation listing targets
3508
3508
  *
3509
3509
  * Required scope: general-ledger:import
3510
3510
  */
@@ -3523,7 +3523,7 @@ export interface paths {
3523
3523
  cookie?: never;
3524
3524
  };
3525
3525
  /**
3526
- * @description Retrieve required historical VRI statement account mappings and suggested target accounts
3526
+ * @description Retrieve required historical VRI statement account mappings, including structured account-path mappings and broad-path description override capabilities, plus the available revenue, expense, and liability targets
3527
3527
  *
3528
3528
  * Required scope: general-ledger:import
3529
3529
  */
@@ -59395,7 +59395,7 @@ export interface operations {
59395
59395
  };
59396
59396
  };
59397
59397
  };
59398
- getMetricActiveListings: {
59398
+ getMetricsActiveListings: {
59399
59399
  parameters: {
59400
59400
  query?: {
59401
59401
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -59656,7 +59656,7 @@ export interface operations {
59656
59656
  };
59657
59657
  };
59658
59658
  };
59659
- getMetricAverageDailyRate: {
59659
+ getMetricsAverageDailyRate: {
59660
59660
  parameters: {
59661
59661
  query?: {
59662
59662
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -59917,7 +59917,7 @@ export interface operations {
59917
59917
  };
59918
59918
  };
59919
59919
  };
59920
- getMetricCashFlow: {
59920
+ getMetricsCashFlow: {
59921
59921
  parameters: {
59922
59922
  query?: {
59923
59923
  interval?: "month" | "week" | "day" | "year";
@@ -60181,7 +60181,7 @@ export interface operations {
60181
60181
  };
60182
60182
  };
60183
60183
  };
60184
- getMetricCheckinCounts: {
60184
+ getMetricsCheckinCounts: {
60185
60185
  parameters: {
60186
60186
  query?: {
60187
60187
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -60442,7 +60442,7 @@ export interface operations {
60442
60442
  };
60443
60443
  };
60444
60444
  };
60445
- getMetricFutureBookedRevenue: {
60445
+ getMetricsFutureBookedRevenue: {
60446
60446
  parameters: {
60447
60447
  query?: {
60448
60448
  interval?: "month" | "week" | "day" | "year";
@@ -60705,7 +60705,7 @@ export interface operations {
60705
60705
  };
60706
60706
  };
60707
60707
  };
60708
- getMetricJournalEntryTotalsByRecurringFee: {
60708
+ getMetricsJournalEntryTotalsByRecurringFee: {
60709
60709
  parameters: {
60710
60710
  query: {
60711
60711
  recurringFeeId: string;
@@ -60969,7 +60969,7 @@ export interface operations {
60969
60969
  };
60970
60970
  };
60971
60971
  };
60972
- getMetricLegacyActiveListingCreated: {
60972
+ getMetricsLegacyActiveListingCreated: {
60973
60973
  parameters: {
60974
60974
  query?: {
60975
60975
  interval?: "month" | "week" | "day" | "year";
@@ -61231,7 +61231,7 @@ export interface operations {
61231
61231
  };
61232
61232
  };
61233
61233
  };
61234
- getMetricLegacyCurrencies: {
61234
+ getMetricsLegacyCurrencies: {
61235
61235
  parameters: {
61236
61236
  query?: {
61237
61237
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -61489,7 +61489,7 @@ export interface operations {
61489
61489
  };
61490
61490
  };
61491
61491
  };
61492
- getMetricLegacyPaymentVolume: {
61492
+ getMetricsLegacyPaymentVolume: {
61493
61493
  parameters: {
61494
61494
  query?: {
61495
61495
  interval?: "month" | "week" | "day" | "year";
@@ -61753,7 +61753,7 @@ export interface operations {
61753
61753
  };
61754
61754
  };
61755
61755
  };
61756
- getMetricLegacyReservationDailyRate: {
61756
+ getMetricsLegacyReservationDailyRate: {
61757
61757
  parameters: {
61758
61758
  query?: {
61759
61759
  interval?: "month" | "week" | "day" | "year";
@@ -62016,7 +62016,7 @@ export interface operations {
62016
62016
  };
62017
62017
  };
62018
62018
  };
62019
- getMetricLegacyReservationVolume: {
62019
+ getMetricsLegacyReservationVolume: {
62020
62020
  parameters: {
62021
62021
  query?: {
62022
62022
  interval?: "month" | "week" | "day" | "year";
@@ -62280,7 +62280,7 @@ export interface operations {
62280
62280
  };
62281
62281
  };
62282
62282
  };
62283
- getMetricListingRevenue: {
62283
+ getMetricsListingRevenue: {
62284
62284
  parameters: {
62285
62285
  query: {
62286
62286
  listingId: string;
@@ -62547,7 +62547,7 @@ export interface operations {
62547
62547
  };
62548
62548
  };
62549
62549
  };
62550
- getMetricOccupancyRateOverTime: {
62550
+ getMetricsOccupancyRateOverTime: {
62551
62551
  parameters: {
62552
62552
  query?: {
62553
62553
  interval?: "month" | "week" | "day" | "year";
@@ -62811,7 +62811,7 @@ export interface operations {
62811
62811
  };
62812
62812
  };
62813
62813
  };
62814
- getMetricOwnerRevenue: {
62814
+ getMetricsOwnerRevenue: {
62815
62815
  parameters: {
62816
62816
  query: {
62817
62817
  ownerId: string;
@@ -63074,7 +63074,7 @@ export interface operations {
63074
63074
  };
63075
63075
  };
63076
63076
  };
63077
- getMetricReservationCount: {
63077
+ getMetricsReservationCount: {
63078
63078
  parameters: {
63079
63079
  query?: {
63080
63080
  /** @description Date boundary string. Accepted syntax: `YYYY`, `YYYY-MM`, or `YYYY-MM-DD`. Deprecated: use dateRange instead. */
@@ -63335,7 +63335,7 @@ export interface operations {
63335
63335
  };
63336
63336
  };
63337
63337
  };
63338
- getMetricReservationVolume: {
63338
+ getMetricsReservationVolume: {
63339
63339
  parameters: {
63340
63340
  query?: {
63341
63341
  interval?: "month" | "week" | "day" | "year";
@@ -63595,7 +63595,7 @@ export interface operations {
63595
63595
  };
63596
63596
  };
63597
63597
  };
63598
- getMetricRevenue: {
63598
+ getMetricsRevenue: {
63599
63599
  parameters: {
63600
63600
  query?: {
63601
63601
  interval?: "month" | "week" | "day" | "year";
@@ -63858,7 +63858,7 @@ export interface operations {
63858
63858
  };
63859
63859
  };
63860
63860
  };
63861
- getSyncMetricsByStatus: {
63861
+ getMetricsSyncByStatus: {
63862
63862
  parameters: {
63863
63863
  query: {
63864
63864
  interval?: "month" | "week" | "day" | "year";
@@ -64132,7 +64132,7 @@ export interface operations {
64132
64132
  };
64133
64133
  };
64134
64134
  };
64135
- getMetricTakeRate: {
64135
+ getMetricsTakeRate: {
64136
64136
  parameters: {
64137
64137
  query?: {
64138
64138
  interval?: "month" | "week" | "day" | "year";
@@ -69845,6 +69845,12 @@ export interface operations {
69845
69845
  /** Format: uuid */
69846
69846
  targetAccountId: string;
69847
69847
  }[];
69848
+ lineDescriptionOverrides?: {
69849
+ legacyAccountKey: string;
69850
+ descriptionIncludes: string;
69851
+ /** Format: uuid */
69852
+ targetAccountId: string;
69853
+ }[];
69848
69854
  listingMappings?: {
69849
69855
  /** Format: uuid */
69850
69856
  sourceListingId: string;
@@ -69865,182 +69871,7 @@ export interface operations {
69865
69871
  };
69866
69872
  content: {
69867
69873
  "application/json": {
69868
- /** Format: uuid */
69869
- id: string;
69870
- uniqueRef: string | null;
69871
- /** @enum {string} */
69872
- dataRegion: "ap" | "crunchy" | "eu" | "hostaway" | "us";
69873
- /** @enum {string} */
69874
- storageRealm: "vrintegration" | "vrtrust";
69875
- defaultCurrency?: string | null;
69876
- longTermStayNights?: number | null;
69877
- defaultRevenueRecognition?: ("checkIn" | "checkOut" | "bookedAt" | "proRata") | null;
69878
- migratedFromTenantId?: string | null;
69879
- historicalStatementsImportedAt?: string | null;
69880
- name: string;
69881
- slug: string;
69882
- statementAddress?: {
69883
- full?: string | null;
69884
- line1?: string | null;
69885
- line2?: string | null;
69886
- city?: string | null;
69887
- /** @description Deprecated, use stateCode instead */
69888
- state?: string | null;
69889
- postalCode?: string | null;
69890
- stateCode?: string | null;
69891
- countryCode?: string | null;
69892
- } | null;
69893
- billingAddress?: {
69894
- full?: string | null;
69895
- line1?: string | null;
69896
- line2?: string | null;
69897
- city?: string | null;
69898
- /** @description Deprecated, use stateCode instead */
69899
- state?: string | null;
69900
- postalCode?: string | null;
69901
- stateCode?: string | null;
69902
- countryCode?: string | null;
69903
- } | null;
69904
- phone?: string | null;
69905
- email?: string | null;
69906
- supportEmail?: string | null;
69907
- taxId?: string | null;
69908
- partner?: {
69909
- /** Format: uuid */
69910
- id: string;
69911
- name: string;
69912
- } | null;
69913
- billingPartner: {
69914
- /** Format: uuid */
69915
- id: string;
69916
- name: string;
69917
- };
69918
- /**
69919
- * Format: uuid
69920
- * @description Effective billing partner ID
69921
- */
69922
- billingPartnerId: string;
69923
- companyName?: string | null;
69924
- /** @enum {string} */
69925
- type: "partner" | "admin" | "propertyManager";
69926
- /**
69927
- * @description Lifecycle status derived from the team and billing-partner subscription states
69928
- * @enum {string}
69929
- */
69930
- status: "active" | "inactive";
69931
- capabilities: {
69932
- activate: {
69933
- enabled: boolean;
69934
- disabledReasons: ("teamBillingSubscriptionInactive" | "billingPartnerInactive")[];
69935
- };
69936
- };
69937
- billingSubscriptionStatus?: string | null;
69938
- billingPlan?: string | null;
69939
- billingPaymentMethodType?: string | null;
69940
- billingCustomerId: string | null;
69941
- colorPrimary?: string | null;
69942
- createdAt?: string | null;
69943
- updatedAt?: string | null;
69944
- cancelledAt?: string | null;
69945
- isOnboarding?: boolean | null;
69946
- issues: ({
69947
- /** @constant */
69948
- code: "unassignedAccount";
69949
- /** @constant */
69950
- severity: "error";
69951
- context: {
69952
- accountIds: string[];
69953
- };
69954
- } | {
69955
- /** @constant */
69956
- code: "brokenConnections";
69957
- /** @constant */
69958
- severity: "error";
69959
- context: {
69960
- connections: {
69961
- /** Format: uuid */
69962
- id: string;
69963
- name: string;
69964
- appId: string;
69965
- }[];
69966
- };
69967
- } | {
69968
- /** @constant */
69969
- code: "outdatedConnections";
69970
- /** @constant */
69971
- severity: "error";
69972
- context: {
69973
- connections: {
69974
- /** Format: uuid */
69975
- id: string;
69976
- name: string;
69977
- appId: string;
69978
- }[];
69979
- };
69980
- } | {
69981
- /** @constant */
69982
- code: "pmsMissingAccountingStart";
69983
- /** @constant */
69984
- severity: "error";
69985
- context: {
69986
- connections: {
69987
- /** Format: uuid */
69988
- id: string;
69989
- name: string;
69990
- appId: string;
69991
- }[];
69992
- };
69993
- })[];
69994
- isGeneralLedger?: boolean | null;
69995
- isOpex?: boolean;
69996
- booksClosedAt?: string | null;
69997
- logo?: string | null;
69998
- statementStartAt?: string | null;
69999
- effectiveStatementStartAt?: string | null;
70000
- settings: {
70001
- showVRPilotGuide: boolean;
70002
- showReservations: boolean;
70003
- showCancelledReservations: boolean;
70004
- showReservationTotal: boolean;
70005
- showOwnerCalendarBlocking: boolean;
70006
- showTaxStatements: boolean;
70007
- showTwoFactorAuth: boolean;
70008
- };
70009
- ownerPortalShowDraftStatements?: boolean;
70010
- members?: {
70011
- userId: string;
70012
- email?: string | null;
70013
- role: string;
70014
- name?: string | null;
70015
- firstName?: string | null;
70016
- lastName?: string | null;
70017
- }[] | null;
70018
- extractableConnections?: {
70019
- [key: string]: {
70020
- connections: {
70021
- /** Format: uuid */
70022
- id: string;
70023
- name: string;
70024
- appId: string;
70025
- urlExample?: string | null;
70026
- allowConfirmationCode?: boolean | null;
70027
- }[];
70028
- };
70029
- } | null;
70030
- enabledFeatures?: {
70031
- /** Format: uuid */
70032
- featureId: string;
70033
- /** @enum {string} */
70034
- status: "all" | "disabled" | "partially";
70035
- }[];
70036
- isBillable: boolean;
70037
- aggregates: {
70038
- activeListings: number;
70039
- members: number;
70040
- activeConnections: number;
70041
- connectionIssues: number;
70042
- childTeams: number;
70043
- };
69874
+ runId: string;
70044
69875
  };
70045
69876
  };
70046
69877
  };
@@ -70312,6 +70143,15 @@ export interface operations {
70312
70143
  id: string;
70313
70144
  title: string;
70314
70145
  } | null;
70146
+ lineDescriptionOverridesAllowed: boolean;
70147
+ currentLineDescriptionOverrides: {
70148
+ descriptionIncludes: string;
70149
+ targetAccount: {
70150
+ /** Format: uuid */
70151
+ id: string;
70152
+ title: string;
70153
+ };
70154
+ }[];
70315
70155
  }[];
70316
70156
  newAccounts: {
70317
70157
  /** Format: uuid */