btrz-api-client 9.10.1 → 9.11.0

package/lib/client.js

@@ -497,6 +497,10 @@ function createAccounts({
       client,
       internalAuthTokenProvider
     }),
+    authorizedExternalMessaging: require("./endpoints/accounts/authorized-external-messaging.js")({
+      client,
+      internalAuthTokenProvider
+    }),
     application: require("./endpoints/accounts/application.js")({
       client,
       internalAuthTokenProvider

package/lib/endpoints/accounts/authorized-external-messaging.js

@@ -0,0 +1,171 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /authorized-external-messaging (btrz-api-accounts).
+ * @typedef {Object} AuthorizedExternalMessagingListQuery
+ * @property {number} [page] - The page number to retrieve (positive integer)
+ * @property {string} [email] - Filter by email prefix (starts with), case-insensitive
+ */
+
+/**
+ * Factory for authorized-external-messaging 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, update: function, remove: function }}
+ */
+function authorizedExternalMessagingFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /authorized-external-messaging - list authorized external messaging entries for the account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AuthorizedExternalMessagingListQuery} [opts.query] - Query params (page, email)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({
+    token,
+    jwtToken,
+    query = {},
+    headers
+  }) {
+    return client.get("/authorized-external-messaging", {
+      params: query,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * GET /authorized-external-messaging/:authorizedExternalMessagingId - get an entry by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.authorizedExternalMessagingId - Entry id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({
+    token,
+    jwtToken,
+    authorizedExternalMessagingId,
+    headers
+  }) {
+    return client({
+      url: `/authorized-external-messaging/${authorizedExternalMessagingId}`,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * POST /authorized-external-messaging - create an authorized external messaging entry.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.authorizedExternalMessaging - Entry payload (email required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({
+    token,
+    jwtToken,
+    authorizedExternalMessaging,
+    headers
+  }) {
+    return client({
+      url: "/authorized-external-messaging",
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        authorizedExternalMessaging
+      }
+    });
+  }
+
+  /**
+   * PUT /authorized-external-messaging/:authorizedExternalMessagingId - update an entry.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.authorizedExternalMessagingId - Entry id (24-char hex ObjectId)
+   * @param {Object} opts.authorizedExternalMessaging - Entry payload (email required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({
+    token,
+    jwtToken,
+    authorizedExternalMessagingId,
+    authorizedExternalMessaging,
+    headers
+  }) {
+    return client({
+      url: `/authorized-external-messaging/${authorizedExternalMessagingId}`,
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        authorizedExternalMessaging
+      }
+    });
+  }
+
+  /**
+   * DELETE /authorized-external-messaging/:authorizedExternalMessagingId - delete an entry.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.authorizedExternalMessagingId - Entry id (24-char hex ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({
+    token,
+    jwtToken,
+    authorizedExternalMessagingId,
+    headers
+  }) {
+    return client({
+      url: `/authorized-external-messaging/${authorizedExternalMessagingId}`,
+      method: "delete",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+  return {
+    all,
+    get,
+    create,
+    update,
+    remove
+  };
+}
+module.exports = authorizedExternalMessagingFactory;

package/lib/endpoints/accounts/network.js

@@ -7,6 +7,7 @@ const {
  * Query params for GET /network/agencies (btrz-api-accounts). See get-agencies-handler getSpec().
  * @typedef {Object} NetworkAgenciesListQuery
  * @property {string} [name] - Filter by agency/seller name (prefix, case-insensitive)
+ * @property {string} [createdBy] - Filter by creating provider user ObjectId
  * @property {number} [page] - Page number (1-based)
  */
 
@@ -23,11 +24,11 @@ function networkFactory({
 }) {
   const agencies = {
     /**
-     * GET /network/agencies - list agencies (paginated). Query: name, page.
+     * GET /network/agencies - list agencies (paginated). Query: name, createdBy, page.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {NetworkAgenciesListQuery} [opts.query] - Query params (name, page)
+     * @param {NetworkAgenciesListQuery} [opts.query] - Query params (name, createdBy, page)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse<{ agencies: Array, next?: string, previous?: string, count?: number }>>}
      *   Errors: 401, 500

package/package.json

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

package/src/client.js

@@ -188,6 +188,7 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     accounts: require("./endpoints/accounts/accounts.js")({client, internalAuthTokenProvider}),
     agencies: require("./endpoints/accounts/agencies.js")({client, internalAuthTokenProvider}),
     agencyTypes: require("./endpoints/accounts/agency-types.js")({client, internalAuthTokenProvider}),
+    authorizedExternalMessaging: require("./endpoints/accounts/authorized-external-messaging.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}),

package/src/endpoints/accounts/authorized-external-messaging.js

@@ -0,0 +1,119 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /authorized-external-messaging (btrz-api-accounts).
+ * @typedef {Object} AuthorizedExternalMessagingListQuery
+ * @property {number} [page] - The page number to retrieve (positive integer)
+ * @property {string} [email] - Filter by email prefix (starts with), case-insensitive
+ */
+
+/**
+ * Factory for authorized-external-messaging 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, update: function, remove: function }}
+ */
+function authorizedExternalMessagingFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /authorized-external-messaging - list authorized external messaging entries for the account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AuthorizedExternalMessagingListQuery} [opts.query] - Query params (page, email)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
+    return client.get("/authorized-external-messaging", {
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * GET /authorized-external-messaging/:authorizedExternalMessagingId - get an entry by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.authorizedExternalMessagingId - Entry id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, authorizedExternalMessagingId, headers}) {
+    return client({
+      url: `/authorized-external-messaging/${authorizedExternalMessagingId}`,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /authorized-external-messaging - create an authorized external messaging entry.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.authorizedExternalMessaging - Entry payload (email required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, authorizedExternalMessaging, headers}) {
+    return client({
+      url: "/authorized-external-messaging",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        authorizedExternalMessaging
+      }
+    });
+  }
+
+  /**
+   * PUT /authorized-external-messaging/:authorizedExternalMessagingId - update an entry.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.authorizedExternalMessagingId - Entry id (24-char hex ObjectId)
+   * @param {Object} opts.authorizedExternalMessaging - Entry payload (email required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, authorizedExternalMessagingId, authorizedExternalMessaging, headers}) {
+    return client({
+      url: `/authorized-external-messaging/${authorizedExternalMessagingId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        authorizedExternalMessaging
+      }
+    });
+  }
+
+  /**
+   * DELETE /authorized-external-messaging/:authorizedExternalMessagingId - delete an entry.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.authorizedExternalMessagingId - Entry id (24-char hex ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({token, jwtToken, authorizedExternalMessagingId, headers}) {
+    return client({
+      url: `/authorized-external-messaging/${authorizedExternalMessagingId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    all,
+    get,
+    create,
+    update,
+    remove
+  };
+}
+
+module.exports = authorizedExternalMessagingFactory;

package/src/endpoints/accounts/network.js

@@ -7,6 +7,7 @@ const {
  * Query params for GET /network/agencies (btrz-api-accounts). See get-agencies-handler getSpec().
  * @typedef {Object} NetworkAgenciesListQuery
  * @property {string} [name] - Filter by agency/seller name (prefix, case-insensitive)
+ * @property {string} [createdBy] - Filter by creating provider user ObjectId
  * @property {number} [page] - Page number (1-based)
  */
 
@@ -20,11 +21,11 @@ const {
 function networkFactory({client, internalAuthTokenProvider}) {
   const agencies = {
     /**
-     * GET /network/agencies - list agencies (paginated). Query: name, page.
+     * GET /network/agencies - list agencies (paginated). Query: name, createdBy, page.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {NetworkAgenciesListQuery} [opts.query] - Query params (name, page)
+     * @param {NetworkAgenciesListQuery} [opts.query] - Query params (name, createdBy, page)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse<{ agencies: Array, next?: string, previous?: string, count?: number }>>}
      *   Errors: 401, 500

package/test/endpoints/accounts/authorized-external-messaging.test.js

@@ -0,0 +1,98 @@
+const {
+  axiosMock,
+  expectRequest
+} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({
+  baseURL: "http://test.com"
+});
+
+describe("accounts/authorized-external-messaging", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should GET a list of authorized external messaging entries", () => {
+    axiosMock.onGet("/authorized-external-messaging").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.accounts.authorizedExternalMessaging.all({
+      token,
+      jwtToken,
+      query: {
+        page: 1,
+        email: "user@"
+      }
+    });
+  });
+
+  it("should GET an authorized external messaging entry by id", () => {
+    const authorizedExternalMessagingId = "507f1f77bcf86cd799439011";
+    axiosMock.onGet(`/authorized-external-messaging/${authorizedExternalMessagingId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.accounts.authorizedExternalMessaging.get({
+      token,
+      jwtToken,
+      authorizedExternalMessagingId
+    });
+  });
+
+  it("should POST an authorized external messaging entry", () => {
+    const authorizedExternalMessaging = {
+      email: "reports@example.com",
+      reports: true
+    };
+    axiosMock.onPost("/authorized-external-messaging").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: {authorizedExternalMessaging}
+    }));
+    return api.accounts.authorizedExternalMessaging.create({
+      token,
+      jwtToken,
+      authorizedExternalMessaging
+    });
+  });
+
+  it("should PUT an authorized external messaging entry", () => {
+    const authorizedExternalMessagingId = "507f1f77bcf86cd799439011";
+    const authorizedExternalMessaging = {
+      email: "reports@example.com",
+      reports: true
+    };
+    axiosMock.onPut(`/authorized-external-messaging/${authorizedExternalMessagingId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: {authorizedExternalMessaging}
+    }));
+    return api.accounts.authorizedExternalMessaging.update({
+      token,
+      jwtToken,
+      authorizedExternalMessagingId,
+      authorizedExternalMessaging
+    });
+  });
+
+  it("should DELETE an authorized external messaging entry", () => {
+    const authorizedExternalMessagingId = "507f1f77bcf86cd799439011";
+    axiosMock.onDelete(`/authorized-external-messaging/${authorizedExternalMessagingId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.accounts.authorizedExternalMessaging.remove({
+      token,
+      jwtToken,
+      authorizedExternalMessagingId
+    });
+  });
+});