btrz-api-client 8.29.0 → 8.31.0

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

@@ -3,10 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /mit-terminals - list MIT terminals. API does not accept query params.
+   * @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>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +36,15 @@ function mitTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * GET /mit-terminals/:mitTerminalId - get MIT terminal by id. API does not accept query params.
+   * @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(_ref3) {
     var mitTerminalId = _ref3.mitTerminalId,
         token = _ref3.token,
@@ -29,6 +55,15 @@ function mitTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * POST /mit-terminals - create MIT terminal. API does not accept query params.
+   * @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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -45,6 +80,15 @@ function mitTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /mit-terminals/:mitTerminalId - remove MIT terminal. API does not accept query params.
+   * @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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         mitTerminalId = _ref5.mitTerminalId,
@@ -58,6 +102,16 @@ function mitTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /mit-terminals/:mitTerminalId - update MIT terminal. API does not accept query params.
+   * @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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

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

@@ -1,13 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /operating-companies (btrz-api-inventory). See get-operating-companies getSpec().
+ * @typedef {Object} OperatingCompaniesListQuery
+ * @property {string} [providerIds] - Provider IDs to get operating companies for
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ * @property {number} [page] - Page number (1-based); null for unpaginated
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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 {OperatingCompaniesListQuery} [opts.query] - Query params (providerIds, enabled, page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +47,15 @@ function operatingCompaniesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /operating-companies - create operating company. API does not accept query params.
+   * @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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -36,6 +70,16 @@ function operatingCompaniesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /operating-companies/:operatingCompanyId - update operating company. API does not accept query params.
+   * @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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -51,6 +95,15 @@ function operatingCompaniesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /operating-companies/:operatingCompanyId - get operating company by id. API does not accept query params.
+   * @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(_ref5) {
     var token = _ref5.token,
         operatingCompanyId = _ref5.operatingCompanyId,
@@ -64,7 +117,18 @@ function operatingCompaniesFactory(_ref) {
     });
   }
 
+  /** @type {{ create: function, all: function, get: function, update: function }} */
   var sequences = {
+    /**
+     * POST /operating-companies/:operatingCompanyId/sequences - create sequence. API does not accept query params.
+     * @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: function create(_ref6) {
       var jwtToken = _ref6.jwtToken,
           token = _ref6.token,
@@ -79,6 +143,16 @@ function operatingCompaniesFactory(_ref) {
         data: sequence
       });
     },
+
+    /**
+     * GET /operating-companies/:operatingCompanyId/sequences - list sequences. API does not accept query params.
+     * @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: function all(_ref7) {
       var jwtToken = _ref7.jwtToken,
           token = _ref7.token,
@@ -91,6 +165,17 @@ function operatingCompaniesFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * GET /operating-companies/:operatingCompanyId/sequences/:sequenceId - get sequence. API does not accept query params.
+     * @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: function get(_ref8) {
       var jwtToken = _ref8.jwtToken,
           token = _ref8.token,
@@ -104,6 +189,18 @@ function operatingCompaniesFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * PUT /operating-companies/:operatingCompanyId/sequences/:sequenceId - update sequence. API does not accept query params.
+     * @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: function update(_ref9) {
       var jwtToken = _ref9.jwtToken,
           token = _ref9.token,

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

@@ -1,13 +1,43 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /operation-messages (btrz-api-inventory). See get-operation-messages getSpec().
+ * @typedef {Object} OperationMessagesListQuery
+ * @property {string} [providerId] - Provider id to get operation messages for
+ * @property {number} [page] - Page number (default 1)
+ * @property {string} [name] - Full or partial name (non case sensitive)
+ * @property {string} [type] - Operation message type
+ * @property {string} [stationId] - Station id of the operation message
+ * @property {string} [avoidPagination] - Any value = true to avoid pagination
+ * @property {string} [active] - Filter active/inactive [true, false]
+ * @property {string} [effectiveDateTimeStartBefore] - ISO datetime (start before/at)
+ * @property {string} [effectiveDateTimeEndAfter] - ISO datetime (end after/at)
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /operation-messages - list operation messages.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {OperationMessagesListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -22,6 +52,15 @@ function operationMessagesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /operation-messages - create operation message. API does not accept query params.
+   * @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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -36,6 +75,16 @@ function operationMessagesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /operation-messages/:operationMessageId - update operation message. API does not accept query params.
+   * @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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -51,6 +100,14 @@ function operationMessagesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /operation-messages/:operationMessageId - get operation message by id. API does not accept query params.
+   * @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(_ref5) {
     var token = _ref5.token,
         operationMessageId = _ref5.operationMessageId,
@@ -63,6 +120,15 @@ function operationMessagesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /operation-messages/:operationMessageId - remove operation message. API does not accept query params.
+   * @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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         operationMessageId = _ref6.operationMessageId,
@@ -76,7 +142,15 @@ function operationMessagesFactory(_ref) {
     });
   }
 
-  // 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(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,

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

@@ -3,10 +3,34 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /operation-reasons (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} OperationReasonsListQuery
+ * @property {number} [page] - The page number to retrieve
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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 {OperationReasonsListQuery} [opts.query] - Query params (page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +46,15 @@ function operationReasonFactory(_ref) {
     });
   }
 
+  /**
+   * GET /operation-reasons/:id - get operation reason by id. API does not accept query params.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +71,16 @@ function operationReasonFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /operation-reasons/:id - update operation reason. API does not accept query params.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -56,6 +99,15 @@ function operationReasonFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /operation-reasons/:id - remove operation reason. API does not accept query params.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -72,6 +124,15 @@ function operationReasonFactory(_ref) {
     });
   }
 
+  /**
+   * POST /operation-reasons - create operation reason. API does not accept query params.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

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

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /parcel-zones (btrz-api-inventory). See get-parcel-zones getSpec().
+ * @typedef {Object} ParcelZonesListQuery
+ * @property {string} [providerIds] - Provider IDs to get parcel zones for
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /parcel-zones - list parcel zones.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {ParcelZonesListQuery} [opts.query] - Query params (providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +42,15 @@ function parcelZonesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /parcel-zones - create parcel zone. API does not accept query params.
+   * @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(_ref3) {
     var token = _ref3.token,
         parcelZone = _ref3.parcelZone,
@@ -34,6 +65,16 @@ function parcelZonesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /parcel-zone/:parcelZoneId - update parcel zone. API does not accept query params.
+   * @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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,

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

@@ -3,10 +3,40 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /pay-on-accounts (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} PayOnAccountsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [format] - Format to retrieve the data
+ * @property {string} [disabled] - Filter by disabled [true, false]
+ * @property {string} [term] - Search term to filter PayOnAccounts
+ * @property {string} [fareIds] - Fare ids to filter
+ * @property {string} [providerId] - Provider id to filter
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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 {PayOnAccountsListQuery} [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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/inventory/payment-terminals.js

@@ -1,13 +1,28 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for payment-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 paymentTerminalFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /payment-terminals - list payment terminals. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +35,14 @@ function paymentTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * GET /payment-terminals/:paymentTerminalId - get payment terminal by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} opts.paymentTerminalId - Payment terminal id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var paymentTerminalId = _ref3.paymentTerminalId,
         token = _ref3.token,
@@ -30,6 +53,15 @@ function paymentTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * POST /payment-terminals - create payment terminal. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.paymentTerminal - Payment terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -46,6 +78,15 @@ function paymentTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /payment-terminals/:paymentTerminalId - remove payment terminal. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentTerminalId - Payment terminal id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         paymentTerminalId = _ref5.paymentTerminalId,
@@ -59,6 +100,16 @@ function paymentTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /payment-terminals/:paymentTerminalId - update payment terminal. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.paymentTerminalId - Payment terminal id
+   * @param {Object} opts.paymentTerminal - Payment terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,