btrz-api-client 8.31.0 → 8.32.0

package/lib/endpoints/accounts/users.js

@@ -4,6 +4,24 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /users (btrz-api-accounts). See get-users getSpec().
+ * @typedef {Object} GetUsersListQuery
+ * @property {number} [page] - Page number (1-based). When provided, response is limited to pageSize items.
+ * @property {string} [deleted] - "true" | "false" to filter by deleted flag
+ * @property {string} [firstName] - Filter by first name (prefix, case-insensitive)
+ * @property {string} [lastName] - Filter by last name (prefix, case-insensitive)
+ * @property {string} [display] - Filter by display name (prefix, case-insensitive)
+ * @property {string} [externalId] - Filter by external ID (exact)
+ * @property {string} [employeeNumber] - Filter by employee number (exact)
+ * @property {string} [email] - Filter by email (prefix, case-insensitive)
+ * @property {string} [assignableToManifest] - "true" | "false"
+ * @property {string} [role] - Filter users that have this role (role key)
+ * @property {string} [excludedRoles] - Comma-separated role keys to exclude
+ * @property {string} [preferredLocationId] - Filter by preferred location ID
+ * @property {string} [preferredLocationIds] - Filter by preferred location IDs
+ */
+
 /**
  * Query params for GET /users/:userId/sequences (btrz-api-accounts). See get-user-sequences-handler getSpec().
  * @typedef {Object} UserSequencesListQuery
@@ -16,7 +34,7 @@ var _require = require("./../endpoints_helpers.js"),
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
+ * @returns {{ get: function, getV2: function, all: function, create: function, login: function, update: function, delete: function, createOrUpdateMany: function, impersonate: function, startMfa: function, confirmMfa: function, disableMfa: function, sequences: { get: function, all: function, create: function, update: function, transfer: function } }}
  */
 
 
