btrz-api-client 8.33.0 → 8.35.0

package/src/endpoints/inventory/taxes.js

@@ -6,6 +6,15 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
  * @property {string} [providerIds] - The id of the providers to get taxes for
  */
 
+/**
+ * Query params for GET /taxes/exceptions (btrz-api-inventory). See get-tax-exceptions-handler getSpec().
+ * @typedef {Object} TaxExceptionsListQuery
+ * @property {string} [originId] - Origin station id (24 hex characters)
+ * @property {string} [destinationId] - Destination station id (24 hex characters)
+ * @property {number} [page] - Page to return
+ * @property {number} [recordsPerPage] - Records per page
+ */
+
 /**
  * Factory for taxes API (btrz-api-inventory).
  * @param {Object} deps
@@ -99,7 +108,7 @@ function taxesFactory({client, internalAuthTokenProvider}) {
         url: "/taxes/exceptions",
         method: "post",
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-        data: taxException
+        data: {taxException}
       });
     },
     /**
@@ -117,7 +126,7 @@ function taxesFactory({client, internalAuthTokenProvider}) {
         url: `/taxes/exceptions/${taxExceptionId}`,
         method: "put",
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-        data: taxException
+        data: {taxException}
       });
     },
     /**

package/src/endpoints/inventory/traveller-card-providers-types.js

@@ -2,6 +2,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
  * Factory for traveller-card-providers types API (btrz-api-inventory).
+ * Returns the list of supported traveller card provider types (e.g. "custom", "caa").
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -9,16 +10,16 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function travellerCardProvidersTypesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /traveller-card-providers/types - list traveller card provider types. API does not accept query params.
+   * GET /traveller-card-providers/types - list traveller card provider types (e.g. "custom", "caa"). No query or path 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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ travellerCardProviderTypes: Array<{ type: string, properties: Object }> }>>}
    */
