btrz-api-client 5.185.1 → 5.187.0

package/lib/client.js

@@ -98,6 +98,7 @@ function createInventory(_ref) {
     giftCertificateDefinitions: require("./endpoints/inventory/gift-certificate-definitions.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     amenities: require("./endpoints/inventory/amenities.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     amenityGroups: require("./endpoints/inventory/amenity-groups.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    scheduleGroups: require("./endpoints/inventory/schedule-groups.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     bundles: require("./endpoints/inventory/bundles.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     stationGroups: require("./endpoints/inventory/station-groups.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     zonePrices: require("./endpoints/inventory/zone-prices.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
@@ -217,7 +218,11 @@ function createAccounts(_ref4) {
     __test: {
       client: client
     },
-    websalesConfig: require("./endpoints/accounts/websales-config.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider })
+    websalesConfig: require("./endpoints/accounts/websales-config.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    transportRegulationSettingsForCNRT: require("./endpoints/accounts/transport-regulation-settings.js")({
+      client: client, internalAuthTokenProvider: internalAuthTokenProvider
+    })
+
   };
 }
 

package/lib/endpoints/accounts/transport-regulation-settings.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function transportRegulationSettingsForCNRT(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  function get(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/transport-regulation-settings/cnrt",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function update(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        transportRegulationSettings = _ref3.transportRegulationSettings,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/transport-regulation-settings/cnrt",
+      method: "put",
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      }),
+      data: transportRegulationSettings
+    });
+  }
+
+  return {
+    get: get,
+    update: update
+  };
+}
+
+module.exports = transportRegulationSettingsForCNRT;

package/lib/endpoints/inventory/schedule-groups.js

