btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/sales/check-in-info.js

@@ -1,7 +1,24 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function checkInInfoFactory({ client, internalAuthTokenProvider }) {
-  function get({ token, jwtToken, id, headers, query = {} }) {
+/**
+ * Factory for check-in API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+function checkInInfoFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /check-in/:id - get check-in info. API does not accept query params (btrz-api-sales).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Check-in id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, id, headers, query = {}}) {
     return client({
       url: `/check-in/${id}`,
       params: query,
@@ -9,9 +26,9 @@ function checkInInfoFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  return { 
+  return {
     get
   };
 }
 
-module.exports = checkInInfoFactory;
+module.exports = checkInInfoFactory;

package/src/endpoints/sales/custom-fields.js

@@ -1,15 +1,36 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function customFieldsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /custom-fields (btrz-api-sales get-custom-fields getSpec).
+ * @typedef {Object} CustomFieldsListQuery
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
+ */
 
-  function all({ token, query = {}, headers }) {
+/**
+ * Factory for custom-fields API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function customFieldsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /custom-fields - list custom fields.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {CustomFieldsListQuery} [opts.query] - Query params (providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, query = {}, headers}) {
     return client.get("/custom-fields", {
       params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  return { 
+  return {
     all
   };
 }

package/src/endpoints/sales/docs.js

@@ -1,4 +1,14 @@
+/**
+ * Factory for API docs (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
 function docsFactory({client}) {
+  /**
+   * GET /api-docs-v2 - get API docs.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }

package/src/endpoints/sales/flexpasses.js

@@ -1,6 +1,23 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for flexpasses API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function flexpassesEndpointsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /flexpasses/:flexpassId - get flexpass by id. API does not accept query params (btrz-api-sales).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.flexpassId - Flexpass id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, flexpassId, query = {}, headers}) {
     return client({
       url: `/flexpasses/${flexpassId}`,

package/src/endpoints/sales/gift-certificates.js

@@ -1,10 +1,34 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /gift-certificates/:GCNumber (btrz-api-sales get-gift-certificate getSpec).
+ * @typedef {Object} GiftCertificateGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Calculate available balance for the voucher applied to the cart
+ */
+
+/**
+ * Factory for gift-certificates API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function giftCertificatesFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * GET /gift-certificates/:GCNumber - get gift certificate by number.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.GCNumber - Gift certificate number
+   * @param {GiftCertificateGetQuery} [opts.query] - Query params (providerId, cartId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, GCNumber, query = {}, headers}) {
     return client({
       url: `/gift-certificates/${GCNumber}`,

package/src/endpoints/sales/order.js

@@ -1,6 +1,36 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for POST /orders/:orderId/payments (btrz-api-sales post-payments-handler getSpec).
+ * @typedef {Object} OrderPaymentsQuery
+ * @property {string} [channel] - Channel where cart is being purchased (defaults to 'none' when not provided)
+ * @property {string} [providerId] - Account id the transaction belongs to
+ */
+
+/**
+ * Query params for GET /order/:orderId (btrz-api-sales get-order getSpec).
+ * @typedef {Object} OrderGetQuery
+ * @property {string} [providerId] - Provider account id
+ */
+
+/**
+ * Factory for order API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, get: function, overwrite: function }}
+ */
 function orderFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /order - create order.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.order - Order payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, order, jwtToken, headers}) {
     return client({
       url: "/order",
@@ -10,6 +40,15 @@ function orderFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /order/:orderId - get order by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.orderId - Order id
+   * @param {OrderGetQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, orderId, query = {}, headers}) {
     return client({
       url: `/order/${orderId}`,
@@ -18,6 +57,17 @@ function orderFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /orders/:orderId/payments - overwrite order payments.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.orderId - Order id
+   * @param {Object} opts.payments - Payments payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel, providerId)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function overwrite({token, orderId, payments, jwtToken, headers, query = {}}) {
     return client({
       url: `/orders/${orderId}/payments`,

package/src/endpoints/sales/parcel-quotes.js

@@ -1,8 +1,25 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for parcel-quotes API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function parcelQuotesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /parcel-quotes - get parcel quote. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.parcelQuoteData - Parcel quote request payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, parcelQuoteData, jwtToken, headers}) {
     return client({
       url: "/parcel-quotes",
@@ -12,7 +29,7 @@ function parcelQuotesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  return { 
+  return {
     get
   };
 }

package/src/endpoints/sales/payment-providers.js

@@ -1,18 +1,41 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function paymentProvidersFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for GET /payment-providers (btrz-api-sales get-payment-providers getSpec).
+ * @typedef {Object} PaymentProvidersListQuery
+ * @property {string} [providerId] - Provider id to get payment providers for
+ * @property {string} [channel] - Channel to get payment providers for
+ * @property {string} [enabled] - Filter by enabled [true, false]
+ */
 
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Factory for payment-providers API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function paymentProvidersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /payment-providers - list payment providers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PaymentProvidersListQuery} [opts.query] - Query params (providerId, channel, enabled)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client.get("/payment-providers", {
-      params: query,   
+      params: query,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  return { 
+  return {
     all
   };
-
 }
 
 module.exports = paymentProvidersFactory;

package/src/endpoints/sales/redeemable-items.js

@@ -1,8 +1,40 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function redeemableItemsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /redeemable-items/:redeemableItemId (btrz-api-sales get-redeemable-item getSpec).
+ * @typedef {Object} RedeemableItemsGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
+ * @property {string} [cartId] - Current cart id (item can be redeemed once per cart)
+ */
 
-  function get({ token, redeemableItemId, query = {}, headers }) {
+/**
+ * Query params for GET /redeemable-items list (btrz-api-sales get-redeemable-items getSpec).
+ * @typedef {Object} RedeemableItemsListQuery
+ * @property {string} [ids] - Redeemable item display ID or _id, comma-separated
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Current cart id
+ */
+
+/**
+ * Factory for redeemable-items API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, getValid: function }}
+ */
+function redeemableItemsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /redeemable-items/:redeemableItemId - get redeemable item by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.redeemableItemId - Redeemable item display ID or _id
+   * @param {RedeemableItemsGetQuery} [opts.query] - Query params (providerId, providerIds, cartId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, redeemableItemId, query = {}, headers}) {
     return client({
       url: `/redeemable-items/${redeemableItemId}`,
       params: query,
@@ -10,6 +42,15 @@ function redeemableItemsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * GET /redeemable-items - get valid redeemable items.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {RedeemableItemsListQuery} [opts.query] - Query params (ids, providerId, cartId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getValid({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/redeemable-items",

package/src/endpoints/sales/sync-entry.js

@@ -1,8 +1,24 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function syncEntryFactory({ client, internalAuthTokenProvider }) {
-
-  function patch({ token, data, jwtToken, headers }) {
+/**
+ * Factory for sync-entry API (btrz-api-sales).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ patch: function }}
+ */
+function syncEntryFactory({client, internalAuthTokenProvider}) {
+  /**
+   * PATCH /sync-entry - patch sync entry. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.data - Request body
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function patch({token, data, jwtToken, headers}) {
     return client({
       url: "/sync-entry",
       method: "patch",
@@ -14,7 +30,6 @@ function syncEntryFactory({ client, internalAuthTokenProvider }) {
   return {
     patch
   };
-
 }
 
 module.exports = syncEntryFactory;

package/src/endpoints/sales/voucher.js

@@ -1,10 +1,51 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query parameters for GET /vouchers/{internalId} (btrz-api-sales getSpec).
+ * @typedef {Object} VoucherGetQuery
+ * @property {string} [firstName] - First name of the customer
+ * @property {string} [lastName] - Last name of the customer
+ * @property {string} [cartId] - Validates if voucher applies to any item in the cart; overrides productType, from, to, fareTypes
+ * @property {string} [productType] - Product type of the voucher
+ * @property {string} [from] - Station "from" to validate if voucher has routes
+ * @property {string} [to] - Station "to" to validate if voucher has routes
+ * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare; use fareIds instead
+ * @property {string} [fareIds] - Validates if voucher has one fare ID
+ * @property {string} [displayCurrencyCode] - Display currency code for multi-currency accounts
+ */
+
+/**
+ * Options object passed to get(). The client builds the URL from voucher.number and voucher.cartId, firstName, lastName, displayCurrencyCode.
+ * @typedef {Object} VoucherGetOptionsVoucher
+ * @property {string} number - Voucher internal ID (path param internalId)
+ * @property {string} [cartId] - Sent as query cartId
+ * @property {string} [firstName] - Sent as query firstName
+ * @property {string} [lastName] - Sent as query lastName
+ * @property {string} [displayCurrencyCode] - Sent as query displayCurrencyCode
+ */
+
+/**
+ * Factory for voucher GET API (btrz-api-sales). GET /vouchers/{internalId}.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function voucherFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * GET /vouchers/:number - get voucher by internal id (number). Query params from API: firstName, lastName, cartId, productType, from, to, fareTypes, fareIds, displayCurrencyCode.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {VoucherGetOptionsVoucher} opts.voucher - Voucher identifier and query fields: number (internalId), cartId, firstName, lastName, displayCurrencyCode
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} response.data is the Voucher (200); 400 Cart invalid, 401 Unauthorized, 404 Voucher not found
+   */
   function get({
     token, voucher, headers
   }) {

package/src/endpoints/seatmaps/access-ticket.js

@@ -1,12 +1,26 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function accessTicketFactory({ client, internalAuthTokenProvider }) {
-
-  function create({ token, jwtToken, headers}) {
+/**
+ * Factory for seatmaps access ticket API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+function accessTicketFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /access-ticket - create access ticket.
+   * @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>}
+   */
+  function create({token, jwtToken, headers}) {
     return client({
       url: "/access-ticket",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
@@ -15,4 +29,4 @@ function accessTicketFactory({ client, internalAuthTokenProvider }) {
   };
 }
 
-module.exports = accessTicketFactory;
+module.exports = accessTicketFactory;

package/src/endpoints/seatmaps/seat.js

@@ -1,12 +1,27 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function seatFactory({ client, internalAuthTokenProvider }) {
-
-  function update({ token, jwtToken, params, headers}) {
+/**
+ * Factory for seatmaps seat API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ update: function }}
+ */
+function seatFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /seat - update seat.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.params] - Query/request params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, params, headers}) {
     return client({
       url: "/seat",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       params
     });
   }

package/src/endpoints/uploads/files.js

@@ -1,8 +1,24 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function filesFactory({ client, internalAuthTokenProvider }) {
-
-  function upload({ token, jwtToken, formData, headers }) {
+/**
+ * Factory for upload files API (btrz-api-uploads).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ upload: function }}
+ */
+function filesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /files - upload file.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {import("form-data")} opts.formData - Form data with file
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function upload({token, jwtToken, formData, headers}) {
     // Only required to support integration tests
     const formHeaders = typeof formData.getHeaders === "function" ? formData.getHeaders() : {};
 
@@ -18,7 +34,7 @@ function filesFactory({ client, internalAuthTokenProvider }) {
   }
 
   return {
-    upload,
+    upload
   };
 }
 

package/src/endpoints/uploads/images.js

@@ -1,10 +1,24 @@
-"use strict";
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-const { authorizationHeaders } = require("./../endpoints_helpers");
-
-function imagesFactory({ client, internalAuthTokenProvider }) {
-
-  function create({ token, jwtToken, formData, headers }) {
+/**
+ * Factory for upload images API (btrz-api-uploads).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+function imagesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /images - upload image.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {import("form-data")} opts.formData - Form data with image
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, formData, headers}) {
     // Only required to support integration tests
     const formHeaders = typeof formData.getHeaders === "function" ? formData.getHeaders() : {};
 
@@ -20,7 +34,7 @@ function imagesFactory({ client, internalAuthTokenProvider }) {
   }
 
   return {
-    create,
+    create
   };
 }
 

package/src/endpoints/webhooks/events.js

@@ -1,19 +1,41 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function eventsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /events (webhooks). Client merges opts.context into query.
+ * @typedef {Object} WebhookEventsListQuery
+ * @property {string} [context] - Context filter (merged from opts.context by client)
+ */
 
-  function all({ token, jwtToken, context, query = {}, headers }) {
-    const queryObj = Object.assign({}, query, { context });
+/**
+ * Factory for webhook events API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+function eventsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /events - list webhook events. Query is merged with context (opts.context).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.context] - Context filter (merged into query)
+   * @param {WebhookEventsListQuery} [opts.query] - Additional query params (merged with context)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, context, query = {}, headers}) {
+    const queryObj = Object.assign({}, query, {context});
 
     return client({
       url: "/events",
       params: queryObj,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
   return {
-    all,
+    all
   };
 }