-  function all({token, query = {}, headers}) {
+  function all({token, jwtToken, headers}) {
     return client.get("/traveller-card-providers/types", {
-      params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 

package/src/endpoints/inventory/trip-ids.js

@@ -0,0 +1,54 @@
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
+
+/**
+ * Body for POST /direct-trip-ids (btrz-api-inventory-trips). See TripIdPostData in post-handler getSpec().
+ * @typedef {Object} TripIdPostData
+ * @property {string} providerId - Provider id (24-char hex ObjectId)
+ * @property {string} routeId - Route id (24-char hex ObjectId)
+ * @property {string} scheduleId - Schedule id
+ * @property {string} departureDate - Departure date (yyyy-mm-dd)
+ * @property {string} fareIds - Fare ids and quantities (e.g. fareId:qty)
+ * @property {string} channel - One of: backoffice, agency-backoffice, websales, agency-websales
+ * @property {string} productId - Product id (24-char hex ObjectId)
+ * @property {string} originId - Origin station id (24-char hex ObjectId)
+ * @property {string} destinationId - Destination station id (24-char hex ObjectId)
+ * @property {string} [currency] - ISO currency code (optional, for multicurrency)
+ */
+
+/**
+ * Factory for trip-ids API (btrz-api-inventory-trips).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+function tripIdsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /direct-trip-ids — Resolve trip parameters to a trip id. Runs trip search internally and returns the matching trip's base64 id (or null). Body can be TripIdPostData or { tripId: TripIdPostData }.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {TripIdPostData|{ tripId: TripIdPostData }} opts.data - Trip parameters (or wrapped in tripId key)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ tripId: { tripId: string|null } }>>}
+   * @throws 400 WRONG_DATA — tripId required or required fields missing
+   * @throws 401 Unauthorized
+   * @throws 404 TRIP_IDS_NOT_FOUND
+   * @throws 500 Internal server error
+   */
+  function create({token, jwtToken, data, headers}) {
+    return client({
+      url: "/direct-trip-ids",
+      method: "post",
+      data,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    create
+  };
+}
+
+module.exports = tripIdsFactory;

package/src/endpoints/inventory/trips.js

@@ -1,46 +1,84 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Factory for trips API (btrz-api-inventory).
+ * Factory for trips API (btrz-api-inventory-trips).
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ all: function, get: function }}
+ * @returns {{ all: function, get: function, getPricingSimulation: function }}
  */
 function tripsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /trips - list trips. API source of truth in btrz-api-inventory-trips; query not documented here.
+   * GET /trips — Search for available trips by date, origin, destination, fare, product, channel, and price. Rate limited (e.g. 8000 req/10 min). See get-trips getSpec() for full query params (productId, originId, destinationId, fareIds, departureDate, returnDate, channel, currency, etc.).
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {Object} [opts.query] - Query params (productId, originId, destinationId, fareIds, departureDate, returnDate, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ trips: { departures: Object[], returns: Object[] } }>>}
+   * @throws 400 INVALID_DATE, INVALID_DATE_FORMAT, INVALID_PRODUCTID, INVALID_ORIGIN, INVALID_DESTINATION, INVALID_CHANNEL, INVALID_FARE, INVALID_FAREID, INVALID_MANIFEST_STATUS, WRONG_DATA
+   * @throws 401 Unauthorized
+   * @throws 409 NO_HIGHER_OR_EQL_PRICE
+   * @throws 500 Internal server error
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/trips",
+      method: "get",
       params: query,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   /**
-   * GET /trip/:id - get trip by id. API does not accept query params.
+   * GET /trip/:id — Get up-to-date information for a trip by its ID (base64-encoded trip summary from a search). Optional query: extraCapacityImpact, ignoreCutoffs, currency, ignoreOmitByAvailability, includeMoveToTrips.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} opts.id - Trip id
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {string} opts.id - Trip id (base64-encoded)
+   * @param {Object} [opts.query] - Optional: extraCapacityImpact, ignoreCutoffs, currency, ignoreOmitByAvailability, includeMoveToTrips
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ trip: Object }>>}
+   * @throws 400 INVALID_TRIP — tripId is invalid
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
-  function get({token, id, headers}) {
-    return client.get(`/trip/${id}`, {
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+  function get({token, jwtToken, id, query = {}, headers}) {
+    return client({
+      url: `/trip/${id}`,
+      method: "get",
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * GET /trips/pricing-simulation — Get pricing simulation for all purchase combinations for a schedule. Query: scheduleId, productId (required); purchaseDate, travelDate, includeReadable, includeMetadata, minimize (optional).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {Object} [opts.query] - scheduleId, productId (required); purchaseDate, travelDate, includeReadable, includeMetadata, minimize
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<Object>>} Response shape per PricingSimulationResult definition
+   * @throws 400 INVALID_SCHEDULE_ID, INVALID_PRODUCT_ID, INVALID_PRODUCT, ROUTE_NOT_FOUND, ONLY_JP_SUPPORTED, INVALID_DATE
+   * @throws 401 Unauthorized, PRICING_SIMULATOR_DISABLED, PROVIDER_UNAUTHORIZED
+   * @throws 404 SCHEDULE_NOT_FOUND, NO_MANIFEST
+   * @throws 500 Internal server error
+   */
+  function getPricingSimulation({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/trips/pricing-simulation",
+      method: "get",
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   return {
     all,
-    get
+    get,
+    getPricingSimulation
   };
 }
 

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

@@ -11,16 +11,15 @@ const {
  */
 function vehicleTypesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /vehicle-types - list vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
+   * GET /vehicle-types - list vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram). No query or path 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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ vehicleTypes: Array<{ _id: string, name: string }> }>>}
    */
-  function all({token, jwtToken, query = {}, headers}) {
+  function all({token, jwtToken, headers}) {
     return client.get("/vehicle-types", {
-      params: query,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }

package/src/endpoints/inventory/vehicles.js

@@ -41,12 +41,13 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
    */
   function all({
     token,
+    jwtToken,
     query = {},
     headers
   }) {
     return client.get("/vehicles", {
       params: query,
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
@@ -59,9 +60,9 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function get({vehicleId, token, headers}) {
+  function get({vehicleId, token, jwtToken, headers}) {
     return client.get(`/vehicles/${vehicleId}`, {
-      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 

package/src/endpoints/invoices/emails.js

@@ -10,13 +10,23 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function emailsFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /emails - create/send invoice email. API does not accept query params.
+   * POST /emails — Send invoice by email to the given addresses.
+   * Request body may be sent as root object or under key "email". On success the API emits webhook invoiceemail.created.
+   *
    * @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 {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol (Authorization: Bearer)
+   * @param {Object} opts.data - Request body (EmailPostData)
+   * @param {string} opts.data.invoiceId - Invoice ID (required, 24-char hex ObjectId)
+   * @param {string[]} opts.data.emails - Recipient email addresses (required)
+   * @param {string} [opts.data.language] - Language code for template (e.g. "en-us")
+   * @param {Object} [opts.query] - Query params (none used by this endpoint)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ status: "OK" }>>} Resolves with { status: "OK" } on success
+   * @throws 400 WRONG_DATA, ACCOUNT_CANT_SEND_EMAILS, NO_VERIFIED_OR_ACTIVE_EMAIL, INVALID_EMAIL_TO_SEND
+   * @throws 401 Unauthorized (missing/invalid X-API-KEY or Authorization)
+   * @throws 404 INVOICE_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({

package/src/endpoints/invoices/invoices.js

@@ -22,13 +22,15 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function invoicesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /invoices - list invoices.
+   * GET /invoices — List invoices by transaction (paginated).
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoicesListQuery} [opts.query] - Query params (transactionId required)
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {InvoicesListQuery} [opts.query] - Query; transactionId (required) = 24-char hex ObjectId
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ invoices: Object[], total: number, page?: number, ... }>>}
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
@@ -40,13 +42,17 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /invoices/:id - get invoice by id. API does not accept query params.
+   * GET /invoices/:id — Get a single invoice by ID.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Invoice id
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {string} opts.id - Invoice ID (24-character hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ invoice: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_INVOICE_ID
+   * @throws 401 Unauthorized
+   * @throws 404 INVOICE_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -58,13 +64,16 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /failures - list invoice failures.
+   * GET /failures — List invoice failures (paginated). Optional transactionId filter.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoicesFailuresQuery} [opts.query] - Query params (transactionId optional)
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {InvoicesFailuresQuery} [opts.query] - Query; transactionId optional (24-char hex; if present must be valid)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ invoicesFailures: Object[], total: number, ... }>>}
+   * @throws 400 WRONG_DATA, INVALID_TRANSACTION_ID (if transactionId provided and invalid)
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function getInvoicesFailures({token, jwtToken, query = {}, headers}) {
     return client({
@@ -76,13 +85,19 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /retry - retry invoicing. API does not accept query params.
+   * POST /retry — Retry invoicing from an invoice failure using saved data. Body: transactionId (required).
+   * On success may emit webhooks invoices.created or invoices.updated.
    * @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 {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {Object} opts.data - Body: { transactionId } (transactionId = 24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ invoice: Object }>>}
+   * @throws 400 WRONG_DATA, INVOICE_NOT_CREATED, INVOICE_PROVIDER_TYPE_NOT_SUPPORTED, INVOICE_PROVIDER_NOT_FOUND, TRANSACTION_ALREADY_INVOICED
+   * @throws 401 Unauthorized
+   * @throws 404 TRANSACTION_NOT_FOUND, INVOICE_FAILURE_NOT_FOUND
+   * @throws 409 INFILE_SIGN_FAILED, INFILE_CERTIFICATION_FAILED
+   * @throws 500 Internal server error
    */
   function retryInvoicing({token, jwtToken, data, query = {}, headers}) {
     return client({
@@ -95,13 +110,19 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /retry - override buyer and retry invoicing. API does not accept query params.
+   * PUT /retry — Override buyer and retry invoicing from an invoice failure. Body: retryData with transactionId and overrideBuyer.
+   * On success may emit webhooks invoices.created or invoices.updated.
    * @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 {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {Object} opts.data - Body: { transactionId, overrideBuyer } (RetryPutData); overrideBuyer required when no certified invoice exists
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ invoice: Object }>>}
+   * @throws 400 WRONG_DATA, INVOICE_NOT_CREATED, INVOICE_PROVIDER_TYPE_NOT_SUPPORTED, INVOICE_PROVIDER_NOT_FOUND, TRANSACTION_ALREADY_INVOICED, OVERRIDE_BUYER_IS_MANDATORY
+   * @throws 401 Unauthorized
+   * @throws 404 TRANSACTION_NOT_FOUND, INVOICE_FAILURE_NOT_FOUND
+   * @throws 409 INFILE_SIGN_FAILED, INFILE_CERTIFICATION_FAILED
+   * @throws 500 Internal server error
    */
   function overrideBuyerRetryInvoicing({token, jwtToken, data, query = {}, headers}) {
     return client({

package/src/endpoints/invoices/pdfs.js

@@ -3,8 +3,8 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
  * Query params for GET /pdfs (btrz-api-invoices). See pdfs get-handler getSpec().
- * @typedef {Object} PdfsListQuery
- * @property {string} transactionId - Transaction id of the invoice (required)
+ * @typedef {Object} PdfsQuery
+ * @property {string} transactionId - Transaction ID of the invoice (required, 24-char hex ObjectId)
  */
 
 /**
@@ -16,14 +16,21 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function pdfsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /pdfs - list invoice PDFs.
+   * GET /pdfs — Returns the invoice PDF for the invoice associated with the given transaction.
+   * Response is binary (application/pdf) with Content-Disposition attachment; filename=invoice-{invoiceId}.pdf.
+   * Use responseType "blob" or "arraybuffer" to receive binary data.
+   *
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PdfsListQuery} [opts.query] - Query params (transactionId required)
-   * @param {string} [opts.responseType] - Response type (e.g. "json", "blob")
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {PdfsQuery} [opts.query] - Query; transactionId (required)
+   * @param {string} [opts.responseType] - Response type: "blob" or "arraybuffer" for binary PDF; "json" default
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<ArrayBuffer|Blob|*>>} PDF binary when responseType is blob/arraybuffer
+   * @throws 400 WRONG_DATA — transactionId is required
+   * @throws 401 Unauthorized
+   * @throws 404 INVOICE_NOT_FOUND — Invoice not found for the transactionId
+   * @throws 500 Internal server error (e.g. unsupported invoice provider type)
    */
   function all({token, jwtToken, query = {}, responseType = "json", headers}) {
     return client({

package/src/endpoints/invoices/providers.js

@@ -20,13 +20,15 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function providersFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /providers - list invoice providers.
+   * GET /providers — List invoice providers (paginated). Optional filters: enabled, invoiceProviderType, channel, country, operatingCompany.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
    * @param {ProvidersListQuery} [opts.query] - Query params (all optional)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ providers: Object[], total?: number, ... }>>}
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
@@ -38,13 +40,17 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /providers/:id - get invoice provider by id. API does not accept query params.
+   * GET /providers/:id — Get a single invoice provider by ID.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Provider id
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {string} opts.id - Provider ID (24-character hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ provider: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_PROVIDER_ID
+   * @throws 401 Unauthorized
+   * @throws 404 PROVIDER_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -56,14 +62,18 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /providers/:id - update invoice provider. API does not accept query params.
+   * PUT /providers/:id — Update invoice provider. Body may be provider or body.provider. Emits webhook invoice_providers.updated on success.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Provider id
-   * @param {Object} opts.data - Request body
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {string} opts.id - Provider ID (24-character hex ObjectId)
+   * @param {Object} opts.data - Request body (ProviderPutData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ provider: Object }>>}
+   * @throws 400 INVALID_PHRASES, OPERATING_COMPANY_NOT_FOUND, CANNOT_CHANGE_PROVIDER, INVALID_IVA_AFFILIATION, CANT_REMOVE_*, INVALID_PARAM_VALUE, CANT_DELETE_DOCUMENT_TYPE_*
+   * @throws 401 Unauthorized
+   * @throws 404 PROVIDER_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
@@ -76,13 +86,17 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /providers/:id - remove invoice provider. API does not accept query params.
+   * DELETE /providers/:id — Remove invoice provider. Emits webhook invoice_providers.deleted on success.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Provider id
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {string} opts.id - Provider ID (24-character hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ providerId: string }>>}
+   * @throws 400 WRONG_DATA, INVALID_PROVIDER_ID
+   * @throws 401 Unauthorized
+   * @throws 404 PROVIDER_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
@@ -94,13 +108,16 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /providers - create invoice provider. API does not accept query params.
+   * POST /providers — Create invoice provider. Body may be provider or body.provider (ProviderPostData). Emits webhook invoice_providers.created on success.
    * @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 {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {Object} opts.data - Request body (ProviderPostData: invoiceProviderType, currencies, params required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ provider: Object }>>}
+   * @throws 400 WRONG_DATA, INVALID_PHRASES, REQUIRED_PARAM_MISSING, INVALID_PARAM_VALUE, OPERATING_COMPANY_NOT_FOUND, INVALID_IVA_AFFILIATION
+   * @throws 401 Unauthorized
+   * @throws 500 Internal server error
    */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({

package/src/endpoints/invoices/tax-ids.js

@@ -6,8 +6,8 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @typedef {Object} TaxIdsListQuery
  * @property {string} taxNumber - Tax number to look up (required)
  * @property {string} country - ISO code of the country of the tax information (required)
- * @property {string} [invoiceProviderId] - Invoice provider id (24 hex chars)
- * @property {string} [documentType] - Tax identification type to check against validation service
+ * @property {string} [invoiceProviderId] - Invoice provider id (24-char hex ObjectId); optional, for external validation
+ * @property {string} [documentType] - Tax identification type for validation (e.g. NIT, DPI for infile)
  */
 
 /**
@@ -19,13 +19,17 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function taxIdsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /tax-ids - list tax IDs.
+   * GET /tax-ids — List tax ID information (paginated). Merges internal tax IDs with external provider validation when invoiceProviderId is provided.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {TaxIdsListQuery} opts.query - taxNumber, country; optional invoiceProviderId, documentType
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {TaxIdsListQuery} [opts.query] - taxNumber and country (required); optional invoiceProviderId, documentType
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>} 400 WRONG_DATA, INVALID_PROVIDER_ID; 404 TAXID_NOT_FOUND
+   * @returns {Promise<import("axios").AxiosResponse<{ taxIds: Object[], total?: number, ... }>>}
+   * @throws 400 WRONG_DATA, INVALID_PROVIDER_ID, INVALID_TAX_NUMBER, INVALID_PROVIDER_CREDENTIALS
+   * @throws 401 Unauthorized
+   * @throws 404 TAXID_NOT_FOUND, PROVIDER_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client({

package/src/endpoints/notifications/customers.js

@@ -62,7 +62,7 @@ function customersFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {CustomersActivationPostQuery} [opts.query] - Query params (providerId required)
-   * @param {Object} [opts.data] - Request body (CustomerForActivation)
+   * @param {Object} opts.data - Body: CustomerForActivation (firstName, lastName, email; optional activateCustomerEmailLoginToken)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */