btrz-api-client 9.11.0 → 9.12.0

package/lib/endpoints/accounts/external-customers.js

@@ -101,6 +101,37 @@ function externalCustomersFactory({
       data
     });
   }
+
+  /**
+   * PUT /external-customers/ado/{externalId} – Update Saldo Max (ADO) client data (e.g. birthDate).
+   * Requires BETTEREZ_APP JWT. Maps to ADO ModificarDatosClienteMonedero.
+   * @param {Object} opts
+   * @param {string} opts.id - ADO idCustomerUnique (path externalId)
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT (BETTEREZ_APP audience)
+   * @param {{birthDate: string}} opts.data - Body; birthDate in DD/MM/YYYY
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ code: string, externalId: string, birthDate: string }>>}
+   */
+  function updateSaldoMaxClientData({
+    id,
+    data,
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client({
+      url: `/external-customers/ado/${encodeURIComponent(id)}`,
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data
+    });
+  }
   const saldoMax = {
     /**
      * GET /external-customers/ado - get SaldoMax user by email, phone or walletId.
@@ -136,6 +167,7 @@ function externalCustomersFactory({
       });
     },
     create: registerSaldoMax,
+    update: updateSaldoMaxClientData,
     confirmation: {
       create: confirmSaldoMaxRegistration,
       resend: {

package/lib/endpoints/inventory/control-classes.js

@@ -18,8 +18,6 @@ const {
  * @property {string} [seatClassId] - Filter by seat class ID(s), comma-separated
  * @property {string} [operatingCompanyId] - Filter by operating company ID(s), comma-separated
  * @property {string} [channel] - Filter by channel(s), comma-separated
- * @property {number} [advancePurchaseFrom] - Filter by advance purchase from (hours)
- * @property {number} [advancePurchaseTo] - Filter by advance purchase to (hours)
  */
 
 /**

package/lib/endpoints/inventory/trips.js

@@ -3,6 +3,33 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} MoveSegmentDemandEntry
+ * @property {string} fromId - Station ObjectId for the moved ticket origin
+ * @property {string} toId - Station ObjectId for the moved ticket destination
+ * @property {string} [fareId] - Optional fare ObjectId
+ * @property {number} [sitting] - Sitting passengers for this segment (default 0)
+ * @property {number} [standing] - Standing passengers for this segment (default 0)
+ */
+
+/**
+ * @typedef {Object} TripsSearchQuery
+ * @property {string} productId
+ * @property {string} originId
+ * @property {string} destinationId
+ * @property {string} fareIds - Format fareId:qty,fareId:qty
+ * @property {string} departureDate - YYYY-MM-DD
+ * @property {string} [returnDate] - YYYY-MM-DD
+ * @property {string} [channel]
+ * @property {string} [currency]
+ * @property {boolean|string} [isMove] - When true, includes dispatched trips and allows moveSegmentDemand
+ * @property {string} [moveSegmentDemand] - JSON stringified MoveSegmentDemandEntry[] used for IROPS/bulk-move segment-aware capacity (requires isMove=true)
+ * @property {boolean|string} [ignoreCutoffs]
+ * @property {boolean|string} [ignorePerFareCapacityLimits]
+ * @property {string} [allowedManifestStatuses]
+ * @property {boolean|string} [includeMoveToTrips]
+ */
+
 /**
  * Factory for trips API (btrz-api-inventory-trips).
  * @param {Object} deps
@@ -19,10 +46,10 @@ function tripsFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key (X-API-KEY)
    * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
-   * @param {Object} [opts.query] - Query params (productId, originId, destinationId, fareIds, departureDate, returnDate, etc.)
+   * @param {TripsSearchQuery} [opts.query] - Query params for trip search
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ trips: { departures: Object[], returns: Object[] } }>>}
-   * @throws 400 INVALID_DATE, INVALID_DATE_FORMAT, INVALID_PRODUCTID, INVALID_ORIGIN, INVALID_DESTINATION, INVALID_CHANNEL, INVALID_FARE, INVALID_FAREID, INVALID_MANIFEST_STATUS, WRONG_DATA
+   * @throws 400 INVALID_DATE, INVALID_DATE_FORMAT, INVALID_PRODUCTID, INVALID_ORIGIN, INVALID_DESTINATION, INVALID_CHANNEL, INVALID_FARE, INVALID_FAREID, INVALID_MANIFEST_STATUS, INVALID_MOVE_SEGMENT_DEMAND, WRONG_DATA
    * @throws 401 Unauthorized
    * @throws 409 NO_HIGHER_OR_EQL_PRICE
    * @throws 500 Internal server error

package/package.json

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

package/src/endpoints/accounts/external-customers.js

@@ -67,6 +67,26 @@ function externalCustomersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /external-customers/ado/{externalId} – Update Saldo Max (ADO) client data (e.g. birthDate).
+   * Requires BETTEREZ_APP JWT. Maps to ADO ModificarDatosClienteMonedero.
+   * @param {Object} opts
+   * @param {string} opts.id - ADO idCustomerUnique (path externalId)
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT (BETTEREZ_APP audience)
+   * @param {{birthDate: string}} opts.data - Body; birthDate in DD/MM/YYYY
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ code: string, externalId: string, birthDate: string }>>}
+   */
+  function updateSaldoMaxClientData({id, data, token, jwtToken, headers}) {
+    return client({
+      url: `/external-customers/ado/${encodeURIComponent(id)}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
   const saldoMax = {
     /**
      * GET /external-customers/ado - get SaldoMax user by email, phone or walletId.
@@ -92,6 +112,7 @@ function externalCustomersFactory({client, internalAuthTokenProvider}) {
       });
     },
     create: registerSaldoMax,
+    update: updateSaldoMaxClientData,
     confirmation: {
       create: confirmSaldoMaxRegistration,
       resend: {

package/src/endpoints/inventory/control-classes.js

@@ -18,8 +18,6 @@ const {
  * @property {string} [seatClassId] - Filter by seat class ID(s), comma-separated
  * @property {string} [operatingCompanyId] - Filter by operating company ID(s), comma-separated
  * @property {string} [channel] - Filter by channel(s), comma-separated
- * @property {number} [advancePurchaseFrom] - Filter by advance purchase from (hours)
- * @property {number} [advancePurchaseTo] - Filter by advance purchase to (hours)
  */
 
 /**

package/src/endpoints/inventory/trips.js

@@ -1,6 +1,33 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} MoveSegmentDemandEntry
+ * @property {string} fromId - Station ObjectId for the moved ticket origin
+ * @property {string} toId - Station ObjectId for the moved ticket destination
+ * @property {string} [fareId] - Optional fare ObjectId
+ * @property {number} [sitting] - Sitting passengers for this segment (default 0)
+ * @property {number} [standing] - Standing passengers for this segment (default 0)
+ */
+
+/**
+ * @typedef {Object} TripsSearchQuery
+ * @property {string} productId
+ * @property {string} originId
+ * @property {string} destinationId
+ * @property {string} fareIds - Format fareId:qty,fareId:qty
+ * @property {string} departureDate - YYYY-MM-DD
+ * @property {string} [returnDate] - YYYY-MM-DD
+ * @property {string} [channel]
+ * @property {string} [currency]
+ * @property {boolean|string} [isMove] - When true, includes dispatched trips and allows moveSegmentDemand
+ * @property {string} [moveSegmentDemand] - JSON stringified MoveSegmentDemandEntry[] used for IROPS/bulk-move segment-aware capacity (requires isMove=true)
+ * @property {boolean|string} [ignoreCutoffs]
+ * @property {boolean|string} [ignorePerFareCapacityLimits]
+ * @property {string} [allowedManifestStatuses]
+ * @property {boolean|string} [includeMoveToTrips]
+ */
+
 /**
  * Factory for trips API (btrz-api-inventory-trips).
  * @param {Object} deps
@@ -14,10 +41,10 @@ function tripsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key (X-API-KEY)
    * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
-   * @param {Object} [opts.query] - Query params (productId, originId, destinationId, fareIds, departureDate, returnDate, etc.)
+   * @param {TripsSearchQuery} [opts.query] - Query params for trip search
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ trips: { departures: Object[], returns: Object[] } }>>}
-   * @throws 400 INVALID_DATE, INVALID_DATE_FORMAT, INVALID_PRODUCTID, INVALID_ORIGIN, INVALID_DESTINATION, INVALID_CHANNEL, INVALID_FARE, INVALID_FAREID, INVALID_MANIFEST_STATUS, WRONG_DATA
+   * @throws 400 INVALID_DATE, INVALID_DATE_FORMAT, INVALID_PRODUCTID, INVALID_ORIGIN, INVALID_DESTINATION, INVALID_CHANNEL, INVALID_FARE, INVALID_FAREID, INVALID_MANIFEST_STATUS, INVALID_MOVE_SEGMENT_DEMAND, WRONG_DATA
    * @throws 401 Unauthorized
    * @throws 409 NO_HIGHER_OR_EQL_PRICE
    * @throws 500 Internal server error

package/test/endpoints/accounts/external-customers.test.js

@@ -94,4 +94,23 @@ describe("accounts/external-customers", () => {
       data
     });
   });
+
+  it("should PUT Saldo Max client data (birthDate) on external-customers/ado/{externalId}", () => {
+    const externalId = "01-1224-000001988";
+    const data = {
+      birthDate: "15/06/1990"
+    };
+    axiosMock.onPut(`/external-customers/ado/${encodeURIComponent(externalId)}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.externalCustomers.saldoMax.update({
+      token,
+      jwtToken,
+      id: externalId,
+      data
+    });
+  });
 });