btrz-api-client 8.32.0 → 8.34.0

package/lib/endpoints/coltrane/paths.js

@@ -5,15 +5,16 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /paths (btrz-api-coltrane). See get-paths getSpec().
+ * Query params for GET /paths (btrz-api-coltrane). All except metrics and preferredAlgorithm are required by the API.
  * @typedef {Object} ColtranePathsListQuery
- * @property {string} [providerId] - Account ID of the travel provider (required by API)
- * @property {string} [productId] - Product ID belonging to the provider (required by API)
- * @property {string} [originId] - Origin station id (required by API)
- * @property {string} [destinationId] - Destination station id (required by API)
- * @property {string} [departureFromDate] - Start of search interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
- * @property {string} [departureToDate] - End of search interval; ISO 8601; interval max 25h
- * @property {string} [metrics] - If true, response includes metrics (debugging)
+ * @property {string} [providerId] - Account ID of the travel provider (24-char hex)
+ * @property {string} [productId] - Product ID belonging to the provider (24-char hex)
+ * @property {string} [originId] - Origin station ID (24-char hex); must differ from destinationId
+ * @property {string} [destinationId] - Destination station ID (24-char hex)
+ * @property {string} [departureFromDate] - Start of departure interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
+ * @property {string} [departureToDate] - End of departure interval; ISO 8601; interval max 25h, must be after departureFromDate
+ * @property {string} [preferredAlgorithm] - "search_algorithm_fast" or "search_algorithm_exhaustive"
+ * @property {string|boolean} [metrics] - If true, response includes metrics object (debugging)
  */
 
 /**
@@ -30,12 +31,15 @@ function coltraneFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /paths - list Coltrane paths.
+   * GET /paths — search for travel paths between two stations in a departure time interval.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {ColtranePathsListQuery} [opts.query] - Query params (providerId, productId, originId, destinationId, etc.)
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {ColtranePathsListQuery} [opts.query] - Query params; providerId, productId, originId, destinationId, departureFromDate, departureToDate required
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { paths: Array<{ segments: Array<{ scheduleId: string, manifestDay: string, fromLegIndex: number, toLegIndex: number }> }>, metrics?: object } }>>}
+   * @throws {import("axios").AxiosError} 400 INVALID_QUERY_PARAMETERS (invalid params, originId=destinationId, interval &gt; 25h, or invalid preferredAlgorithm)
+   * @throws {import("axios").AxiosError} 401 Unauthorized
+   * @throws {import("axios").AxiosError} 500 Internal server error
    */
   function all(_ref2) {
     var token = _ref2.token,

package/lib/endpoints/inventory/segments-information-tables.js

@@ -1,12 +1,13 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
  * Query params for GET /segments-information-tables/:routeId (btrz-api-inventory-trips). See get-by-id-handler getSpec().
  * @typedef {Object} SegmentsInformationTablesQuery
- * @property {string} [providerId] - Provider id of the route if not the same as the user making the request (ObjectId format)
+ * @property {string} [providerId] - Provider/account id of the route when different from the authenticated user (24-char hex ObjectId)
  */
 
 /**
@@ -23,14 +24,18 @@ function segmentInformationTableFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /segments-information-tables/:routeId - get segments information table by route id.
+   * GET /segments-information-tables/:routeId — Returns segment information tables for the route (distances, durations, durationsHHMM between stops). Requires BETTEREZ_APP audience.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.routeId - Route id (ObjectId format)
-   * @param {SegmentsInformationTablesQuery} [opts.query] - Query params (providerId)
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
+   * @param {string} opts.routeId - Route id (24-char hex ObjectId)
+   * @param {SegmentsInformationTablesQuery} [opts.query] - Optional providerId
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ segmentInformationTables: { distances: Object, durations: Object, durationsHHMM: Object } }>>}
+   * @throws 400 INVALID_ROUTE_ID — routeId not 24 hex characters
+   * @throws 401 Unauthorized
+   * @throws 404 ROUTE_NOT_FOUND
+   * @throws 500 Internal server error
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -42,6 +47,7 @@ function segmentInformationTableFactory(_ref) {
 
     return client({
       url: "/segments-information-tables/" + routeId,
+      method: "get",
       params: query,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });

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

@@ -0,0 +1,67 @@
+"use strict";
+
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * 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(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.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(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        data = _ref2.data,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/direct-trip-ids",
+      method: "post",
+      data: data,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  return {
+    create: create
+  };
+}
+
+module.exports = tripIdsFactory;

package/lib/endpoints/inventory/trips.js

@@ -1,14 +1,15 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * 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 }}
  */
 
 
@@ -17,12 +18,17 @@ function tripsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -33,32 +39,73 @@ function tripsFactory(_ref) {
 
     return client({
       url: "/trips",
+      method: "get",
       params: query,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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(_ref3) {
     var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
         id = _ref3.id,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
         headers = _ref3.headers;
 
-    return client.get("/trip/" + id, {
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    return client({
+      url: "/trip/" + id,
+      method: "get",
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        _ref4$query = _ref4.query,
+        query = _ref4$query === undefined ? {} : _ref4$query,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/trips/pricing-simulation",
+      method: "get",
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
   return {
     all: all,
-    get: get
+    get: get,
+    getPricingSimulation: getPricingSimulation
   };
 }
 

package/lib/endpoints/invoices/emails.js

@@ -18,13 +18,23 @@ function emailsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,

package/lib/endpoints/invoices/invoices.js

@@ -30,13 +30,15 @@ function invoicesFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -54,13 +56,17 @@ function invoicesFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,
@@ -79,13 +85,16 @@ function invoicesFactory(_ref) {
   }
 
   /**
-   * 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(_ref4) {
     var token = _ref4.token,
@@ -103,13 +112,19 @@ function invoicesFactory(_ref) {
   }
 
   /**
-   * 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(_ref5) {
     var token = _ref5.token,
@@ -129,13 +144,19 @@ function invoicesFactory(_ref) {
   }
 
   /**
-   * 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(_ref6) {
     var token = _ref6.token,

package/lib/endpoints/invoices/pdfs.js

@@ -6,8 +6,8 @@ var _require = 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)
  */
 
 /**
@@ -24,14 +24,21 @@ function pdfsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,

package/lib/endpoints/invoices/providers.js

@@ -28,13 +28,15 @@ function providersFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -52,13 +54,17 @@ function providersFactory(_ref) {
   }
 
   /**
-   * 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(_ref3) {
     var token = _ref3.token,
@@ -77,14 +83,18 @@ function providersFactory(_ref) {
   }
 
   /**
-   * 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(_ref4) {
     var token = _ref4.token,
@@ -105,13 +115,17 @@ function providersFactory(_ref) {
   }
 
   /**
-   * 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(_ref5) {
     var token = _ref5.token,
@@ -130,13 +144,16 @@ function providersFactory(_ref) {
   }
 
   /**
-   * 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(_ref6) {
     var token = _ref6.token,

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

@@ -9,8 +9,8 @@ var _require = 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)
  */
 
 /**
@@ -27,13 +27,17 @@ function taxIdsFactory(_ref) {
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,