btrz-api-client 8.33.0 → 8.35.0

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

@@ -1,7 +1,7 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /document-types (btrz-api-inventory). See get-document-types getSpec().
+ * Query params for GET /document-types (btrz-api-inventory).
  * @typedef {Object} DocumentTypesListQuery
  * @property {string} [providerIds] - Comma-separated provider IDs to get document types for
  */
@@ -15,99 +15,100 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function documentTypesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /document-types - list document types.
+   * GET /document-types - list document types (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {DocumentTypesListQuery} [opts.query] - Query params (providerIds); opts.providerId merged into query if set
-   * @param {string} [opts.providerId] - Provider id (added to query if set)
+   * @param {DocumentTypesListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ documenttypes: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (401 Unauthorized, 500)
    */
-  function all({token, jwtToken, query = {}, headers, providerId}) {
-    const query_ = providerId ? {...query, providerId} : query;
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/document-types",
       method: "get",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      params: query_
+      params: query
     });
   }
 
   /**
-   * GET /document-types/:id - get document type by id. API does not accept query params.
+   * GET /document-types/:documenttypeId - get document type by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Document type id
-   * @param {string} [opts.providerId] - Provider id (added to query if set)
+   * @param {string} opts.id - Document type id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ documenttype: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 DOCUMENTTYPE_NOT_FOUND, 500)
    */
