btrz-api-client 8.73.0 → 8.74.0

package/lib/client.js

@@ -610,11 +610,11 @@ function createInvoices(_ref14) {
 }
 
 /**
- * Creates the GPS API client (scannerAppLocation).
+ * Creates the BPE API client (configuration).
  * @param {CreateModuleOptions} opts - Client options
- * @returns {Object} Object with gps endpoint namespaces and __test.client
+ * @returns {Object} Object with bpes endpoint namespaces and __test.client
  */
-function createGPS(_ref15) {
+function createBpes(_ref15) {
   var baseURL = _ref15.baseURL,
       headers = _ref15.headers,
       timeout = _ref15.timeout,
@@ -625,7 +625,7 @@ function createGPS(_ref15) {
   var client = clientFactory({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: overrideFn, agents: agents });
 
   return {
-    scannerAppLocation: require("./endpoints/gps/scanner-app-location.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    configuration: require("./endpoints/bpes/configuration.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     __test: {
       client: client
     }
@@ -633,17 +633,40 @@ function createGPS(_ref15) {
 }
 
 /**
- * Creates the Ratality API client (auth, clients, integrations). Does not use internalAuthTokenProvider.
- * @param {Omit<CreateModuleOptions, "internalAuthTokenProvider">} opts - Client options (no internalAuthTokenProvider)
- * @returns {Object} Object with ratality endpoint namespaces and __test.client
+ * Creates the GPS API client (scannerAppLocation).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with gps endpoint namespaces and __test.client
  */
-function createRatality(_ref16) {
+function createGPS(_ref16) {
   var baseURL = _ref16.baseURL,
       headers = _ref16.headers,
       timeout = _ref16.timeout,
       overrideFn = _ref16.overrideFn,
+      internalAuthTokenProvider = _ref16.internalAuthTokenProvider,
       agents = _ref16.agents;
 
+  var client = clientFactory({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: overrideFn, agents: agents });
+
+  return {
+    scannerAppLocation: require("./endpoints/gps/scanner-app-location.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    __test: {
+      client: client
+    }
+  };
+}
+
+/**
+ * Creates the Ratality API client (auth, clients, integrations). Does not use internalAuthTokenProvider.
+ * @param {Omit<CreateModuleOptions, "internalAuthTokenProvider">} opts - Client options (no internalAuthTokenProvider)
+ * @returns {Object} Object with ratality endpoint namespaces and __test.client
+ */
+function createRatality(_ref17) {
+  var baseURL = _ref17.baseURL,
+      headers = _ref17.headers,
+      timeout = _ref17.timeout,
+      overrideFn = _ref17.overrideFn,
+      agents = _ref17.agents;
+
   var client = clientFactory({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: overrideFn, agents: agents });
   var version = "v2";
 
@@ -671,15 +694,15 @@ function createRatality(_ref16) {
  * @param {{httpAgent: import("http").Agent, httpsAgent: import("https").Agent}} options.agents - An object containg one or both http agents
  */
 function createApiClient(options) {
-  var _ref17 = options || productionOptions,
-      baseURL = _ref17.baseURL,
-      _ref17$baseURLOverrid = _ref17.baseURLOverride,
-      baseURLOverride = _ref17$baseURLOverrid === undefined ? {} : _ref17$baseURLOverrid,
-      headers = _ref17.headers,
-      _ref17$timeout = _ref17.timeout,
-      timeout = _ref17$timeout === undefined ? 0 : _ref17$timeout,
-      internalAuthTokenProvider = _ref17.internalAuthTokenProvider,
-      agents = _ref17.agents;
+  var _ref18 = options || productionOptions,
+      baseURL = _ref18.baseURL,
+      _ref18$baseURLOverrid = _ref18.baseURLOverride,
+      baseURLOverride = _ref18$baseURLOverrid === undefined ? {} : _ref18$baseURLOverrid,
+      headers = _ref18.headers,
+      _ref18$timeout = _ref18.timeout,
+      timeout = _ref18$timeout === undefined ? 0 : _ref18$timeout,
+      internalAuthTokenProvider = _ref18.internalAuthTokenProvider,
+      agents = _ref18.agents;
 
   return {
     constants: require("./constants.js"),
@@ -698,6 +721,7 @@ function createApiClient(options) {
     seatmaps: createSeatmaps({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.seatmaps, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
     btrzpay: createBtrzPay({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.btrzpay, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
     invoices: createInvoices({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
+    bpes: createBpes({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.bpes, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
     gps: createGPS({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
     ratality: createRatality({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.ratality, agents: agents })
   };

package/lib/endpoints/bpes/configuration.js

@@ -0,0 +1,92 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Factory for BPE configuration API (btrz-api-bpes).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, create: function, update: function }}
+ */
+
+
+function configurationFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * GET /bpe-configurations - returns the BPE configuration for the authenticated account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ bpeConfiguration: Object }>>}
+   */
+  function get(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/bpe-configurations",
+      method: "get",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * POST /bpe-configurations - creates the BPE configuration for the authenticated account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.bpeConfiguration - Configuration payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ bpeConfiguration: Object }>>}
+   */
+  function create(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        bpeConfiguration = _ref3.bpeConfiguration,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/bpe-configurations",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { bpeConfiguration: bpeConfiguration }
+    });
+  }
+
+  /**
+   * PUT /bpe-configurations - updates the BPE configuration for the authenticated account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.bpeConfiguration - Configuration payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ bpeConfiguration: Object }>>}
+   */
+  function update(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        bpeConfiguration = _ref4.bpeConfiguration,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/bpe-configurations",
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { bpeConfiguration: bpeConfiguration }
+    });
+  }
+
+  return {
+    get: get,
+    create: create,
+    update: update
+  };
+}
+
+module.exports = configurationFactory;

package/lib/endpoints/inventory/marketplace-modifiers.js

@@ -15,6 +15,8 @@ var _require = require("../endpoints_helpers.js"),
  * @property {string} [latestPurchaseDate] - ISO 8601 datetime (purchase on or before)
  * @property {string} [earliestTravelDate] - ISO 8601 datetime (trip depart on or after)
  * @property {string} [latestTravelDate] - ISO 8601 datetime (trip depart on or before)
+ * @property {string} [currency] - Currency ISO code (e.g. "USD"). Modifiers without a currency apply to all currencies and are always returned
+ * @property {string} [excludeExpired] - When "true", modifiers whose sellEndDate and/or tripEndDate is in the past are not returned
  */
 
 /**

package/lib/productionDefaults.js

@@ -13,6 +13,9 @@ module.exports = {
     },
     trips: function trips(url) {
       return url + "/inventory";
+    },
+    bpes: function bpes(url) {
+      return url + "/bpes";
     }
   }
 };

package/package.json

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

package/src/client.js

@@ -505,6 +505,22 @@ function createInvoices({baseURL, headers, timeout, overrideFn, internalAuthToke
   };
 }
 
+/**
+ * Creates the BPE API client (configuration).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with bpes endpoint namespaces and __test.client
+ */
+function createBpes({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
+  const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
+
+  return {
+    configuration: require("./endpoints/bpes/configuration.js")({client, internalAuthTokenProvider}),
+    __test: {
+      client
+    }
+  };
+}
+
 /**
  * Creates the GPS API client (scannerAppLocation).
  * @param {CreateModuleOptions} opts - Client options
@@ -576,6 +592,7 @@ function createApiClient(options) {
     seatmaps: createSeatmaps({baseURL, headers, timeout, overrideFn: baseURLOverride.seatmaps, internalAuthTokenProvider, agents}),
     btrzpay: createBtrzPay({baseURL, headers, timeout, overrideFn: baseURLOverride.btrzpay, internalAuthTokenProvider, agents}),
     invoices: createInvoices({baseURL, headers, timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider, agents}),
+    bpes: createBpes({baseURL, headers, timeout, overrideFn: baseURLOverride.bpes, internalAuthTokenProvider, agents}),
     gps: createGPS({baseURL, headers, timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider, agents}),
     ratality: createRatality({baseURL, headers, timeout, overrideFn: baseURLOverride.ratality, agents})
   };

package/src/endpoints/bpes/configuration.js

@@ -0,0 +1,70 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Factory for BPE configuration API (btrz-api-bpes).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, create: function, update: function }}
+ */
+function configurationFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /bpe-configurations - returns the BPE configuration for the authenticated account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ bpeConfiguration: Object }>>}
+   */
+  function get({token, jwtToken, headers}) {
+    return client({
+      url: "/bpe-configurations",
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /bpe-configurations - creates the BPE configuration for the authenticated account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.bpeConfiguration - Configuration payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ bpeConfiguration: Object }>>}
+   */
+  function create({token, jwtToken, bpeConfiguration, headers}) {
+    return client({
+      url: "/bpe-configurations",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {bpeConfiguration}
+    });
+  }
+
+  /**
+   * PUT /bpe-configurations - updates the BPE configuration for the authenticated account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.bpeConfiguration - Configuration payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ bpeConfiguration: Object }>>}
+   */
+  function update({token, jwtToken, bpeConfiguration, headers}) {
+    return client({
+      url: "/bpe-configurations",
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {bpeConfiguration}
+    });
+  }
+
+  return {
+    get,
+    create,
+    update
+  };
+}
+
+module.exports = configurationFactory;

package/src/endpoints/inventory/marketplace-modifiers.js

@@ -14,6 +14,8 @@ const {
  * @property {string} [latestPurchaseDate] - ISO 8601 datetime (purchase on or before)
  * @property {string} [earliestTravelDate] - ISO 8601 datetime (trip depart on or after)
  * @property {string} [latestTravelDate] - ISO 8601 datetime (trip depart on or before)
+ * @property {string} [currency] - Currency ISO code (e.g. "USD"). Modifiers without a currency apply to all currencies and are always returned
+ * @property {string} [excludeExpired] - When "true", modifiers whose sellEndDate and/or tripEndDate is in the past are not returned
  */
 
 /**

package/src/productionDefaults.js

@@ -11,6 +11,9 @@ module.exports = {
     },
     trips: (url) => {
       return `${url}/inventory`;
+    },
+    bpes: (url) => {
+      return `${url}/bpes`;
     }
   }
 };

package/test/all.test.js

@@ -149,6 +149,7 @@ require("./endpoints/invoices/invoices.test.js");
 require("./endpoints/invoices/providers.test.js");
 require("./endpoints/invoices/providersSequences.test.js");
 require("./endpoints/invoices/system.test.js");
+require("./endpoints/bpes/configuration.test.js");
 require("./endpoints/loyalty/movements.test.js");
 require("./endpoints/loyalty/programs.test.js");
 require("./endpoints/notifications/customers.test.js");

package/test/endpoints/bpes/configuration.test.js

@@ -0,0 +1,38 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("bpes/configuration", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.restore();
+  });
+
+  it("should get the BPE configuration", () => {
+    axiosMock.onGet("/bpe-configurations").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.bpes.configuration.get({token, jwtToken});
+  });
+
+  it("should create the BPE configuration", () => {
+    axiosMock.onPost("/bpe-configurations").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.bpes.configuration.create({
+      token,
+      jwtToken,
+      bpeConfiguration: {
+        companyIdentificator: "00000000-0000-0000-0000-000000000000"
+      }
+    });
+  });
+
+  it("should update the BPE configuration", () => {
+    axiosMock.onPut("/bpe-configurations").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.bpes.configuration.update({
+      token,
+      jwtToken,
+      bpeConfiguration: {
+        companyIdentificator: "00000000-0000-0000-0000-000000000001"
+      }
+    });
+  });
+});

package/types/client.d.ts

@@ -93,6 +93,7 @@ export function createApiClient(options: {
     seatmaps: any;
     btrzpay: any;
     invoices: any;
+    bpes: any;
     gps: any;
     ratality: any;
 };

package/types/endpoints/bpes/configuration.d.ts

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

package/types/initializedClient.d.ts

@@ -16,6 +16,7 @@ declare const _exports: {
     seatmaps: any;
     btrzpay: any;
     invoices: any;
+    bpes: any;
     gps: any;
     ratality: any;
 };

package/types/productionDefaults.d.ts

@@ -4,6 +4,7 @@ declare const _exports: {
     baseURLOverride: {
         inventory: (arg0: string) => string;
         trips: (arg0: string) => string;
+        bpes: (arg0: string) => string;
     };
 };
 export = _exports;