btrz-api-client 8.29.0 → 8.31.0

package/lib/client.js

@@ -44,6 +44,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(_ref) {
   var baseURL = _ref.baseURL,
       headers = _ref.headers,
@@ -131,6 +146,11 @@ function createInventory(_ref) {
   };
 }
 
+/**
+ * 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(_ref2) {
   var baseURL = _ref2.baseURL,
       headers = _ref2.headers,
@@ -150,6 +170,11 @@ function createTrips(_ref2) {
   };
 }
 
+/**
+ * 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(_ref3) {
   var baseURL = _ref3.baseURL,
       headers = _ref3.headers,
@@ -170,6 +195,11 @@ function createColtrane(_ref3) {
   };
 }
 
+/**
+ * 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(_ref4) {
   var baseURL = _ref4.baseURL,
       headers = _ref4.headers,
@@ -246,6 +276,11 @@ function createAccounts(_ref4) {
   };
 }
 
+/**
+ * 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(_ref5) {
   var baseURL = _ref5.baseURL,
       headers = _ref5.headers,
@@ -278,6 +313,11 @@ function createSales(_ref5) {
   };
 }
 
+/**
+ * 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(_ref6) {
   var baseURL = _ref6.baseURL,
       headers = _ref6.headers,
@@ -323,6 +363,11 @@ function createOperations(_ref6) {
   };
 }
 
+/**
+ * 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(_ref7) {
   var baseURL = _ref7.baseURL,
       headers = _ref7.headers,
@@ -345,6 +390,11 @@ function createReports(_ref7) {
   };
 }
 
+/**
+ * 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(_ref8) {
   var baseURL = _ref8.baseURL,
       headers = _ref8.headers,
@@ -372,6 +422,11 @@ function createNotifications(_ref8) {
   };
 }
 
+/**
+ * Creates the uploads API client (files, images).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with uploads endpoint namespaces and __test.client
+ */
 function createUploads(_ref9) {
   var baseURL = _ref9.baseURL,
       headers = _ref9.headers,
@@ -391,6 +446,11 @@ function createUploads(_ref9) {
   };
 }
 
+/**
+ * Creates the loyalty API client (programs, movements).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with loyalty endpoint namespaces and __test.client
+ */
 function createLoyalty(_ref10) {
   var baseURL = _ref10.baseURL,
       headers = _ref10.headers,
@@ -410,6 +470,11 @@ function createLoyalty(_ref10) {
   };
 }
 
+/**
+ * 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(_ref11) {
   var baseURL = _ref11.baseURL,
       headers = _ref11.headers,
@@ -431,6 +496,11 @@ function createWebhooks(_ref11) {
   };
 }
 
+/**
+ * Creates the seatmaps API client (accessTicket, seat).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with seatmaps endpoint namespaces and __test.client
+ */
 function createSeatmaps(_ref12) {
   var baseURL = _ref12.baseURL,
       headers = _ref12.headers,
@@ -450,6 +520,11 @@ function createSeatmaps(_ref12) {
   };
 }
 
+/**
+ * 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(_ref13) {
   var baseURL = _ref13.baseURL,
       headers = _ref13.headers,
@@ -482,6 +557,11 @@ function createBtrzPay(_ref13) {
   };
 }
 
+/**
+ * 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(_ref14) {
   var baseURL = _ref14.baseURL,
       headers = _ref14.headers,
@@ -511,6 +591,11 @@ function createInvoices(_ref14) {
   };
 }
 
+/**
+ * Creates the GPS API client (scannerAppLocation).
+ * @param {CreateModuleOptions} opts - Client options
+ * @returns {Object} Object with gps endpoint namespaces and __test.client
+ */
 function createGPS(_ref15) {
   var baseURL = _ref15.baseURL,
       headers = _ref15.headers,
@@ -529,6 +614,11 @@ function createGPS(_ref15) {
   };
 }
 
+/**
+ * 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(_ref16) {
   var baseURL = _ref16.baseURL,
       headers = _ref16.headers,

package/lib/constants.js

@@ -1,5 +1,9 @@
 "use strict";
 
+/**
+ * Shared constants for the API client.
+ * @type {{ INTERNAL_AUTH_TOKEN_SYMBOL: string }}
+ */
 var constants = {
   INTERNAL_AUTH_TOKEN_SYMBOL: "internal_auth_token"
 };

package/lib/endpoints/accounts/accounts.js

@@ -1,12 +1,29 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var jwtToken = _ref2.jwtToken,
         accountId = _ref2.accountId,
@@ -19,6 +36,16 @@ function accountsFactory(_ref) {
   }
 
   var 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: function create(_ref3) {
       var token = _ref3.token,
           jwtToken = _ref3.jwtToken,

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

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         providerId = _ref2.providerId,
@@ -21,6 +45,16 @@ function applicationSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,
@@ -36,6 +70,15 @@ function applicationSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -49,6 +92,15 @@ function applicationSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,
@@ -62,6 +114,15 @@ function applicationSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

package/lib/endpoints/accounts/application.js

@@ -1,12 +1,29 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/accounts/applications.js

@@ -1,12 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         id = _ref2.id,
@@ -17,6 +35,15 @@ function applicationsFactory(_ref) {
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: 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(_ref3) {
     var token = _ref3.token,
         appName = _ref3.appName,

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

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         userId = _ref2.userId,

package/lib/endpoints/accounts/customers.js

@@ -4,13 +4,41 @@ var _extends = Object.assign || function (target) { for (var i = 1; i < argument
 
 var base64 = require("base-64");
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var customerId = _ref2.customerId,
         customer = _ref2.customer,
@@ -26,6 +54,16 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -42,6 +80,15 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var customer = _ref4.customer,
         token = _ref4.token,
@@ -58,6 +105,14 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var email = _ref5.email,
         password = _ref5.password,
@@ -78,6 +133,15 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var service = _ref6.service,
         ticket = _ref6.ticket,
@@ -97,6 +161,16 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref7) {
     var customerId = _ref7.customerId,
         token = _ref7.token,
@@ -114,6 +188,15 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref8) {
     var destinationCustomerId = _ref8.destinationCustomerId,
         sourceCustomerIds = _ref8.sourceCustomerIds,

package/lib/endpoints/accounts/docs.js

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

package/lib/endpoints/accounts/domains.js

@@ -1,12 +1,28 @@
 "use strict";
 
-var _require = require("../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +36,15 @@ function domainsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var data = _ref3.data,
         token = _ref3.token,
@@ -34,6 +59,15 @@ function domainsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var domain = _ref4.domain,
         token = _ref4.token,