@vrplatform/api 1.3.1-stage.6229 → 1.3.1-stage.6249

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.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.6229",
6
+ "version": "1.3.1-stage.6249",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -819,7 +819,7 @@ export interface paths {
819
819
  get?: never;
820
820
  put?: never;
821
821
  /**
822
- * @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. PMS connections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp connections activate and run chart-of-accounts synchronization when autoExtract is enabled. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
822
+ * @description Connect an app and create the connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Legacy production /callback is normalized to /callback/, and legacy staging /callback to /connections/oauth-callback. Provider integrations must return stable account identity. The built-in API app receives server-generated connection identity. PMS connections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp connections activate and run chart-of-accounts synchronization when autoExtract is enabled. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
823
823
  *
824
824
  * Required scope: integrations:write
825
825
  */
@@ -861,7 +861,7 @@ export interface paths {
861
861
  get?: never;
862
862
  put?: never;
863
863
  /**
864
- * @description Get a redirect URL to connect an app through OAuth2.0. Defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Normalizes the legacy production /callback path to /callback/.
864
+ * @description Get a redirect URL to connect an app through OAuth2.0. Defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Normalizes legacy production /callback to /callback/ and legacy staging /callback to /connections/oauth-callback.
865
865
  *
866
866
  * Required scope: integrations:write
867
867
  */
@@ -976,7 +976,7 @@ export interface paths {
976
976
  get?: never;
977
977
  put?: never;
978
978
  /**
979
- * @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. The built-in API app preserves its existing server-generated identity. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp reconnections run chart-of-accounts synchronization unless that flow is explicitly inactive. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
979
+ * @description Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. Legacy production /callback is normalized to /callback/, and legacy staging /callback to /connections/oauth-callback. The built-in API app preserves its existing server-generated identity. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Ramp reconnections run chart-of-accounts synchronization unless that flow is explicitly inactive. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
980
980
  *
981
981
  * Required scope: integrations:write
982
982
  */
@@ -4522,7 +4522,7 @@ export interface paths {
4522
4522
  get: operations["getReservations"];
4523
4523
  put?: never;
4524
4524
  /**
4525
- * @description Create a reservation. Financial lines post journal entries inline against the listing ownership period covering the stay, so writes into books-closed or statement-locked months are rejected. Owner API keys cannot create reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations.
4525
+ * @description Create a reservation. Financial lines post journal entries inline against the listing ownership period covering the stay, so writes into books-closed or statement-locked months are rejected. Creation rejects duplicates by connection and unique reference or by connection, resolved listing, and confirmation code. Owner API keys cannot create reservations. Supports dryRun. See https://docs.vrplatform.app/guides/build/reservations.
4526
4526
  *
4527
4527
  * Required scope: reservations:write
4528
4528
  */
@@ -5758,7 +5758,7 @@ export interface paths {
5758
5758
  get: operations["getTeams"];
5759
5759
  put?: never;
5760
5760
  /**
5761
- * @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/lookup instead of creating it again. Retrying a provisioning request that failed before completing is safe. 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.
5761
+ * @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/lookup instead of creating it again. Retrying a provisioning request that failed before completing is safe. 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.
5762
5762
  *
5763
5763
  * Required scope: teams:provision
5764
5764
  */
@@ -78059,6 +78059,7 @@ export interface operations {
78059
78059
  getGuestBalancesReport: {
78060
78060
  parameters: {
78061
78061
  query: {
78062
+ /** @description As-of date or date range. For a range, the inclusive end is used. */
78062
78063
  date: string;
78063
78064
  occupancyStatus: "departed" | "inHouse" | "upcoming" | "cancelled" | "unassigned" | "all";
78064
78065
  channels?: string;
@@ -78437,6 +78438,7 @@ export interface operations {
78437
78438
  getGuestBalancesReportCsv: {
78438
78439
  parameters: {
78439
78440
  query: {
78441
+ /** @description As-of date or date range. For a range, the inclusive end is used. */
78440
78442
  date: string;
78441
78443
  occupancyStatus: "departed" | "inHouse" | "upcoming" | "cancelled" | "unassigned" | "all";
78442
78444
  channels?: string;
@@ -78689,6 +78691,7 @@ export interface operations {
78689
78691
  getGuestBalancesReportAggregated: {
78690
78692
  parameters: {
78691
78693
  query: {
78694
+ /** @description As-of date or date range. For a range, the inclusive end is used. */
78692
78695
  date: string;
78693
78696
  channels?: string;
78694
78697
  };