-  function get({token, jwtToken, id, query = {}, headers, providerId}) {
-    const query_ = providerId ? {...query, providerId} : query;
+  function get({token, jwtToken, id, headers}) {
     return client({
       url: `/document-types/${id}`,
       method: "get",
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      params: query_
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * PUT /document-types/:id - update document type. API does not accept query params.
+   * PUT /document-types/:documenttypeId - update document type.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Document type id
-   * @param {Object} opts.data - Document type payload
+   * @param {Object} [opts.documenttype] - Document type payload (DocumentTypePutData)
+   * @param {Object} [opts.data] - Alias for documenttype (deprecated, use documenttype)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ documenttype: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404, 409 CANNOT_UPDATE_LEXICON_ENTRIES, 500)
    */
-  function update({token, jwtToken, id, data, query = {}, headers}) {
+  function update({token, jwtToken, id, documenttype, data, headers}) {
+    const payload = documenttype || data;
     return client({
       url: `/document-types/${id}`,
       method: "put",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      params: query,
-      data
+      data: {documenttype: payload}
     });
   }
 
   /**
-   * DELETE /document-types/:id - remove document type. API does not accept query params.
+   * DELETE /document-types/:documenttypeId - remove document type.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Document type id
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ documenttypeId: string }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 DOCUMENTTYPE_NOT_FOUND, 500)
    */
-  function remove({token, jwtToken, id, query = {}, headers}) {
+  function remove({token, jwtToken, id, headers}) {
     return client({
       url: `/document-types/${id}`,
       method: "delete",
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      params: query
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * POST /document-types - create document type. API does not accept query params.
+   * POST /document-types - create document type.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Document type payload
+   * @param {Object} [opts.documenttype] - Document type payload (DocumentTypePostData)
+   * @param {Object} [opts.data] - Alias for documenttype (deprecated, use documenttype)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ documenttype: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 409 CANNOT_CREATE_LEXICON_ENTRIES, 500)
    */
-  function create({token, jwtToken, data, query = {}, headers}) {
+  function create({token, jwtToken, documenttype, data, headers}) {
+    const payload = documenttype || data;
     return client({
       url: "/document-types",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      params: query,
-      data
+      data: {documenttype: payload}
     });
   }
 

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

@@ -3,22 +3,24 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Factory for external-wallets API (btrz-api-inventory).
+ * Factory for external-wallets API (btrz-api-inventory). SaldoMax external wallets only.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ saldoMax: object }}
+ * @returns {{ saldoMax: { all: function, get: function, create: function, update: function, movements: { create: function } } }}
  */
 function externalWalletsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ all: function, create: function, get: function, update: function, movements: object }} */
   const saldoMax = {
     /**
-     * GET /external-wallets/saldo-max - list saldo max wallets. API does not accept query params.
+     * GET /external-wallets/saldo-max - list SaldoMax external wallets (paginated).
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} [opts.query] - Pagination query params
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ externalWallets: Array, next?: string, previous?: string, count: number }>>}
+     * @throws When response is 4xx/5xx (401, 500)
      */
     all: ({token, jwtToken, query = {}, headers}) => {
       return client.get("/external-wallets/saldo-max", {
@@ -27,13 +29,14 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /external-wallets/saldo-max - create saldo max wallet. API does not accept query params.
+     * POST /external-wallets/saldo-max - create SaldoMax external wallet.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {Object} opts.externalWallet - External wallet payload
+     * @param {Object} opts.externalWallet - External wallet payload (ExternalWalletData: firstName, lastName, email, tel, dob, nip)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ externalWallet: Object }>>}
+     * @throws When response is 4xx/5xx (400, 401, 409 DUPLICATE_EXTERNAL_WALLET_EMAIL/TEL, 500)
      */
     create: ({token, jwtToken, externalWallet, headers}) => {
       return client({
@@ -44,13 +47,14 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /external-wallets/saldo-max/:walletId - get saldo max wallet. API does not accept query params.
+     * GET /external-wallets/saldo-max/:walletId - get SaldoMax external wallet by id.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.walletId - Wallet id
+     * @param {string} opts.walletId - Wallet id (24 hex characters)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ externalWallet: Object }>>}
+     * @throws When response is 4xx/5xx (400, 401, 404 EXTERNAL_WALLET_NOT_FOUND, 500)
      */
     get: ({token, jwtToken, walletId, headers}) => {
       return client.get(`/external-wallets/saldo-max/${walletId}`, {
@@ -58,13 +62,14 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /external-wallets/saldo-max/:externalWallet._id - update saldo max wallet. API does not accept query params.
+     * PUT /external-wallets/saldo-max/:walletId - update SaldoMax external wallet.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} opts.externalWallet - External wallet payload (must include _id)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ externalWallet: Object }>>}
+     * @throws When response is 4xx/5xx (400, 401, 404 EXTERNAL_WALLET_NOT_FOUND, 500)
      */
     update: ({token, jwtToken, externalWallet, headers}) => {
       const externalWalletFieldsToUpdate = {
@@ -85,22 +90,22 @@ function externalWalletsFactory({client, internalAuthTokenProvider}) {
     /** @type {{ create: function }} */
     movements: {
       /**
-       * PUT /external-wallets/saldo-max/:walletId/movements - create movement. API does not accept query params.
+       * PUT /external-wallets/saldo-max/:walletId/movements - add movement to wallet.
        * @param {Object} opts
        * @param {string} [opts.token] - API key
        * @param {string} [opts.jwtToken] - JWT or internal auth symbol
        * @param {string} opts.walletId - Wallet id
-       * @param {Object} opts.movement - Movement payload
-       * @returns {Promise<import("axios").AxiosResponse>}
+       * @param {Object} opts.movement - Movement payload (amount, type: payment|refund|manual, reason, nip)
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse<{ externalWallet: Object }>>}
+       * @throws When response is 4xx/5xx (400, 401, 403 INVALID_NIP/WALLET_BLOCKED/WALLET_NOT_ACTIVE, 404, 500)
        */
-      create: ({token, jwtToken, walletId, movement}) => {
+      create: ({token, jwtToken, walletId, movement, headers}) => {
         return client({
           url: `/external-wallets/saldo-max/${walletId}/movements`,
           method: "put",
-          headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider}),
-          data: {
-            movement
-          }
+          headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+          data: {movement}
         });
       }
     }

package/src/endpoints/inventory/fees.js

@@ -18,28 +18,31 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function feesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /fees - list fees.
+   * GET /fees - list fees (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryFeesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryFeesQuery} [opts.query] - Query params (providerIds, rules, productId, internalId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ fees: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (401, 500)
    */
-  function all({token, query = {}, headers}) {
+  function all({token, jwtToken, query = {}, headers}) {
     return client.get("/fees", {
       params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * GET /fees/:feeId - get fee by id. API does not accept query params.
+   * GET /fees/:feeId - get fee by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.feeId - Fee id
+   * @param {string} opts.feeId - Fee id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ fee: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 FEE_NOT_FOUND, 500)
    */
   function get({token, jwtToken, feeId, headers}) {
     return client.get(`/fees/${feeId}`, {
@@ -48,13 +51,14 @@ function feesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /fees - create fee. API does not accept query params.
+   * POST /fees - create fee.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.fee - Fee payload
+   * @param {Object} opts.fee - Fee payload (FeePostData: name, internalId, valueType, value, rules, products, lexiconKeys, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ fee: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 409 CANNOT_CREATE_LEXICON_ENTRIES, 500)
    */
   function create({token, jwtToken, fee, headers}) {
     return client({
@@ -66,14 +70,15 @@ function feesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /fees/:feeId - update fee. API does not accept query params.
+   * PUT /fees/:feeId - update fee.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.feeId - Fee id
-   * @param {Object} opts.fee - Fee payload
+   * @param {Object} opts.fee - Fee payload (partial FeePostData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ fee: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 FEE_NOT_FOUND, 409 CANNOT_UPDATE_LEXICON_ENTRIES, 500)
    */
   function update({token, jwtToken, feeId, fee, headers}) {
     return client({

package/src/endpoints/inventory/filtered-trips.js

@@ -17,17 +17,18 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ all: function, create: function }}
+ * @returns {{ all: function, create: function, remove: function }}
  */
 function filteredTripsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /filtered-trips - list filtered trips.
+   * GET /filtered-trips - list filtered trips (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {FilteredTripsListQuery} [opts.query] - Query params (providerIds, productId, originId, destinationId, page, orderBy, orderDir)
+   * @param {FilteredTripsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ filteredTrips: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (401, 500)
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/filtered-trips", {
@@ -37,13 +38,14 @@ function filteredTripsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /filtered-trips - create filtered trip. API does not accept query params.
+   * POST /filtered-trips - add a trip to the blacklist (filtered trips).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.tripSegmentsId - Trip segments id payload
+   * @param {string} opts.tripSegmentsId - Base64-encoded JSON (FilteredTripRequest: productId, segments)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ filteredTrip: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 409 TRIP_ALREADY_FILTERED, 500)
    */
   function create({token, jwtToken, tripSegmentsId, headers}) {
     return client({
@@ -54,9 +56,28 @@ function filteredTripsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /filtered-trip/:filteredTripId - remove a filtered trip from the blacklist.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.filteredTripId - Filtered trip id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<void>>}
+   * @throws When response is 4xx/5xx (400, 401, 500)
+   */
+  function remove({token, jwtToken, filteredTripId, headers}) {
+    return client({
+      url: `/filtered-trip/${filteredTripId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
   return {
     all,
-    create
+    create,
+    remove
   };
 }
 

package/src/endpoints/inventory/financing-costs.js

@@ -24,13 +24,14 @@ const {
  */
 function financingCostsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /financing-costs - list financing costs.
+   * GET /financing-costs - list financing costs (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {FinancingCostsListQuery} [opts.query] - Query params (page, providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcosts: Array, next: string, previous: string, count: number }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_PAGE, 401, 500)
    */
   function all({
     token,
@@ -49,10 +50,11 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Financing cost id
+   * @param {string} opts.id - Financing cost id (24 hex characters)
    * @param {FinancingCostGetQuery} [opts.query] - Query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcost: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_FINANCINGCOST_ID, 401, 404 FINANCINGCOST_NOT_FOUND, 500)
    */
   function get({
     id,
@@ -68,13 +70,14 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /financing-costs - create financing cost. API does not accept query params.
+   * POST /financing-costs - create financing cost.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.financingCost - Financing cost payload
+   * @param {Object} opts.financingCost - Financing cost (name, internalId, currencyCode, dow, creditCard, maxQuota, interest, enabled)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcost: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA, 401, 409 duplicated internalId, 500)
    */
   function create({jwtToken, token, financingCost, headers}) {
     return client({
@@ -88,13 +91,14 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /financing-costs/:id - remove financing cost. API does not accept query params.
+   * DELETE /financing-costs/:id - remove financing cost.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Financing cost id
+   * @param {string} opts.id - Financing cost id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcostId: string }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_FINANCINGCOST_ID, 401, 404 FINANCINGCOST_NOT_FOUND, 500)
    */
   function remove({jwtToken, id, token, headers, query = {}}) {
     return client({
@@ -106,14 +110,15 @@ function financingCostsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /financing-costs/:id - update financing cost. API does not accept query params.
+   * PUT /financing-costs/:id - update financing cost.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Financing cost id
-   * @param {Object} opts.financingCost - Financing cost payload
+   * @param {string} opts.id - Financing cost id (24 hex characters)
+   * @param {Object} opts.financingCost - Financing cost (name, internalId, currencyCode, dow, creditCard, maxQuota, interest, enabled)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ financingcost: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA, 401, 404 not found, 409 duplicated internalId, 500)
    */
   function update({jwtToken, token, id, financingCost, headers}) {
     return client({

package/src/endpoints/inventory/garages.js

@@ -16,13 +16,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function garagesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /garages - list garages.
+   * GET /garages - list garages (paginated).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {GaragesQuery} [opts.query] - Query params (location, stationId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ garages: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (401, 500)
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/garages", {
@@ -32,13 +33,14 @@ function garagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /garages/:garageId - get garage by id. API does not accept query params.
+   * GET /garages/:garageId - get garage by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.garageId - Garage id
+   * @param {string} opts.garageId - Garage id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ garage: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_GARAGE_ID, 401, 404 GARAGE_NOT_FOUND, 500)
    */
   function get({token, jwtToken, garageId, headers}) {
     return client.get(`/garages/${garageId}`, {
@@ -47,13 +49,14 @@ function garagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /garages - create garage. API does not accept query params.
+   * POST /garages - create garage.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Garage payload
+   * @param {Object} opts.data - Garage payload (name, location, stationId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ garage: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA, 401, 500)
    */
   function create({token, jwtToken, data, headers}) {
     return client({
@@ -71,10 +74,11 @@ function garagesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.garageId - Garage id
-   * @param {Object} opts.data - Garage payload
+   * @param {string} opts.garageId - Garage id (24 hex characters)
+   * @param {Object} opts.data - Garage payload (name, location, stationId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ garage: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 GARAGE_NOT_FOUND/STATION_NOT_FOUND, 500)
    */
   function update({token, jwtToken, garageId, data, headers}) {
     return client({
@@ -88,13 +92,14 @@ function garagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /garages/:garageId - remove garage. API does not accept query params.
+   * DELETE /garages/:garageId - remove garage.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.garageId - Garage id
+   * @param {string} opts.garageId - Garage id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ success: boolean }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_GARAGE_ID or GARAGE_WITH_VEHICLES, 401, 404, 500)
    */
   function remove({token, jwtToken, garageId, headers}) {
     return client({