btrz-api-client 8.51.0 → 8.52.0

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.52.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

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