btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/accounts/dynamic-forms.js

@@ -2,13 +2,48 @@
 
 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 _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /dynamic-forms (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} DynamicFormsQuery
+ * @property {string} [dynamicFormFieldId] - Get all dynamic forms for the given field id (ObjectId)
+ * @property {string} [providerId] - Get all dynamic forms for the given provider id (ObjectId)
+ * @property {string} [type] - Filter by type: "reservation" | "parcel" | "checkin" | "paid_in" | "pay_on_account"
+ */
+
+/**
+ * Query params for GET /dynamic-forms/:dynamicFormId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} DynamicFormByIdQuery
+ * @property {string} [providerId] - Fetch the dynamic form for the given providerId (ObjectId)
+ */
+
+/**
+ * Factory for dynamic-forms API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, update: function, remove: function, fields: { get: function, all: function, create: function, update: function, remove: function } }}
+ */
+
+
 function dynamicFormsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /dynamic-forms/:dynamicFormId - get a dynamic form.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.dynamicFormId - Dynamic form id (ObjectId)
+   * @param {DynamicFormByIdQuery} [opts.query] - Query params (providerId)
+   * @param {string} [opts.providerId] - Provider id; if set, added to query (convenience)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -26,6 +61,15 @@ function dynamicFormsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /dynamic-forms - list dynamic forms.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {DynamicFormsQuery} [opts.query] - Query params (dynamicFormFieldId, providerId, type)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -40,6 +84,15 @@ function dynamicFormsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /dynamic-forms - create a dynamic form.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Form payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -57,6 +110,16 @@ function dynamicFormsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /dynamic-forms/:dynamicFormId - update a dynamic form.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.dynamicFormId - Dynamic form id (ObjectId)
+   * @param {Object} opts.data - Form payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -72,6 +135,15 @@ function dynamicFormsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /dynamic-forms/:dynamicFormId - delete a dynamic form.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.dynamicFormId - Dynamic form id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref6) {
     var dynamicFormId = _ref6.dynamicFormId,
         token = _ref6.token,
@@ -86,6 +158,15 @@ function dynamicFormsFactory(_ref) {
   }
 
   var fields = {
+    /**
+     * GET /dynamic-forms/fields/:dynamicFormFieldId - get a dynamic form field.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.dynamicFormFieldId - Field id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get() {
       var _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
           token = _ref7.token,
@@ -98,6 +179,15 @@ function dynamicFormsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * GET /dynamic-forms/fields - list dynamic form fields.
+     * @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>}
+     */
     all: function all(_ref8) {
       var token = _ref8.token,
           jwtToken = _ref8.jwtToken,
@@ -111,6 +201,16 @@ function dynamicFormsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /dynamic-forms/fields - create a dynamic form field.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.data - Field payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref9) {
       var jwtToken = _ref9.jwtToken,
           token = _ref9.token,
@@ -124,6 +224,17 @@ function dynamicFormsFactory(_ref) {
         data: data
       });
     },
+
+    /**
+     * PUT /dynamic-forms/fields/:dynamicFormFieldId - update a dynamic form field.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.dynamicFormFieldId - Field id (ObjectId)
+     * @param {Object} opts.data - Field payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref10) {
       var jwtToken = _ref10.jwtToken,
           token = _ref10.token,
@@ -138,6 +249,16 @@ function dynamicFormsFactory(_ref) {
         data: data
       });
     },
+
+    /**
+     * DELETE /dynamic-forms/fields/:dynamicFormFieldId - delete a dynamic form field.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.dynamicFormFieldId - Field id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: function remove(_ref11) {
       var dynamicFormFieldId = _ref11.dynamicFormFieldId,
           token = _ref11.token,

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

@@ -1,13 +1,30 @@
 "use strict";
 
 /* eslint-disable import/extensions */
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for email-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getByEmail: function, create: function, update: function, remove: function }}
+ */
+
+
 function emailSettingsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /email-settings - list email settings. 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +38,15 @@ function emailSettingsFactory(_ref) {
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
+  /**
+   * GET /email-settings/:email - get email settings by email. 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.email - Email address
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getByEmail(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -36,6 +62,15 @@ function emailSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /email-settings - create email settings.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var data = _ref4.data,
         token = _ref4.token,
@@ -50,6 +85,16 @@ function emailSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /email-settings/:email - update email settings.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -65,6 +110,15 @@ function emailSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /email-settings/:email - remove email settings.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref6) {
     var email = _ref6.email,
         token = _ref6.token,

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

@@ -1,12 +1,66 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /email-templates (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} EmailTemplatesListQuery
+ * @property {string} [providerId] - Filter by provider account (ObjectId)
+ * @property {string} [type] - Filter by template type
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales | any | mobileapp
+ * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {string} [templateCollectionId] - default | custom
+ * @property {string} [status] - draft | published
+ * @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
+ */
+
+/**
+ * Query params for GET /email-templates/:emailTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} EmailTemplateGetByIdQuery
+ * @property {string} [providerId] - Filter by provider; template must belong to this account, current account, or be global (ObjectId)
+ * @property {string} [superUserId] - Super user ID for authentication (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
+/**
+ * @typedef {Object} EmailTemplatePostData
+ * @property {string} name - Template name
+ * @property {string} type - Template type
+ * @property {string} subject - Subject line (plain text + Liquid)
+ * @property {string} lang - ISO language code (e.g. en-us)
+ * @property {string} htmlTemplate - HTML body (no scripts)
+ * @property {string} txtTemplate - Plain text body (no HTML)
+ * @property {string} [channel] - any (default) or other channel
+ * @property {string} [status] - draft | published
+ * @property {string} [templateCollectionId] - default | custom (required for accountId "")
+ * @property {string} [accountId] - "" for global template (super user)
+ */
+
+/**
+ * Factory for email-templates API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ getTypes: function, all: function, get: function, create: function, update: function, remove: function, createSub: function, versions: { update: function } }}
+ */
+
+
 function emailTemplatesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /email-templates/types - returns available template types.
+   * @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>} response.data contains types array
+   */
   function getTypes(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -18,6 +72,15 @@ function emailTemplatesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /email-templates - list email templates (paginated when page is provided).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {EmailTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, sort, status, lang, page, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplates: Array<object>, next?: string, previous?: string, totalRecords?: number, page?: number }>>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -32,6 +95,16 @@ function emailTemplatesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /email-templates/:emailTemplateId - get a single email template.
+   * @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 {EmailTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
+   */
   function get(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +120,15 @@ function emailTemplatesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /email-templates - create an email template.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {EmailTemplatePostData} opts.data - Template payload (name, type, subject, lang, htmlTemplate, txtTemplate required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
+   */
   function create(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -61,6 +143,16 @@ function emailTemplatesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /email-templates/:emailTemplateId - update an email template.
+   * @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 {Partial<EmailTemplatePostData>} opts.data - Fields to update (lang is read-only)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
+   */
   function update(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -76,6 +168,15 @@ function emailTemplatesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /email-templates/:emailTemplateId - delete an email template.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -89,6 +190,16 @@ function emailTemplatesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /sub-email-templates - create a sub (agency) email template linked to a main template.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @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>}
+   */
   function createSub(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -105,6 +216,16 @@ function emailTemplatesFactory(_ref) {
   }
 
   var versions = {
+    /**
+     * PUT /email-templates/:emailTemplateId/versions/:versionId - update a template version.
+     * @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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref9) {
       var token = _ref9.token,
           jwtToken = _ref9.jwtToken,

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

@@ -1,13 +1,32 @@
 "use strict";
 
+/* eslint-disable max-len */
 /* eslint-disable import/extensions */
 var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for exchange-rates API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ allByIsoCode: function, create: function }}
+ */
+
+
 function exchangeRatesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /exchange-rates/:isoCode - get exchange rates by ISO code. API does not define query params in getSpec().
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function allByIsoCode(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -23,6 +42,15 @@ function exchangeRatesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /exchange-rates - create an exchange rate.
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var data = _ref3.data,
         token = _ref3.token,

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

@@ -4,10 +4,28 @@
 var _require = require("../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for exchange-receipt-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ update: function, get: function }}
+ */
+
+
 function exchangeReceiptsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * PUT /exchange-receipt-settings - update exchange receipt settings. 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 {Object} opts.data - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref2) {
     var data = _ref2.data,
         token = _ref2.token,
@@ -22,6 +40,14 @@ function exchangeReceiptsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /exchange-receipt-settings - get exchange receipt settings. 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

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

@@ -3,10 +3,27 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for goal-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
+
+
 function goalSettingsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /goal-settings - get goal settings. 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +37,15 @@ function goalSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /goal-settings - update goal settings. 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 {Object} opts.goalSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,

package/lib/endpoints/accounts/images.js

@@ -4,10 +4,27 @@
 var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for images 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, remove: function }}
+ */
+
+
 function ImagesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /images - list images. API getSpec() does not define 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>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +39,15 @@ function ImagesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /images/:imageId - get an image. 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.imageId - Image id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -37,6 +63,15 @@ function ImagesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /images - create an image.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.image - Image payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,13 +82,23 @@ function ImagesFactory(_ref) {
       url: "/images",
       method: "post",
       headers: authorizationHeaders({
-        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      }),
       data: {
         image: image
       }
     });
   }
 
+  /**
+   * DELETE /images/:imageId - remove an image.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.imageId - Image id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var imageId = _ref5.imageId,
         token = _ref5.token,