btrz-api-client 8.31.0 → 8.33.0

package/src/endpoints/coltrane/info.js

@@ -0,0 +1,28 @@
+/* eslint-disable max-len */
+/**
+ * Factory for Coltrane info API (btrz-api-coltrane) — service and dependency status.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
+function infoFactory({client}) {
+  /**
+   * GET /info — get Coltrane API service status and dependency health. No authentication required.
+   * @param {Object} [opts]
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { status: number, services: Array<{ name: string, status: number }>, build?: string, instanceId?: string, commit?: string } }>>}
+   * @throws {import("axios").AxiosError} 500 Internal server error or dependency check failure
+   */
+  function get({headers} = {}) {
+    return client({
+      url: "/info",
+      headers: headers || {}
+    });
+  }
+
+  return {
+    get
+  };
+}
+
+module.exports = infoFactory;

package/src/endpoints/coltrane/paths.js

@@ -2,15 +2,16 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /paths (btrz-api-coltrane). See get-paths getSpec().
+ * Query params for GET /paths (btrz-api-coltrane). All except metrics and preferredAlgorithm are required by the API.
  * @typedef {Object} ColtranePathsListQuery
- * @property {string} [providerId] - Account ID of the travel provider (required by API)
- * @property {string} [productId] - Product ID belonging to the provider (required by API)
- * @property {string} [originId] - Origin station id (required by API)
- * @property {string} [destinationId] - Destination station id (required by API)
- * @property {string} [departureFromDate] - Start of search interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
- * @property {string} [departureToDate] - End of search interval; ISO 8601; interval max 25h
- * @property {string} [metrics] - If true, response includes metrics (debugging)
+ * @property {string} [providerId] - Account ID of the travel provider (24-char hex)
+ * @property {string} [productId] - Product ID belonging to the provider (24-char hex)
+ * @property {string} [originId] - Origin station ID (24-char hex); must differ from destinationId
+ * @property {string} [destinationId] - Destination station ID (24-char hex)
+ * @property {string} [departureFromDate] - Start of departure interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
+ * @property {string} [departureToDate] - End of departure interval; ISO 8601; interval max 25h, must be after departureFromDate
+ * @property {string} [preferredAlgorithm] - "search_algorithm_fast" or "search_algorithm_exhaustive"
+ * @property {string|boolean} [metrics] - If true, response includes metrics object (debugging)
  */
 
 /**
@@ -22,12 +23,15 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function coltraneFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /paths - list Coltrane paths.
+   * GET /paths — search for travel paths between two stations in a departure time interval.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {ColtranePathsListQuery} [opts.query] - Query params (providerId, productId, originId, destinationId, etc.)
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {ColtranePathsListQuery} [opts.query] - Query params; providerId, productId, originId, destinationId, departureFromDate, departureToDate required
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { paths: Array<{ segments: Array<{ scheduleId: string, manifestDay: string, fromLegIndex: number, toLegIndex: number }> }>, metrics?: object } }>>}
+   * @throws {import("axios").AxiosError} 400 INVALID_QUERY_PARAMETERS (invalid params, originId=destinationId, interval &gt; 25h, or invalid preferredAlgorithm)
+   * @throws {import("axios").AxiosError} 401 Unauthorized
+   * @throws {import("axios").AxiosError} 500 Internal server error
    */
   function all({token, query = {}, headers}) {
     return client({

package/test/endpoints/accounts/agencies.test.js

@@ -0,0 +1,58 @@
+const {
+  axiosMock,
+  expectRequest
+} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({
+  baseURL: "http://test.com"
+});
+
+describe("accounts/agencies", () => {
+  const jwtToken = "I owe you a JWT token";
+  const token = "I owe you a token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should PUT credit limit for an agency", () => {
+    const agencyId = "507f1f77bcf86cd799439011";
+    const data = {
+      limitAmount: 1000,
+      unlimited: false
+    };
+    axiosMock.onPut(`/agencies/${agencyId}/credit-limit`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.agencies.putCreditLimit({
+      token,
+      jwtToken,
+      agencyId,
+      data
+    });
+  });
+
+  it("should PUT credit limit with wrapped creditLimit body", () => {
+    const agencyId = "507f1f77bcf86cd799439012";
+    const data = {
+      creditLimit: {
+        limitAmount: 2000,
+        unlimited: true
+      }
+    };
+    axiosMock.onPut(`/agencies/${agencyId}/credit-limit`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.agencies.putCreditLimit({
+      token,
+      jwtToken,
+      agencyId,
+      data
+    });
+  });
+});

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

@@ -0,0 +1,62 @@
+const {
+  axiosMock,
+  expectRequest
+} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({
+  baseURL: "http://test.com"
+});
+
+describe("accounts/external-customers", () => {
+  const jwtToken = "I owe you a JWT token";
+  const token = "I owe you a token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should POST Saldo Max registration (external-customers/ado)", () => {
+    const data = {
+      firstName: "TestName",
+      lastName: "TestLastName",
+      email: "test@betterez.com",
+      password: "YmFzZTY0cGFzc3dvcmQ=",
+      verificationCode: "689411",
+      isoCode: "AR"
+    };
+    axiosMock.onPost("/external-customers/ado").reply(expectRequest({
+      statusCode: 201,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.externalCustomers.registerSaldoMax({
+      token,
+      jwtToken,
+      data
+    });
+  });
+
+  it("should POST with body wrapper when using body key", () => {
+    const data = {
+      body: {
+        firstName: "A",
+        lastName: "B",
+        email: "a@b.com",
+        password: "cGFzcw==",
+        verificationCode: "123",
+        isoCode: "MX"
+      }
+    };
+    const withoutApiKey = true;
+    axiosMock.onPost("/external-customers/ado").reply(expectRequest({
+      statusCode: 201,
+      jwtToken,
+      withoutApiKey,
+      body: data
+    }));
+    return api.accounts.externalCustomers.registerSaldoMax({
+      jwtToken,
+      data
+    });
+  });
+});

package/test/endpoints/accounts/users.js

@@ -61,6 +61,16 @@ describe("accounts/user/{id}", () => {
     });
   });
 
+  it("should delete a user", () => {
+    const userId = "627a25404a761f0fcbdbdfc1";
+    axiosMock.onDelete(`/users/${userId}`).reply(expectRequest({statusCode: 204, token, jwtToken}));
+    return api.accounts.users.delete({
+      jwtToken,
+      token,
+      id: userId
+    });
+  });
+
   it("should create a user", () => {
     const user = {
       firstName: "Jane",

package/test/endpoints/accounts/verified-emails.test.js

@@ -0,0 +1,35 @@
+const {axiosMock, expectRequest} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("accounts/verified-emails", () => {
+  const token = "someToken";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.restore();
+  });
+
+  it("should get all verified emails", () => {
+    const query = {page: 1, pageSize: 20};
+    axiosMock.onGet("/verified-emails").reply(expectRequest({statusCode: 200, token, jwtToken, query}));
+    return api.accounts.verifiedEmails.all({token, jwtToken, query});
+  });
+
+  it("should get verified email by email address", () => {
+    const email = "user@example.com";
+    axiosMock.onGet(`/verified-emails/${encodeURIComponent(email)}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.accounts.verifiedEmails.get({token, jwtToken, email});
+  });
+  it("should create a verified email", () => {
+    const data = {email: "test@example.com", status: "WHITELISTED"};
+    axiosMock.onPost("/verified-emails").reply(expectRequest({statusCode: 200, token, jwtToken, body: data}));
+    return api.accounts.verifiedEmails.create({token, jwtToken, data});
+  });
+
+  it("should update a verified email", () => {
+    const email = "user@example.com";
+    const data = {status: "BLACKLISTED"};
+    axiosMock.onPut(`/verified-emails/${encodeURIComponent(email)}`).reply(expectRequest({statusCode: 200, token, jwtToken, body: data}));
+    return api.accounts.verifiedEmails.update({token, jwtToken, email, data});
+  });
+});

package/test/endpoints/coltrane/healthcheck.test.js

@@ -0,0 +1,13 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("coltrane/healthcheck", () => {
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should get healthcheck (liveness)", () => {
+    axiosMock.onGet("/healthcheck").reply(expectRequest({statusCode: 200, withoutApiKey: true}));
+    return api.coltrane.healthcheck.get();
+  });
+});

package/test/endpoints/coltrane/info.test.js

@@ -0,0 +1,13 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("coltrane/info", () => {
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should get Coltrane service info (status and dependencies)", () => {
+    axiosMock.onGet("/info").reply(expectRequest({statusCode: 200, withoutApiKey: true}));
+    return api.coltrane.info.get();
+  });
+});

package/types/endpoints/accounts/users.d.ts

@@ -4,7 +4,7 @@ export = usersFactory;
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
+ * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
  */
 declare function usersFactory({ client, internalAuthTokenProvider }: {
     client: import("axios").AxiosInstance;
@@ -18,6 +18,7 @@ declare function usersFactory({ client, internalAuthTokenProvider }: {
     create: Function;
     login: Function;
     update: Function;
+    delete: Function;
     createOrUpdateMany: Function;
     impersonate: Function;
     startMfa: Function;

package/types/endpoints/accounts/verified-emails.d.ts

@@ -0,0 +1,19 @@
+export = verifiedEmailsFactory;
+/**
+ * Factory for verified-emails API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
+declare function verifiedEmailsFactory({ client, internalAuthTokenProvider }: {
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): {
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+};