btrz-api-client 8.31.0 → 8.33.0

package/lib/client.js

@@ -187,6 +187,8 @@ function createColtrane(_ref3) {
 
   return {
     docs: require("./endpoints/coltrane/docs.js")({ client: client }),
+    healthcheck: require("./endpoints/coltrane/healthcheck.js")({ client: client }),
+    info: require("./endpoints/coltrane/info.js")({ client: client }),
     paths: require("./endpoints/coltrane/paths.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     mergedFareTables: require("./endpoints/coltrane/merged-fare-tables.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     __test: {
@@ -212,6 +214,7 @@ function createAccounts(_ref4) {
 
   return {
     accounts: require("./endpoints/accounts/accounts.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    agencies: require("./endpoints/accounts/agencies.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     application: require("./endpoints/accounts/application.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     applications: require("./endpoints/accounts/applications.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     applicationSettings: require("./endpoints/accounts/application-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
@@ -227,6 +230,7 @@ function createAccounts(_ref4) {
     smsTemplates: require("./endpoints/accounts/sms-templates.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     exchangeRates: require("./endpoints/accounts/exchange-rates.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     exchangeReceipts: require("./endpoints/accounts/exchange-receipts.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    externalCustomers: require("./endpoints/accounts/external-customers.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     goalSettings: require("./endpoints/accounts/goal-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     images: require("./endpoints/accounts/images.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     interline: require("./endpoints/accounts/interline.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
@@ -265,6 +269,7 @@ function createAccounts(_ref4) {
     trustedMachines: require("./endpoints/accounts/trusted-machines.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     twilioSettings: require("./endpoints/accounts/twilio-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     users: require("./endpoints/accounts/users.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    verifiedEmails: require("./endpoints/accounts/verified-emails.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     __test: {
       client: client
     },

package/lib/endpoints/accounts/agencies.js

@@ -0,0 +1,52 @@
+"use strict";
+
+/* eslint-disable max-len */
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Factory for agencies endpoints (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ putCreditLimit: function }}
+ */
+
+
+function agenciesFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * PUT /agencies/:agencyId/credit-limit - update credit limit for an agency (seller) in the provider's network.
+   * Requires BETTEREZ_APP audience. Request body can be { limitAmount, unlimited } or { creditLimit: { limitAmount, unlimited } }.
+   * Side effect: Emits webhook event creditlimit.updated.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyId - Agency (seller) ID, 24-char hex ObjectId. Must not be the provider's own accountId.
+   * @param {Object} opts.data - Credit limit payload: { limitAmount: number, unlimited: boolean } or { creditLimit: { limitAmount, unlimited } }
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ creditLimit: { _id: string, sellerId: string, providerId: string, unlimited: boolean, overrideLimit: number, currentLimit: number } }>>}
+   */
+  function putCreditLimit(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        agencyId = _ref2.agencyId,
+        data = _ref2.data,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/agencies/" + agencyId + "/credit-limit",
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  return {
+    putCreditLimit: putCreditLimit
+  };
+}
+
+module.exports = agenciesFactory;

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

@@ -1,11 +1,12 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
  * @typedef {Object} ApplicationSettingsQuery
- * @property {string} [name] - The application name
+ * @property {string} [name] - Optional. Filter by application name. When set, unauthenticated returns one object or 404; authenticated returns array with at most one item.
  */
 
 /**
@@ -22,14 +23,14 @@ function applicationSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /application-settings/:providerId - get application settings for provider.
+   * GET /application-settings/:providerId - get application settings for a provider (account). Auth is optional: without auth returns one public object { key, settings, requestEndpoint }; with valid token returns array of application documents (see API docs for privateKey handling for internal apps).
    * @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 {string} opts.providerId - Account (provider) ID whose application settings to return
+   * @param {ApplicationSettingsQuery} [opts.query] - Optional query; use name to filter by application name
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} Response data: unauthenticated = { key, settings, requestEndpoint }; authenticated = array of application objects (see API docs)
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -46,14 +47,14 @@ function applicationSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /application-settings/:id - update application settings.
+   * PUT /application-settings/:id - update an application. Body can be { application: { name, description?, settings?, requestEndpoint?, enableUserSignOn?, channels?, roles? } } or direct. Emits webhook applications.updated.
    * @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 {string} opts.id - Application id (24-char hex ObjectId)
+   * @param {Object} opts.application - Application payload (name required; optional description, settings, requestEndpoint, enableUserSignOn, channels, roles)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} Response data: { application }
    */
   function update(_ref3) {
     var jwtToken = _ref3.jwtToken,
@@ -71,13 +72,13 @@ function applicationSettingsFactory(_ref) {
   }
 
   /**
-   * DELETE /application-settings/:id - remove application settings.
+   * DELETE /application-settings/:id - soft-delete an application. Emits webhook applications.deleted.
    * @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 {string} opts.id - Application id (24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} Response data: { id } (deleted application id)
    */
   function remove(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -93,13 +94,13 @@ function applicationSettingsFactory(_ref) {
   }
 
   /**
-   * POST /application-settings/:id/keys - regenerate application keys.
+   * POST /application-settings/:id/keys - regenerate application keys; returns new key and privateKey. Emits webhook applications.updated.
    * @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 {string} opts.id - Application id (24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} Response data: { keys: { key, privateKey } }
    */
   function regenerateKeys(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -115,13 +116,13 @@ function applicationSettingsFactory(_ref) {
   }
 
   /**
-   * POST /application-settings - create application settings.
+   * POST /application-settings - create an application. Body can be { application: { name, description?, settings?, requestEndpoint?, enableUserSignOn?, channels?, roles? } } or direct. Emits webhook applications.created.
    * @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.application - Application payload (name required; optional description, settings, requestEndpoint, enableUserSignOn, channels, roles)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} Response data: { application }
    */
   function create(_ref6) {
     var jwtToken = _ref6.jwtToken,

package/lib/endpoints/accounts/applications.js

@@ -1,10 +1,11 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for applications (by id/name) API (btrz-api-accounts).
+ * Factory for applications API (btrz-api-accounts): get by id or by name. Requires BETTEREZ_APP or MOBILE_SCANNER (get by id); get by name requires authentication.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,13 +18,13 @@ function applicationsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /applications/:id - get an application by id.
+   * GET /applications/:id - get an application by id. Application must belong to the authenticated account.
    * @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 {string} opts.id - Application id (24-char hex ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} Response data: { application } (full application document including privateKey)
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -36,13 +37,13 @@ function applicationsFactory(_ref) {
     });
   }
   /**
-   * GET /applications/name/:appName - get an application by name.
+   * GET /applications/name/:appName - get an application by name. Returns non-internal, non-deleted application for the account; response excludes privateKey.
    * @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 {string} opts.appName - Application name (exact match)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} Response data: { application } (application document without privateKey)
    */
   function getByName(_ref3) {
     var token = _ref3.token,

package/lib/endpoints/accounts/customers.js

@@ -2,18 +2,19 @@
 
 var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 
+/* eslint-disable max-len */
 var base64 = require("base-64");
 
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /customers (btrz-api-accounts). See get-customers getSpec().
+ * Query params for GET /customers (btrz-api-accounts). Response is paginated (customers array + pagination).
  * @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"
+ * @property {string} [customerNumber] - Filter: only that customer will be listed
+ * @property {string} [externalId] - Filter: same format as when creating the customer; only that customer listed
+ * @property {string} [providerIds] - Filter: provider ids to get customers from (comma-separated)
+ * @property {string} [lookupSearchParams] - Lookup search in format "documentTypeId|DNI,documentNumber|1234567" (documentNumber required)
  */
 
 /**
@@ -30,14 +31,14 @@ function customersFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * PUT /customers/:customerId - update a customer (full replace).
+   * PUT /customers/:customerId - update a customer (full replace). Requires BETTEREZ_APP or CUSTOMER audience; customer token may only update own record. Side effect: may emit customer.updated webhook.
    * @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 {string} opts.customerId - Customer id (24-char hex ObjectId)
+   * @param {Object} opts.customer - Customer payload (CustomerData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ _id: string, customerNumber: string, ... }>>}
    */
   function put(_ref2) {
     var customerId = _ref2.customerId,
@@ -55,14 +56,14 @@ function customersFactory(_ref) {
   }
 
   /**
-   * GET /customers - list customers.
+   * GET /customers - list customers (paginated). Optional filters: customerNumber, externalId, providerIds, lookupSearchParams.
    * @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 {CustomersQuery} [opts.query] - Query params; API expects providerIds (comma-separated). Use providerId to send a single id.
+   * @param {string} [opts.providerId] - Convenience: added to query as providerId (single provider)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ customers: Array<object>, total: number, ... }>>}
    */
   function all(_ref3) {
     var token = _ref3.token,
@@ -81,13 +82,14 @@ function customersFactory(_ref) {
   }
 
   /**
-   * POST /customer - create a customer.
+   * POST /customer - create a customer. Body: { customer }. If password is included, activation token is created and activation email sent. Side effect: may emit customer.created webhook.
    * @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.customer - Customer payload (CustomerPost); email, firstName, lastName required
+   * @param {Object} [opts.query] - Optional: uniqueEmail, lang, channel, platform, appVersion, appName, activateIfExists
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ _id: string, customerNumber: string, ... }>>}
    */
   function create(_ref4) {
     var customer = _ref4.customer,
@@ -162,14 +164,15 @@ function customersFactory(_ref) {
   }
 
   /**
-   * PATCH /customers/:customerId - partial update a customer.
+   * PATCH /customers/:customerId - apply operations (activate, reset password, activateEmailAndPwd). Body: { operations } array of PatchCustomerOperation. Returns Customer and auth tokens. Side effect: may emit customer.updated webhook.
    * @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 {string} opts.customerId - Customer id (24-char hex ObjectId)
+   * @param {Object} opts.data - Body: { operations } or array of { op, path, value }
+   * @param {Object} [opts.query] - Optional query
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<CustomerWithAuthToken>>}
    */
   function update(_ref7) {
     var customerId = _ref7.customerId,
@@ -189,13 +192,13 @@ function customersFactory(_ref) {
   }
 
   /**
-   * POST /customers/merge - merge source customers into destination.
+   * POST /customers/merge - merge source customers into destination. Requires BETTEREZ_APP. Side effect: emits customers.merged webhook.
    * @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>}
+   * @param {string} opts.destinationCustomerId - Destination customer id (24-char hex ObjectId)
+   * @param {Array<string>} opts.sourceCustomerIds - Source customer ids (24-char hex ObjectIds)
+   * @returns {Promise<import("axios").AxiosResponse<{ customerMerge: object }>>}
    */
   function merge(_ref8) {
     var destinationCustomerId = _ref8.destinationCustomerId,

package/lib/endpoints/accounts/domains.js

@@ -5,6 +5,7 @@ var _require = require("./../endpoints_helpers.js"),
 
 /**
  * Factory for domains API (btrz-api-accounts).
+ * Endpoints manage subdomains for the account: list, create (with DNS and websales config), and delete.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,11 +18,12 @@ function domainsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /domains - list domains. API does not accept query params.
+   * GET /domains – List all domain names for the current account.
+   * Response body is an array of strings (primary domain first, then secondary domains). No query parameters.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
+   * @param {string} [opts.token] - API key (X-API-KEY)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<string[]>>} response.data is string[]
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -37,13 +39,14 @@ function domainsFactory(_ref) {
   }
 
   /**
-   * POST /domains - create a domain.
+   * POST /domains – Create a new subdomain for the account.
+   * Adds DNS CNAME and default websales config. Requires BETTEREZ_APP JWT. Emits domains.created (and websalesConfig.created) webhooks.
    * @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 {string} [opts.jwtToken] - JWT (required for BETTEREZ_APP audience)
+   * @param {Object} opts.data - Body: { domain } or { domainInfo: { domain } }. domain must match pattern (no dots, no underscores).
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ domain: string }>>} response.data is AddedDomainResponse
    */
   function create(_ref3) {
     var data = _ref3.data,
@@ -60,13 +63,15 @@ function domainsFactory(_ref) {
   }
 
   /**
-   * DELETE /domains/:domain - remove a domain.
+   * DELETE /domains/:domain – Remove a subdomain from the account.
+   * Removes DNS entry, websales config, and domain from payment methods and inventory products.
+   * Primary domain cannot be deleted. Emits domains.deleted and websalesConfig.deleted.
    * @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 {string} [opts.jwtToken] - JWT (required for BETTEREZ_APP audience)
+   * @param {string} opts.domain - Domain name (path parameter)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ domain: string }>>} response.data is DeletedDomainResponse
    */
   function remove(_ref4) {
     var domain = _ref4.domain,

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

@@ -6,6 +6,7 @@ var _require = require("./../endpoints_helpers.js"),
 
 /**
  * Factory for email-settings API (btrz-api-accounts).
+ * Manage account email settings (identity/verified senders). Path parameter is email address.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -18,12 +19,13 @@ function emailSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /email-settings - list email settings. API does not accept query params.
+   * GET /email-settings – List all email settings for the account.
+   * Response may trigger AWS verification and commIdentity updates. No query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ emailSettings: object[] }>>}
    */
   function all(_ref2) {
     var token = _ref2.token,
@@ -39,13 +41,13 @@ function emailSettingsFactory(_ref) {
     });
   }
   /**
-   * GET /email-settings/:email - get email settings by email. API does not accept query params.
+   * GET /email-settings/:email – Get one email setting by email address (path param).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.email - Email address
+   * @param {string} opts.email - Email address (path parameter; must match email pattern)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<object>>} response.data is EmailSetting
    */
   function getByEmail(_ref3) {
     var token = _ref3.token,
@@ -63,13 +65,14 @@ function emailSettingsFactory(_ref) {
   }
 
   /**
-   * POST /email-settings - create email settings.
+   * POST /email-settings – Create an email setting. Requires BETTEREZ_APP JWT. Emits emailSetting.created.
+   * Body: { emailSetting } or { name, email, active }. Email and domain are verified in AWS.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Email settings payload
+   * @param {string} [opts.jwtToken] - JWT (required for BETTEREZ_APP audience)
+   * @param {Object} opts.data - Body: { name, email, active? } or { emailSetting: { name, email, active? } }
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ emailSetting: object }>>}
    */
   function create(_ref4) {
     var data = _ref4.data,
@@ -86,14 +89,14 @@ function emailSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /email-settings/:email - update email settings.
+   * PUT /email-settings/:email – Update an email setting. Requires BETTEREZ_APP JWT. Emits emailSetting.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.email - Email address
-   * @param {Object} opts.data - Email settings payload
+   * @param {string} [opts.jwtToken] - JWT (required for BETTEREZ_APP audience)
+   * @param {string} opts.email - Email address (path parameter)
+   * @param {Object} opts.data - Body: { name, email, active?, ... } or { emailSetting: { ... } }
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ emailSetting: object }>>}
    */
   function update(_ref5) {
     var token = _ref5.token,
@@ -111,13 +114,14 @@ function emailSettingsFactory(_ref) {
   }
 
   /**
-   * DELETE /email-settings/:email - remove email settings.
+   * DELETE /email-settings/:email – Remove an email setting. Requires BETTEREZ_APP JWT. Emits emailSetting.deleted.
+   * Fails with 400 if the email is currently active.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.email - Email address
+   * @param {string} [opts.jwtToken] - JWT (required for BETTEREZ_APP audience)
+   * @param {string} opts.email - Email address (path parameter)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ emailSetting: object }>>}
    */
   function remove(_ref6) {
     var email = _ref6.email,

package/lib/endpoints/accounts/email-templates.js

@@ -13,6 +13,7 @@ var _require = require("../endpoints_helpers.js"),
  * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
  * @property {string} [templateCollectionId] - default | custom
  * @property {string} [status] - draft | published
+ * @property {string} [agencyId] - Filter sub-templates for this agency (ObjectId)
  * @property {string} [mainTemplateAccountId] - Filter by source provider (ObjectId)
  * @property {string} [lang] - ISO language code (e.g. en-us)
  * @property {number} [page] - 1-based page for pagination
@@ -198,7 +199,8 @@ function emailTemplatesFactory(_ref) {
    * @param {string} opts.mainTemplateId - Main template id (ObjectId)
    * @param {string} opts.agencyId - Agency id (ObjectId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 validation (WRONG_DATA, MAIN_TEMPLATE_IS_NOT_CUSTOM), 401 (MAIN_TEMPLATE_ACCOUNT_MISMATCH, MAIN_TEMPLATE_NOT_FROM_PROVIDER), 404 MAIN_TEMPLATE_NOT_FOUND, 500
    */
   function createSub(_ref8) {
     var token = _ref8.token,
@@ -217,14 +219,16 @@ function emailTemplatesFactory(_ref) {
 
   var versions = {
     /**
-     * PUT /email-templates/:emailTemplateId/versions/:versionId - update a template version.
+     * PUT /email-templates/:emailTemplateId/versions/:versionId - roll back template to a saved version (versionId is zero-based index in versions array).
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.emailTemplateId - Template id (ObjectId)
-     * @param {string} opts.versionId - Version id (ObjectId)
+     * @param {string} opts.versionId - Zero-based version index (e.g. "0", "1")
+     * @param {Object} [opts.query] - Optional query (superUserId, superUserHash for default templates)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
+     * @throws {import("axios").AxiosError} 400 WRONG_DATA, 401 NOT_SUPER_USER, 404 EMAIL_TEMPLATE_NOT_FOUND / EMAIL_TEMPLATE_VERSION_NOT_FOUND, 500
      */
     update: function update(_ref9) {
       var token = _ref9.token,

package/lib/endpoints/accounts/exchange-rates.js

@@ -7,6 +7,7 @@ var _require = require("./../endpoints_helpers"),
 
 /**
  * Factory for exchange-rates API (btrz-api-accounts).
+ * Manage account exchange rates by currency ISO code. GET returns paginated list; POST creates a rate and updates account preferences.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -19,13 +20,15 @@ function exchangeRatesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /exchange-rates/:isoCode - get exchange rates by ISO code. API does not define query params in getSpec().
+   * GET /exchange-rates/:isoCode – List exchange rates for the account filtered by currency ISO code (3 letters).
+   * Response is paginated (exchangeRates array + totalRecords, page, etc.).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.isoCode - Currency ISO code (3 characters)
+   * @param {string} opts.isoCode - Currency ISO code (3 uppercase letters, e.g. USD, MXN)
+   * @param {Object} [opts.query] - Optional query (e.g. page for pagination)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ exchangeRates: object[], totalRecords: number, ... }>>}
    */
   function allByIsoCode(_ref2) {
     var token = _ref2.token,
@@ -43,13 +46,15 @@ function exchangeRatesFactory(_ref) {
   }
 
   /**
-   * POST /exchange-rates - create an exchange rate.
+   * POST /exchange-rates – Create an exchange rate. Requires BETTEREZ_APP JWT. Currency must be in account preferences and enabled.
+   * Updates account preferences.supportedCurrencies for that currency. Emits exchangeRates.created.
+   * Body: { exchangeRate } or { isoCode, buy, sell }. buy and sell must be > 0.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Exchange rate payload
+   * @param {string} [opts.jwtToken] - JWT (required for BETTEREZ_APP audience)
+   * @param {Object} opts.data - Body: { isoCode, buy, sell } or { exchangeRate: { isoCode, buy, sell } }
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ exchangeRate: object }>>}
    */
   function create(_ref3) {
     var data = _ref3.data,