btrz-api-client 5.193.0 → 5.195.0

package/lib/client.js

@@ -502,6 +502,26 @@ function createGPS(_ref15) {
   };
 }
 
+function createRatality(_ref16) {
+  var baseURL = _ref16.baseURL,
+      headers = _ref16.headers,
+      timeout = _ref16.timeout,
+      overrideFn = _ref16.overrideFn,
+      agents = _ref16.agents;
+
+  var client = clientFactory({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: overrideFn, agents: agents });
+  var version = "v2";
+
+  return {
+    auth: require("./endpoints/ratality/auth.js")({ client: client }),
+    clients: require("./endpoints/ratality/clients.js")({ client: client, version: version }),
+    integrations: require("./endpoints/ratality/integrations.js")({ client: client, version: version }),
+    __test: {
+      client: client
+    }
+  };
+}
+
 /**
  * Returns the apiClient object with defaults set
  *
@@ -516,15 +536,15 @@ function createGPS(_ref15) {
  * @param {{httpAgent: import("http").Agent, httpsAgent: import("https").Agent}} options.agents - An object containg one or both http agents
  */
 function createApiClient(options) {
-  var _ref16 = options || productionOptions,
-      baseURL = _ref16.baseURL,
-      _ref16$baseURLOverrid = _ref16.baseURLOverride,
-      baseURLOverride = _ref16$baseURLOverrid === undefined ? {} : _ref16$baseURLOverrid,
-      headers = _ref16.headers,
-      _ref16$timeout = _ref16.timeout,
-      timeout = _ref16$timeout === undefined ? 0 : _ref16$timeout,
-      internalAuthTokenProvider = _ref16.internalAuthTokenProvider,
-      agents = _ref16.agents;
+  var _ref17 = options || productionOptions,
+      baseURL = _ref17.baseURL,
+      _ref17$baseURLOverrid = _ref17.baseURLOverride,
+      baseURLOverride = _ref17$baseURLOverrid === undefined ? {} : _ref17$baseURLOverrid,
+      headers = _ref17.headers,
+      _ref17$timeout = _ref17.timeout,
+      timeout = _ref17$timeout === undefined ? 0 : _ref17$timeout,
+      internalAuthTokenProvider = _ref17.internalAuthTokenProvider,
+      agents = _ref17.agents;
 
   return {
     constants: require("./constants.js"),
@@ -543,7 +563,8 @@ function createApiClient(options) {
     seatmaps: createSeatmaps({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.seatmaps, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
     btrzpay: createBtrzPay({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.btrzpay, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
     invoices: createInvoices({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
-    gps: createGPS({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents })
+    gps: createGPS({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider: internalAuthTokenProvider, agents: agents }),
+    ratality: createRatality({ baseURL: baseURL, headers: headers, timeout: timeout, overrideFn: baseURLOverride.ratality, agents: agents })
   };
 }
 

package/lib/endpoints/accounts/shifts.js

@@ -362,6 +362,18 @@ function shiftsFactory(_ref) {
       });
     }
   };
+  var commissions = {
+    get: function get(_ref28) {
+      var token = _ref28.token,
+          jwtToken = _ref28.jwtToken,
+          shiftId = _ref28.shiftId,
+          headers = _ref28.headers;
+
+      return client.get("/shifts/" + shiftId + "/commissions", {
+        headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      });
+    }
+  };
 
   return {
     all: all,
@@ -384,7 +396,8 @@ function shiftsFactory(_ref) {
     locationClosures: locationClosures,
     startingBalances: startingBalances,
     purchaseLimitPayments: purchaseLimitPayments,
-    salesSummary: salesSummary
+    salesSummary: salesSummary,
+    commissions: commissions
   };
 }
 

package/lib/endpoints/ratality/auth.js

@@ -0,0 +1,23 @@
+"use strict";
+
+function authFactory(_ref) {
+  var client = _ref.client;
+
+  function create(_ref2) {
+    var data = _ref2.data,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/authenticate",
+      method: "post",
+      headers: headers,
+      data: data
+    });
+  }
+
+  return {
+    create: create
+  };
+}
+
+module.exports = authFactory;

package/lib/endpoints/ratality/clients.js

@@ -0,0 +1,40 @@
+"use strict";
+
+var _require = require("./../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function clientsFactory(_ref) {
+  var client = _ref.client,
+      version = _ref.version;
+
+  function create(_ref2) {
+    var jwtToken = _ref2.jwtToken,
+        data = _ref2.data,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/" + version + "/client",
+      method: "post",
+      headers: authorizationHeaders({ jwtToken: jwtToken, headers: headers }),
+      data: data
+    });
+  }
+
+  function get(_ref3) {
+    var jwtToken = _ref3.jwtToken,
+        clientId = _ref3.clientId;
+
+    return client({
+      url: "/" + version + "/client",
+      method: "get",
+      headers: Object.assign({ clientId: clientId }, authorizationHeaders({ jwtToken: jwtToken }))
+    });
+  }
+
+  return {
+    create: create,
+    get: get
+  };
+}
+
+module.exports = clientsFactory;

