btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/sales/custom-fields.js

@@ -2,8 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} CustomFieldsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /custom-fields (btrz-api-sales get-custom-fields getSpec).
+ * @typedef {Object} CustomFieldsListQuery
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
  */
 
 /**
@@ -18,7 +19,7 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
    * GET /custom-fields - list custom fields.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {CustomFieldsQuery} [opts.query] - Query params
+   * @param {CustomFieldsListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/flexpasses.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} FlexpassGetQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for flexpasses API (btrz-api-sales).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function flexpassesEndpointsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /flexpasses/:flexpassId - get flexpass by id.
+   * GET /flexpasses/:flexpassId - get flexpass by id. API does not accept query params (btrz-api-sales).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.flexpassId - Flexpass id
-   * @param {FlexpassGetQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/gift-certificates.js

@@ -4,8 +4,10 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /gift-certificates/:GCNumber (btrz-api-sales get-gift-certificate getSpec).
  * @typedef {Object} GiftCertificateGetQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Calculate available balance for the voucher applied to the cart
  */
 
 /**
@@ -23,7 +25,7 @@ function giftCertificatesFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.GCNumber - Gift certificate number
-   * @param {GiftCertificateGetQuery} [opts.query] - Query params
+   * @param {GiftCertificateGetQuery} [opts.query] - Query params (providerId, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/order.js

@@ -2,14 +2,16 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for POST /orders/:orderId/payments (btrz-api-sales post-payments-handler getSpec).
  * @typedef {Object} OrderPaymentsQuery
- * @property {string} channel - Channel where cart is being purchased (see API for allowed values)
- * @property {string} [providerId] - Account ID the transaction belongs to
+ * @property {string} [channel] - Channel where cart is being purchased (defaults to 'none' when not provided)
+ * @property {string} [providerId] - Account id the transaction belongs to
  */
 
 /**
+ * Query params for GET /order/:orderId (btrz-api-sales get-order getSpec).
  * @typedef {Object} OrderGetQuery
- * @property {string} [providerId] - Account ID for the order
+ * @property {string} [providerId] - Provider account id
  */
 
 /**
@@ -63,7 +65,7 @@ function orderFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts.payments - Payments payload
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
-   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel required, providerId optional)
+   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel, providerId)
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function overwrite({token, orderId, payments, jwtToken, headers, query = {}}) {

package/src/endpoints/sales/parcel-quotes.js

@@ -12,7 +12,7 @@ const {
  */
 function parcelQuotesFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /parcel-quotes - get parcel quote.
+   * POST /parcel-quotes - get parcel quote. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.parcelQuoteData - Parcel quote request payload

package/src/endpoints/sales/payment-providers.js

@@ -2,8 +2,11 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} PaymentProvidersQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /payment-providers (btrz-api-sales get-payment-providers getSpec).
+ * @typedef {Object} PaymentProvidersListQuery
+ * @property {string} [providerId] - Provider id to get payment providers for
+ * @property {string} [channel] - Channel to get payment providers for
+ * @property {string} [enabled] - Filter by enabled [true, false]
  */
 
 /**
@@ -19,7 +22,7 @@ function paymentProvidersFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PaymentProvidersQuery} [opts.query] - Query params
+   * @param {PaymentProvidersListQuery} [opts.query] - Query params (providerId, channel, enabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/redeemable-items.js

@@ -2,8 +2,19 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} RedeemableItemsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /redeemable-items/:redeemableItemId (btrz-api-sales get-redeemable-item getSpec).
+ * @typedef {Object} RedeemableItemsGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
+ * @property {string} [cartId] - Current cart id (item can be redeemed once per cart)
+ */
+
+/**
+ * Query params for GET /redeemable-items list (btrz-api-sales get-redeemable-items getSpec).
+ * @typedef {Object} RedeemableItemsListQuery
+ * @property {string} [ids] - Redeemable item display ID or _id, comma-separated
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Current cart id
  */
 
 /**
@@ -18,8 +29,8 @@ function redeemableItemsFactory({client, internalAuthTokenProvider}) {
    * GET /redeemable-items/:redeemableItemId - get redeemable item by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.redeemableItemId - Redeemable item id
-   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {string} opts.redeemableItemId - Redeemable item display ID or _id
+   * @param {RedeemableItemsGetQuery} [opts.query] - Query params (providerId, providerIds, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -36,7 +47,7 @@ function redeemableItemsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {RedeemableItemsListQuery} [opts.query] - Query params (ids, providerId, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/sync-entry.js

@@ -10,7 +10,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function syncEntryFactory({client, internalAuthTokenProvider}) {
   /**
-   * PATCH /sync-entry - patch sync entry.
+   * PATCH /sync-entry - patch sync entry. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.data - Request body

package/src/endpoints/sales/voucher.js

@@ -12,7 +12,7 @@ const {
  * @property {string} [productType] - Product type of the voucher
  * @property {string} [from] - Station "from" to validate if voucher has routes
  * @property {string} [to] - Station "to" to validate if voucher has routes
- * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare
+ * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare; use fareIds instead
  * @property {string} [fareIds] - Validates if voucher has one fare ID
  * @property {string} [displayCurrencyCode] - Display currency code for multi-currency accounts
  */

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