btrz-api-client 9.11.0 → 9.13.0

package/lib/client.js

@@ -536,6 +536,10 @@ function createAccounts({
       client,
       internalAuthTokenProvider
     }),
+    qrMappings: require("./endpoints/accounts/qr-mappings.js")({
+      client,
+      internalAuthTokenProvider
+    }),
     emailSettings: require("./endpoints/accounts/email-settings.js")({
       client,
       internalAuthTokenProvider

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/accounts/qr-mappings.js

@@ -0,0 +1,167 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /qr-mappings (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} QrMappingsListQuery
+ * @property {number} [page] - 1-based page for pagination
+ */
+
+/**
+ * Factory for qr-mappings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, update: function, remove: function }}
+ */
+function qrMappingsFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /qr-mappings/:qrMappingId - get a QR mapping.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.qrMappingId - QR mapping id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({
+    token,
+    jwtToken,
+    qrMappingId,
+    headers
+  }) {
+    return client({
+      url: `/qr-mappings/${qrMappingId}`,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * GET /qr-mappings - list QR mappings (paginated when page is provided).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {QrMappingsListQuery} [opts.query] - Query params (page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({
+    token,
+    jwtToken,
+    query = {},
+    headers
+  }) {
+    return client({
+      url: "/qr-mappings",
+      params: query,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * POST /qr-mappings - create a QR mapping.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - QR mapping payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({
+    token,
+    jwtToken,
+    data,
+    headers
+  }) {
+    return client({
+      url: "/qr-mappings",
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data
+    });
+  }
+
+  /**
+   * PUT /qr-mappings/:qrMappingId - update a QR mapping.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.qrMappingId - QR mapping id (ObjectId)
+   * @param {Object} opts.data - QR mapping payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({
+    token,
+    jwtToken,
+    qrMappingId,
+    data,
+    headers
+  }) {
+    return client({
+      url: `/qr-mappings/${qrMappingId}`,
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data
+    });
+  }
+
+  /**
+   * DELETE /qr-mappings/:qrMappingId - delete a QR mapping.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.qrMappingId - QR mapping id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({
+    qrMappingId,
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client({
+      url: `/qr-mappings/${qrMappingId}`,
+      method: "delete",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+  return {
+    get,
+    all,
+    create,
+    update,
+    remove
+  };
+}
+module.exports = qrMappingsFactory;

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.13.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/client.js

@@ -200,6 +200,7 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     }),
     domains: require("./endpoints/accounts/domains.js")({client, internalAuthTokenProvider}),
     dynamicForms: require("./endpoints/accounts/dynamic-forms.js")({client, internalAuthTokenProvider}),
+    qrMappings: require("./endpoints/accounts/qr-mappings.js")({client, internalAuthTokenProvider}),
     emailSettings: require("./endpoints/accounts/email-settings.js")({client, internalAuthTokenProvider}),
     emailTemplates: require("./endpoints/accounts/email-templates.js")({client, internalAuthTokenProvider}),
     smsTemplates: require("./endpoints/accounts/sms-templates.js")({client, internalAuthTokenProvider}),

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/accounts/qr-mappings.js

@@ -0,0 +1,107 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /qr-mappings (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} QrMappingsListQuery
+ * @property {number} [page] - 1-based page for pagination
+ */
+
+/**
+ * Factory for qr-mappings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, update: function, remove: function }}
+ */
+function qrMappingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /qr-mappings/:qrMappingId - get a QR mapping.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.qrMappingId - QR mapping id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, qrMappingId, headers}) {
+    return client({
+      url: `/qr-mappings/${qrMappingId}`,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * GET /qr-mappings - list QR mappings (paginated when page is provided).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {QrMappingsListQuery} [opts.query] - Query params (page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/qr-mappings",
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /qr-mappings - create a QR mapping.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - QR mapping payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, data, headers}) {
+    return client({
+      url: "/qr-mappings",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  /**
+   * PUT /qr-mappings/:qrMappingId - update a QR mapping.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.qrMappingId - QR mapping id (ObjectId)
+   * @param {Object} opts.data - QR mapping payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, qrMappingId, data, headers}) {
+    return client({
+      url: `/qr-mappings/${qrMappingId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  /**
+   * DELETE /qr-mappings/:qrMappingId - delete a QR mapping.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.qrMappingId - QR mapping id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({qrMappingId, token, jwtToken, headers}) {
+    return client({
+      url: `/qr-mappings/${qrMappingId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {get, all, create, update, remove};
+}
+
+module.exports = qrMappingsFactory;

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/all.test.js

@@ -10,6 +10,7 @@ require("./endpoints/accounts/current-shifts.test.js");
 require("./endpoints/accounts/customers.js");
 require("./endpoints/accounts/domains.test.js");
 require("./endpoints/accounts/dynamic-forms.test.js");
+require("./endpoints/accounts/qr-mappings.test.js");
 require("./endpoints/accounts/email-templates.test.js");
 require("./endpoints/accounts/exchange-rates.test.js");
 require("./endpoints/accounts/exchange-receipts.test.js");

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
+    });
+  });
 });

package/test/endpoints/accounts/qr-mappings.test.js

@@ -0,0 +1,73 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("accounts/qr-mappings/", () => {
+  const token = "someToken";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.restore();
+  });
+
+  it("should GET a list of qr mappings", () => {
+    axiosMock.onGet("/qr-mappings").reply(expectRequest({
+      statusCode: 200,
+      token
+    }));
+    return api.accounts.qrMappings.all({
+      token
+    });
+  });
+
+  it("should GET a list of qr mappings with page query", () => {
+    const query = {page: 2};
+    axiosMock.onGet("/qr-mappings").reply(expectRequest({
+      statusCode: 200,
+      token,
+      query
+    }));
+    return api.accounts.qrMappings.all({
+      token,
+      query
+    });
+  });
+
+  it("should GET the qr mapping", () => {
+    const qrMappingId = "123";
+    axiosMock.onGet(`/qr-mappings/${qrMappingId}`)
+      .reply(expectRequest({statusCode: 200, token}));
+    return api.accounts.qrMappings.get({token, jwtToken, qrMappingId});
+  });
+
+  it("should create qr mapping", () => {
+    const data = {name: "mapping", separator: "|", segments: []};
+    axiosMock.onPost("/qr-mappings").reply(expectRequest({statusCode: 200, token, jwtToken, body: data}));
+    return api.accounts.qrMappings.create({
+      jwtToken,
+      token,
+      data
+    });
+  });
+
+  it("should update qr mapping", () => {
+    const qrMappingId = "123";
+    const data = {name: "updated", separator: "-", segments: []};
+    axiosMock.onPut(`/qr-mappings/${qrMappingId}`).reply(expectRequest({statusCode: 200, token, jwtToken, body: data}));
+    return api.accounts.qrMappings.update({
+      jwtToken,
+      qrMappingId,
+      token,
+      data
+    });
+  });
+
+  it("should delete qr mapping", () => {
+    const qrMappingId = "123";
+    axiosMock.onDelete(`/qr-mappings/${qrMappingId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.accounts.qrMappings.remove({
+      jwtToken,
+      qrMappingId,
+      token
+    });
+  });
+});