btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/webhooks/subscriptions.js

@@ -1,48 +1,107 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function subscriptionsFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /subscriptions (webhooks). Client merges opts.context into query.
+ * @typedef {Object} WebhookSubscriptionsListQuery
+ * @property {string} [context] - Context filter (merged from opts.context by client)
+ */
 
-  function all({ token, jwtToken, context, query = {}, headers }) {
-    const queryObj = Object.assign({}, query, { context });
+/**
+ * Factory for webhook subscriptions API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getById: function, create: function, put: function, deleteById: function }}
+ */
+function subscriptionsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /subscriptions - list webhook subscriptions. Query is merged with context (opts.context).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.context] - Context filter (merged into query)
+   * @param {WebhookSubscriptionsListQuery} [opts.query] - Additional query params (merged with context)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, context, query = {}, headers}) {
+    const queryObj = Object.assign({}, query, {context});
 
     return client({
       url: "/subscriptions",
       params: queryObj,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function getById({ token, jwtToken, id, headers }) {
+  /**
+   * GET /subscriptions/:id - get subscription by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Subscription id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function getById({token, jwtToken, id, headers}) {
     return client({
       url: `/subscriptions/${id}`,
       method: "get",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, subscription, headers }) {
+  /**
+   * POST /subscriptions - create webhook subscription.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.subscription - Subscription payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, subscription, headers}) {
     return client({
       url: "/subscriptions",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       data: subscription
     });
   }
 
-  function put({ token, jwtToken, id, subscription, headers }) {
+  /**
+   * PUT /subscriptions/:id - update subscription.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Subscription id
+   * @param {Object} opts.subscription - Subscription payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function put({token, jwtToken, id, subscription, headers}) {
     return client({
       url: `/subscriptions/${id}`,
       method: "put",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       data: subscription
     });
   }
 
-  function deleteById({ token, jwtToken, id, headers }) {
+  /**
+   * DELETE /subscriptions/:id - delete subscription by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Subscription id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function deleteById({token, jwtToken, id, headers}) {
     return client({
       url: `/subscriptions/${id}`,
       method: "delete",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
@@ -53,7 +112,6 @@ function subscriptionsFactory({ client, internalAuthTokenProvider }) {
     put,
     deleteById
   };
-
 }
 
-module.exports = subscriptionsFactory;
+module.exports = subscriptionsFactory;

package/src/endpoints/webhooks/undelivered.js

@@ -1,58 +1,133 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function undeliveredFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /undelivered (btrz-api-notifications). context can also be passed via opts.context and is merged into query.
+ * @typedef {Object} WebhookUndeliveredListQuery
+ * @property {string} [context] - Context filter (also accepted as opts.context)
+ */
 
-  function all({ token, jwtToken, context, query = {}, headers }) {
-    const queryObj = Object.assign({}, query, { context });
+/**
+ * Factory for undelivered webhooks API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getById: function, patch: function, resend: function, resendAll: function, deleteById: function, deleteAll: function }}
+ */
+function undeliveredFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /undelivered - list undelivered webhooks.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.context] - Context filter (merged into query)
+   * @param {WebhookUndeliveredListQuery} [opts.query] - Optional query params (context merged from opts.context)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, context, query = {}, headers}) {
+    const queryObj = Object.assign({}, query, {context});
 
     return client({
       url: "/undelivered",
       params: queryObj,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function getById({ token, jwtToken, id, headers }) {
+  /**
+   * GET /undelivered/:id - get undelivered webhook by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Undelivered id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function getById({token, jwtToken, id, headers}) {
     return client({
       url: `/undelivered/${id}`,
       method: "get",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function patch({ token, jwtToken, operation, headers }) {
+  /**
+   * PATCH /undelivered - patch undelivered.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.operation - Patch operation
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function patch({token, jwtToken, operation, headers}) {
     return client({
       url: "/undelivered",
       method: "patch",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       data: operation
     });
   }
 
-  function resend({ token, jwtToken, id, headers }) {
+  /**
+   * PUT /undelivered/:id/retry - resend undelivered webhook.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Undelivered id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function resend({token, jwtToken, id, headers}) {
     return client({
       url: `/undelivered/${id}/retry`,
       method: "put",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function resendAll({ token, jwtToken, headers }) {
+  /**
+   * PUT /undelivered/retry-all - resend all undelivered webhooks.
+   * @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 resendAll({token, jwtToken, headers}) {
     return client({
-      url: `/undelivered/retry-all`,
+      url: "/undelivered/retry-all",
       method: "put",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function deleteById({ token, jwtToken, id, headers }) {
+  /**
+   * DELETE /undelivered/:id - delete undelivered webhook by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Undelivered id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function deleteById({token, jwtToken, id, headers}) {
     return client({
       url: `/undelivered/${id}`,
       method: "delete",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * DELETE /undelivered/batch-all - delete all undelivered webhooks.
+   * @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 deleteAll({token, jwtToken, headers}) {
     return client({
       url: "/undelivered/batch-all",
@@ -72,4 +147,4 @@ function undeliveredFactory({ client, internalAuthTokenProvider }) {
   };
 }
 
-module.exports = undeliveredFactory;
+module.exports = undeliveredFactory;

package/src/endpoints/webhooks/webhooks.js

@@ -1,12 +1,27 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function webhooksFactory({ client, internalAuthTokenProvider }) {
-
-  function emit({ token, jwtToken, webhook, headers }) {
+/**
+ * Factory for webhooks emit API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ emit: function }}
+ */
+function webhooksFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /emit - emit webhook.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.webhook - Webhook payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function emit({token, jwtToken, webhook, headers}) {
     return client({
       url: "/emit",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       data: webhook
     });
   }
@@ -14,7 +29,6 @@ function webhooksFactory({ client, internalAuthTokenProvider }) {
   return {
     emit
   };
-
 }
 
-module.exports = webhooksFactory;
+module.exports = webhooksFactory;

package/src/productionDefaults.js

@@ -1,8 +1,16 @@
+/**
+ * Default options for createApiClient when no options are passed.
+ * @type {{ baseURL: string, timeout: number, baseURLOverride: { inventory: function(string): string, trips: function(string): string } }}
+ */
 module.exports = {
   baseURL: "https://api.betterez.com",
   timeout: 15000,
   baseURLOverride: {
-    inventory: (url) => `${url}/inventory`,
-    trips: (url) => `${url}/inventory`
+    inventory: (url) => {
+      return `${url}/inventory`;
+    },
+    trips: (url) => {
+      return `${url}/inventory`;
+    }
   }
 };