btrz-api-client 9.6.0 → 9.8.0

package/lib/endpoints/accounts/ticket-movement-settings.js

@@ -2,6 +2,78 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} AmenityGroupTransition
+ * @property {string} from - Original ticket amenity group id.
+ * @property {string} to - Destination amenity group id.
+ */
+
+/**
+ * @typedef {Object} AmenityGroupTransitionsSettings
+ * @property {boolean} allowAny - When true, any transition is allowed.
+ * @property {AmenityGroupTransition[] | null} allowedTransitions - Allowed transition pairs when allowAny is false.
+ */
+
+/**
+ * @typedef {Object} OriginalTripRestrictions
+ * @property {number} cutoffMinutes - Minutes before/after the selected reference point.
+ * @property {"original_passenger_departure_time" | "original_schedule_departure_time"} referencePoint - Restriction reference point.
+ */
+
+/**
+ * @typedef {Object} NewTripRestrictions
+ * @property {number} lowerBoundCutoffMinutes - Lower bound for move eligibility in minutes.
+ * @property {"original_passenger_departure_time"} lowerBoundReferencePoint - Lower bound reference point.
+ * @property {number} upperBoundCutoffMinutes - Upper bound for move eligibility in minutes.
+ * @property {"original_passenger_departure_time"} upperBoundReferencePoint - Upper bound reference point.
+ */
+
+/**
+ * @typedef {Object} TimeRestrictionsSettings
+ * @property {OriginalTripRestrictions} originalTripRestrictions - Restrictions applied to the original trip.
+ * @property {NewTripRestrictions} newTripRestrictions - Restrictions applied to the destination trip.
+ */
+
+/**
+ * Ticket movement settings payload used by the accounts API.
+ * @typedef {Object} TicketMovementSettings
+ * @property {boolean} preventMovementsAfterManifestHasBeenPrinted - Prevent moves after printing manifests.
+ * @property {boolean} preventSeatmapOptimizationMovementsWithDifferentSeatClassOrFees - Block optimization moves changing class/fees.
+ * @property {boolean} preventMovementsWhenOriginalManifestIsBoarding - Prevent moves when original manifest is boarding.
+ * @property {null | "passengers_board_at_any_station" | "passengers_board_at_ticket_departure_station"} originalManifestIsBoardingWhen - Rule to determine original manifest boarding state.
+ * @property {boolean} preventMovementsWhenDestinationManifestIsBoarding - Prevent moves when destination manifest is boarding.
+ * @property {null | "passengers_board_at_any_station" | "passengers_board_at_ticket_departure_station"} destinationManifestIsBoardingWhen - Rule to determine destination manifest boarding state.
+ * @property {boolean} preventMovedTicketsFromBeingChanged - Block changing tickets after movement.
+ * @property {boolean} preventMovedTicketsFromBeingCancelled - Block cancelling tickets after movement.
+ * @property {boolean} preventMovementsWhenFareSpecificCapacityLimitsAreExceeded - Prevent moves when fare capacity is exceeded.
+ * @property {boolean} sendSMSNotifications - Enable SMS notifications for ticket movements.
+ * @property {boolean} [allowSendingEmailNotification] - Enable email notifications for ticket movements.
+ * @property {boolean} [useConfirmationRecipientForNotifications] - Send notifications to the confirmation recipient.
+ * @property {number} maxMovementsPerTicket - Maximum ticket movements without authorization.
+ * @property {number} [maxMovementsPerTicketWithAuthorization] - Maximum ticket movements with authorization.
+ * @property {AmenityGroupTransitionsSettings} amenityGroupTransitions - Allowed amenity group transitions.
+ * @property {TimeRestrictionsSettings} timeRestrictions - Time restriction rules.
+ * @property {string[]} [allowMovementToManifestsWithStatus] - Allowed destination manifest statuses.
+ * @property {string} [singleTicketMoveUIVersion] - Single ticket move UI version preference.
+ * @property {boolean} [displayExpiredSchedulesInUIToMove] - Show expired schedules in move UI when true.
+ * @property {boolean} [followingSeatBehaviorEnabled] - Enables following-seat behavior for automatic seat movement resolution.
+ */
+
+/**
+ * @typedef {Object} GetTicketMovementSettingsOptions
+ * @property {string} [token] - API key.
+ * @property {string} [jwtToken] - JWT or internal auth symbol.
+ * @property {Object} [headers] - Optional headers.
+ */
+
+/**
+ * @typedef {Object} UpdateTicketMovementSettingsOptions
+ * @property {string} [token] - API key.
+ * @property {string} [jwtToken] - JWT or internal auth symbol.
+ * @property {TicketMovementSettings} ticketMovementSettings - Full settings payload to persist.
+ * @property {Object} [headers] - Optional headers.
+ */
+
 /**
  * Factory for ticket-movement-settings API (btrz-api-accounts).
  * @param {Object} deps
@@ -16,11 +88,8 @@ function ticketMovementSettingsFactory({
   /**
    * GET /ticket-movement-settings - get ticket movement settings for the account.
    * No query or path parameters. See get-handler getSpec() in btrz-api-accounts for response schema.
-   * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse<Object>>} Response body: ticket movement settings object. Errors: 401, 500
+   * @param {GetTicketMovementSettingsOptions} opts
+   * @returns {Promise<import("axios").AxiosResponse<TicketMovementSettings>>} Response body: ticket movement settings object. Errors: 401, 500
    */
   function get({
     token,
@@ -42,12 +111,8 @@ function ticketMovementSettingsFactory({
    * PUT /ticket-movement-settings - update ticket movement settings for the account.
    * Body must include all required fields (see put-handler getSpec() in btrz-api-accounts).
    * Side effect: persists to account.preferences.ticketMovements.
-   * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.ticketMovementSettings - Full settings payload (see put-handler getSpec())
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse<Object>>} Updated settings. Errors: 400, 401, 500
+   * @param {UpdateTicketMovementSettingsOptions} opts
+   * @returns {Promise<import("axios").AxiosResponse<TicketMovementSettings>>} Updated settings. Errors: 400, 401, 500
    */
   function update({
     token,

package/lib/endpoints/operations/manifest.js

@@ -1028,6 +1028,108 @@ function manifestFactory({
       });
     }
   };
+
+  /**
+  * POST manifests/:manifestId/boarding/:stationId - board passengers at station.
+  * @param {Object} opts
+  * @param {string} [opts.token] - API key
+  * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+  * @param {Object} [opts.headers] - Optional headers
+  * @param {string} opts.manifestId - Manifest id
+  * @param {string} opts.stationId - Station id
+  * @param {Object} opts.data - Request body
+  * @returns {Promise<import("axios").AxiosResponse>}
+  */
+  function stationBoarding({
+    token,
+    jwtToken,
+    headers,
+    manifestId,
+    stationId,
+    data,
+    query
+  }) {
+    return client({
+      url: `/manifests/${manifestId}/boarding/${stationId}`,
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data,
+      params: query
+    });
+  }
+
+  /**
+   * POST manifests/:manifestId/dispatch/:stationId - dispatch manifest at station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.stationId - Station id
+   * @param {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function stationDispatch({
+    token,
+    jwtToken,
+    headers,
+    manifestId,
+    stationId,
+    data,
+    query
+  }) {
+    return client({
+      url: `/manifests/${manifestId}/dispatch/${stationId}`,
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data,
+      params: query
+    });
+  }
+
+  /**
+  * POST manifests/:manifestId/sales-closure/:stationId - close sales at station.
+  * @param {Object} opts
+  * @param {string} [opts.token] - API key
+  * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+  * @param {Object} [opts.headers] - Optional headers
+  * @param {string} opts.manifestId - Manifest id
+  * @param {string} opts.stationId - Station id
+  * @param {Object} opts.data - Request body
+  * @returns {Promise<import("axios").AxiosResponse>}
+  */
+  function stationSalesClosure({
+    token,
+    jwtToken,
+    headers,
+    manifestId,
+    stationId,
+    data,
+    query
+  }) {
+    return client({
+      url: `/manifests/${manifestId}/sales-closure/${stationId}`,
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data,
+      params: query
+    });
+  }
   return {
     get,
     getAll,
@@ -1052,7 +1154,10 @@ function manifestFactory({
     reports,
     labels,
     driverRelays,
-    tripClose
+    tripClose,
+    stationBoarding,
+    stationDispatch,
+    stationSalesClosure
   };
 }
 module.exports = manifestFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "9.6.0",
+  "version": "9.8.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/endpoints/accounts/ticket-movement-settings.js

@@ -2,6 +2,78 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} AmenityGroupTransition
+ * @property {string} from - Original ticket amenity group id.
+ * @property {string} to - Destination amenity group id.
+ */
+
+/**
+ * @typedef {Object} AmenityGroupTransitionsSettings
+ * @property {boolean} allowAny - When true, any transition is allowed.
+ * @property {AmenityGroupTransition[] | null} allowedTransitions - Allowed transition pairs when allowAny is false.
+ */
+
+/**
+ * @typedef {Object} OriginalTripRestrictions
+ * @property {number} cutoffMinutes - Minutes before/after the selected reference point.
+ * @property {"original_passenger_departure_time" | "original_schedule_departure_time"} referencePoint - Restriction reference point.
+ */
+
+/**
+ * @typedef {Object} NewTripRestrictions
+ * @property {number} lowerBoundCutoffMinutes - Lower bound for move eligibility in minutes.
+ * @property {"original_passenger_departure_time"} lowerBoundReferencePoint - Lower bound reference point.
+ * @property {number} upperBoundCutoffMinutes - Upper bound for move eligibility in minutes.
+ * @property {"original_passenger_departure_time"} upperBoundReferencePoint - Upper bound reference point.
+ */
+
+/**
+ * @typedef {Object} TimeRestrictionsSettings
+ * @property {OriginalTripRestrictions} originalTripRestrictions - Restrictions applied to the original trip.
+ * @property {NewTripRestrictions} newTripRestrictions - Restrictions applied to the destination trip.
+ */
+
+/**
+ * Ticket movement settings payload used by the accounts API.
+ * @typedef {Object} TicketMovementSettings
+ * @property {boolean} preventMovementsAfterManifestHasBeenPrinted - Prevent moves after printing manifests.
+ * @property {boolean} preventSeatmapOptimizationMovementsWithDifferentSeatClassOrFees - Block optimization moves changing class/fees.
+ * @property {boolean} preventMovementsWhenOriginalManifestIsBoarding - Prevent moves when original manifest is boarding.
+ * @property {null | "passengers_board_at_any_station" | "passengers_board_at_ticket_departure_station"} originalManifestIsBoardingWhen - Rule to determine original manifest boarding state.
+ * @property {boolean} preventMovementsWhenDestinationManifestIsBoarding - Prevent moves when destination manifest is boarding.
+ * @property {null | "passengers_board_at_any_station" | "passengers_board_at_ticket_departure_station"} destinationManifestIsBoardingWhen - Rule to determine destination manifest boarding state.
+ * @property {boolean} preventMovedTicketsFromBeingChanged - Block changing tickets after movement.
+ * @property {boolean} preventMovedTicketsFromBeingCancelled - Block cancelling tickets after movement.
+ * @property {boolean} preventMovementsWhenFareSpecificCapacityLimitsAreExceeded - Prevent moves when fare capacity is exceeded.
+ * @property {boolean} sendSMSNotifications - Enable SMS notifications for ticket movements.
+ * @property {boolean} [allowSendingEmailNotification] - Enable email notifications for ticket movements.
+ * @property {boolean} [useConfirmationRecipientForNotifications] - Send notifications to the confirmation recipient.
+ * @property {number} maxMovementsPerTicket - Maximum ticket movements without authorization.
+ * @property {number} [maxMovementsPerTicketWithAuthorization] - Maximum ticket movements with authorization.
+ * @property {AmenityGroupTransitionsSettings} amenityGroupTransitions - Allowed amenity group transitions.
+ * @property {TimeRestrictionsSettings} timeRestrictions - Time restriction rules.
+ * @property {string[]} [allowMovementToManifestsWithStatus] - Allowed destination manifest statuses.
+ * @property {string} [singleTicketMoveUIVersion] - Single ticket move UI version preference.
+ * @property {boolean} [displayExpiredSchedulesInUIToMove] - Show expired schedules in move UI when true.
+ * @property {boolean} [followingSeatBehaviorEnabled] - Enables following-seat behavior for automatic seat movement resolution.
+ */
+
+/**
+ * @typedef {Object} GetTicketMovementSettingsOptions
+ * @property {string} [token] - API key.
+ * @property {string} [jwtToken] - JWT or internal auth symbol.
+ * @property {Object} [headers] - Optional headers.
+ */
+
+/**
+ * @typedef {Object} UpdateTicketMovementSettingsOptions
+ * @property {string} [token] - API key.
+ * @property {string} [jwtToken] - JWT or internal auth symbol.
+ * @property {TicketMovementSettings} ticketMovementSettings - Full settings payload to persist.
+ * @property {Object} [headers] - Optional headers.
+ */
+
 /**
  * Factory for ticket-movement-settings API (btrz-api-accounts).
  * @param {Object} deps
@@ -13,11 +85,8 @@ function ticketMovementSettingsFactory({client, internalAuthTokenProvider}) {
   /**
    * GET /ticket-movement-settings - get ticket movement settings for the account.
    * No query or path parameters. See get-handler getSpec() in btrz-api-accounts for response schema.
-   * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse<Object>>} Response body: ticket movement settings object. Errors: 401, 500
+   * @param {GetTicketMovementSettingsOptions} opts
+   * @returns {Promise<import("axios").AxiosResponse<TicketMovementSettings>>} Response body: ticket movement settings object. Errors: 401, 500
    */
   function get({token, jwtToken, headers}) {
     return client({
@@ -30,12 +99,8 @@ function ticketMovementSettingsFactory({client, internalAuthTokenProvider}) {
    * PUT /ticket-movement-settings - update ticket movement settings for the account.
    * Body must include all required fields (see put-handler getSpec() in btrz-api-accounts).
    * Side effect: persists to account.preferences.ticketMovements.
-   * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.ticketMovementSettings - Full settings payload (see put-handler getSpec())
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse<Object>>} Updated settings. Errors: 400, 401, 500
+   * @param {UpdateTicketMovementSettingsOptions} opts
+   * @returns {Promise<import("axios").AxiosResponse<TicketMovementSettings>>} Updated settings. Errors: 400, 401, 500
    */
   function update({token, jwtToken, ticketMovementSettings, headers}) {
     return client({

package/src/endpoints/operations/manifest.js

@@ -730,6 +730,69 @@ function manifestFactory({
     }
   };
 
+    /**
+   * POST manifests/:manifestId/boarding/:stationId - board passengers at station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.stationId - Station id
+   * @param {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+    function stationBoarding({token, jwtToken, headers, manifestId, stationId, data, query}) {
+      return client({
+        url: `/manifests/${manifestId}/boarding/${stationId}`,
+        method: "post",
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+        data,
+        params: query
+      });
+    }
+    
+  /**
+   * POST manifests/:manifestId/dispatch/:stationId - dispatch manifest at station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.stationId - Station id
+   * @param {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+    function stationDispatch({token, jwtToken, headers, manifestId, stationId, data, query}) {
+      return client({
+        url: `/manifests/${manifestId}/dispatch/${stationId}`,
+        method: "post",
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+        data,
+        params: query
+      });
+    }
+
+            /**
+   * POST manifests/:manifestId/sales-closure/:stationId - close sales at station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.stationId - Station id
+   * @param {Object} opts.data - Request body
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+    function stationSalesClosure({token, jwtToken, headers, manifestId, stationId, data, query}) {
+      return client({
+        url: `/manifests/${manifestId}/sales-closure/${stationId}`,
+        method: "post",
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+        data,
+        params: query
+      });
+    }
+
   return {
     get,
     getAll,
@@ -754,7 +817,10 @@ function manifestFactory({
     reports,
     labels,
     driverRelays,
-    tripClose
+    tripClose,
+    stationBoarding,
+    stationDispatch,
+    stationSalesClosure
   };
 }
 

package/test/endpoints/accounts/ticket-movement-settings.test.js

@@ -17,7 +17,37 @@ describe("accounts/ticket-movement-settings", () => {
 
   it("should update ticket movement settings", () => {
     const ticketMovementSettings = {
-      enabled: true
+      preventMovementsAfterManifestHasBeenPrinted: true,
+      preventSeatmapOptimizationMovementsWithDifferentSeatClassOrFees: false,
+      preventMovementsWhenOriginalManifestIsBoarding: false,
+      originalManifestIsBoardingWhen: null,
+      preventMovementsWhenDestinationManifestIsBoarding: false,
+      destinationManifestIsBoardingWhen: null,
+      preventMovedTicketsFromBeingChanged: true,
+      preventMovedTicketsFromBeingCancelled: false,
+      preventMovementsWhenFareSpecificCapacityLimitsAreExceeded: true,
+      sendSMSNotifications: true,
+      allowSendingEmailNotification: true,
+      useConfirmationRecipientForNotifications: false,
+      maxMovementsPerTicket: 1,
+      maxMovementsPerTicketWithAuthorization: 2,
+      amenityGroupTransitions: {
+        allowAny: true,
+        allowedTransitions: null
+      },
+      timeRestrictions: {
+        originalTripRestrictions: {
+          cutoffMinutes: 0,
+          referencePoint: "original_passenger_departure_time"
+        },
+        newTripRestrictions: {
+          lowerBoundCutoffMinutes: 0,
+          lowerBoundReferencePoint: "original_passenger_departure_time",
+          upperBoundCutoffMinutes: 15,
+          upperBoundReferencePoint: "original_passenger_departure_time"
+        }
+      },
+      followingSeatBehaviorEnabled: true
     };
 
     axiosMock.onPut("/ticket-movement-settings")

package/test/endpoints/operations/manifest.test.js

@@ -406,3 +406,83 @@ describe("operations/manifests/:manifestKey/manifests-exceptions", () => {
     return api.operations.manifest.manifestsExceptions.update({token, jwtToken, manifestKey, manifestException});
   });
 });
+
+describe("operations/manifests/:manifestId/station operations", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should board passengers at station", async () => {
+    const manifestId = "manifestId";
+    const stationId = "stationId";
+    const data = {
+      user: {
+        firstName: "Test",
+        lastName: "Testing",
+        email: "test@betterez.com"
+      }
+    };
+    const query = {bypassValidations: false};
+
+    axiosMock.onPost(`/manifests/${manifestId}/boarding/${stationId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    const call = await api.operations.manifest.stationBoarding({
+      token, jwtToken, manifestId, stationId, data, query
+    });
+    assert.deepStrictEqual(JSON.parse(call.config.data), data);
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+
+  it("should dispatch manifest at station", async () => {
+    const manifestId = "manifestId";
+    const stationId = "stationId";
+    const data = {
+      user: {
+        firstName: "Test",
+        lastName: "Testing",
+        email: "Test@betterez.com",
+        shiftId: "649f20a95679910784326e81",
+        shiftNumber: "S-WTN6LDX"
+      }
+    };
+    const query = {bypassValidations: false};
+
+    axiosMock.onPost(`/manifests/${manifestId}/dispatch/${stationId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    const call = await api.operations.manifest.stationDispatch({
+      token, jwtToken, manifestId, stationId, data, query
+    });
+    assert.deepStrictEqual(JSON.parse(call.config.data), data);
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+
+  it("should close sales at station", async () => {
+    const manifestId = "manifestId";
+    const stationId = "stationId";
+    const data = {
+      user: {
+        firstName: "Test",
+        lastName: "Testing",
+        email: "Test@betterez.com"
+      }
+    };
+    const query = {bypassValidations: false};
+
+    axiosMock.onPost(`/manifests/${manifestId}/sales-closure/${stationId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    const call = await api.operations.manifest.stationSalesClosure({
+      token, jwtToken, manifestId, stationId, data, query
+    });
+    assert.deepStrictEqual(JSON.parse(call.config.data), data);
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+});