btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,17 +1,54 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function operationMessagesFactory({ client, internalAuthTokenProvider }) {
+/**
+ * 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)
+ */
 
-  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 {OperationMessagesListQuery} [opts.query] - Query params
+   * @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. 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({token, jwtToken, opMsgData, headers}) {
     return client({
       url: "/operation-messages",
       method: "post",
@@ -20,7 +57,17 @@ function operationMessagesFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function update({ token, jwtToken, operationMessageId, opMsgData, headers }) {
+  /**
+   * 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({token, jwtToken, operationMessageId, opMsgData, headers}) {
     return client({
       url: `/operation-messages/${operationMessageId}`,
       method: "put",
@@ -29,15 +76,32 @@ function operationMessagesFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * 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({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. 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({jwtToken, operationMessageId, token, headers}) {
     return client({
       url: `/operation-messages/${operationMessageId}`,
       method: "delete",
@@ -45,7 +109,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,28 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * 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({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 {OperationReasonsListQuery} [opts.query] - Query params (page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/operation-reasons",
@@ -10,6 +32,15 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/operation-reasons/${id}`,
@@ -19,6 +50,16 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, id, operationReason, query = {}, headers}) {
     return client({
       url: `/operation-reasons/${id}`,
@@ -29,6 +70,15 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/operation-reasons/${id}`,
@@ -38,6 +88,15 @@ function operationReasonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, operationReason, query = {}, headers}) {
     return client({
       url: "/operation-reasons",

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

@@ -1,33 +1,72 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function parcelZonesFactory({ client, internalAuthTokenProvider }) {
-  
-  function all({ token, query = {}, headers }) {
+/**
+ * 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({client, 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({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. 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({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. 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({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,34 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * 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({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 {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({token, jwtToken, query = {}, responseType = "json", headers}) {
     return client.get("/pay-on-accounts", {
       params: query,

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

@@ -1,9 +1,22 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, 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({
     token,
     query = {},
@@ -15,13 +28,30 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({paymentTerminalId, token, headers}) {
     return client.get(`/payment-terminals/${paymentTerminalId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ jwtToken, token, paymentTerminal, headers }) {
+  /**
+   * 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({jwtToken, token, paymentTerminal, headers}) {
     return client({
       url: "/payment-terminals",
       method: "post",
@@ -32,7 +62,16 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function remove({ jwtToken, paymentTerminalId, token, headers }) {
+  /**
+   * 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({jwtToken, paymentTerminalId, token, headers}) {
     return client({
       url: `/payment-terminals/${paymentTerminalId}`,
       method: "delete",
@@ -40,6 +79,16 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({jwtToken, token, paymentTerminalId, paymentTerminal, headers}) {
     return client({
       url: `/payment-terminals/${paymentTerminalId}`,

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

@@ -2,7 +2,32 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /prisma-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} PrismaTerminalsListQuery
+ * @property {number} [page] - Page number
+ * @property {string} [providerId] - Account provider (operator) ID
+ * @property {string} [name] - Filter by terminal name (exact match)
+ * @property {string} [externalId] - Filter by terminal externalId (exact match)
+ */
+
+/**
+ * Factory for prisma-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 prismaTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /prisma-terminals - list prisma terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PrismaTerminalsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,12 +40,30 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /prisma-terminals/:prismaTerminalId - get prisma terminal by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.prismaTerminalId - Prisma terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({prismaTerminalId, token, jwtToken, headers}) {
     return client.get(`/prisma-terminals/${prismaTerminalId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /prisma-terminals - create prisma 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.prismaTerminal - Prisma terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, prismaTerminal, headers}) {
     return client({
       url: "/prisma-terminals",
@@ -32,6 +75,15 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /prisma-terminals/:prismaTerminalId - remove prisma 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.prismaTerminalId - Prisma terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, prismaTerminalId, token, headers}) {
     return client({
       url: `/prisma-terminals/${prismaTerminalId}`,
@@ -40,6 +92,16 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /prisma-terminals/:prismaTerminalId - update prisma 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.prismaTerminalId - Prisma terminal id
+   * @param {Object} opts.prismaTerminal - Prisma terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, prismaTerminalId, prismaTerminal, headers}) {
     return client({
       url: `/prisma-terminals/${prismaTerminalId}`,

package/src/endpoints/inventory/products.js

@@ -1,6 +1,47 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /products (btrz-api-inventory). See get-products getSpec().
+ * @typedef {Object} ProductsListQuery
+ * @property {string} [providerIds] - Provider IDs to get products for
+ * @property {string} [channels] - Filter by channels
+ * @property {string} [enabled] - 'true', 'false' or 'any' (default 'true')
+ * @property {string} [pricingType] - One of point-to-point, distance, journey, etc.
+ * @property {string} [hasRoutes] - 'true' or 'false' (deprecated, use family)
+ * @property {string} [hasDates] - 'true' or 'false' (deprecated)
+ * @property {string} [hasPassengerInfo] - 'true' or 'false' (deprecated)
+ * @property {string} [isParcel] - 'true' or 'false' (deprecated)
+ * @property {string} [family] - One of bundle, parcel, paid in, paid out, reservation, flexpass, ticket
+ * @property {string} [domain] - Filter by domain
+ * @property {string} [parentProductId] - Child products of this parent
+ * @property {string} [dynamicFormId] - Filter by dynamic form
+ */
+
+/**
+ * Query params for GET /products/:productId (btrz-api-inventory). See get-products-id getSpec().
+ * @typedef {Object} ProductGetQuery
+ * @property {string} [providerIds] - Provider IDs to get product for
+ * @property {string} [channels] - Filter by channels
+ * @property {string} [enabled] - 'true', 'false' or 'any'
+ */
+
+/**
+ * Factory for products 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, families: object, domains: object }}
+ */
 function productsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /products - list products.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ProductsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client({
       url: "/products",
@@ -9,6 +50,16 @@ function productsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /products/:productId - get product by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {ProductGetQuery} [opts.query] - Query params (providerIds, channels, enabled)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({productId, token, jwtToken, query = {}, headers}) {
     return client({
       url: `/products/${productId}`,
@@ -17,6 +68,15 @@ function productsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /products - create product. 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.data - Product payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({data, token, jwtToken, headers}) {
     return client({
       url: "/products",
@@ -26,6 +86,16 @@ function productsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /products/:productId - update product. 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.productId - Product id
+   * @param {Object} opts.data - Product payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({productId, data, token, jwtToken, headers}) {
     return client({
       url: `/products/${productId}`,
@@ -35,7 +105,17 @@ function productsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ remove: function }} */
   const domains = {
+    /**
+     * DELETE /products/domains/:domain - remove product domain. 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.domain - Domain
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: ({token, jwtToken, domain, headers}) => {
       return client({
         url: `/products/domains/${domain}`,
@@ -45,7 +125,16 @@ function productsFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ all: function }} */
   const families = {
+    /**
+     * GET /products/families - list product families. 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>}
+     */
     all: ({token, query = {}, headers}) => {
       return client({
         url: "/products/families",