btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/inventory/mit-terminal-settings.js

@@ -2,7 +2,28 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} MitTerminalSettingsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for mit-terminals-settings 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 mitTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /mit-terminals-settings - list MIT terminal settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {MitTerminalSettingsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,12 +36,30 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /mit-terminals-settings/:id - get MIT terminal setting by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - MIT terminal setting id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({id, token, jwtToken, headers}) {
     return client.get(`/mit-terminals-settings/${id}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /mit-terminals-settings - create MIT terminal settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, mitTerminalSettings, headers}) {
     return client({
       url: "/mit-terminals-settings",
@@ -32,6 +71,15 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /mit-terminals-settings/:id - remove MIT terminal settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - MIT terminal setting id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, id, token, headers}) {
     return client({
       url: `/mit-terminals-settings/${id}`,
@@ -40,6 +88,16 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /mit-terminals-settings/:id - update MIT terminal settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - MIT terminal setting id
+   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, id, mitTerminalSettings, headers}) {
     return client({
       url: `/mit-terminals-settings/${id}`,

package/src/endpoints/inventory/mit-terminals.js

@@ -2,7 +2,28 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} MitTerminalsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for mit-terminals 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 mitTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /mit-terminals - list MIT terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {MitTerminalsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -14,12 +35,30 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /mit-terminals/:mitTerminalId - get MIT terminal by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.mitTerminalId - MIT terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({mitTerminalId, token, headers}) {
     return client.get(`/mit-terminals/${mitTerminalId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /mit-terminals - create MIT terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.mitTerminal - MIT terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, mitTerminal, headers}) {
     return client({
       url: "/mit-terminals",
@@ -31,6 +70,15 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /mit-terminals/:mitTerminalId - remove MIT terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.mitTerminalId - MIT terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, mitTerminalId, token, headers}) {
     return client({
       url: `/mit-terminals/${mitTerminalId}`,
@@ -39,6 +87,16 @@ function mitTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /mit-terminals/:mitTerminalId - update MIT terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.mitTerminalId - MIT terminal id
+   * @param {Object} opts.mitTerminal - MIT terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, mitTerminalId, mitTerminal, headers}) {
     return client({
       url: `/mit-terminals/${mitTerminalId}`,

package/src/endpoints/inventory/operating-companies.js

@@ -1,42 +1,101 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function operatingCompaniesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * @typedef {Object} OperatingCompaniesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for operating-companies 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, get: function, sequences: object }}
+ */
+function operatingCompaniesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /operating-companies - list operating companies.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {OperatingCompaniesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/operating-companies",
       params: query,
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, operatingCompany, headers }) {
+  /**
+   * POST /operating-companies - create operating company.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.operatingCompany - Operating company payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, operatingCompany, headers}) {
     return client({
       url: "/operating-companies",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { operatingCompany }
+      data: {operatingCompany}
     });
   }
 
-  function update({ jwtToken, token, operatingCompanyId, operatingCompany, headers }) {
+  /**
+   * PUT /operating-companies/:operatingCompanyId - update operating company.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.operatingCompanyId - Operating company id
+   * @param {Object} opts.operatingCompany - Operating company payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({jwtToken, token, operatingCompanyId, operatingCompany, headers}) {
     return client({
       url: `/operating-companies/${operatingCompanyId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { operatingCompany }
+      data: {operatingCompany}
     });
   }
 
+  /**
+   * GET /operating-companies/:operatingCompanyId - get operating company by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.operatingCompanyId - Operating company id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, operatingCompanyId, jwtToken, headers}) {
     return client({
       url: `/operating-companies/${operatingCompanyId}`,
       method: "get",
-      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers}),
+      headers: authorizationHeaders({token, internalAuthTokenProvider, jwtToken, headers})
     });
   }
 
+  /** @type {{ create: function, all: function, get: function, update: function }} */
   const sequences = {
+    /**
+     * POST /operating-companies/:operatingCompanyId/sequences - create sequence.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.operatingCompanyId - Operating company id
+     * @param {Object} opts.sequence - Sequence payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, operatingCompanyId, sequence, headers}) {
       return client({
         url: `/operating-companies/${operatingCompanyId}/sequences`,
@@ -45,6 +104,15 @@ function operatingCompaniesFactory({ client, internalAuthTokenProvider }) {
         data: sequence
       });
     },
+    /**
+     * GET /operating-companies/:operatingCompanyId/sequences - list sequences.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.operatingCompanyId - Operating company id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({jwtToken, token, operatingCompanyId, headers}) {
       return client({
         url: `/operating-companies/${operatingCompanyId}/sequences`,
@@ -52,6 +120,16 @@ function operatingCompaniesFactory({ client, internalAuthTokenProvider }) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * GET /operating-companies/:operatingCompanyId/sequences/:sequenceId - get sequence.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.operatingCompanyId - Operating company id
+     * @param {string} opts.sequenceId - Sequence id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({jwtToken, token, operatingCompanyId, sequenceId, headers}) {
       return client({
         url: `/operating-companies/${operatingCompanyId}/sequences/${sequenceId}`,
@@ -59,6 +137,17 @@ function operatingCompaniesFactory({ client, internalAuthTokenProvider }) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * PUT /operating-companies/:operatingCompanyId/sequences/:sequenceId - update sequence.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.operatingCompanyId - Operating company id
+     * @param {string} opts.sequenceId - Sequence id
+     * @param {Object} opts.sequence - Sequence payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({jwtToken, token, operatingCompanyId, sequenceId, sequence, headers}) {
       return client({
         url: `/operating-companies/${operatingCompanyId}/sequences/${sequenceId}`,

package/src/endpoints/inventory/operation-messages.js

@@ -1,17 +1,45 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function operationMessagesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for operation-messages endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryOperationMessagesQuery
+ */
 
-  function all({ token, query = {}, headers }) {
+/**
+ * Factory for operation-messages API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, update: function, remove: function, getByStation: function }}
+ */
+function operationMessagesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /operation-messages - list operation messages.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryOperationMessagesQuery} [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: "/operation-messages",
       method: "get",
       params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, opMsgData, headers }) {
+  /**
+   * POST /operation-messages - create operation message.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.opMsgData - Operation message payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, opMsgData, headers}) {
     return client({
       url: "/operation-messages",
       method: "post",
@@ -20,7 +48,17 @@ function operationMessagesFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function update({ token, jwtToken, operationMessageId, opMsgData, headers }) {
+  /**
+   * PUT /operation-messages/:operationMessageId - update operation message.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.operationMessageId - Operation message id
+   * @param {Object} opts.opMsgData - Operation message payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, operationMessageId, opMsgData, headers}) {
     return client({
       url: `/operation-messages/${operationMessageId}`,
       method: "put",
@@ -29,15 +67,32 @@ function operationMessagesFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * GET /operation-messages/:operationMessageId - get operation message by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.operationMessageId - Operation message id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, operationMessageId, headers}) {
     return client({
       url: `/operation-messages/${operationMessageId}`,
       method: "get",
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers}),
+      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function remove({ jwtToken, operationMessageId, token, headers }) {
+  /**
+   * DELETE /operation-messages/:operationMessageId - remove operation message.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.operationMessageId - Operation message id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({jwtToken, operationMessageId, token, headers}) {
     return client({
       url: `/operation-messages/${operationMessageId}`,
       method: "delete",
@@ -45,7 +100,15 @@ function operationMessagesFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  // it's being used post to get the ability to use a complex json payload
+  /**
+   * POST /operation-messages-stations - get operation messages by station (complex JSON payload).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.opMsgData - Request body (station criteria)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getByStation({token, jwtToken, opMsgData, headers}) {
     return client({
       url: "/operation-messages-stations",

package/src/endpoints/inventory/operation-reasons.js

@@ -1,6 +1,22 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * Factory for operation-reasons 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 operationReasonFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /operation-reasons - list operation reasons.
+   * @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({
       url: "/operation-reasons",
@@ -10,6 +26,16 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /operation-reasons/:id - get operation reason by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operation reason 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: `/operation-reasons/${id}`,
@@ -19,6 +45,17 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /operation-reasons/:id - update operation reason.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operation reason id
+   * @param {Object} opts.operationReason - Operation reason payload
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, id, operationReason, query = {}, headers}) {
     return client({
       url: `/operation-reasons/${id}`,
@@ -29,6 +66,16 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /operation-reasons/:id - remove operation reason.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operation reason id
+   * @param {Object} [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: `/operation-reasons/${id}`,
@@ -38,6 +85,16 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /operation-reasons - create operation reason.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.operationReason - Operation reason payload
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, operationReason, query = {}, headers}) {
     return client({
       url: "/operation-reasons",

package/src/endpoints/inventory/parcel-zones.js

@@ -1,33 +1,71 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function parcelZonesFactory({ client, internalAuthTokenProvider }) {
-  
-  function all({ token, query = {}, headers }) {
+/**
+ * Query params for parcel-zones endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryParcelZonesQuery
+ */
+
+/**
+ * Factory for parcel-zones 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 parcelZonesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /parcel-zones - list parcel zones.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryParcelZonesQuery} [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("/parcel-zones", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, parcelZone, jwtToken, headers }) {
-    return client({ 
+  /**
+   * POST /parcel-zones - create parcel zone.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.parcelZone - Parcel zone payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, parcelZone, jwtToken, headers}) {
+    return client({
       url: "/parcel-zones",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { parcelZone }
+      data: {parcelZone}
     });
   }
 
-  function update({ jwtToken, token, parcelZoneId, parcelZone, headers }) {
-    return client({ 
+  /**
+   * PUT /parcel-zone/:parcelZoneId - update parcel zone.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.parcelZoneId - Parcel zone id
+   * @param {Object} opts.parcelZone - Parcel zone payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({jwtToken, token, parcelZoneId, parcelZone, headers}) {
+    return client({
       url: `/parcel-zone/${parcelZoneId}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      data: { parcelZone }
+      data: {parcelZone}
     });
   }
 
-  return { 
+  return {
     all,
     create,
     update

package/src/endpoints/inventory/pay-on-accounts.js

@@ -1,6 +1,28 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} PayOnAccountsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for pay-on-accounts API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function payOnAccountsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /pay-on-accounts - list pay-on accounts.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PayOnAccountsQuery} [opts.query] - Query params
+   * @param {string} [opts.responseType] - Response type (e.g. json)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, responseType = "json", headers}) {
     return client.get("/pay-on-accounts", {
       params: query,