btrz-api-client 8.30.0 → 8.32.0

package/lib/endpoints/operations/waitlists.js

@@ -49,7 +49,7 @@ function waitlistsFactory(_ref) {
   }
 
   /**
-   * GET /waitlists/:waitlistId - get waitlist by id.
+   * GET /waitlists/:waitlistId - get waitlist by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -93,7 +93,7 @@ function waitlistsFactory(_ref) {
   }
 
   /**
-   * POST /waitlists - create waitlist.
+   * POST /waitlists - create waitlist. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/sales/bundles.js

@@ -5,8 +5,10 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for GET /bundles (btrz-api-sales get-bundles getSpec).
  * @typedef {Object} BundlesListQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account id to get bundles for
+ * @property {string} type - Filter bundles by bundle type (required)
  */
 
 /**
@@ -26,7 +28,7 @@ function bundlesFactory(_ref) {
    * GET /bundles - list bundles.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {BundlesListQuery} [opts.query] - Query params
+   * @param {BundlesListQuery} [opts.query] - Query params (type required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/cancellations.js

@@ -38,7 +38,7 @@ function cancellationEndpointsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * Creates a set of refundable items and payments to be refunded
+   * Creates a set of refundable items and payments to be refunded. API does not accept query params.
    * @param {Object} params
    * @param {string} params.token Public key
    * @param {string} params.jwtToken Auth token
@@ -86,7 +86,7 @@ function cancellationEndpointsFactory(_ref) {
   }
 
   /**
-   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund).
+   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund). API does not accept query params.
    * @param {Object} params
    * @param {string} params.token Public key
    * @param {string} params.jwtToken Auth token

package/lib/endpoints/sales/cart-promo.js

@@ -4,11 +4,6 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-/**
- * @typedef {Object} CartPromoQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for cart promos API (btrz-api-sales).
  * @param {Object} deps
@@ -23,12 +18,11 @@ function cartPromoFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /cart/:cartId/promos - add promo to cart.
+   * POST /cart/:cartId/promos - add promo to cart. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.cartId - Cart id
-   * @param {CartPromoQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -49,12 +43,11 @@ function cartPromoFactory(_ref) {
   }
 
   /**
-   * DELETE /cart/:cartId - remove cart promo.
+   * DELETE /cart/:cartId - remove cart promo. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.cartId - Cart id
-   * @param {CartPromoQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/cart.js

@@ -5,8 +5,22 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} CartQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /cart/:cartId (btrz-api-sales get-cart getSpec).
+ * @typedef {Object} CartGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [transactionStatus] - Filter: 'created' or 'waiting_for_payment'
+ */
+
+/**
+ * Query params for POST /carts/:cartId/financing-costs (btrz-api-sales post-financingcost-handler getSpec).
+ * @typedef {Object} CartFinancingCostsCreateQuery
+ * @property {string} [providerId] - Provider id to get financing costs for
+ */
+
+/**
+ * Query params for DELETE /carts/:cartId/financing-costs (btrz-api-sales delete-financingcost-handler getSpec).
+ * @typedef {Object} CartFinancingCostsDeleteQuery
+ * @property {string} [internalId] - Internal id or code of the financing cost to match
  */
 
 /**
@@ -23,11 +37,11 @@ function cartFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /cart/:id - get cart by id.
+   * GET /cart/:id - get cart by id. Query: providerId, transactionStatus (per get-cart getSpec).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.id - Cart id
-   * @param {string} [opts.providerId] - Provider id
+   * @param {string} [opts.providerId] - Provider id (sent as query)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -73,7 +87,7 @@ function cartFactory(_ref) {
   }
 
   /**
-   * POST /cart/:cartId/items - add items to cart.
+   * POST /cart/:cartId/items - add items to cart. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -98,7 +112,7 @@ function cartFactory(_ref) {
   }
 
   /**
-   * DELETE /cart/:cartId/items - delete items from cart.
+   * DELETE /cart/:cartId/items - delete items from cart. Query forwarded via opts.params if provided.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -123,7 +137,7 @@ function cartFactory(_ref) {
   }
 
   /**
-   * DELETE /carts/:cartId/paid-in-items/:itemId - delete paid-in item.
+   * DELETE /carts/:cartId/paid-in-items/:itemId - delete paid-in item. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -147,7 +161,7 @@ function cartFactory(_ref) {
   }
 
   /**
-   * DELETE /carts/:cartId/paid-in-items - delete paid-in items.
+   * DELETE /carts/:cartId/paid-in-items - delete paid-in items. Query forwarded via opts.params if provided.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -173,12 +187,11 @@ function cartFactory(_ref) {
 
   var loyaltyPointsAmount = {
     /**
-     * GET /carts/:cartId/loyalty-points-amount - get loyalty points amount for cart.
+     * GET /carts/:cartId/loyalty-points-amount - get loyalty points amount for cart. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.cartId - Cart id
-     * @param {CartQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -199,7 +212,7 @@ function cartFactory(_ref) {
   };
 
   /**
-   * PATCH /cart/:cartId - patch cart.
+   * PATCH /cart/:cartId - patch cart. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -225,7 +238,7 @@ function cartFactory(_ref) {
 
   var partialDepositStatus = {
     /**
-     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status.
+     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -247,7 +260,7 @@ function cartFactory(_ref) {
 
   var payments = {
     /**
-     * DELETE /carts/:cartId/payments - delete cart payments.
+     * DELETE /carts/:cartId/payments - delete cart payments. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -269,7 +282,7 @@ function cartFactory(_ref) {
     },
 
     /**
-     * PUT /carts/:cartId/payments - put cart payments.
+     * PUT /carts/:cartId/payments - put cart payments. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -296,7 +309,7 @@ function cartFactory(_ref) {
 
   var taxExemptPaymentMethod = {
     /**
-     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method.
+     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -331,7 +344,7 @@ function cartFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.cartId - Cart id
      * @param {Object} opts.financingCost - Financing cost payload
-     * @param {CartQuery} [opts.query] - Query params
+     * @param {CartFinancingCostsCreateQuery} [opts.query] - Query params (providerId)
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     create: function create(_ref14) {
@@ -361,7 +374,7 @@ function cartFactory(_ref) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.cartId - Cart id
-     * @param {CartQuery} [opts.query] - Query params
+     * @param {CartFinancingCostsDeleteQuery} [opts.query] - Query params (internalId)
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     delete: function _delete(_ref15) {

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

@@ -4,11 +4,6 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-/**
- * @typedef {Object} CheckInInfoQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for check-in API (btrz-api-sales).
  * @param {Object} deps
@@ -23,13 +18,12 @@ function checkInInfoFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /check-in/:id - get check-in info.
+   * GET /check-in/:id - get check-in info. API does not accept query params (btrz-api-sales).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Check-in id
    * @param {Object} [opts.headers] - Optional headers
-   * @param {CheckInInfoQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get(_ref2) {

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

@@ -5,8 +5,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} CustomFieldsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /custom-fields (btrz-api-sales get-custom-fields getSpec).
+ * @typedef {Object} CustomFieldsListQuery
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
  */
 
 /**
@@ -26,7 +27,7 @@ function customFieldsFactory(_ref) {
    * GET /custom-fields - list custom fields.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {CustomFieldsQuery} [opts.query] - Query params
+   * @param {CustomFieldsListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/flexpasses.js

@@ -4,11 +4,6 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-/**
- * @typedef {Object} FlexpassGetQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for flexpasses API (btrz-api-sales).
  * @param {Object} deps
@@ -23,12 +18,11 @@ function flexpassesEndpointsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /flexpasses/:flexpassId - get flexpass by id.
+   * GET /flexpasses/:flexpassId - get flexpass by id. API does not accept query params (btrz-api-sales).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.flexpassId - Flexpass id
-   * @param {FlexpassGetQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

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

@@ -5,8 +5,10 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for GET /gift-certificates/:GCNumber (btrz-api-sales get-gift-certificate getSpec).
  * @typedef {Object} GiftCertificateGetQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Calculate available balance for the voucher applied to the cart
  */
 
 /**
@@ -27,7 +29,7 @@ function giftCertificatesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.GCNumber - Gift certificate number
-   * @param {GiftCertificateGetQuery} [opts.query] - Query params
+   * @param {GiftCertificateGetQuery} [opts.query] - Query params (providerId, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/order.js

@@ -5,14 +5,16 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for POST /orders/:orderId/payments (btrz-api-sales post-payments-handler getSpec).
  * @typedef {Object} OrderPaymentsQuery
- * @property {string} channel - Channel where cart is being purchased (see API for allowed values)
- * @property {string} [providerId] - Account ID the transaction belongs to
+ * @property {string} [channel] - Channel where cart is being purchased (defaults to 'none' when not provided)
+ * @property {string} [providerId] - Account id the transaction belongs to
  */
 
 /**
+ * Query params for GET /order/:orderId (btrz-api-sales get-order getSpec).
  * @typedef {Object} OrderGetQuery
- * @property {string} [providerId] - Account ID for the order
+ * @property {string} [providerId] - Provider account id
  */
 
 /**
@@ -82,7 +84,7 @@ function orderFactory(_ref) {
    * @param {Object} opts.payments - Payments payload
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
-   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel required, providerId optional)
+   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel, providerId)
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function overwrite(_ref4) {

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

@@ -18,7 +18,7 @@ function parcelQuotesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /parcel-quotes - get parcel quote.
+   * POST /parcel-quotes - get parcel quote. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.parcelQuoteData - Parcel quote request payload

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

@@ -5,8 +5,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} PaymentProvidersQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /payment-providers (btrz-api-sales get-payment-providers getSpec).
+ * @typedef {Object} PaymentProvidersListQuery
+ * @property {string} [providerId] - Provider id to get payment providers for
+ * @property {string} [channel] - Channel to get payment providers for
+ * @property {string} [enabled] - Filter by enabled [true, false]
  */
 
 /**
@@ -27,7 +30,7 @@ function paymentProvidersFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PaymentProvidersQuery} [opts.query] - Query params
+   * @param {PaymentProvidersListQuery} [opts.query] - Query params (providerId, channel, enabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

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

@@ -5,8 +5,19 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} RedeemableItemsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /redeemable-items/:redeemableItemId (btrz-api-sales get-redeemable-item getSpec).
+ * @typedef {Object} RedeemableItemsGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
+ * @property {string} [cartId] - Current cart id (item can be redeemed once per cart)
+ */
+
+/**
+ * Query params for GET /redeemable-items list (btrz-api-sales get-redeemable-items getSpec).
+ * @typedef {Object} RedeemableItemsListQuery
+ * @property {string} [ids] - Redeemable item display ID or _id, comma-separated
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Current cart id
  */
 
 /**
@@ -26,8 +37,8 @@ function redeemableItemsFactory(_ref) {
    * GET /redeemable-items/:redeemableItemId - get redeemable item by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.redeemableItemId - Redeemable item id
-   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {string} opts.redeemableItemId - Redeemable item display ID or _id
+   * @param {RedeemableItemsGetQuery} [opts.query] - Query params (providerId, providerIds, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -50,7 +61,7 @@ function redeemableItemsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {RedeemableItemsListQuery} [opts.query] - Query params (ids, providerId, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

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

@@ -18,7 +18,7 @@ function syncEntryFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * PATCH /sync-entry - patch sync entry.
+   * PATCH /sync-entry - patch sync entry. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.data - Request body

package/lib/endpoints/sales/voucher.js

@@ -13,7 +13,7 @@ var _require = require("./../endpoints_helpers.js"),
  * @property {string} [productType] - Product type of the voucher
  * @property {string} [from] - Station "from" to validate if voucher has routes
  * @property {string} [to] - Station "to" to validate if voucher has routes
- * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare
+ * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare; use fareIds instead
  * @property {string} [fareIds] - Validates if voucher has one fare ID
  * @property {string} [displayCurrencyCode] - Display currency code for multi-currency accounts
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "8.30.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,5 +1,11 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} ApplicationSettingsQuery
+ * @property {string} [name] - Optional. Filter by application name. When set, unauthenticated returns one object or 404; authenticated returns array with at most one item.
+ */
+
 /**
  * Factory for application-settings API (btrz-api-accounts).
  * @param {Object} deps
@@ -9,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 {Object} [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}`, {
@@ -26,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({
@@ -45,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({
@@ -62,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({
@@ -79,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({