package/lib/endpoints/ratality/integrations.js

@@ -0,0 +1,53 @@
+"use strict";
+
+var _require = require("./../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function integrationsFactory(_ref) {
+  var client = _ref.client,
+      version = _ref.version;
+
+  function get(_ref2) {
+    var jwtToken = _ref2.jwtToken,
+        clientId = _ref2.clientId;
+
+    return client({
+      url: "/" + version + "/client/integrations",
+      method: "get",
+      headers: Object.assign({ clientId: clientId }, authorizationHeaders({ jwtToken: jwtToken }))
+    });
+  }
+
+  function create(_ref3) {
+    var jwtToken = _ref3.jwtToken,
+        clientId = _ref3.clientId,
+        data = _ref3.data;
+
+    return client({
+      url: "/" + version + "/client/integrations",
+      method: "post",
+      headers: Object.assign({ clientId: clientId }, authorizationHeaders({ jwtToken: jwtToken })),
+      data: data
+    });
+  }
+
+  function remove(_ref4) {
+    var jwtToken = _ref4.jwtToken,
+        clientId = _ref4.clientId,
+        integrationType = _ref4.integrationType;
+
+    return client({
+      url: "/" + version + "/client/integrations/" + integrationType,
+      method: "delete",
+      headers: Object.assign({ clientId: clientId }, authorizationHeaders({ jwtToken: jwtToken }))
+    });
+  }
+
+  return {
+    get: get,
+    create: create,
+    remove: remove
+  };
+}
+
+module.exports = integrationsFactory;

package/package.json

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

package/src/client.js

@@ -391,6 +391,20 @@ function createGPS({baseURL, headers, timeout, overrideFn, internalAuthTokenProv
   };
 }
 