@@ -69,10 +87,11 @@ function usersFactory(_ref) {
   }
 
   /**
-   * GET /users - list users. API getSpec() does not define query params.
+   * GET /users - list users with optional pagination and filters.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {GetUsersListQuery} [opts.query] - Query params (page, deleted, firstName, lastName, display, externalId, employeeNumber, email, assignableToManifest, role, excludedRoles, preferredLocationId, preferredLocationIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -137,14 +156,14 @@ function usersFactory(_ref) {
   }
 
   /**
-   * PUT /users/:userId - update a user.
+   * PUT /users/:userId - update a user. Emits webhook user.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.userId - User id (ObjectId)
-   * @param {Object} opts.user - User payload
+   * @param {Object} opts.user - User payload (allowed fields per PUT /users/:userId spec)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ user: Object }>>}
    */
   function update(_ref7) {
     var token = _ref7.token,
@@ -162,20 +181,42 @@ function usersFactory(_ref) {
   }
 
   /**
-   * POST /users/import - create or update many users.
+   * DELETE /users/:id - delete a user. Emits webhook user.deleted. Returns 204 on success.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Array} opts.users - Array of user objects
+   * @param {string} opts.id - User id (ObjectId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function createOrUpdateMany(_ref8) {
+  function deleteUser(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
-        users = _ref8.users,
+        id = _ref8.id,
         headers = _ref8.headers;
 
+    return client({
+      url: "/users/" + id,
+      method: "delete",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * POST /users/import - create or update many users.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Array} opts.users - Array of user objects
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function createOrUpdateMany(_ref9) {
+    var token = _ref9.token,
+        jwtToken = _ref9.jwtToken,
+        users = _ref9.users,
+        headers = _ref9.headers;
+
     return client({
       url: "/users/import",
       method: "post",
@@ -193,11 +234,11 @@ function usersFactory(_ref) {
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function impersonate(_ref9) {
-    var token = _ref9.token,
-        jwtToken = _ref9.jwtToken,
-        offlineUserId = _ref9.offlineUserId,
-        headers = _ref9.headers;
+  function impersonate(_ref10) {
+    var token = _ref10.token,
+        jwtToken = _ref10.jwtToken,
+        offlineUserId = _ref10.offlineUserId,
+        headers = _ref10.headers;
 
     return client({
       url: "/users/impersonate",
@@ -216,11 +257,11 @@ function usersFactory(_ref) {
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function startMfa(_ref10) {
-    var token = _ref10.token,
-        jwtToken = _ref10.jwtToken,
-        userId = _ref10.userId,
-        headers = _ref10.headers;
+  function startMfa(_ref11) {
+    var token = _ref11.token,
+        jwtToken = _ref11.jwtToken,
+        userId = _ref11.userId,
+        headers = _ref11.headers;
 
     return client({
       url: "/users/" + userId + "/mfa",
@@ -239,12 +280,12 @@ function usersFactory(_ref) {
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function confirmMfa(_ref11) {
-    var token = _ref11.token,
-        jwtToken = _ref11.jwtToken,
-        userId = _ref11.userId,
-        totpToken = _ref11.totpToken,
-        headers = _ref11.headers;
+  function confirmMfa(_ref12) {
+    var token = _ref12.token,
+        jwtToken = _ref12.jwtToken,
+        userId = _ref12.userId,
+        totpToken = _ref12.totpToken,
+        headers = _ref12.headers;
 
     return client({
       url: "/users/" + userId + "/mfa",
@@ -263,11 +304,11 @@ function usersFactory(_ref) {
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function disableMfa(_ref12) {
-    var token = _ref12.token,
-        jwtToken = _ref12.jwtToken,
-        userId = _ref12.userId,
-        headers = _ref12.headers;
+  function disableMfa(_ref13) {
+    var token = _ref13.token,
+        jwtToken = _ref13.jwtToken,
+        userId = _ref13.userId,
+        headers = _ref13.headers;
 
     return client({
       url: "/users/" + userId + "/mfa",
@@ -287,12 +328,12 @@ function usersFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    get: function get(_ref13) {
-      var token = _ref13.token,
-          jwtToken = _ref13.jwtToken,
-          userId = _ref13.userId,
-          sequenceId = _ref13.sequenceId,
-          headers = _ref13.headers;
+    get: function get(_ref14) {
+      var token = _ref14.token,
+          jwtToken = _ref14.jwtToken,
+          userId = _ref14.userId,
+          sequenceId = _ref14.sequenceId,
+          headers = _ref14.headers;
 
       return client({
         url: "/users/" + userId + "/sequences/" + sequenceId,
@@ -310,13 +351,13 @@ function usersFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    all: function all(_ref14) {
-      var token = _ref14.token,
-          jwtToken = _ref14.jwtToken,
-          userId = _ref14.userId,
-          _ref14$query = _ref14.query,
-          query = _ref14$query === undefined ? {} : _ref14$query,
-          headers = _ref14.headers;
+    all: function all(_ref15) {
+      var token = _ref15.token,
+          jwtToken = _ref15.jwtToken,
+          userId = _ref15.userId,
+          _ref15$query = _ref15.query,
+          query = _ref15$query === undefined ? {} : _ref15$query,
+          headers = _ref15.headers;
 
       return client({
         url: "/users/" + userId + "/sequences",
@@ -335,12 +376,12 @@ function usersFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    create: function create(_ref15) {
-      var jwtToken = _ref15.jwtToken,
-          token = _ref15.token,
-          userId = _ref15.userId,
-          sequence = _ref15.sequence,
-          headers = _ref15.headers;
+    create: function create(_ref16) {
+      var jwtToken = _ref16.jwtToken,
+          token = _ref16.token,
+          userId = _ref16.userId,
+          sequence = _ref16.sequence,
+          headers = _ref16.headers;
 
       return client({
         url: "/users/" + userId + "/sequences",
@@ -361,13 +402,13 @@ function usersFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    update: function update(_ref16) {
-      var jwtToken = _ref16.jwtToken,
-          token = _ref16.token,
-          userId = _ref16.userId,
-          sequenceId = _ref16.sequenceId,
-          sequence = _ref16.sequence,
-          headers = _ref16.headers;
+    update: function update(_ref17) {
+      var jwtToken = _ref17.jwtToken,
+          token = _ref17.token,
+          userId = _ref17.userId,
+          sequenceId = _ref17.sequenceId,
+          sequence = _ref17.sequence,
+          headers = _ref17.headers;
 
       return client({
         url: "/users/" + userId + "/sequences/" + sequenceId,
@@ -388,13 +429,13 @@ function usersFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    transfer: function transfer(_ref17) {
-      var jwtToken = _ref17.jwtToken,
-          token = _ref17.token,
-          userId = _ref17.userId,
-          sequenceId = _ref17.sequenceId,
-          newUserId = _ref17.newUserId,
-          headers = _ref17.headers;
+    transfer: function transfer(_ref18) {
+      var jwtToken = _ref18.jwtToken,
+          token = _ref18.token,
+          userId = _ref18.userId,
+          sequenceId = _ref18.sequenceId,
+          newUserId = _ref18.newUserId,
+          headers = _ref18.headers;
 
       return client({
         url: "/users/" + userId + "/sequences/" + sequenceId,
@@ -415,6 +456,7 @@ function usersFactory(_ref) {
     create: create,
     login: login,
     update: update,
+    delete: deleteUser,
     createOrUpdateMany: createOrUpdateMany,
     impersonate: impersonate,
     startMfa: startMfa,

package/lib/endpoints/accounts/verified-emails.js

@@ -0,0 +1,130 @@
+"use strict";
+
+var _require = require("./../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Query params for GET /verified-emails (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} VerifiedEmailsListQuery
+ * @property {number} [page] - Page number (1-based). Default 1.
+ * @property {number} [pageSize] - Page size. Default 20.
+ */
+
+/**
+ * Factory for verified-emails API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function }}
+ */
+
+
+function verifiedEmailsFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * GET /verified-emails - list verified emails for the account (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {VerifiedEmailsListQuery} [opts.query] - Query params (page, pageSize)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ verifiedEmails: Array }>>}
+   *   Errors: 401, 500
+   */
+  function all(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        _ref2$query = _ref2.query,
+        query = _ref2$query === undefined ? {} : _ref2$query,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/verified-emails",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: query
+    });
+  }
+
+  /**
+   * GET /verified-emails/:email - get a verified email by email address.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.email - Email address (path parameter)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ verifiedEmail: Object }>>}
+   *   Errors: 400 (WRONG_DATA), 401, 404 (VERIFIED_EMAIL_NOT_FOUND), 500
+   */
+  function get(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        email = _ref3.email,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/verified-emails/" + encodeURIComponent(email),
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * POST /verified-emails - create a verified email. Emits webhook verifiedEmails.created.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Body: email (required), status (BLACKLISTED | BLOCKED | WHITELISTED), optional QEVResponse
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ verifiedEmail: Object }>>}
+   *   Errors: 400 (WRONG_DATA, INVALID_STATUS), 401, 500
+   */
+  function create(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        data = _ref4.data,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/verified-emails",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  /**
+   * PUT /verified-emails/:email - update a verified email. Emits webhook verifiedEmails.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 (path parameter)
+   * @param {Object} opts.data - Body: status (BLACKLISTED | BLOCKED | WHITELISTED), optional QEVResponse
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ verifiedEmail: Object }>>}
+   *   Errors: 400 (INVALID_STATUS, VERIFIED_EMAIL_BLOCKED), 401, 404 (VERIFIED_EMAIL_NOT_FOUND), 500
+   */
+  function update(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        email = _ref5.email,
+        data = _ref5.data,
+        headers = _ref5.headers;
+
+    return client({
+      url: "/verified-emails/" + encodeURIComponent(email),
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  return {
+    all: all,
+    get: get,
+    create: create,
+    update: update
+  };
+}
+
+module.exports = verifiedEmailsFactory;

package/lib/endpoints/accounts/websales-config.js

@@ -25,13 +25,14 @@ function websalesConfigFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /websales-config - get websales config (list).
+   * GET /websales-config - get websales config list (paginated). Query: domain, providerId.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {WebsalesConfigListQuery} [opts.query] - Query params (domain, providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ websalesConfig: Array, next?: string, previous?: string, count?: number }>>}
+   *   Errors: 401, 500
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -48,14 +49,15 @@ function websalesConfigFactory(_ref) {
   }
 
   /**
-   * PUT /websales-config/:websalesConfigId - update websales config. API does not accept query params.
+   * PUT /websales-config/:websalesConfigId - update websales config. Emits webhook websalesConfig.updated.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.websalesConfigId - Websales config id (ObjectId)
-   * @param {Object} opts.websalesConfig - Config payload
+   * @param {Object} opts.websalesConfig - Config payload (WebsalesConfigPutData; SSO cannot be updated)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ websalesConfig: Object }>>}
+   *   Errors: 400, 401, 404 (WEBSALESCONFIG_NOT_FOUND), 409, 500
    */
   function update(_ref3) {
     var token = _ref3.token,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "8.31.0",
+  "version": "8.32.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/client.js

@@ -178,6 +178,7 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
 
   return {
     accounts: require("./endpoints/accounts/accounts.js")({client, internalAuthTokenProvider}),
+    agencies: require("./endpoints/accounts/agencies.js")({client, internalAuthTokenProvider}),
     application: require("./endpoints/accounts/application.js")({client, internalAuthTokenProvider}),
     applications: require("./endpoints/accounts/applications.js")({client, internalAuthTokenProvider}),
     applicationSettings: require("./endpoints/accounts/application-settings.js")({client, internalAuthTokenProvider}),
@@ -193,6 +194,7 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     smsTemplates: require("./endpoints/accounts/sms-templates.js")({client, internalAuthTokenProvider}),
     exchangeRates: require("./endpoints/accounts/exchange-rates.js")({client, internalAuthTokenProvider}),
     exchangeReceipts: require("./endpoints/accounts/exchange-receipts.js")({client, internalAuthTokenProvider}),
+    externalCustomers: require("./endpoints/accounts/external-customers.js")({client, internalAuthTokenProvider}),
     goalSettings: require("./endpoints/accounts/goal-settings.js")({client, internalAuthTokenProvider}),
     images: require("./endpoints/accounts/images.js")({client, internalAuthTokenProvider}),
     interline: require("./endpoints/accounts/interline.js")({client, internalAuthTokenProvider}),
@@ -231,6 +233,7 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     trustedMachines: require("./endpoints/accounts/trusted-machines.js")({client, internalAuthTokenProvider}),
     twilioSettings: require("./endpoints/accounts/twilio-settings.js")({client, internalAuthTokenProvider}),
     users: require("./endpoints/accounts/users.js")({client, internalAuthTokenProvider}),
+    verifiedEmails: require("./endpoints/accounts/verified-emails.js")({client, internalAuthTokenProvider}),
     __test: {
       client
     },

package/src/endpoints/accounts/agencies.js

@@ -0,0 +1,40 @@
+/* eslint-disable max-len */
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * 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({client, 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({token, jwtToken, agencyId, data, headers}) {
+    return client({
+      url: `/agencies/${agencyId}/credit-limit`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  return {
+    putCreditLimit
+  };
+}
+
+module.exports = agenciesFactory;

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

@@ -1,8 +1,9 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
  * @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.
  */
 
 /**
@@ -14,14 +15,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function applicationSettingsFactory({client, 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({token, providerId, jwtToken, query = {}, headers}) {
     return client.get(`/application-settings/${providerId}`, {
@@ -31,14 +32,14 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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({jwtToken, token, id, application, headers}) {
     return client({
@@ -50,13 +51,13 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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({jwtToken, token, id, headers}) {
     return client({
@@ -67,13 +68,13 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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({jwtToken, token, id, headers}) {
     return client({
@@ -84,13 +85,13 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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({jwtToken, token, application, headers}) {
     return client({