@@ -0,0 +1,72 @@
+"use strict";
+
+var _require = require("./../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function scheduleGroupsFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  function all(_ref2) {
+    var token = _ref2.token,
+        _ref2$query = _ref2.query,
+        query = _ref2$query === undefined ? {} : _ref2$query,
+        headers = _ref2.headers;
+
+    return client.get("/schedule-groups", {
+      params: query,
+      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function get(_ref3) {
+    var token = _ref3.token,
+        scheduleGroupId = _ref3.scheduleGroupId,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
+        headers = _ref3.headers;
+
+    return client.get("/schedule-groups/" + scheduleGroupId, {
+      params: query,
+      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  function create(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        scheduleGroup = _ref4.scheduleGroup,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/schedule-groups",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { scheduleGroup: scheduleGroup }
+    });
+  }
+
+  function update(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        scheduleGroupId = _ref5.scheduleGroupId,
+        scheduleGroup = _ref5.scheduleGroup,
+        headers = _ref5.headers;
+
+    return client({
+      url: "/schedule-groups/" + scheduleGroupId,
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: { scheduleGroup: scheduleGroup }
+    });
+  }
+
+  return {
+    all: all,
+    get: get,
+    create: create,
+    update: update
+  };
+}
+
+module.exports = scheduleGroupsFactory;

package/lib/endpoints/operations/rms.js

@@ -15,7 +15,7 @@ function rmsFactory(_ref) {
           query = _ref2$query === undefined ? {} : _ref2$query,
           headers = _ref2.headers;
 
-      return client.get("/rms/manifest-forecast/", {
+      return client.get("/rms/manifest-forecast", {
         params: query,
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });

package/package.json

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

package/src/client.js

@@ -85,6 +85,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
     giftCertificateDefinitions: require("./endpoints/inventory/gift-certificate-definitions.js")({client, internalAuthTokenProvider}),
     amenities: require("./endpoints/inventory/amenities.js")({client, internalAuthTokenProvider}),
     amenityGroups: require("./endpoints/inventory/amenity-groups.js")({client, internalAuthTokenProvider}),
+    scheduleGroups: require("./endpoints/inventory/schedule-groups.js")({client, internalAuthTokenProvider}),
     bundles: require("./endpoints/inventory/bundles.js")({client, internalAuthTokenProvider}),
     stationGroups: require("./endpoints/inventory/station-groups.js")({client, internalAuthTokenProvider}),
     zonePrices: require("./endpoints/inventory/zone-prices.js")({client, internalAuthTokenProvider}),
@@ -183,7 +184,11 @@ function createAccounts({baseURL, headers, timeout, overrideFn, internalAuthToke
     __test: {
       client
     },
-    websalesConfig: require("./endpoints/accounts/websales-config.js")({client, internalAuthTokenProvider})
+    websalesConfig: require("./endpoints/accounts/websales-config.js")({client, internalAuthTokenProvider}),
+    transportRegulationSettingsForCNRT: require("./endpoints/accounts/transport-regulation-settings.js")({
+      client, internalAuthTokenProvider
+    })
+
   };
 }
 

package/src/endpoints/accounts/transport-regulation-settings.js

@@ -0,0 +1,30 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+function transportRegulationSettingsForCNRT({client, internalAuthTokenProvider}) {
+  function get({token, jwtToken, headers}) {
+    return client({
+      url: "/transport-regulation-settings/cnrt",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function update({token, jwtToken, transportRegulationSettings, headers}) {
+    return client({
+      url: "/transport-regulation-settings/cnrt",
+      method: "put",
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      }),
+      data: transportRegulationSettings
+    });
+  }
+
+  return {
+    get,
+    update
+  };
+}
+
+module.exports = transportRegulationSettingsForCNRT;

package/src/endpoints/inventory/schedule-groups.js

@@ -0,0 +1,44 @@
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
+
+function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
+  function all({token, query = {}, headers}) {
+    return client.get("/schedule-groups", {
+      params: query,
+      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function get({token, scheduleGroupId, query = {}, headers}) {
+    return client.get(`/schedule-groups/${scheduleGroupId}`, {
+      params: query,
+      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+    });
+  }
+
+  function create({token, jwtToken, scheduleGroup, headers}) {
+    return client({
+      url: "/schedule-groups",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {scheduleGroup}
+    });
+  }
+
+  function update({token, jwtToken, scheduleGroupId, scheduleGroup, headers}) {
+    return client({
+      url: `/schedule-groups/${scheduleGroupId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {scheduleGroup}
+    });
+  }
+
+  return {
+    all,
+    get,
+    create,
+    update
+  };
+}
+
+module.exports = scheduleGroupsFactory;

package/src/endpoints/operations/rms.js

@@ -12,7 +12,7 @@ function rmsFactory({
       query = {},
       headers
     }) {
-      return client.get("/rms/manifest-forecast/", {
+      return client.get("/rms/manifest-forecast", {
         params: query,
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });

package/test/endpoints/accounts/transport-regulation-settings.test.js

@@ -0,0 +1,33 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("accounts/transport-regulation-settings/cnrt", () => {
+  const token = "I owe you a token";
+  const jwtToken = "secret";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should get the transport regulation settings for CNRT", () => {
+    axiosMock.onGet("/transport-regulation-settings/cnrt")
+      .reply(expectRequest({statusCode: 200, token}));
+    return api.accounts.transportRegulationSettingsForCNRT.get({token, jwtToken});
+  });
+
+  it("should update transport regulation settings for CNRT", () => {
+    const transportRegulationSettingsForCNRT = {
+      enabled: true
+    };
+
+    axiosMock.onPut("/transport-regulation-settings/cnrt")
+      .reply(expectRequest({
+        statusCode: 200,
+        token,
+        jwtToken
+      }));
+    return api.accounts.transportRegulationSettingsForCNRT.update({
+      token, jwtToken, transportRegulationSettingsForCNRT
+    });
+  });
+});

package/test/endpoints/inventory/schedule-groups.test.js

@@ -0,0 +1,56 @@
+const {axiosMock, expectRequest} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("inventory/schedule-groups", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should list Schedule Groups", () => {
+    axiosMock.onGet("/schedule-groups").reply(expectRequest({statusCode: 200, token}));
+    return api.inventory.scheduleGroups.all({token});
+  });
+
+
+  it("should get a Schedule Group", () => {
+    const scheduleGroupId = "5ad7804216b426412c19f06f";
+    axiosMock.onGet(`/schedule-groups/${scheduleGroupId}`).reply(expectRequest({statusCode: 200, token}));
+    return api.inventory.scheduleGroups.get({
+      token,
+      scheduleGroupId
+    });
+  });
+
+  it("should create an Schedule Group", () => {
+    axiosMock.onPost("/schedule-groups").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.scheduleGroups.create({
+      jwtToken,
+      token,
+      scheduleGroup: {
+        name: "schedule group name",
+        colour: "#1414b8",
+        enabled: "true",
+        rule: {}
+      }
+    });
+  });
+
+  it("should update an Schedule Group", () => {
+    const scheduleGroupId = "5ad7804216b426412c19f06f";
+    axiosMock.onPut(`/schedule-groups/${scheduleGroupId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.scheduleGroups.update({
+      jwtToken,
+      token,
+      scheduleGroupId,
+      update: {
+        name: "updated schedule group name",
+        colour: "#1515b8",
+        enabled: "true",
+        rule: {}
+      }
+    });
+  });
+});

package/test/endpoints/operations/rms.js

@@ -12,7 +12,7 @@ describe("operations/accounting-items", () => {
   });
 
   it("should get all manifest forecast information in a single day", () => {
-    axiosMock.onGet("/rms/manifest-forecast/").reply(expectRequest({
+    axiosMock.onGet("/rms/manifest-forecast").reply(expectRequest({
       statusCode: 200, token, jwtToken
     }));
     return api.operations.rms.manifestForecasts.all({

package/test-integration/endpoints/inventory/schedule-groups.test.js

@@ -0,0 +1,83 @@
+const {expect} = require("chai");
+const port = process.env.INVENTORY_API_PORT;
+const token = process.env.API_TOKEN;
+const jwtToken = process.env.JWT_TOKEN;
+const scheduleGroupId = process.env.SCHEDULE_GROUP_ID;
+
+const api = require("./../../../src/client.js").createApiClient({
+  baseURL: `http://localhost:${port}`,
+  baseURLOverride: {
+    inventory: (baseUrl) => `${baseUrl}/inventory`
+  }
+});
+
+describe("inventory/schedule-groups", () => {
+  it("should get an Schedule Group", () => {
+    return api.inventory.scheduleGroups.get({
+      token,
+      scheduleGroupId
+    })
+      .then(({status, data}) => {
+        expect(status).to.equal(200);
+        expect(data.scheduleGroup).to.exist;
+        expect(data.scheduleGroup._id).to.eql(scheduleGroupId);
+      });
+  });
+
+  it("should create an Schedule Group", () => {
+    const newName = "New Name 97";
+    const newColour = "#000017";
+    const newState = false;
+    return api.inventory.scheduleGroups.create({
+      jwtToken,
+      token,
+      scheduleGroup: {
+        name: newName,
+        enabled: newState,
+        colour: newColour,
+        rule: {}
+      }
+    })
+      .then(({status, data}) => {
+        expect(status).to.equal(200);
+        expect(data.scheduleGroup).to.exist;
+        expect(data.scheduleGroup.name).to.eql(newName);
+        expect(data.scheduleGroup.enabled).to.eql(newState);
+        expect(data.scheduleGroup.colour).to.eql(newColour);
+        expect(data.amenityGroup.createdAt).to.exist;
+        expect(data.amenityGroup.createdBy).to.exist;
+        expect(data.amenityGroup.updatedAt).to.exist;
+        expect(data.amenityGroup.updatedBy).to.exist;
+      });
+  });
+
+  it("should update an Schedule Group", () => {
+    const newName = "Schedule Group New Name";
+    const newState = false;
+    const newColour = "#000044";
+
+    return api.inventory.scheduleGroups.update({
+      jwtToken,
+      token,
+      scheduleGroupId,
+      amenityGroup: {
+        name: newName,
+        colour: newColour,
+        enabled: newState,
+        amenityIds: [],
+        lexiconKeys: {}
+      }
+    })
+      .then(({status, data}) => {
+        expect(status).to.equal(200);
+        expect(data.amenityGroup).to.exist;
+        expect(data.amenityGroup.name).to.eql(newName);
+        expect(data.amenityGroup.enabled).to.eql(newState);
+        expect(data.amenityGroup.colour).to.eql(newColour);
+        expect(data.amenityGroup.createdAt).to.exist;
+        expect(data.amenityGroup.createdBy).to.exist;
+        expect(data.amenityGroup.updatedAt).to.exist;
+        expect(data.amenityGroup.updatedBy).to.exist;
+      });
+  });
+});

package/types/client.d.ts

@@ -1224,6 +1224,32 @@ export function createApiClient(options: {
                 headers: any;
             }) => any;
         };
+        scheduleGroups: {
+            all: ({ token, query, headers }: {
+                token: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            get: ({ token, scheduleGroupId, query, headers }: {
+                token: any;
+                scheduleGroupId: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            create: ({ token, jwtToken, scheduleGroup, headers }: {
+                token: any;
+                jwtToken: any;
+                scheduleGroup: any;
+                headers: any;
+            }) => any;
+            update: ({ token, jwtToken, scheduleGroupId, scheduleGroup, headers }: {
+                token: any;
+                jwtToken: any;
+                scheduleGroupId: any;
+                scheduleGroup: any;
+                headers: any;
+            }) => any;
+        };
         bundles: {
             all: ({ token, jwtToken, query, headers }: {
                 token: any;
@@ -1798,7 +1824,12 @@ export function createApiClient(options: {
         };
         dynamicForms: {
             fields: {
-                get({ token, jwtToken, dynamicFormFieldId, headers }?: {}): any;
+                get({ token, jwtToken, dynamicFormFieldId, headers }?: {
+                    token: any;
+                    jwtToken: any;
+                    dynamicFormFieldId: any;
+                    headers: any;
+                }): any;
                 all({ token, jwtToken, query, headers }: {
                     token: any;
                     jwtToken: any;
@@ -2500,7 +2531,12 @@ export function createApiClient(options: {
             }) => any;
         };
         users: {
-            get: ({ token, jwtToken, id, headers }?: {}) => any;
+            get: ({ token, jwtToken, id, headers }?: {
+                token: any;
+                jwtToken: any;
+                id: any;
+                headers: any;
+            }) => any;
             all: ({ token, jwtToken, query, headers }: {
                 token: any;
                 jwtToken: any;
@@ -2578,6 +2614,19 @@ export function createApiClient(options: {
                 headers: any;
             }) => any;
         };
+        transportRegulationSettingsForCNRT: {
+            get: ({ token, jwtToken, headers }: {
+                token: any;
+                jwtToken: any;
+                headers: any;
+            }) => any;
+            update: ({ token, jwtToken, transportRegulationSettings, headers }: {
+                token: any;
+                jwtToken: any;
+                transportRegulationSettings: any;
+                headers: any;
+            }) => any;
+        };
     };
     sales: {
         docs: {
@@ -2787,7 +2836,7 @@ export function createApiClient(options: {
                 create: ({ token, jwtToken, cancelData, headers }: {
                     token: string;
                     jwtToken: string;
-                    cancelData: CancelSetData;
+                    cancelData: import("./endpoints/sales/cancellations.js").CancelSetData;
                     headers: any;
                 }) => Promise<any>;
             };
@@ -3616,7 +3665,7 @@ export function createApiClient(options: {
                     jwtToken: any;
                     phoneNumberData?: {};
                     headers: any;
-                }): any;
+                }): any; /** @type {import("axios").AxiosRequestConfig} */
             };
             sms: {
                 create({ token, jwtToken, smsMsg, headers }: {

package/types/endpoints/accounts/dynamic-forms.d.ts

@@ -4,7 +4,12 @@ declare function dynamicFormsFactory({ client, internalAuthTokenProvider }: {
     internalAuthTokenProvider: any;
 }): {
     fields: {
-        get({ token, jwtToken, dynamicFormFieldId, headers }?: {}): any;
+        get({ token, jwtToken, dynamicFormFieldId, headers }?: {
+            token: any;
+            jwtToken: any;
+            dynamicFormFieldId: any;
+            headers: any;
+        }): any;
         all({ token, jwtToken, query, headers }: {
             token: any;
             jwtToken: any;

package/types/endpoints/accounts/transport-regulation-settings.d.ts

@@ -0,0 +1,17 @@
+export = transportRegulationSettingsForCNRT;
+declare function transportRegulationSettingsForCNRT({ client, internalAuthTokenProvider }: {
+    client: any;
+    internalAuthTokenProvider: any;
+}): {
+    get: ({ token, jwtToken, headers }: {
+        token: any;
+        jwtToken: any;
+        headers: any;
+    }) => any;
+    update: ({ token, jwtToken, transportRegulationSettings, headers }: {
+        token: any;
+        jwtToken: any;
+        transportRegulationSettings: any;
+        headers: any;
+    }) => any;
+};

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

@@ -3,7 +3,12 @@ declare function usersFactory({ client, internalAuthTokenProvider }: {
     client: any;
     internalAuthTokenProvider: any;
 }): {
-    get: ({ token, jwtToken, id, headers }?: {}) => any;
+    get: ({ token, jwtToken, id, headers }?: {
+        token: any;
+        jwtToken: any;
+        id: any;
+        headers: any;
+    }) => any;
     all: ({ token, jwtToken, query, headers }: {
         token: any;
         jwtToken: any;

package/types/endpoints/inventory/schedule-groups.d.ts

@@ -0,0 +1,30 @@
+export = scheduleGroupsFactory;
+declare function scheduleGroupsFactory({ client, internalAuthTokenProvider }: {
+    client: any;
+    internalAuthTokenProvider: any;
+}): {
+    all: ({ token, query, headers }: {
+        token: any;
+        query?: {};
+        headers: any;
+    }) => any;
+    get: ({ token, scheduleGroupId, query, headers }: {
+        token: any;
+        scheduleGroupId: any;
+        query?: {};
+        headers: any;
+    }) => any;
+    create: ({ token, jwtToken, scheduleGroup, headers }: {
+        token: any;
+        jwtToken: any;
+        scheduleGroup: any;
+        headers: any;
+    }) => any;
+    update: ({ token, jwtToken, scheduleGroupId, scheduleGroup, headers }: {
+        token: any;
+        jwtToken: any;
+        scheduleGroupId: any;
+        scheduleGroup: any;
+        headers: any;
+    }) => any;
+};