btrz-api-client 8.35.0 → 8.38.0

package/lib/client.js

@@ -362,6 +362,7 @@ function createOperations(_ref6) {
     transaction: require("./endpoints/operations/transaction.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     transactions: require("./endpoints/operations/transactions.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     tripChangeInfo: require("./endpoints/operations/trip_change_info.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    cancellationSettings: require("./endpoints/operations/cancellation_settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     vehicleAssignments: require("./endpoints/operations/vehicle_assignments.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     vouchers: require("./endpoints/operations/vouchers.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     waitlists: require("./endpoints/operations/waitlists.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
@@ -424,6 +425,7 @@ function createNotifications(_ref8) {
     externalCustomers: require("./endpoints/notifications/external-customers.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     twilio: require("./endpoints/notifications/twilio.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     salesforce: require("./endpoints/notifications/salesforce.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    shortUrls: require("./endpoints/notifications/short-urls.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     notify: require("./endpoints/notifications/notify.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     ordersRulesValidations: require("./endpoints/notifications/orders-rules-validations.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     __test: {

package/lib/endpoints/inventory/custom-content.js

@@ -27,7 +27,6 @@ function customContentFactory(_ref) {
    * GET /custom-content — List custom content (paginated). Query: enabled, pageId.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth
    * @param {InventoryCustomContentQuery} [opts.query] - Query params (enabled, pageId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ customContent: Object[] }>>}

package/lib/endpoints/inventory/fees.js

@@ -6,10 +6,11 @@ var _require = require("./../endpoints_helpers.js"),
 /**
  * Query params for GET /fees (btrz-api-inventory). See fees get-handler getSpec().
  * @typedef {Object} InventoryFeesQuery
- * @property {string} [providerIds] - Provider IDs to get fees for
- * @property {string} [rules] - Rules where the fees apply
- * @property {string} [productId] - Product ID for the fee
- * @property {string} [internalId] - Fee internal id
+ * @property {string} [providerIds] - Comma-separated provider (account) IDs to get fees for
+ * @property {string} [rules] - Comma-separated rules where the fees apply (e.g. cancel, ticket, transaction)
+ * @property {string} [productId] - Product ID to filter fees by
+ * @property {string} [internalId] - Fee internal id to filter by
+ * @property {string} [page] - Page number for pagination (1-based). Response includes next, previous, count
  */
 
 /**
@@ -32,7 +33,7 @@ function feesFactory(_ref) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {InventoryFeesQuery} [opts.query] - Query params (providerIds, rules, productId, internalId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse<{ fees: Array, next?: string, previous?: string, count: number }>>}
+   * @returns {Promise<import("axios").AxiosResponse<{ fees: Array, next: string, previous: string, count: number }>>}
    * @throws When response is 4xx/5xx (401, 500)
    */
   function all(_ref2) {

package/lib/endpoints/notifications/short-urls.js

@@ -0,0 +1,83 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Request body for POST /short-urls (btrz-api-notifications). Sent as urlData.
+ * @typedef {Object} ShortUrlPostData
+ * @property {string} fullUrl - The full URL to shorten (target of the short link)
+ */
+
+/**
+ * Factory for short URLs API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, getByShortId: function }}
+ */
+
+
+function shortUrlsFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * POST /short-urls - create a short URL for the given fullUrl. Requires JWT (BETTEREZ_APP) and X-API-KEY.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol (required for this endpoint)
+   * @param {ShortUrlPostData} opts.urlData - Payload: fullUrl (required), method (optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ shortUrl: string, shortId: string, fullUrl: string, createdAt: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA fullUrl is required, 401, 500)
+   */
+  function create(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        urlData = _ref2.urlData,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/short-urls",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { urlData: urlData }
+    });
+  }
+
+  /**
+   * GET /u/:shortId - resolve short ID. Returns 302 to full URL. Use maxRedirects: 0 to get Location.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} opts.shortId - The short identifier (e.g. from btrz.ca/u/<shortId>)
+   * @param {number} [opts.maxRedirects=0] - Set to 0 to receive 302 and Location header without following redirect
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA shortId is required, 401, 404 SHORT_URL_NOT_FOUND, 500)
+   */
+  function getByShortId(_ref3) {
+    var token = _ref3.token,
+        shortId = _ref3.shortId,
+        _ref3$maxRedirects = _ref3.maxRedirects,
+        maxRedirects = _ref3$maxRedirects === undefined ? 0 : _ref3$maxRedirects,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/u/" + encodeURIComponent(shortId),
+      method: "get",
+      maxRedirects: maxRedirects,
+      validateStatus: function validateStatus(status) {
+        return status === 302 || status >= 200 && status < 300;
+      },
+      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  return {
+    create: create,
+    getByShortId: getByShortId
+  };
+}
+
+module.exports = shortUrlsFactory;

package/lib/endpoints/operations/cancellation_settings.js

@@ -0,0 +1,42 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function cancellationSettingsFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  function get(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/cancellation-settings",
+      method: "get",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function update(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        data = _ref3.data,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/cancellation-settings",
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  return {
+    get: get,
+    update: update
+  };
+}
+
+module.exports = cancellationSettingsFactory;

package/package.json

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

package/src/client.js

@@ -314,6 +314,7 @@ function createOperations({baseURL, headers, timeout, overrideFn, internalAuthTo
     transaction: require("./endpoints/operations/transaction.js")({client, internalAuthTokenProvider}),
     transactions: require("./endpoints/operations/transactions.js")({client, internalAuthTokenProvider}),
     tripChangeInfo: require("./endpoints/operations/trip_change_info.js")({client, internalAuthTokenProvider}),
+    cancellationSettings: require("./endpoints/operations/cancellation_settings.js")({client, internalAuthTokenProvider}),
     vehicleAssignments: require("./endpoints/operations/vehicle_assignments.js")({client, internalAuthTokenProvider}),
     vouchers: require("./endpoints/operations/vouchers.js")({client, internalAuthTokenProvider}),
     waitlists: require("./endpoints/operations/waitlists.js")({client, internalAuthTokenProvider}),
@@ -362,6 +363,7 @@ function createNotifications({baseURL, headers, timeout, overrideFn, internalAut
     externalCustomers: require("./endpoints/notifications/external-customers.js")({client, internalAuthTokenProvider}),
     twilio: require("./endpoints/notifications/twilio.js")({client, internalAuthTokenProvider}),
     salesforce: require("./endpoints/notifications/salesforce.js")({client, internalAuthTokenProvider}),
+    shortUrls: require("./endpoints/notifications/short-urls.js")({client, internalAuthTokenProvider}),
     notify: require("./endpoints/notifications/notify.js")({client, internalAuthTokenProvider}),
     ordersRulesValidations: require("./endpoints/notifications/orders-rules-validations.js")({client, internalAuthTokenProvider}),
     __test: {

package/src/endpoints/inventory/custom-content.js

@@ -21,7 +21,6 @@ function customContentFactory({client, internalAuthTokenProvider}) {
    * GET /custom-content — List custom content (paginated). Query: enabled, pageId.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth
    * @param {InventoryCustomContentQuery} [opts.query] - Query params (enabled, pageId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ customContent: Object[] }>>}

package/src/endpoints/inventory/fees.js

@@ -3,10 +3,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
 /**
  * Query params for GET /fees (btrz-api-inventory). See fees get-handler getSpec().
  * @typedef {Object} InventoryFeesQuery
- * @property {string} [providerIds] - Provider IDs to get fees for
- * @property {string} [rules] - Rules where the fees apply
- * @property {string} [productId] - Product ID for the fee
- * @property {string} [internalId] - Fee internal id
+ * @property {string} [providerIds] - Comma-separated provider (account) IDs to get fees for
+ * @property {string} [rules] - Comma-separated rules where the fees apply (e.g. cancel, ticket, transaction)
+ * @property {string} [productId] - Product ID to filter fees by
+ * @property {string} [internalId] - Fee internal id to filter by
+ * @property {string} [page] - Page number for pagination (1-based). Response includes next, previous, count
  */
 
 /**
@@ -24,7 +25,7 @@ function feesFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {InventoryFeesQuery} [opts.query] - Query params (providerIds, rules, productId, internalId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse<{ fees: Array, next?: string, previous?: string, count: number }>>}
+   * @returns {Promise<import("axios").AxiosResponse<{ fees: Array, next: string, previous: string, count: number }>>}
    * @throws When response is 4xx/5xx (401, 500)
    */
   function all({token, jwtToken, query = {}, headers}) {

package/src/endpoints/notifications/short-urls.js

@@ -0,0 +1,64 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Request body for POST /short-urls (btrz-api-notifications). Sent as urlData.
+ * @typedef {Object} ShortUrlPostData
+ * @property {string} fullUrl - The full URL to shorten (target of the short link)
+ */
+
+/**
+ * Factory for short URLs API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, getByShortId: function }}
+ */
+function shortUrlsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /short-urls - create a short URL for the given fullUrl. Requires JWT (BETTEREZ_APP) and X-API-KEY.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol (required for this endpoint)
+   * @param {ShortUrlPostData} opts.urlData - Payload: fullUrl (required), method (optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ shortUrl: string, shortId: string, fullUrl: string, createdAt: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA fullUrl is required, 401, 500)
+   */
+  function create({token, jwtToken, urlData, headers}) {
+    return client({
+      url: "/short-urls",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {urlData}
+    });
+  }
+
+  /**
+   * GET /u/:shortId - resolve short ID. Returns 302 to full URL. Use maxRedirects: 0 to get Location.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} opts.shortId - The short identifier (e.g. from btrz.ca/u/<shortId>)
+   * @param {number} [opts.maxRedirects=0] - Set to 0 to receive 302 and Location header without following redirect
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA shortId is required, 401, 404 SHORT_URL_NOT_FOUND, 500)
+   */
+  function getByShortId({token, shortId, maxRedirects = 0, headers}) {
+    return client({
+      url: `/u/${encodeURIComponent(shortId)}`,
+      method: "get",
+      maxRedirects,
+      validateStatus: (status) => {
+        return status === 302 || (status >= 200 && status < 300);
+      },
+      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    create,
+    getByShortId
+  };
+}
+
+module.exports = shortUrlsFactory;

package/src/endpoints/operations/cancellation_settings.js

@@ -0,0 +1,27 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+function cancellationSettingsFactory({client, internalAuthTokenProvider}) {
+  function get({token, jwtToken, headers}) {
+    return client({
+      url: "/cancellation-settings",
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function update({token, jwtToken, data, headers}) {
+    return client({
+      url: "/cancellation-settings",
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  return {
+    get,
+    update
+  };
+}
+
+module.exports = cancellationSettingsFactory;

package/test/endpoints/notifications/short-urls.test.js

@@ -0,0 +1,59 @@
+const {expect} = require("chai");
+const {axiosMock} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("notifications/short-urls", () => {
+  const token = "my-api-key";
+  const jwtToken = "my-jwt";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should POST create short URL with urlData (fullUrl)", () => {
+    const urlData = {fullUrl: "https://example.com/path"};
+    axiosMock.onPost("/short-urls").reply(({headers, data}) => {
+      if (headers["x-api-key"] === token && headers.authorization === `Bearer ${jwtToken}`) {
+        const body = JSON.parse(data);
+        if (body.urlData && body.urlData.fullUrl === urlData.fullUrl) {
+          return [200, {shortUrl: "https://btrz.ca/u/abc123", shortId: "abc123", fullUrl: urlData.fullUrl, createdAt: {}}];
+        }
+        return [400];
+      }
+      return [403];
+    });
+    return api.notifications.shortUrls.create({token, jwtToken, urlData}).then((res) => {
+      expect(res.status).to.equal(200);
+      expect(res.data.shortUrl).to.equal("https://btrz.ca/u/abc123");
+      expect(res.data.shortId).to.equal("abc123");
+    });
+  });
+
+  it("should POST create short URL with only fullUrl", () => {
+    const urlData = {fullUrl: "https://example.com/only"};
+    axiosMock.onPost("/short-urls").reply(({headers, data}) => {
+      const body = JSON.parse(data);
+      if (body.urlData && body.urlData.fullUrl === urlData.fullUrl && !body.urlData.method) {
+        return [200, {shortUrl: "https://btrz.ca/u/xyz", shortId: "xyz", fullUrl: urlData.fullUrl, createdAt: {}}];
+      }
+      return [400];
+    });
+    return api.notifications.shortUrls.create({token, jwtToken, urlData}).then((res) => {
+      expect(res.status).to.equal(200);
+      expect(res.data.fullUrl).to.equal("https://example.com/only");
+    });
+  });
+
+  it("should GET resolve shortId (returns 302)", () => {
+    axiosMock.onGet("/u/V1StGXR8_Z5j").reply(({headers}) => {
+      if (headers["x-api-key"] === token) {
+        return [302, {}, {location: "https://example.com/target"}];
+      }
+      return [401];
+    });
+    return api.notifications.shortUrls.getByShortId({token, shortId: "V1StGXR8_Z5j", maxRedirects: 0}).then((res) => {
+      expect(res.status).to.equal(302);
+      expect(res.headers.location || res.headers.Location).to.equal("https://example.com/target");
+    });
+  });
+});

package/test/endpoints/operations/cancellation_settings.test.js

@@ -0,0 +1,59 @@
+const {expect} = require("chai");
+const {axiosMock, expectRequest} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({
+  baseURL: "http://test.com"
+});
+
+describe("operations/cancellation-settings", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should GET cancellation settings", () => {
+    axiosMock.onGet("/cancellation-settings").reply(expectRequest({
+      statusCode: 200,
+      token
+    }));
+    return api.operations.cancellationSettings.get({
+      token,
+      jwtToken
+    });
+  });
+
+  it("should PUT (update) cancellation settings", () => {
+    const data = {
+      cancellationWindowMinutes: 60,
+      allowCancellationAfterDeparture: false
+    };
+    axiosMock.onPut("/cancellation-settings").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.operations.cancellationSettings.update({
+      token,
+      jwtToken,
+      data
+    });
+  });
+
+  it("should send the request body when updating cancellation settings", async () => {
+    const data = {
+      cancellationWindowMinutes: 120,
+      allowCancellationAfterDeparture: true
+    };
+    axiosMock.onPut("/cancellation-settings").reply((config) => {
+      expect(JSON.parse(config.data)).to.eql(data);
+      return [200, {}];
+    });
+    const response = await api.operations.cancellationSettings.update({
+      token,
+      jwtToken,
+      data
+    });
+    return response;
+  });
+});