btrz-api-client 9.14.0 → 9.15.0

package/lib/client.js

@@ -544,6 +544,14 @@ function createAccounts({
       client,
       internalAuthTokenProvider
     }),
+    emailTemplateSettings: require("./endpoints/accounts/email-template-settings.js")({
+      client,
+      internalAuthTokenProvider
+    }),
+    smsTemplateSettings: require("./endpoints/accounts/sms-template-settings.js")({
+      client,
+      internalAuthTokenProvider
+    }),
     emailTemplates: require("./endpoints/accounts/email-templates.js")({
       client,
       internalAuthTokenProvider

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

@@ -0,0 +1,74 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for email-template-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 emailTemplateSettingsFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /email-template-settings – email template flow preference for the account.
+   * @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<{ emailTemplateSettings: { useEmailTemplates: boolean } }>>}
+   */
+  function get({
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client({
+      url: "/email-template-settings",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * PUT /email-template-settings – update email template flow preference.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.emailTemplateSettings - Payload with useEmailTemplates
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplateSettings: { useEmailTemplates: boolean } }>>}
+   */
+  function update({
+    token,
+    jwtToken,
+    emailTemplateSettings,
+    headers
+  }) {
+    return client({
+      url: "/email-template-settings",
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        emailTemplateSettings
+      }
+    });
+  }
+  return {
+    get,
+    update
+  };
+}
+module.exports = emailTemplateSettingsFactory;

package/lib/endpoints/accounts/sms-template-settings.js

@@ -0,0 +1,74 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for sms-template-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 smsTemplateSettingsFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /sms-template-settings – SMS template flow preference for the account.
+   * @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<{ smsTemplateSettings: { useSmsTemplates: boolean } }>>}
+   */
+  function get({
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client({
+      url: "/sms-template-settings",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * PUT /sms-template-settings – update SMS template flow preference.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.smsTemplateSettings - Payload with useSmsTemplates
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ smsTemplateSettings: { useSmsTemplates: boolean } }>>}
+   */
+  function update({
+    token,
+    jwtToken,
+    smsTemplateSettings,
+    headers
+  }) {
+    return client({
+      url: "/sms-template-settings",
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        smsTemplateSettings
+      }
+    });
+  }
+  return {
+    get,
+    update
+  };
+}
+module.exports = smsTemplateSettingsFactory;

package/lib/endpoints/inventory/segments-information-tables.js

@@ -6,7 +6,7 @@ const {
 /**
  * Query params for GET /segments-information-tables/:routeId (btrz-api-inventory-trips). See get-by-id-handler getSpec().
  * @typedef {Object} SegmentsInformationTablesQuery
- * @property {string} [providerId] - Provider/account id of the route when different from the authenticated user (24-char hex ObjectId)
+ * @property {string} [providerId] - Provider account ID when route belongs to a provider in the requester's network
  */
 
 /**
@@ -26,7 +26,7 @@ function segmentInformationTableFactory({
    * @param {string} [opts.token] - API key (X-API-KEY)
    * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
    * @param {string} opts.routeId - Route id (24-char hex ObjectId)
-   * @param {SegmentsInformationTablesQuery} [opts.query] - Optional providerId
+   * @param {SegmentsInformationTablesQuery} [opts.query] - Optional query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ segmentInformationTables: { distances: Object, durations: Object, durationsHHMM: Object } }>>}
    * @throws 400 INVALID_ROUTE_ID — routeId not 24 hex characters

package/lib/endpoints/notifications/notify.js

@@ -6,12 +6,12 @@ const {
 /**
  * Request body for POST /notify/email (btrz-api-notifications). See post-notify-email-handler getSpec() and NotifyEmailPostData.
  * @typedef {Object} NotifyEmailByTypePostData
- * @property {string} type - Document/template type (e.g. product, voucher, order, transaction)
+ * @property {string} type - Document/PDF type (e.g. order, voucher, movement, cancellation)
  * @property {string} itemId - ObjectId of the item (24-char hex)
  * @property {string} [to] - Recipient email (optional; derived from item when omitted)
  * @property {string} [lang] - ISO language code (e.g. en-us)
  * @property {string} [channel] - Channel filter for template selection
- * @property {string} [family] - Required when type is 'product'. One of: ticket, reservation, paid in, paid out, parcel, flexpass, bundle
+ * @property {string} [family] - When type is product or movement: ticket, reservation, parcel, etc.
  * @property {string} [humanDate] - "mm" | "dd"
  */
 

package/package.json

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

package/src/client.js

@@ -202,6 +202,8 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     dynamicForms: require("./endpoints/accounts/dynamic-forms.js")({client, internalAuthTokenProvider}),
     qrMappings: require("./endpoints/accounts/qr-mappings.js")({client, internalAuthTokenProvider}),
     emailSettings: require("./endpoints/accounts/email-settings.js")({client, internalAuthTokenProvider}),
+    emailTemplateSettings: require("./endpoints/accounts/email-template-settings.js")({client, internalAuthTokenProvider}),
+    smsTemplateSettings: require("./endpoints/accounts/sms-template-settings.js")({client, internalAuthTokenProvider}),
     emailTemplates: require("./endpoints/accounts/email-templates.js")({client, internalAuthTokenProvider}),
     smsTemplates: require("./endpoints/accounts/sms-templates.js")({client, internalAuthTokenProvider}),
     exchangeRates: require("./endpoints/accounts/exchange-rates.js")({client, internalAuthTokenProvider}),

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

@@ -0,0 +1,54 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for email-template-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 emailTemplateSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /email-template-settings – email template flow preference for the account.
+   * @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<{ emailTemplateSettings: { useEmailTemplates: boolean } }>>}
+   */
+  function get({token, jwtToken, headers}) {
+    return client({
+      url: "/email-template-settings",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * PUT /email-template-settings – update email template flow preference.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.emailTemplateSettings - Payload with useEmailTemplates
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ emailTemplateSettings: { useEmailTemplates: boolean } }>>}
+   */
+  function update({token, jwtToken, emailTemplateSettings, headers}) {
+    return client({
+      url: "/email-template-settings",
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        emailTemplateSettings
+      }
+    });
+  }
+
+  return {
+    get,
+    update
+  };
+}
+
+module.exports = emailTemplateSettingsFactory;

