btrz-api-client 8.51.0 → 8.53.0

package/lib/client.js

@@ -265,6 +265,7 @@ function createAccounts(_ref4) {
     salesforceSettings: require("./endpoints/accounts/salesforce-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     shifts: require("./endpoints/accounts/shifts.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     shiftSettings: require("./endpoints/accounts/shift-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    systemModelSettings: require("./endpoints/accounts/system-model-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     ticketMovementSettings: require("./endpoints/accounts/ticket-movement-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     tokens: require("./endpoints/accounts/tokens.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     travellers: require("./endpoints/accounts/travellers.js")({

package/lib/endpoints/accounts/system-model-settings.js

@@ -0,0 +1,75 @@
+"use strict";
+
+var _require = require("./../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Factory for system-model-settings API (btrz-api-accounts). Requires BETTEREZ_APP audience.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
+
+
+function systemModelSettingsFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * GET /system-models/:modelName/settings – required-field settings for a system model.
+   * @param {Object} opts
+   * @param {string} opts.modelName - System model
+   * @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<{ systemModelSettings: object }>>}
+   */
+  function get(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        modelName = _ref2.modelName,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/system-models/" + modelName + "/settings",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * PUT /system-models/:modelName/settings – create or update required-field settings.
+   * @param {Object} opts
+   * @param {string} opts.modelName - System model
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.systemModelSettings - Payload (requiredFields, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ systemModelSettings: object }>>}
+   */
+  function update(_ref3) {
+    var jwtToken = _ref3.jwtToken,
+        token = _ref3.token,
+        modelName = _ref3.modelName,
+        systemModelSettings = _ref3.systemModelSettings,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/system-models/" + modelName + "/settings",
+      method: "put",
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      }),
+      data: {
+        systemModelSettings: systemModelSettings
+      }
+    });
+  }
+
+  return {
+    get: get,
+    update: update
+  };
+}
+
+module.exports = systemModelSettingsFactory;

package/lib/endpoints/inventory/countries.js

@@ -7,6 +7,7 @@ var _require = require("./../endpoints_helpers.js"),
  * Query params for GET /countries (btrz-api-inventory). See get-countries getSpec().
  * @typedef {Object} CountriesListQuery
  * @property {string} [isoCode] - Country 2- or 3-letter ISO code (must be 2 or 3 chars if provided)
+ * @property {"name"|"ord"} [sortBy] - Sort: `name` (default) by country name ascending; `ord` by display order then name
  */
 
 /**
@@ -30,11 +31,11 @@ function countriesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /countries — List countries. Optional filter by isoCode (2 or 3 characters).
+   * GET /countries — List countries. Optional filter by isoCode (2 or 3 characters) and sortBy.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth
-   * @param {CountriesListQuery} [opts.query] - Query params (isoCode)
+   * @param {CountriesListQuery} [opts.query] - Query params (isoCode, sortBy)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ countries: Object[] }>>}
    * @throws 400 Validation failure (e.g. invalid isoCode length)

package/package.json

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

package/src/client.js

@@ -229,6 +229,7 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     salesforceSettings: require("./endpoints/accounts/salesforce-settings.js")({client, internalAuthTokenProvider}),
     shifts: require("./endpoints/accounts/shifts.js")({client, internalAuthTokenProvider}),
     shiftSettings: require("./endpoints/accounts/shift-settings.js")({client, internalAuthTokenProvider}),
+    systemModelSettings: require("./endpoints/accounts/system-model-settings.js")({client, internalAuthTokenProvider}),
     ticketMovementSettings: require("./endpoints/accounts/ticket-movement-settings.js")({client, internalAuthTokenProvider}),
     tokens: require("./endpoints/accounts/tokens.js")({client, internalAuthTokenProvider}),
     travellers: require("./endpoints/accounts/travellers.js")({

package/src/endpoints/accounts/system-model-settings.js

@@ -0,0 +1,58 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for system-model-settings API (btrz-api-accounts). Requires BETTEREZ_APP audience.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
+function systemModelSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /system-models/:modelName/settings – required-field settings for a system model.
+   * @param {Object} opts
+   * @param {string} opts.modelName - System model
+   * @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<{ systemModelSettings: object }>>}
+   */
+  function get({token, jwtToken, modelName, headers}) {
+    return client({
+      url: `/system-models/${modelName}/settings`,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * PUT /system-models/:modelName/settings – create or update required-field settings.
+   * @param {Object} opts
+   * @param {string} opts.modelName - System model
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.systemModelSettings - Payload (requiredFields, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ systemModelSettings: object }>>}
+   */
+  function update({jwtToken, token, modelName, systemModelSettings, headers}) {
+    return client({
+      url: `/system-models/${modelName}/settings`,
+      method: "put",
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      }),
+      data: {
+        systemModelSettings
+      }
+    });
+  }
+
+  return {
+    get,
+    update
+  };
+}
+
+module.exports = systemModelSettingsFactory;

package/src/endpoints/inventory/countries.js

@@ -4,6 +4,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * Query params for GET /countries (btrz-api-inventory). See get-countries getSpec().
  * @typedef {Object} CountriesListQuery
  * @property {string} [isoCode] - Country 2- or 3-letter ISO code (must be 2 or 3 chars if provided)
+ * @property {"name"|"ord"} [sortBy] - Sort: `name` (default) by country name ascending; `ord` by display order then name
  */
 
 /**
@@ -22,11 +23,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function countriesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /countries — List countries. Optional filter by isoCode (2 or 3 characters).
+   * GET /countries — List countries. Optional filter by isoCode (2 or 3 characters) and sortBy.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth
-   * @param {CountriesListQuery} [opts.query] - Query params (isoCode)
+   * @param {CountriesListQuery} [opts.query] - Query params (isoCode, sortBy)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ countries: Object[] }>>}
    * @throws 400 Validation failure (e.g. invalid isoCode length)

package/test/endpoints/accounts/system-model-settings.test.js

@@ -0,0 +1,37 @@
+const {
+  axiosMock, expectRequest
+} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("accounts/system-model-settings", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+  const modelName = "station";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should update system model settings", () => {
+    const path = `/system-models/${modelName}/settings`;
+    axiosMock.onPut(path).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.accounts.systemModelSettings.update({
+      jwtToken,
+      token,
+      modelName,
+      systemModelSettings: {
+        requiredFields: []
+      }
+    });
+  });
+
+  it("should get system model settings", () => {
+    const path = `/system-models/${modelName}/settings`;
+    axiosMock.onGet(path).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.accounts.systemModelSettings.get({
+      jwtToken,
+      token,
+      modelName
+    });
+  });
+});

package/test/endpoints/inventory/countries.test.js

@@ -14,6 +14,12 @@ describe("inventory/countries", () => {
     return api.inventory.countries.all({token});
   });
 
+  it("should list countries with query params (e.g. sortBy)", () => {
+    const query = {sortBy: "ord"};
+    axiosMock.onGet("/countries").reply(expectRequest({statusCode: 200, token, query}));
+    return api.inventory.countries.all({token, query});
+  });
+
   it("should get a country by id", () => {
     const countryId = "countryId";
     axiosMock.onGet(`/countries/${countryId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));