btrz-api-client 8.22.0 → 8.24.0

package/lib/client.js

@@ -193,6 +193,8 @@ function createAccounts(_ref4) {
     domains: require("./endpoints/accounts/domains.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     dynamicForms: require("./endpoints/accounts/dynamic-forms.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     emailSettings: require("./endpoints/accounts/email-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    emailTemplates: require("./endpoints/accounts/email-templates.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    smsTemplates: require("./endpoints/accounts/sms-templates.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     exchangeRates: require("./endpoints/accounts/exchange-rates.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     exchangeReceipts: require("./endpoints/accounts/exchange-receipts.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     goalSettings: require("./endpoints/accounts/goal-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),

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

@@ -0,0 +1,126 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function emailTemplatesFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  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({
+      url: "/email-templates",
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function get(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        emailTemplateId = _ref3.emailTemplateId,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/email-templates/" + emailTemplateId,
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function create(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        data = _ref4.data,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/email-templates",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  function update(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        emailTemplateId = _ref5.emailTemplateId,
+        data = _ref5.data,
+        headers = _ref5.headers;
+
+    return client({
+      url: "/email-templates/" + emailTemplateId,
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  function remove(_ref6) {
+    var token = _ref6.token,
+        jwtToken = _ref6.jwtToken,
+        emailTemplateId = _ref6.emailTemplateId,
+        headers = _ref6.headers;
+
+    return client({
+      url: "/email-templates/" + emailTemplateId,
+      method: "delete",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function createSub(_ref7) {
+    var token = _ref7.token,
+        jwtToken = _ref7.jwtToken,
+        mainTemplateId = _ref7.mainTemplateId,
+        agencyId = _ref7.agencyId,
+        headers = _ref7.headers;
+
+    return client({
+      url: "/sub-email-templates",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { mainTemplateId: mainTemplateId, agencyId: agencyId }
+    });
+  }
+
+  var versions = {
+    update: function update(_ref8) {
+      var token = _ref8.token,
+          jwtToken = _ref8.jwtToken,
+          emailTemplateId = _ref8.emailTemplateId,
+          versionId = _ref8.versionId,
+          _ref8$query = _ref8.query,
+          query = _ref8$query === undefined ? {} : _ref8$query,
+          headers = _ref8.headers;
+
+      return client({
+        url: "/email-templates/" + emailTemplateId + "/versions/" + versionId,
+        method: "put",
+        headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+        params: query
+      });
+    }
+  };
+
+  return {
+    all: all,
+    get: get,
+    create: create,
+    update: update,
+    remove: remove,
+    createSub: createSub,
+    versions: versions
+  };
+}
+
+module.exports = emailTemplatesFactory;

package/lib/endpoints/accounts/sms-templates.js

@@ -0,0 +1,126 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function smsTemplatesFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  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({
+      url: "/sms-templates",
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function get(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        smsTemplateId = _ref3.smsTemplateId,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/sms-templates/" + smsTemplateId,
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function create(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        data = _ref4.data,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/sms-templates",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  function update(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        smsTemplateId = _ref5.smsTemplateId,
+        data = _ref5.data,
+        headers = _ref5.headers;
+
+    return client({
+      url: "/sms-templates/" + smsTemplateId,
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  function remove(_ref6) {
+    var token = _ref6.token,
+        jwtToken = _ref6.jwtToken,
+        smsTemplateId = _ref6.smsTemplateId,
+        headers = _ref6.headers;
+
+    return client({
+      url: "/sms-templates/" + smsTemplateId,
+      method: "delete",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function createSub(_ref7) {
+    var token = _ref7.token,
+        jwtToken = _ref7.jwtToken,
+        mainTemplateId = _ref7.mainTemplateId,
+        agencyId = _ref7.agencyId,
+        headers = _ref7.headers;
+
+    return client({
+      url: "/sub-sms-templates",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { mainTemplateId: mainTemplateId, agencyId: agencyId }
+    });
+  }
+
+  var versions = {
+    update: function update(_ref8) {
+      var token = _ref8.token,
+          jwtToken = _ref8.jwtToken,
+          smsTemplateId = _ref8.smsTemplateId,
+          versionId = _ref8.versionId,
+          _ref8$query = _ref8.query,
+          query = _ref8$query === undefined ? {} : _ref8$query,
+          headers = _ref8.headers;
+
+      return client({
+        url: "/sms-templates/" + smsTemplateId + "/versions/" + versionId,
+        method: "put",
+        headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+        params: query
+      });
+    }
+  };
+
+  return {
+    all: all,
+    get: get,
+    create: create,
+    update: update,
+    remove: remove,
+    createSub: createSub,
+    versions: versions
+  };
+}
+
+module.exports = smsTemplatesFactory;

package/package.json

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

package/src/client.js

@@ -159,6 +159,8 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     domains: require("./endpoints/accounts/domains.js")({client, internalAuthTokenProvider}),
     dynamicForms: require("./endpoints/accounts/dynamic-forms.js")({client, internalAuthTokenProvider}),
     emailSettings: require("./endpoints/accounts/email-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}),
     exchangeReceipts: require("./endpoints/accounts/exchange-receipts.js")({client, internalAuthTokenProvider}),
     goalSettings: require("./endpoints/accounts/goal-settings.js")({client, internalAuthTokenProvider}),

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

@@ -0,0 +1,79 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+function emailTemplatesFactory({client, internalAuthTokenProvider}) {
+  function all({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/email-templates",
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function get({token, jwtToken, emailTemplateId, query = {}, headers}) {
+    return client({
+      url: `/email-templates/${emailTemplateId}`,
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function create({token, jwtToken, data, headers}) {
+    return client({
+      url: "/email-templates",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  function update({token, jwtToken, emailTemplateId, data, headers}) {
+    return client({
+      url: `/email-templates/${emailTemplateId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  function remove({token, jwtToken, emailTemplateId, headers}) {
+    return client({
+      url: `/email-templates/${emailTemplateId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function createSub({token, jwtToken, mainTemplateId, agencyId, headers}) {
+    return client({
+      url: "/sub-email-templates",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {mainTemplateId, agencyId}
+    });
+  }
+
+  const versions = {
+    update({token, jwtToken, emailTemplateId, versionId, query = {}, headers}) {
+      return client({
+        url: `/email-templates/${emailTemplateId}/versions/${versionId}`,
+        method: "put",
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+        params: query
+      });
+    }
+  };
+
+  return {
+    all,
+    get,
+    create,
+    update,
+    remove,
+    createSub,
+    versions
+  };
+}
+
+module.exports = emailTemplatesFactory;

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

@@ -0,0 +1,79 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+function smsTemplatesFactory({client, internalAuthTokenProvider}) {
+  function all({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/sms-templates",
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function get({token, jwtToken, smsTemplateId, query = {}, headers}) {
+    return client({
+      url: `/sms-templates/${smsTemplateId}`,
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function create({token, jwtToken, data, headers}) {
+    return client({
+      url: "/sms-templates",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  function update({token, jwtToken, smsTemplateId, data, headers}) {
+    return client({
+      url: `/sms-templates/${smsTemplateId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  function remove({token, jwtToken, smsTemplateId, headers}) {
+    return client({
+      url: `/sms-templates/${smsTemplateId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function createSub({token, jwtToken, mainTemplateId, agencyId, headers}) {
+    return client({
+      url: "/sub-sms-templates",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {mainTemplateId, agencyId}
+    });
+  }
+
+  const versions = {
+    update({token, jwtToken, smsTemplateId, versionId, query = {}, headers}) {
+      return client({
+        url: `/sms-templates/${smsTemplateId}/versions/${versionId}`,
+        method: "put",
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+        params: query
+      });
+    }
+  };
+
+  return {
+    all,
+    get,
+    create,
+    update,
+    remove,
+    createSub,
+    versions
+  };
+}
+
+module.exports = smsTemplatesFactory;

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

@@ -0,0 +1,117 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("accounts/email-templates", () => {
+  const token = "someToken";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.restore();
+  });
+
+  it("should GET a list of email templates", () => {
+    axiosMock.onGet("/email-templates").reply(expectRequest({
+      statusCode: 200,
+      token
+    }));
+    return api.accounts.emailTemplates.all({
+      token
+    });
+  });
+
+  it("should GET a list of email templates with query params", () => {
+    const query = {type: "order_confirmation", channel: "websales"};
+    axiosMock.onGet("/email-templates").reply(expectRequest({
+      statusCode: 200,
+      token,
+      query
+    }));
+    return api.accounts.emailTemplates.all({
+      token,
+      query
+    });
+  });
+
+  it("should GET an email template by id", () => {
+    const emailTemplateId = "507f1f77bcf86cd799439011";
+    axiosMock.onGet(`/email-templates/${emailTemplateId}`)
+      .reply(expectRequest({statusCode: 200, token}));
+    return api.accounts.emailTemplates.get({token, jwtToken, emailTemplateId});
+  });
+
+  it("should create an email template", () => {
+    const data = {name: "My Template", type: "order_confirmation", htmlTemplate: "<p>Hello</p>"};
+    axiosMock.onPost("/email-templates").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.emailTemplates.create({
+      token,
+      jwtToken,
+      data
+    });
+  });
+
+  it("should update an email template", () => {
+    const emailTemplateId = "507f1f77bcf86cd799439011";
+    const data = {name: "Updated Template", type: "order_confirmation", htmlTemplate: "<p>Hi</p>"};
+    axiosMock.onPut(`/email-templates/${emailTemplateId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.emailTemplates.update({
+      token,
+      jwtToken,
+      emailTemplateId,
+      data
+    });
+  });
+
+  it("should delete an email template", () => {
+    const emailTemplateId = "507f1f77bcf86cd799439011";
+    axiosMock.onDelete(`/email-templates/${emailTemplateId}`)
+      .reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.accounts.emailTemplates.remove({
+      token,
+      jwtToken,
+      emailTemplateId
+    });
+  });
+
+  it("should create a sub email template", () => {
+    const mainTemplateId = "507f1f77bcf86cd799439011";
+    const agencyId = "507f1f77bcf86cd799439012";
+    const data = {mainTemplateId, agencyId};
+    axiosMock.onPost("/sub-email-templates").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.emailTemplates.createSub({
+      token,
+      jwtToken,
+      mainTemplateId,
+      agencyId
+    });
+  });
+
+  describe("versions", () => {
+    it("should update an email template version", () => {
+      const emailTemplateId = "507f1f77bcf86cd799439011";
+      const versionId = "507f1f77bcf86cd799439013";
+      axiosMock.onPut(`/email-templates/${emailTemplateId}/versions/${versionId}`)
+        .reply(expectRequest({statusCode: 200, token, jwtToken}));
+      return api.accounts.emailTemplates.versions.update({
+        token,
+        jwtToken,
+        emailTemplateId,
+        versionId
+      });
+    });
+  });
+});

package/test/endpoints/accounts/sms-templates.test.js

@@ -0,0 +1,117 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("accounts/sms-templates", () => {
+  const token = "someToken";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.restore();
+  });
+
+  it("should GET a list of sms templates", () => {
+    axiosMock.onGet("/sms-templates").reply(expectRequest({
+      statusCode: 200,
+      token
+    }));
+    return api.accounts.smsTemplates.all({
+      token
+    });
+  });
+
+  it("should GET a list of sms templates with query params", () => {
+    const query = {type: "order_confirmation", channel: "websales"};
+    axiosMock.onGet("/sms-templates").reply(expectRequest({
+      statusCode: 200,
+      token,
+      query
+    }));
+    return api.accounts.smsTemplates.all({
+      token,
+      query
+    });
+  });
+
+  it("should GET an sms template by id", () => {
+    const smsTemplateId = "507f1f77bcf86cd799439011";
+    axiosMock.onGet(`/sms-templates/${smsTemplateId}`)
+      .reply(expectRequest({statusCode: 200, token}));
+    return api.accounts.smsTemplates.get({token, jwtToken, smsTemplateId});
+  });
+
+  it("should create an sms template", () => {
+    const data = {name: "My SMS Template", type: "order_confirmation", txtTemplate: "Hello"};
+    axiosMock.onPost("/sms-templates").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.smsTemplates.create({
+      token,
+      jwtToken,
+      data
+    });
+  });
+
+  it("should update an sms template", () => {
+    const smsTemplateId = "507f1f77bcf86cd799439011";
+    const data = {name: "Updated SMS Template", type: "order_confirmation", txtTemplate: "Hi"};
+    axiosMock.onPut(`/sms-templates/${smsTemplateId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.smsTemplates.update({
+      token,
+      jwtToken,
+      smsTemplateId,
+      data
+    });
+  });
+
+  it("should delete an sms template", () => {
+    const smsTemplateId = "507f1f77bcf86cd799439011";
+    axiosMock.onDelete(`/sms-templates/${smsTemplateId}`)
+      .reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.accounts.smsTemplates.remove({
+      token,
+      jwtToken,
+      smsTemplateId
+    });
+  });
+
+  it("should create a sub sms template", () => {
+    const mainTemplateId = "507f1f77bcf86cd799439011";
+    const agencyId = "507f1f77bcf86cd799439012";
+    const data = {mainTemplateId, agencyId};
+    axiosMock.onPost("/sub-sms-templates").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.accounts.smsTemplates.createSub({
+      token,
+      jwtToken,
+      mainTemplateId,
+      agencyId
+    });
+  });
+
+  describe("versions", () => {
+    it("should update an sms template version", () => {
+      const smsTemplateId = "507f1f77bcf86cd799439011";
+      const versionId = "507f1f77bcf86cd799439013";
+      axiosMock.onPut(`/sms-templates/${smsTemplateId}/versions/${versionId}`)
+        .reply(expectRequest({statusCode: 200, token, jwtToken}));
+      return api.accounts.smsTemplates.versions.update({
+        token,
+        jwtToken,
+        smsTemplateId,
+        versionId
+      });
+    });
+  });
+});

package/test/endpoints/accounts/sub-print-templates.test.js

@@ -1,5 +1,5 @@
-const {axiosMock, expectRequest} = require("./../../test-helpers");
-const api = require("./../../../src/client").createApiClient({baseURL: "http://test.com"});
+const {axiosMock, expectRequest} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
 
 describe("accounts/accounts/sub-print-templates", () => {
   const token = "I owe you a token";
@@ -25,5 +25,4 @@ describe("accounts/accounts/sub-print-templates", () => {
       token, jwtToken, subPrintTemplate
     });
   });
-
 });