package/src/endpoints/accounts/sms-template-settings.js

@@ -0,0 +1,54 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for sms-template-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 smsTemplateSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /sms-template-settings – SMS template flow preference for the account.
+   * @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<{ smsTemplateSettings: { useSmsTemplates: boolean } }>>}
+   */
+  function get({token, jwtToken, headers}) {
+    return client({
+      url: "/sms-template-settings",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * PUT /sms-template-settings – update SMS template flow preference.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.smsTemplateSettings - Payload with useSmsTemplates
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ smsTemplateSettings: { useSmsTemplates: boolean } }>>}
+   */
+  function update({token, jwtToken, smsTemplateSettings, headers}) {
+    return client({
+      url: "/sms-template-settings",
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        smsTemplateSettings
+      }
+    });
+  }
+
+  return {
+    get,
+    update
+  };
+}
+
+module.exports = smsTemplateSettingsFactory;

package/src/endpoints/inventory/segments-information-tables.js

@@ -6,7 +6,7 @@ const {
 /**
  * Query params for GET /segments-information-tables/:routeId (btrz-api-inventory-trips). See get-by-id-handler getSpec().
  * @typedef {Object} SegmentsInformationTablesQuery
- * @property {string} [providerId] - Provider/account id of the route when different from the authenticated user (24-char hex ObjectId)
+ * @property {string} [providerId] - Provider account ID when route belongs to a provider in the requester's network
  */
 
 /**
@@ -23,7 +23,7 @@ function segmentInformationTableFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key (X-API-KEY)
    * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization: Bearer)
    * @param {string} opts.routeId - Route id (24-char hex ObjectId)
-   * @param {SegmentsInformationTablesQuery} [opts.query] - Optional providerId
+   * @param {SegmentsInformationTablesQuery} [opts.query] - Optional query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ segmentInformationTables: { distances: Object, durations: Object, durationsHHMM: Object } }>>}
    * @throws 400 INVALID_ROUTE_ID — routeId not 24 hex characters

package/src/endpoints/notifications/notify.js

@@ -6,12 +6,12 @@ const {
 /**
  * Request body for POST /notify/email (btrz-api-notifications). See post-notify-email-handler getSpec() and NotifyEmailPostData.
  * @typedef {Object} NotifyEmailByTypePostData
- * @property {string} type - Document/template type (e.g. product, voucher, order, transaction)
+ * @property {string} type - Document/PDF type (e.g. order, voucher, movement, cancellation)
  * @property {string} itemId - ObjectId of the item (24-char hex)
  * @property {string} [to] - Recipient email (optional; derived from item when omitted)
  * @property {string} [lang] - ISO language code (e.g. en-us)
  * @property {string} [channel] - Channel filter for template selection
- * @property {string} [family] - Required when type is 'product'. One of: ticket, reservation, paid in, paid out, parcel, flexpass, bundle
+ * @property {string} [family] - When type is product or movement: ticket, reservation, parcel, etc.
  * @property {string} [humanDate] - "mm" | "dd"
  */
 

package/types/endpoints/inventory/segments-information-tables.d.ts

@@ -1,7 +1,7 @@
 export = segmentInformationTableFactory;
 /**
  * @typedef {Object} SegmentsInformationTablesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account ID when route belongs to a provider in the requester's network
  */
 /**
  * Factory for segments-information-tables API (btrz-api-inventory).
@@ -23,7 +23,7 @@ declare namespace segmentInformationTableFactory {
 }
 type SegmentsInformationTablesQuery = {
     /**
-     * - Provider account ID
+     * - Provider account ID when route belongs to a provider in the requester's network
      */
     providerId?: string;
 };