btrz-api-client 8.29.0 → 8.30.0

package/src/endpoints/inventory/countries.js

@@ -1,6 +1,22 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for countries API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
 function countriesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /countries - list countries.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client({
       url: "/countries",
@@ -9,6 +25,16 @@ function countriesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /countries/:id - get country by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Country id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/countries/${id}`,

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

@@ -1,8 +1,29 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for custom-content endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryCustomContentQuery
+ */
+
+/**
+ * Factory for custom-content API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
 function customContentFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /custom-content - list custom content.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryCustomContentQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -14,13 +35,31 @@ function customContentFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /custom-content/:customContentId - get custom content by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customContentId - Custom content id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({customContentId, token, headers}) {
     return client.get(`/custom-content/${customContentId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ jwtToken, token, customContent, headers }) {
+  /**
+   * POST /custom-content - create custom content.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.customContent - Custom content payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({jwtToken, token, customContent, headers}) {
     return client({
       url: "/custom-content",
       method: "post",
@@ -31,7 +70,16 @@ function customContentFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function remove({ jwtToken, customContentId, token, headers }) {
+  /**
+   * DELETE /custom-content/:customContentId - remove custom content.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customContentId - Custom content id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({jwtToken, customContentId, token, headers}) {
     return client({
       url: `/custom-content/${customContentId}`,
       method: "delete",
@@ -39,6 +87,16 @@ function customContentFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /custom-content/:customContentId - update custom content.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customContentId - Custom content id
+   * @param {Object} opts.customContent - Custom content payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, customContentId, customContent, headers}) {
     return client({
       url: `/custom-content/${customContentId}`,

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

@@ -1,6 +1,27 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for custom-fields endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryCustomFieldsQuery
+ */
+
+/**
+ * Factory for custom-fields API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, types: object }}
+ */
 function customFieldsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /custom-fields - list custom fields.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryCustomFieldsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client({
       url: "/custom-fields",
@@ -9,6 +30,16 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /custom-fields/:fieldId - get custom field by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.fieldId - Field id
+   * @param {InventoryCustomFieldsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({fieldId, token, jwtToken, query = {}, headers}) {
     return client({
       url: `/custom-fields/${fieldId}`,
@@ -17,6 +48,15 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /custom-fields - create custom field.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.field - Field payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, field, headers}) {
     return client({
       url: "/custom-fields",
@@ -26,6 +66,16 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /custom-fields/:fieldId - update custom field.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.fieldId - Field id
+   * @param {Object} opts.field - Field payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, fieldId, field, headers}) {
     return client({
       url: `/custom-fields/${fieldId}`,
@@ -35,7 +85,15 @@ function customFieldsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ all: function }} */
   const types = {
+    /**
+     * GET /custom-fields/types - list custom field types.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({token, headers}) {
       return client({
         url: "/custom-fields/types",

package/src/endpoints/inventory/docs.js

@@ -1,4 +1,14 @@
+/**
+ * Factory for API docs (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
 function docsFactory({client}) {
+  /**
+   * GET /api-docs-v2 - get API docs.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }

package/src/endpoints/inventory/document-types.js

@@ -1,6 +1,28 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} DocumentTypesQuery
+ * @property {string} [providerId] - Provider account ID (also set via opts.providerId)
+ */
+
+/**
+ * Factory for document-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
 function documentTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /document-types - list document types.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {DocumentTypesQuery} [opts.query] - Query params
+   * @param {string} [opts.providerId] - Provider id (added to query if set)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
     return client({
@@ -11,6 +33,17 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /document-types/:id - get document type by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Document type id
+   * @param {DocumentTypesQuery} [opts.query] - Query params
+   * @param {string} [opts.providerId] - Provider id (added to query if set)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, query = {}, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
     return client({
@@ -21,6 +54,17 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /document-types/:id - update document type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Document type id
+   * @param {Object} opts.data - Document type payload
+   * @param {DocumentTypesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
       url: `/document-types/${id}`,
@@ -31,6 +75,16 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /document-types/:id - remove document type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Document type id
+   * @param {DocumentTypesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/document-types/${id}`,
@@ -40,6 +94,16 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /document-types - create document type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Document type payload
+   * @param {DocumentTypesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/document-types",

package/src/endpoints/inventory/external-passes.js

@@ -2,7 +2,28 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} ExternalPassesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for external-passes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
 function externalPassesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /external-passes - list external passes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ExternalPassesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,6 +36,15 @@ function externalPassesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /external-passes/:externalPassId - get external pass by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.externalPassId - External pass id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({externalPassId, token, jwtToken, headers}) {
     return client.get(`/external-passes/${externalPassId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers})

package/src/endpoints/inventory/external-wallets.js

@@ -2,14 +2,40 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for external-wallets API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ saldoMax: object }}
+ */
 function externalWalletsFactory({client, internalAuthTokenProvider}) {
+  /** @type {{ all: function, create: function, get: function, update: function, movements: object }} */
   const saldoMax = {
+    /**
+     * GET /external-wallets/saldo-max - list saldo max wallets.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: ({token, jwtToken, query = {}, headers}) => {
       return client.get("/external-wallets/saldo-max", {
         params: query,
         headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers})
       });
     },
+    /**
+     * POST /external-wallets/saldo-max - create saldo max wallet.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.externalWallet - External wallet payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: ({token, jwtToken, externalWallet, headers}) => {
       return client({
         url: "/external-wallets/saldo-max",
@@ -18,11 +44,29 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
         data: {externalWallet}
       });
     },
+    /**
+     * GET /external-wallets/saldo-max/:walletId - get saldo max wallet.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.walletId - Wallet id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: ({token, jwtToken, walletId, headers}) => {
       return client.get(`/external-wallets/saldo-max/${walletId}`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * PUT /external-wallets/saldo-max/:externalWallet._id - update saldo max wallet.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.externalWallet - External wallet payload (must include _id)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: ({token, jwtToken, externalWallet, headers}) => {
       const externalWalletFieldsToUpdate = {
         nip: externalWallet.nip,
@@ -39,7 +83,17 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /** @type {{ create: function }} */
     movements: {
+      /**
+       * PUT /external-wallets/saldo-max/:walletId/movements - create movement.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {string} opts.walletId - Wallet id
+       * @param {Object} opts.movement - Movement payload
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create: ({token, jwtToken, walletId, movement}) => {
         return client({
           url: `/external-wallets/saldo-max/${walletId}/movements`,

package/src/endpoints/inventory/fallback-codes.js

@@ -1,6 +1,22 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for fallback-codes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
 function fallbackCodesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /fallback-codes - list fallback codes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/fallback-codes", {
       params: query,
@@ -8,12 +24,29 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /fallback-code/:id - get fallback code by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.id - Fallback code id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, id, headers}) {
     return client.get(`/fallback-code/${id}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /fallback-codes - create fallback code.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.fallbackCode - Fallback code payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, fallbackCode, headers}) {
     return client({
       url: "/fallback-codes",
@@ -23,6 +56,16 @@ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /fallback-code/:fallbackCodeId - update fallback code.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.fallbackCodeId - Fallback code id
+   * @param {Object} opts.fallbackCode - Fallback code payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, fallbackCodeId, fallbackCode, headers}) {
     return client({
       url: `/fallback-code/${fallbackCodeId}`,

package/src/endpoints/inventory/fare-classes.js

@@ -1,30 +1,70 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function fareClassesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for fare-classes endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryFareClassesQuery
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for fare-classes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function }}
+ */
+function fareClassesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /fare-classes - list fare classes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryFareClassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/fare-classes",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, fareClass, headers }) {
+  /**
+   * POST /fare-classes - create fare class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.fareClass - Fare class payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, fareClass, headers}) {
     return client({
       url: "/fare-classes",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { fareClass }
+      data: {fareClass}
     });
   }
 
-  function update({ token, jwtToken, fareClassId, update, headers }) {
+  /**
+   * PATCH /fare-classes/:fareClassId - update fare class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.fareClassId - Fare class id
+   * @param {Object} opts.update - Update payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  // eslint-disable-next-line no-shadow -- param name matches API
+  function update({token, jwtToken, fareClassId, update, headers}) {
     return client({
       url: `/fare-classes/${fareClassId}`,
       method: "patch",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { update }
+      data: {update}
     });
   }