+function createRatality({baseURL, headers, timeout, overrideFn, agents}) {
+  const client = clientFactory({baseURL, headers, timeout, overrideFn, agents});
+  const version = "v2";
+
+  return {
+    auth: require("./endpoints/ratality/auth.js")({client}),
+    clients: require("./endpoints/ratality/clients.js")({client, version}),
+    integrations: require("./endpoints/ratality/integrations.js")({client, version}),
+    __test: {
+      client
+    }
+  };
+}
+
 /**
  * Returns the apiClient object with defaults set
  *
@@ -427,7 +441,8 @@ function createApiClient(options) {
     seatmaps: createSeatmaps({baseURL, headers, timeout, overrideFn: baseURLOverride.seatmaps, internalAuthTokenProvider, agents}),
     btrzpay: createBtrzPay({baseURL, headers, timeout, overrideFn: baseURLOverride.btrzpay, internalAuthTokenProvider, agents}),
     invoices: createInvoices({baseURL, headers, timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider, agents}),
-    gps: createGPS({baseURL, headers, timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider, agents})
+    gps: createGPS({baseURL, headers, timeout, overrideFn: baseURLOverride.invoices, internalAuthTokenProvider, agents}),
+    ratality: createRatality({baseURL, headers, timeout, overrideFn: baseURLOverride.ratality, agents})
   };
 }
 

package/src/endpoints/accounts/shifts.js

@@ -218,6 +218,13 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
       });
     }
   };
+  const commissions = {
+    get({token, jwtToken, shiftId, headers}) {
+      return client.get(`/shifts/${shiftId}/commissions`, {
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+      });
+    }
+  };
 
   return {
     all,
@@ -240,7 +247,8 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     locationClosures,
     startingBalances,
     purchaseLimitPayments, 
-    salesSummary
+    salesSummary,
+    commissions
   };
 }
 

package/src/endpoints/ratality/auth.js

@@ -0,0 +1,19 @@
+function authFactory({client}) {
+  function create({
+    data,
+    headers
+  }) {
+    return client({
+      url: "/authenticate",
+      method: "post",
+      headers,
+      data
+    });
+  }
+
+  return {
+    create
+  };
+}
+
+module.exports = authFactory;

package/src/endpoints/ratality/clients.js

@@ -0,0 +1,35 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+function clientsFactory({client, version}) {
+  function create({
+    jwtToken,
+    data,
+    headers
+  }) {
+    return client({
+      url: `/${version}/client`,
+      method: "post",
+      headers: authorizationHeaders({jwtToken, headers}),
+      data
+    });
+  }
+
+  function get({
+    jwtToken, clientId
+  }) {
+    return client({
+      url: `/${version}/client`,
+      method: "get",
+      headers: Object.assign({clientId}, authorizationHeaders({jwtToken}))
+    });
+  }
+
+  return {
+    create,
+    get
+  };
+}
+
+module.exports = clientsFactory;

package/src/endpoints/ratality/integrations.js

@@ -0,0 +1,44 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+function integrationsFactory({client, version}) {
+  function get({
+    jwtToken, clientId
+  }) {
+    return client({
+      url: `/${version}/client/integrations`,
+      method: "get",
+      headers: Object.assign({clientId}, authorizationHeaders({jwtToken}))
+    });
+  }
+
+  function create({
+    jwtToken, clientId, data
+  }) {
+    return client({
+      url: `/${version}/client/integrations`,
+      method: "post",
+      headers: Object.assign({clientId}, authorizationHeaders({jwtToken})),
+      data
+    });
+  }
+
+  function remove({
+    jwtToken, clientId, integrationType
+  }) {
+    return client({
+      url: `/${version}/client/integrations/${integrationType}`,
+      method: "delete",
+      headers: Object.assign({clientId}, authorizationHeaders({jwtToken}))
+    });
+  }
+
+  return {
+    get,
+    create,
+    remove
+  };
+}
+
+module.exports = integrationsFactory;

package/test/endpoints/accounts/shifts.test.js

@@ -197,5 +197,12 @@ describe("accounts/shifts", () => {
     axiosMock.onGet(`/shifts/${shiftId}/sales-summary`).reply(expectRequest({statusCode: 200, token, query}));
     return api.accounts.shifts.salesSummary.get({token, jwtToken, shiftId, query});
   });
+
+  it("should get the shift commissions", () => {
+    const shiftId = "shiftId1";
+    axiosMock.onGet(`/shifts/${shiftId}/commissions`).reply(expectRequest({statusCode: 200, token}));
+    return api.accounts.shifts.commissions.get({token, jwtToken, shiftId});
+  });
+
 });
 

package/test/endpoints/ratality/auth.test.js

@@ -0,0 +1,23 @@
+const {expect} = require("chai");
+const {axiosMock} = require("./../../test-helpers");
+const api = require("./../../../src/client").createApiClient({ baseURL: "http://ratality.com" });
+
+describe("auth", () => {
+  afterEach(function() {
+    axiosMock.restore();
+  });
+
+  it("should perform a token create", () => {
+    const data = {
+      "username": "user_123",
+      "password": "pass_123",
+      "rememberMe": true
+    };
+    const response = {id_token: "someToken"};
+    axiosMock.onPost("/authenticate").reply((config) => {
+      expect(config.data).to.eql(JSON.stringify(data));
+      return [200, response];
+    });
+    return api.ratality.auth.create({data});
+  });
+});

package/test/endpoints/ratality/client.test.js

@@ -0,0 +1,32 @@
+const { axiosMock, expectRequest } = require("./../../test-helpers");
+const api = require("./../../../src/client").createApiClient({ baseURL: "http://ratality.com/v2" });
+
+describe("client", () => {
+  const jwtToken = 'I owe you a JWT token';
+  const version = "v2";
+
+  afterEach(function() {
+    axiosMock.restore();
+  });
+
+  it("should perform a client create", () => {
+    const data = {
+      "name": "test_account",
+      "externalId": "testAccountId123"
+    };
+    axiosMock.onPost(`/${version}/client`).reply(expectRequest({statusCode: 200, jwtToken, body: data, withoutApiKey: true}));
+    return api.ratality.clients.create({
+      jwtToken,
+      data
+    });
+  });
+
+  it("should perform a client get", () => {
+    const clientId = "clientId123";
+    axiosMock.onGet(`/${version}/client`).reply(expectRequest({statusCode: 200, jwtToken, withoutApiKey: true}));
+    return api.ratality.clients.get({
+      jwtToken,
+      clientId
+    });
+  });
+});

package/test/endpoints/ratality/integrations.test.js

@@ -0,0 +1,90 @@
+const { expect } = require("chai");
+const { axiosMock, expectRequest } = require("./../../test-helpers");
+const api = require("./../../../src/client").createApiClient({ baseURL: "http://ratality.com/v2" });
+
+describe("integrations", () => {
+  const jwtToken = 'I owe you a JWT token';
+  const version = "v2";
+
+  afterEach(function() {
+    axiosMock.restore();
+  });
+
+  it("should perform an integration create", () => {
+    const clientId = "clientId123";
+    const data = {
+      "integrationType": "Betterez",
+      "outboundConnection": {
+        "url": "https://sandbox-api.betterez.com",
+        "username": "user@place.com",
+        "password": "123456"
+      }
+    };
+    axiosMock.onPost(`/${version}/client/integrations`).reply((config) => {
+      expectRequest({statusCode: 200, jwtToken, body: data, withoutApiKey: true});
+      expect(config.headers).to.include({clientId});
+      return [200, {
+        "integrationType": "Betterez",
+        "clientId": clientId,
+        "channelId": 1000,
+        "outboundConnection": {
+          "url": "https://sandbox-api.betterez.com",
+          "username": "user@place.com",
+          "password": "123456"
+        },
+        "inboundConnection": {
+          "url": "https://integrate.us.ratality.com/betterez/99999",
+          "tags": [
+            "brand.created",
+            "brand.updated",
+            "station.created",
+            "station.updated",
+            "route.created",
+            "route.updated",
+            "route.deleted",
+            "schedule.created",
+            "schedule.updated",
+            "schedule.deleted",
+            "ticket.created",
+            "ticket.updated",
+            "ticket.moved"
+          ]
+        }
+      }];
+    });
+    return api.ratality.integrations.create({
+      jwtToken,
+      clientId,
+      data
+    });
+  });
+
+  it("should perform an integration get", () => {
+    const clientId = "clientId123";
+    axiosMock.onGet(`/${version}/client/integrations`).reply((config) => {
+      expectRequest({statusCode: 200, jwtToken, withoutApiKey: true});
+      expect(config.headers).to.include({clientId});
+      return [200, {integrations: []}];
+    });
+    return api.ratality.integrations.get({
+      jwtToken,
+      clientId
+    });
+  });
+
+  it("should perform an integration delete", () => {
+    const clientId = "clientId123";
+    const integrationType = "Betterez";
+    axiosMock.onDelete(`/${version}/client/integrations/${integrationType}`).reply((config) => {
+      expectRequest({statusCode: 200, jwtToken, withoutApiKey: true});
+      expect(config.headers).to.include({clientId});
+      expect(config.url).to.contain("Betterez");
+      return [200, {integrations: []}];
+    });
+    return api.ratality.integrations.remove({
+      jwtToken,
+      clientId,
+      integrationType
+    });
+  });
+});

package/types/client.d.ts

@@ -2474,6 +2474,14 @@ export function createApiClient(options: {
                     headers: any;
                 }): any;
             };
+            commissions: {
+                get({ token, jwtToken, shiftId, headers }: {
+                    token: any;
+                    jwtToken: any;
+                    shiftId: any;
+                    headers: any;
+                }): any;
+            };
         };
         shiftSettings: {
             get: ({ token, jwtToken, query, headers }: {
@@ -4460,5 +4468,43 @@ export function createApiClient(options: {
             client: axios.AxiosInstance;
         };
     };
+    ratality: {
+        auth: {
+            create: ({ data, headers }: {
+                data: any;
+                headers: any;
+            }) => any;
+        };
+        clients: {
+            create: ({ jwtToken, data, headers }: {
+                jwtToken: any;
+                data: any;
+                headers: any;
+            }) => any;
+            get: ({ jwtToken, clientId }: {
+                jwtToken: any;
+                clientId: any;
+            }) => any;
+        };
+        integrations: {
+            get: ({ jwtToken, clientId }: {
+                jwtToken: any;
+                clientId: any;
+            }) => any;
+            create: ({ jwtToken, clientId, data }: {
+                jwtToken: any;
+                clientId: any;
+                data: any;
+            }) => any;
+            remove: ({ jwtToken, clientId, integrationType }: {
+                jwtToken: any;
+                clientId: any;
+                integrationType: any;
+            }) => any;
+        };
+        __test: {
+            client: axios.AxiosInstance;
+        };
+    };
 };
 import axios = require("axios");

package/types/endpoints/accounts/shifts.d.ts

@@ -202,4 +202,12 @@ declare function shiftsFactory({ client, internalAuthTokenProvider }: {
             headers: any;
         }): any;
     };
+    commissions: {
+        get({ token, jwtToken, shiftId, headers }: {
+            token: any;
+            jwtToken: any;
+            shiftId: any;
+            headers: any;
+        }): any;
+    };
 };

package/types/endpoints/ratality/auth.d.ts

@@ -0,0 +1,9 @@
+export = authFactory;
+declare function authFactory({ client }: {
+    client: any;
+}): {
+    create: ({ data, headers }: {
+        data: any;
+        headers: any;
+    }) => any;
+};

package/types/endpoints/ratality/clients.d.ts

@@ -0,0 +1,15 @@
+export = clientsFactory;
+declare function clientsFactory({ client, version }: {
+    client: any;
+    version: any;
+}): {
+    create: ({ jwtToken, data, headers }: {
+        jwtToken: any;
+        data: any;
+        headers: any;
+    }) => any;
+    get: ({ jwtToken, clientId }: {
+        jwtToken: any;
+        clientId: any;
+    }) => any;
+};

package/types/endpoints/ratality/integrations.d.ts

@@ -0,0 +1,20 @@
+export = integrationsFactory;
+declare function integrationsFactory({ client, version }: {
+    client: any;
+    version: any;
+}): {
+    get: ({ jwtToken, clientId }: {
+        jwtToken: any;
+        clientId: any;
+    }) => any;
+    create: ({ jwtToken, clientId, data }: {
+        jwtToken: any;
+        clientId: any;
+        data: any;
+    }) => any;
+    remove: ({ jwtToken, clientId, integrationType }: {
+        jwtToken: any;
+        clientId: any;
+        integrationType: any;
+    }) => any;
+};