btrz-api-client 8.74.0 → 8.75.0

package/lib/client.js

@@ -219,6 +219,7 @@ function createAccounts(_ref4) {
   return {
     accounts: require("./endpoints/accounts/accounts.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     agencies: require("./endpoints/accounts/agencies.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    agencyTypes: require("./endpoints/accounts/agency-types.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     application: require("./endpoints/accounts/application.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     applications: require("./endpoints/accounts/applications.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     applicationSettings: require("./endpoints/accounts/application-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),

package/lib/endpoints/accounts/agency-types.js

@@ -0,0 +1,151 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Query params for GET /agency-types (btrz-api-accounts).
+ * @typedef {Object} AgencyTypesListQuery
+ * @property {number} [page] - The page number to retrieve (positive integer)
+ */
+
+/**
+ * Factory for agency-types 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 agencyTypesFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * GET /agency-types - list agency types for the account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AgencyTypesListQuery} [opts.query] - Query params (page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        _ref2$query = _ref2.query,
+        query = _ref2$query === undefined ? {} : _ref2$query,
+        headers = _ref2.headers;
+
+    return client.get("/agency-types", {
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * GET /agency-types/:agencyTypeId - get an agency type by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyTypeId - Agency type id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        agencyTypeId = _ref3.agencyTypeId,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/agency-types/" + agencyTypeId,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * POST /agency-types - create an agency type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.agencyType - Agency type payload (name required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        agencyType = _ref4.agencyType,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/agency-types",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: {
+        agencyType: agencyType
+      }
+    });
+  }
+
+  /**
+   * PUT /agency-types/:agencyTypeId - update an agency type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyTypeId - Agency type id (24-char hex ObjectId)
+   * @param {Object} opts.agencyType - Agency type payload (name required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        agencyTypeId = _ref5.agencyTypeId,
+        agencyType = _ref5.agencyType,
+        headers = _ref5.headers;
+
+    return client({
+      url: "/agency-types/" + agencyTypeId,
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: {
+        agencyType: agencyType
+      }
+    });
+  }
+
+  /**
+   * DELETE /agency-types/:agencyTypeId - delete an agency type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyTypeId - Agency type id (24-char hex ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove(_ref6) {
+    var token = _ref6.token,
+        jwtToken = _ref6.jwtToken,
+        agencyTypeId = _ref6.agencyTypeId,
+        headers = _ref6.headers;
+
+    return client({
+      url: "/agency-types/" + agencyTypeId,
+      method: "delete",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  return {
+    all: all,
+    get: get,
+    create: create,
+    update: update,
+    remove: remove
+  };
+}
+
+module.exports = agencyTypesFactory;

package/package.json

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

package/src/client.js

@@ -185,6 +185,7 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
   return {
     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}),
     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/agency-types.js

@@ -0,0 +1,118 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /agency-types (btrz-api-accounts).
+ * @typedef {Object} AgencyTypesListQuery
+ * @property {number} [page] - The page number to retrieve (positive integer)
+ */
+
+/**
+ * Factory for agency-types 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 agencyTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /agency-types - list agency types for the account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AgencyTypesListQuery} [opts.query] - Query params (page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
+    return client.get("/agency-types", {
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * GET /agency-types/:agencyTypeId - get an agency type by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyTypeId - Agency type id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, agencyTypeId, headers}) {
+    return client({
+      url: `/agency-types/${agencyTypeId}`,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /agency-types - create an agency type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.agencyType - Agency type payload (name required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, agencyType, headers}) {
+    return client({
+      url: "/agency-types",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        agencyType
+      }
+    });
+  }
+
+  /**
+   * PUT /agency-types/:agencyTypeId - update an agency type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyTypeId - Agency type id (24-char hex ObjectId)
+   * @param {Object} opts.agencyType - Agency type payload (name required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, agencyTypeId, agencyType, headers}) {
+    return client({
+      url: `/agency-types/${agencyTypeId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        agencyType
+      }
+    });
+  }
+
+  /**
+   * DELETE /agency-types/:agencyTypeId - delete an agency type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.agencyTypeId - Agency type id (24-char hex ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({token, jwtToken, agencyTypeId, headers}) {
+    return client({
+      url: `/agency-types/${agencyTypeId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    all,
+    get,
+    create,
+    update,
+    remove
+  };
+}
+
+module.exports = agencyTypesFactory;

package/test/all.test.js

@@ -3,6 +3,7 @@
 require("./client.test.js");
 require("./endpoints/accounts/accounts.js");
 require("./endpoints/accounts/agencies.test.js");
+require("./endpoints/accounts/agency-types.test.js");
 require("./endpoints/accounts/application-settings.test.js");
 require("./endpoints/accounts/applications.test.js");
 require("./endpoints/accounts/current-shifts.test.js");

package/test/endpoints/accounts/agency-types.test.js

@@ -0,0 +1,95 @@
+const {
+  axiosMock,
+  expectRequest
+} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({
+  baseURL: "http://test.com"
+});
+
+describe("accounts/agency-types", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should GET a list of agency types", () => {
+    axiosMock.onGet("/agency-types").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.accounts.agencyTypes.all({
+      token,
+      jwtToken,
+      query: {
+        page: 1
+      }
+    });
+  });
+
+  it("should GET an agency type by id", () => {
+    const agencyTypeId = "507f1f77bcf86cd799439011";
+    axiosMock.onGet(`/agency-types/${agencyTypeId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.accounts.agencyTypes.get({
+      token,
+      jwtToken,
+      agencyTypeId
+    });
+  });
+
+  it("should POST an agency type", () => {
+    const agencyType = {
+      name: "Retail"
+    };
+    axiosMock.onPost("/agency-types").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: {agencyType}
+    }));
+    return api.accounts.agencyTypes.create({
+      token,
+      jwtToken,
+      agencyType
+    });
+  });
+
+  it("should PUT an agency type", () => {
+    const agencyTypeId = "507f1f77bcf86cd799439011";
+    const agencyType = {
+      name: "Updated Retail"
+    };
+    axiosMock.onPut(`/agency-types/${agencyTypeId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: {agencyType}
+    }));
+    return api.accounts.agencyTypes.update({
+      token,
+      jwtToken,
+      agencyTypeId,
+      agencyType
+    });
+  });
+
+  it("should DELETE an agency type", () => {
+    const agencyTypeId = "507f1f77bcf86cd799439011";
+    axiosMock.onDelete(`/agency-types/${agencyTypeId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.accounts.agencyTypes.remove({
+      token,
+      jwtToken,
+      agencyTypeId
+    });
+  });
+});

package/types/endpoints/accounts/agency-types.d.ts

@@ -0,0 +1,34 @@
+export = agencyTypesFactory;
+/**
+ * Query params for GET /agency-types (btrz-api-accounts).
+ * @typedef {Object} AgencyTypesListQuery
+ * @property {number} [page] - The page number to retrieve (positive integer)
+ */
+/**
+ * Factory for agency-types 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 }}
+ */
+declare function agencyTypesFactory({ client, internalAuthTokenProvider }: {
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): {
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
+};
+declare namespace agencyTypesFactory {
+    export { AgencyTypesListQuery };
+}
+/**
+ * Query params for GET /agency-types (btrz-api-accounts).
+ */
+type AgencyTypesListQuery = {
+    page?: number;
+};