btrz-api-client 8.33.0 → 8.35.0

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

@@ -19,13 +19,14 @@ const {
  */
 function getnetTerminalFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /getnet-terminals - list getnet terminals.
+   * GET /getnet-terminals - list getnet terminals (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {GetnetTerminalsQuery} [opts.query] - Query params
+   * @param {GetnetTerminalsQuery} [opts.query] - Query params (page, stationId, serialNumber)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminals: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_PAGE, 401, 500)
    */
   function all({
     token,
@@ -40,13 +41,14 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal. API does not accept query params.
+   * GET /getnet-terminals/:getnetTerminalId - get a getnet terminal by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.getnetTerminalId - Getnet terminal id
+   * @param {string} opts.getnetTerminalId - Getnet terminal id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_GETNET_TERMINAL_ID, 401, 404 GETNET_TERMINAL_NOT_FOUND, 500)
    */
   function get({
     getnetTerminalId,
@@ -64,9 +66,10 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.getnetTerminal - Getnet terminal payload
+   * @param {Object} opts.getnetTerminal - Getnet terminal payload (name, serialNumber, stationId optional)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA/INVALID_STATION_ID/STATION_NOT_FOUND, 401, 409 duplicate serial, 500)
    */
   function create({
     jwtToken,
@@ -85,13 +88,14 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal. API does not accept query params.
+   * DELETE /getnet-terminals/:getnetTerminalId - remove getnet terminal.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.getnetTerminalId - Getnet terminal id
+   * @param {string} opts.getnetTerminalId - Getnet terminal id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminalId: string }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_GETNET_TERMINAL_ID, 401, 404 GETNET_TERMINAL_NOT_FOUND, 500)
    */
   function remove({
     jwtToken,
@@ -107,14 +111,15 @@ function getnetTerminalFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal. API does not accept query params.
+   * PUT /getnet-terminals/:getnetTerminalId - update getnet terminal.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.getnetTerminalId - Getnet terminal id
-   * @param {Object} opts.getnetTerminal - Getnet terminal payload
+   * @param {string} opts.getnetTerminalId - Getnet terminal id (24 hex characters)
+   * @param {Object} opts.getnetTerminal - Getnet terminal payload (name, serialNumber, stationId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ getnetTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 GETNET_TERMINAL_NOT_FOUND, 409 duplicate serial, 500)
    */
   function update({
     jwtToken,

package/src/endpoints/inventory/gift-certificate-definitions.js

@@ -22,7 +22,8 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
    * @param {string} [opts.token] - API key
    * @param {GiftCertificateDefinitionsListQuery} [opts.query] - Query params (channels, currencies, providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftCertificates: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 400 WRONG_DATA, PROVIDER_ID; 401 Unauthorized; 500.
    */
   function all({token, query = {}, headers}) {
     return client.get("/gift-certificate-definitions", {
@@ -38,7 +39,8 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.giftcertificateId - Gift certificate definition id
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftcertificate: Object }>>}
+   * @throws When the API returns an error. 400 INVALID_GIFTCERTIFICATE_ID; 401 Unauthorized; 404 GIFTCERTIFICATE_NOT_FOUND; 500.
    */
   function get({token, jwtToken, giftcertificateId, query = {}, headers}) {
     return client({
@@ -56,7 +58,8 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} opts.giftcertificate - Gift certificate payload
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftcertificate: Object }>>}
+   * @throws When the API returns an error. 400 WRONG_DATA; 401 Unauthorized; 500.
    */
   function create({token, jwtToken, giftcertificate, query = {}, headers}) {
     return client({
@@ -76,7 +79,8 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
    * @param {string} opts.giftcertificateId - Gift certificate definition id
    * @param {Object} opts.giftcertificate - Gift certificate payload
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftcertificate: Object }>>}
+   * @throws 400 WRONG_DATA, GIFTCERTIFICATE_ID; 401; 404 GIFTCERTIFICATE_NOT_FOUND; 500.
    */
   function update({token, jwtToken, giftcertificateId, giftcertificate, query = {}, headers}) {
     return client({
@@ -95,7 +99,8 @@ function giftCertificateDefinitionsFactory({client, internalAuthTokenProvider})
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.giftcertificateId - Gift certificate definition id
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ giftcertificateId: string }>>}
+   * @throws 400 WRONG_DATA, GIFTCERTIFICATE_ID, GIFT_CERTIFICATE_DEFINITION_ALREADY_IMPLEMENTED; 401; 404; 500.
    */
   function remove({token, jwtToken, giftcertificateId, query = {}, headers}) {
     return client({

package/src/endpoints/inventory/holidays.js

@@ -0,0 +1,121 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /holidays (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} HolidaysListQuery
+ * @property {number} [page] - The page number to retrieve
+ * @property {string} [providerId] - Provider (account) id to list holidays for
+ */
+
+/**
+ * Factory for holidays 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 holidaysFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /holidays - list holidays (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {HolidaysListQuery} [opts.query] - Query params (page, providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holidays: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 400 INVALID_PAGE; 401; 500.
+   */
+  function all({token, jwtToken, query = {}, headers}) {
+    return client.get("/holidays", {
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * GET /holidays/:holidayId - get holiday by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.holidayId - Holiday id (24 hex characters)
+   * @param {{ providerId?: string }} [opts.query] - Optional providerId
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holiday: Object }>>}
+   * @throws 400 INVALID_HOLIDAY_ID, INVALID_PROVIDER_ID; 401; 404 HOLIDAY_NOT_FOUND; 500.
+   */
+  function get({token, jwtToken, holidayId, query = {}, headers}) {
+    return client({
+      url: `/holidays/${holidayId}`,
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query
+    });
+  }
+
+  /**
+   * POST /holidays - create holiday.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.holiday - Holiday payload (day, month, year required; name, blackout, recurring, externalId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holiday: Object }>>}
+   * @throws 400 WRONG_DATA; 401; 500.
+   */
+  function create({token, jwtToken, holiday, headers}) {
+    return client({
+      url: "/holidays",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {holiday}
+    });
+  }
+
+  /**
+   * PUT /holidays/:holidayId - update holiday.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.holidayId - Holiday id
+   * @param {Object} opts.holiday - Holiday payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holiday: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_HOLIDAY_ID; 401; 404 HOLIDAY_NOT_FOUND; 500.
+   */
+  function update({token, jwtToken, holidayId, holiday, headers}) {
+    return client({
+      url: `/holidays/${holidayId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {holiday}
+    });
+  }
+
+  /**
+   * DELETE /holidays/:holidayId - remove holiday.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.holidayId - Holiday id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ holidayId: string }>>}
+   * @throws 400 INVALID_HOLIDAY_ID; 401; 404 HOLIDAY_NOT_FOUND; 500.
+   */
+  function remove({token, jwtToken, holidayId, headers}) {
+    return client({
+      url: `/holidays/${holidayId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    all,
+    get,
+    create,
+    update,
+    remove
+  };
+}
+
+module.exports = holidaysFactory;

package/src/endpoints/inventory/insurances.js

@@ -5,9 +5,9 @@ const {
 /**
  * Query params for GET /insurances (btrz-api-inventory). See get-insurances getSpec().
  * @typedef {Object} InsurancesListQuery
- * @property {string} [productId] - Filter by product id
- * @property {boolean} [enabled] - Filter by enabled
- * @property {string[]} [providerIds] - Filter by provider ids
+ * @property {string} [productId] - The ids of the products to get insurances for
+ * @property {string} [enabled] - Filter insurances if they are enabled or not [true, false]
+ * @property {string} [providerIds] - The ids of the providers to get products for
  */
 
 /**
@@ -21,12 +21,13 @@ function insurancesFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * GET /insurances - list insurances.
+   * GET /insurances - list insurances for the account and product provided.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {InsurancesListQuery} [opts.query] - Query params (productId, enabled, providerIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ insurances: Object[] }>>}
+   * @throws 400 INVALID_PRODUCTIDS; 401; 500.
    */
   function all({
     token, query = {}, headers
@@ -40,12 +41,13 @@ function insurancesFactory({
   }
 
   /**
-   * GET /insurances/:insuranceId - get insurance by id. API does not accept query params.
+   * GET /insurances/:insuranceId - get insurance by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.insuranceId - Insurance id
+   * @param {string} opts.insuranceId - Insurance id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ insurance: Object }>>}
+   * @throws 400 INVALID_INSURANCE_ID; 401; 404 INSURANCE_NOT_FOUND; 500.
    */
   function get({
     token, insuranceId, headers
@@ -80,14 +82,15 @@ function insurancesFactory({
   }
 
   /**
-   * PUT /insurances/:insuranceId - update insurance. API does not accept query params.
+   * PUT /insurances/:insuranceId - update insurance.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.insurance - Insurance payload
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.insuranceId - Insurance id
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ insurance: Object }>>}
+   * @throws 400 WRONG_DATA; 401; 404 INSURANCE_NOT_FOUND; 500.
    */
   function update({
     token, insurance, jwtToken, insuranceId, headers
@@ -103,13 +106,14 @@ function insurancesFactory({
   }
 
   /**
-   * DELETE /insurances/:insuranceId - remove insurance. API does not accept query params.
+   * DELETE /insurances/:insuranceId - remove insurance.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.insuranceId - Insurance id
+   * @param {string} opts.insuranceId - Insurance id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ insuranceId: string }>>}
+   * @throws 400 INVALID_INSURANCE_ID; 401; 404 INSURANCE_NOT_FOUND; 500.
    */
   function remove({
     token, jwtToken, insuranceId, headers

package/src/endpoints/inventory/items.js

@@ -30,13 +30,14 @@ const {
  */
 function itemsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /items - list items.
+   * GET /items - list items (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {ItemsQuery} [opts.query] - Query params (productId, disabled, type, providerIds, channels, currency, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ items: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 401; 500.
    */
   function all({
     token,
@@ -56,10 +57,11 @@ function itemsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.itemId - Item id (ObjectId format)
+   * @param {string} opts.itemId - Item id (24 hex characters)
    * @param {ItemByIdQuery} [opts.query] - Query params (currency)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ item: Object }>>}
+   * @throws 400 INVALID_ITEM_ID; 401; 404 ITEM_NOT_FOUND; 500.
    */
   function get({itemId, token, jwtToken, query = {}, headers}) {
     return client.get(`/items/${itemId}`, {
@@ -73,9 +75,10 @@ function itemsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.item - Item payload
+   * @param {Object} opts.item - Item payload (ItemPostData: name, productId, type, amount, valueType, order, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ item: Object }>>}
+   * @throws 400 WRONG_DATA, PRODUCT_ID_INVALID, etc.; 401; 404 PRODUCT_NOT_FOUND, etc.; 500.
    */
   function create({jwtToken, item, token, headers}) {
     return client({
@@ -91,10 +94,11 @@ function itemsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.itemId - Item id
-   * @param {Object} opts.item - Item payload
+   * @param {string} opts.itemId - Item id (24 hex characters)
+   * @param {Object} opts.item - Item payload (ItemPostData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ item: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID ids; 401; 404 ITEM_NOT_FOUND, PRODUCT_NOT_FOUND, etc.; 500.
    */
   function update({jwtToken, token, itemId, item, headers}) {
     return client({

package/src/endpoints/inventory/labels.js

@@ -16,13 +16,14 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
  */
 function labelsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /labels - list labels.
+   * GET /labels - list labels (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {LabelsQuery} [opts.query] - Query params (name, page)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ labels: Object[], count: number, next?: string, previous?: string }>>}
+   * @throws 401; 500.
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/labels", {
@@ -36,9 +37,10 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.labelId - Label id (ObjectId format)
+   * @param {string} opts.labelId - Label id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ label: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_LABEL_ID; 401; 404 LABEL_NOT_FOUND; 500.
    */
   function get({labelId, token, jwtToken, query = {}, headers}) {
     return client.get(`/labels/${labelId}`, {
@@ -52,9 +54,10 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.label - Label payload
+   * @param {Object} opts.label - Label payload (name, description, color required; type: ticket|manifest)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ label: Object }>>}
+   * @throws 400 WRONG_DATA (name/description/color required), INVALID_TYPE; 401; 500.
    */
   function create({jwtToken, label, token, headers}) {
     return client({
@@ -70,10 +73,11 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.labelId - Label id
-   * @param {Object} opts.label - Label payload
+   * @param {string} opts.labelId - Label id (24 hex characters)
+   * @param {Object} opts.label - Label payload (LabelData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ label: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_TYPE, LABEL_ALREADY_USED; 401; 404 LABEL_NOT_FOUND; 500.
    */
   function update({jwtToken, token, labelId, label, headers}) {
     return client({
@@ -90,9 +94,10 @@ function labelsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.labelId - Label id
+   * @param {string} opts.labelId - Label id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ labelId: string }>>}
+   * @throws 400 LABEL_ID (invalid format), LABEL_ALREADY_USED; 401; 404 LABEL_NOT_FOUND; 500.
    */
   function remove({jwtToken, token, labelId, headers}) {
     return client({

package/src/endpoints/inventory/marital-status.js

@@ -15,13 +15,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function maritalStatusFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /marital-status - list marital statuses.
+   * GET /marital-status - list marital statuses (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {MaritalStatusListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatus: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 401; 500.
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
@@ -37,9 +38,10 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Marital status id
+   * @param {string} opts.id - Marital status id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatus: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_MARITALSTATUS_ID; 401; 404 MARITALSTATUS_NOT_FOUND; 500.
    */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -55,10 +57,11 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Marital status id
-   * @param {Object} opts.data - Request body
+   * @param {string} opts.id - Marital status id (24 hex characters)
+   * @param {Object} opts.data - Request body (MaritalStatusPutData: name, ord, lexiconKeys)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatus: Object }>>}
+   * @throws 400 WRONG_DATA; 401; 404 MARITALSTATUS_NOT_FOUND; 409 CANNOT_UPDATE_LEXICON_ENTRIES; 500.
    */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
@@ -75,9 +78,10 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Marital status id
+   * @param {string} opts.id - Marital status id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatusId: string }>>}
+   * @throws 400 WRONG_DATA, INVALID_MARITALSTATUS_ID; 401; 404 MARITALSTATUS_NOT_FOUND; 500.
    */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -93,9 +97,10 @@ function maritalStatusFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Request body
+   * @param {Object} opts.data - Request body (MaritalStatusPostData: name, ord, lexiconKeys required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ maritalstatus: Object }>>}
+   * @throws 400 WRONG_DATA (maritalstatus/name/ord/lexiconKeys required); 401; 409 CANNOT_CREATE_LEXICON_ENTRIES; 500.
    */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({

package/src/endpoints/inventory/marketplace-modifiers.js

@@ -25,12 +25,13 @@ const {
  */
 function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /marketplace-modifiers - list marketplace modifiers.
+   * GET /marketplace-modifiers - list marketplace modifiers (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {MarketplaceModifiersListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifiers: Object[], next?: string, previous?: string, count: number }>>}
+   * @throws 401; 500 MISSING_ACCOUNT.
    */
   function all({
     token,
@@ -46,10 +47,11 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
   /**
    * GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id. API does not accept query params.
    * @param {Object} opts
-   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id (24 hex characters)
    * @param {string} [opts.token] - API key
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifier: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_MARKETPLACEMODIFIER_ID; 401; 404 MARKETPLACE_MODIFIER_NOT_FOUND; 500.
    */
   function get({marketplaceModifierId, token, headers}) {
     return client.get(`/marketplace-modifiers/${marketplaceModifierId}`, {
@@ -62,9 +64,10 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
-   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload
+   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload (MarketplaceModifierPostData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifier: Object }>>}
+   * @throws 400 WRONG_DATA, *_NOT_FOUND, INVALID_*, MODIFIER_*, OANDDS_STATION_NOT_FOUND; 401; 404; 500.
    */
   function create({jwtToken, token, marketplaceModifier, headers}) {
     return client({
@@ -81,10 +84,11 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
    * DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id (24 hex characters)
    * @param {string} [opts.token] - API key
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifierId: string }>>}
+   * @throws 400 MARKETPLACE_MODIFIER_ID (invalid format); 401; 404 MARKETPLACE_MODIFIER_NOT_FOUND; 500.
    */
   function remove({jwtToken, marketplaceModifierId, token, headers}) {
     return client({
@@ -99,10 +103,11 @@ function marketplaceModifierFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
-   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
-   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id (24 hex characters)
+   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload (MarketplaceModifierPutData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ marketplaceModifier: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_MARKETPLACEMODIFIER_ID, *_NOT_FOUND, INVALID_*, MODIFIER_*; 401; 404; 500.
    */
   function update({jwtToken, token, marketplaceModifierId, marketplaceModifier, headers}) {
     return client({