btrz-api-client 8.28.0 → 8.30.0

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

@@ -1,6 +1,25 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * 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({client, 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 {Object} [opts.query] - Query params
+   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, dynamicFormId, query = {}, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
     return client({
@@ -10,6 +29,15 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/dynamic-forms",
@@ -18,6 +46,16 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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.query] - Query params
+   * @param {Object} opts.data - Form payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, query = {}, data, headers}) {
     return client({
       url: "/dynamic-forms",
@@ -28,6 +66,16 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, dynamicFormId, data, headers}) {
     return client({
       url: `/dynamic-forms/${dynamicFormId}`,
@@ -37,6 +85,15 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({dynamicFormId, token, jwtToken, headers}) {
     return client({
       url: `/dynamic-forms/${dynamicFormId}`,
@@ -46,12 +103,30 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
   }
 
   const 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({token, jwtToken, dynamicFormFieldId, headers} = {}) {
       return client({
         url: `/dynamic-forms/fields/${dynamicFormFieldId}`,
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, 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.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({token, jwtToken, query = {}, headers}) {
       return client({
         url: "/dynamic-forms/fields",
@@ -59,6 +134,15 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, 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({jwtToken, token, data, headers}) {
       return client({
         url: "/dynamic-forms/fields",
@@ -67,6 +151,16 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
         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({jwtToken, token, dynamicFormFieldId, data, headers}) {
       return client({
         url: `/dynamic-forms/fields/${dynamicFormFieldId}`,
@@ -75,6 +169,15 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
         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({dynamicFormFieldId, token, jwtToken, headers}) {
       return client({
         url: `/dynamic-forms/fields/${dynamicFormFieldId}`,

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

@@ -1,7 +1,23 @@
 /* eslint-disable import/extensions */
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /email-settings - list email settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       params: query,
@@ -9,6 +25,16 @@ function emailSettingsFactory({client, internalAuthTokenProvider}) {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
+  /**
+   * GET /email-settings/:email - get email settings by email.
+   * @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.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getByEmail({token, jwtToken, email, query = {}, headers}) {
     return client({
       params: query,
@@ -17,6 +43,15 @@ function emailSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({data, token, jwtToken, headers}) {
     return client({
       url: "/email-settings",
@@ -26,6 +61,16 @@ function emailSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, email, data, headers}) {
     return client({
       url: `/email-settings/${email}`,
@@ -35,6 +80,15 @@ function emailSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({email, token, jwtToken, headers}) {
     return client({
       url: `/email-settings/${email}`,

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

@@ -1,8 +1,67 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * @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
+ */
+
+/**
+ * @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({client, 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({token, jwtToken, headers}) {
+    return client({
+      url: "/email-templates/types",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * 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({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/email-templates",
@@ -11,6 +70,16 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.query] - Optional query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
+   */
   function get({token, jwtToken, emailTemplateId, query = {}, headers}) {
     return client({
       url: `/email-templates/${emailTemplateId}`,
@@ -19,6 +88,15 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, data, headers}) {
     return client({
       url: "/email-templates",
@@ -28,6 +106,16 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, emailTemplateId, data, headers}) {
     return client({
       url: `/email-templates/${emailTemplateId}`,
@@ -37,6 +125,15 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, emailTemplateId, headers}) {
     return client({
       url: `/email-templates/${emailTemplateId}`,
@@ -45,6 +142,16 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, mainTemplateId, agencyId, headers}) {
     return client({
       url: "/sub-email-templates",
@@ -55,6 +162,17 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   const 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.query] - Optional query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({token, jwtToken, emailTemplateId, versionId, query = {}, headers}) {
       return client({
         url: `/email-templates/${emailTemplateId}/versions/${versionId}`,
@@ -66,6 +184,7 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
   };
 
   return {
+    getTypes,
     all,
     get,
     create,

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

@@ -1,7 +1,24 @@
 /* eslint-disable import/extensions */
 const {authorizationHeaders} = require("./../endpoints_helpers");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /exchange-rates/:isoCode - get exchange rates by ISO code.
+   * @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
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function allByIsoCode({token, jwtToken, isoCode, query = {}, headers}) {
     return client({
       params: query,
@@ -10,6 +27,15 @@ function exchangeRatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({data, token, jwtToken, headers}) {
     return client({
       url: "/exchange-rates",

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

@@ -1,7 +1,23 @@
 /* eslint-disable import/extensions */
 const {authorizationHeaders} = require("../endpoints_helpers");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * PUT /exchange-receipt-settings - update exchange receipt settings.
+   * @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({data, token, jwtToken, headers}) {
     return client({
       url: "/exchange-receipt-settings",
@@ -11,6 +27,14 @@ function exchangeReceiptsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /exchange-receipt-settings - get exchange receipt settings.
+   * @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({token, jwtToken, headers}) {
     return client({
       url: "/exchange-receipt-settings",

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

@@ -2,7 +2,23 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /goal-settings - get goal settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, query, headers}) {
     return client({
       url: "/goal-settings",
@@ -11,6 +27,15 @@ function goalSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /goal-settings - update goal settings.
+   * @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({jwtToken, token, goalSettings, headers}) {
     return client({
       url: "/goal-settings",

package/src/endpoints/accounts/images.js

@@ -1,7 +1,23 @@
 /* eslint-disable import/extensions */
 const {authorizationHeaders} = require("./../endpoints_helpers");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /images - list images.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       params: query,
@@ -10,6 +26,16 @@ function ImagesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /images/:imageId - get an image.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {string} opts.imageId - Image id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, query = {}, headers, imageId}) {
     return client({
       params: query,
@@ -18,18 +44,37 @@ function ImagesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({jwtToken, token, image, headers}) {
     return client({
       url: "/images",
       method: "post",
       headers: authorizationHeaders({
-        token, jwtToken, internalAuthTokenProvider, headers}),
+        token, jwtToken, internalAuthTokenProvider, headers
+      }),
       data: {
         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({imageId, token, jwtToken, headers}) {
     return client({
       url: `/images/${imageId}`,