btrz-api-client 8.29.0 → 8.31.0

package/src/client.js

@@ -38,6 +38,21 @@ function clientFactory(opts) {
 
 /** MODULES */
 
+/**
+ * @typedef {Object} CreateModuleOptions
+ * @property {string} [baseURL] - Base URL for the HTTP client
+ * @property {Object} [headers] - Optional headers (e.g. x-amzn-trace-id)
+ * @property {number} [timeout] - Request timeout in ms
+ * @property {function(string): string} [overrideFn] - Optional function to override baseURL per request
+ * @property {{ getToken: function(): string }} [internalAuthTokenProvider] - Provider for service-to-service auth token
+ * @property {{ httpAgent?: import("http").Agent, httpsAgent?: import("https").Agent }} [agents] - Optional HTTP/HTTPS agents
+ */
+
+/**
+ * Creates the inventory API client with all inventory endpoint namespaces (amenities, banks, routes, products, etc.).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with inventory endpoint namespaces and __test.client
+ */
 function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -118,6 +133,11 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
   };
 }
 
+/**
+ * Creates the trips API client (trips, segmentsInformationTables). Uses inventory base path.
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with trips and segmentsInformationTables endpoint namespaces and __test_trips.client
+ */
 function createTrips({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -130,6 +150,11 @@ function createTrips({baseURL, headers, timeout, overrideFn, internalAuthTokenPr
   };
 }
 
+/**
+ * Creates the Coltrane API client (docs, paths, mergedFareTables).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with coltrane endpoint namespaces and __test.client
+ */
 function createColtrane({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -143,6 +168,11 @@ function createColtrane({baseURL, headers, timeout, overrideFn, internalAuthToke
   };
 }
 
+/**
+ * Creates the accounts API client (accounts, emailTemplates, users, lexicons, shifts, etc.).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with accounts endpoint namespaces and __test.client
+ */
 function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -212,6 +242,11 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
   };
 }
 
+/**
+ * Creates the sales API client (cart, order, cancellations, parcelQuotes, etc.).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with sales endpoint namespaces and __test.client
+ */
 function createSales({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -237,6 +272,11 @@ function createSales({baseURL, headers, timeout, overrideFn, internalAuthTokenPr
   };
 }
 
+/**
+ * Creates the operations API client (manifest, tickets, transactions, vouchers, parcels, etc.).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with operations endpoint namespaces and __test.client
+ */
 function createOperations({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -275,6 +315,11 @@ function createOperations({baseURL, headers, timeout, overrideFn, internalAuthTo
   };
 }
 
+/**
+ * Creates the reports API client (reportTypes, customReports, reportEmail, tripManifests).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with reports endpoint namespaces and __test.client
+ */
 function createReports({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -290,6 +335,11 @@ function createReports({baseURL, headers, timeout, overrideFn, internalAuthToken
   };
 }
 
+/**
+ * Creates the notifications API client (pdfs, pdfData, email, twilio, notify, etc.).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with notifications endpoint namespaces and __test.client
+ */
 function createNotifications({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -310,6 +360,11 @@ function createNotifications({baseURL, headers, timeout, overrideFn, internalAut
   };
 }
 
+/**
+ * Creates the uploads API client (files, images).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with uploads endpoint namespaces and __test.client
+ */
 function createUploads({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -322,6 +377,11 @@ function createUploads({baseURL, headers, timeout, overrideFn, internalAuthToken
   };
 }
 
+/**
+ * Creates the loyalty API client (programs, movements).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with loyalty endpoint namespaces and __test.client
+ */
 function createLoyalty({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -334,6 +394,11 @@ function createLoyalty({baseURL, headers, timeout, overrideFn, internalAuthToken
   };
 }
 
+/**
+ * Creates the webhooks API client (subscriptions, events, undelivered, webhooks).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with webhooks endpoint namespaces and __test.client
+ */
 function createWebhooks({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -348,6 +413,11 @@ function createWebhooks({baseURL, headers, timeout, overrideFn, internalAuthToke
   };
 }
 
+/**
+ * Creates the seatmaps API client (accessTicket, seat).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with seatmaps endpoint namespaces and __test.client
+ */
 function createSeatmaps({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -360,6 +430,11 @@ function createSeatmaps({baseURL, headers, timeout, overrideFn, internalAuthToke
   };
 }
 
+/**
+ * Creates the BtrzPay API client (paymentMethods, terminals, payments, oxxo, etc.).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with btrzpay endpoint namespaces and __test.client
+ */
 function createBtrzPay({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -385,6 +460,11 @@ function createBtrzPay({baseURL, headers, timeout, overrideFn, internalAuthToken
   };
 }
 
+/**
+ * Creates the invoices API client (providers, infile, system, invoices, etc.).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with invoices endpoint namespaces and __test.client
+ */
 function createInvoices({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -407,6 +487,11 @@ function createInvoices({baseURL, headers, timeout, overrideFn, internalAuthToke
   };
 }
 
+/**
+ * Creates the GPS API client (scannerAppLocation).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with gps endpoint namespaces and __test.client
+ */
 function createGPS({baseURL, headers, timeout, overrideFn, internalAuthTokenProvider, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
 
@@ -418,6 +503,11 @@ function createGPS({baseURL, headers, timeout, overrideFn, internalAuthTokenProv
   };
 }
 
+/**
+ * Creates the Ratality API client (auth, clients, integrations). Does not use internalAuthTokenProvider.
+ * @param {Omit<CreateModuleOptions, "internalAuthTokenProvider">} opts - Client options (no internalAuthTokenProvider)
+ * @returns {Object} Object with ratality endpoint namespaces and __test.client
+ */
 function createRatality({baseURL, headers, timeout, overrideFn, agents}) {
   const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
   const version = "v2";

package/src/constants.js

@@ -1,3 +1,7 @@
+/**
+ * Shared constants for the API client.
+ * @type {{ INTERNAL_AUTH_TOKEN_SYMBOL: string }}
+ */
 const constants = {
   INTERNAL_AUTH_TOKEN_SYMBOL: "internal_auth_token"
 };

package/src/endpoints/accounts/accounts.js

@@ -1,8 +1,23 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for accounts API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, defaultUsers: { create: function } }}
+ */
 function accountsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /accounts/:accountId - get an account by id.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.accountId - Account id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({jwtToken, accountId, headers}) {
     return client({
       url: `/accounts/${accountId}`,
@@ -11,6 +26,16 @@ function accountsFactory({client, internalAuthTokenProvider}) {
   }
 
   const defaultUsers = {
+    /**
+     * POST /accounts/:accountId/default-users - create default users for account.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.accountId - Account id (ObjectId)
+     * @param {Object} opts.data - Default users payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({token, jwtToken, accountId, data, headers}) {
       return client({
         url: `/accounts/${accountId}/default-users`,

package/src/endpoints/accounts/application-settings.js

@@ -1,6 +1,28 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} ApplicationSettingsQuery
+ * @property {string} [name] - The application name
+ */
+
+/**
+ * Factory for application-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function, remove: function, regenerateKeys: function, create: function }}
+ */
 function applicationSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /application-settings/:providerId - get application settings for provider.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.providerId - Provider id (ObjectId)
+   * @param {ApplicationSettingsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, providerId, jwtToken, query = {}, headers}) {
     return client.get(`/application-settings/${providerId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
@@ -8,6 +30,16 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /application-settings/:id - update application settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Application settings id (ObjectId)
+   * @param {Object} opts.application - Application payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, id, application, headers}) {
     return client({
       url: `/application-settings/${id}`,
@@ -17,6 +49,15 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /application-settings/:id - remove application settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Application settings id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, token, id, headers}) {
     return client({
       url: `/application-settings/${id}`,
@@ -25,6 +66,15 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /application-settings/:id/keys - regenerate application keys.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Application settings id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function regenerateKeys({jwtToken, token, id, headers}) {
     return client({
       url: `/application-settings/${id}/keys`,
@@ -33,6 +83,15 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /application-settings - create application settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.application - Application payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, application, headers}) {
     return client({
       url: "/application-settings",

package/src/endpoints/accounts/application.js

@@ -1,6 +1,21 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for current application (single) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function applicationsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /application - get current application.
+   * @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 get({token, jwtToken, headers}) {
     return client.get("/application", {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -12,4 +27,4 @@ function applicationsFactory({client, internalAuthTokenProvider}) {
   };
 }
 
-module.exports = applicationsFactory;
+module.exports = applicationsFactory;

package/src/endpoints/accounts/applications.js

@@ -1,11 +1,36 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for applications (by id/name) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, getByName: function }}
+ */
 function applicationsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /applications/:id - get an application by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Application id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, id, jwtToken, headers}) {
     return client.get(`/applications/${id}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
+  /**
+   * GET /applications/name/:appName - get an application by name.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.appName - Application name
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getByName({token, appName, jwtToken, headers}) {
     return client.get(`/applications/name/${appName}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})

package/src/endpoints/accounts/current-shifts.js

@@ -1,7 +1,29 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
 
-function currentShiftsFactory({client, internalAuthTokenProvider}) {
+/**
+ * @typedef {Object} CurrentShiftsQuery
+ * @property {string} [includeActivity] - Set to 'false' to avoid returning sales activity data for the shift (default 'true')
+ */
 
+/**
+ * Factory for current-shift (per user) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+function currentShiftsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /users/:userId/current-shift - get current shift for user.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.userId - User id (ObjectId)
+   * @param {CurrentShiftsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, userId, query = {}, headers}) {
     return client.get(`/users/${userId}/current-shift`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers}),

package/src/endpoints/accounts/customers.js

@@ -1,9 +1,35 @@
 const base64 = require("base-64");
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /customers (btrz-api-accounts). See get-customers getSpec().
+ * @typedef {Object} CustomersQuery
+ * @property {string} [customerNumber] - A particular customer number; only that customer will be listed
+ * @property {string} [externalId] - A particular externalId (same format as when creating the customer)
+ * @property {string} [providerIds] - Provider ids to get customers from (comma-separated if more than one)
+ * @property {string} [lookupSearchParams] - Lookup search data in format "documentTypeId|DNI,documentNumber|1234567"
+ */
+
+/**
+ * Factory for customers API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ put: function, all: function, create: function, signIn: function, signInCas: function, update: function, merge: function }}
+ */
 function customersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * PUT /customers/:customerId - update a customer (full replace).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customerId - Customer id (ObjectId)
+   * @param {Object} opts.customer - Customer payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function put({customerId, customer, token, jwtToken, headers}) {
     return client({
       url: `/customers/${customerId}`,
@@ -13,6 +39,16 @@ function customersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /customers - list customers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {CustomersQuery} [opts.query] - Query params (customerNumber, externalId, providerIds, lookupSearchParams)
+   * @param {string} [opts.providerId] - Provider id; if set, added to query (convenience for single provider)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
     return client({
@@ -22,16 +58,33 @@ function customersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /customer - create a customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.customer - Customer payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({customer, token, jwtToken, query, headers}) {
     return client({
       url: "/customer",
       method: "post",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       data: {customer},
-      params: query,
+      params: query
     });
   }
 
+  /**
+   * POST /customers - sign in with email/password (Basic auth).
+   * @param {Object} opts
+   * @param {string} opts.email - Customer email
+   * @param {string} opts.password - Customer password
+   * @param {string} opts.apiKey - API key (x-api-key)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function signIn({email, password, apiKey}) {
     const encodedCredentials = base64.encode(`${email}:${password}`);
     const headers = {
@@ -48,6 +101,15 @@ function customersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /customers/cas - sign in via CAS (ticket).
+   * @param {Object} opts
+   * @param {string} opts.service - CAS service URL
+   * @param {string} opts.ticket - CAS ticket
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function signInCas({service, ticket, token, headers}) {
     return client({
       url: "/customers/cas",
@@ -62,6 +124,16 @@ function customersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PATCH /customers/:customerId - partial update a customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customerId - Customer id (ObjectId)
+   * @param {Object} opts.data - Partial customer payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({customerId, token, jwtToken, data, query, headers}) {
     return client({
       url: `/customers/${customerId}`,
@@ -72,6 +144,15 @@ function customersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /customers/merge - merge source customers into destination.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.destinationCustomerId - Destination customer id (ObjectId)
+   * @param {Array<string>} opts.sourceCustomerIds - Source customer ids (ObjectIds)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function merge({destinationCustomerId, sourceCustomerIds, jwtToken, token}) {
     return client({
       url: "/customers/merge",

package/src/endpoints/accounts/docs.js

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

package/src/endpoints/accounts/domains.js

@@ -1,8 +1,22 @@
 const {
   authorizationHeaders
-} = require("../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for domains API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, remove: function }}
+ */
 function domainsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /domains - list domains. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client({
       params: query,
@@ -11,6 +25,15 @@ function domainsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /domains - create a domain.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Domain payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({data, token, jwtToken, headers}) {
     return client({
       url: "/domains",
@@ -20,6 +43,15 @@ function domainsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /domains/:domain - remove a domain.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.domain - Domain name
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({domain, token, jwtToken, headers}) {
     return client({
       url: `/domains/${domain}`,