btrz-api-client 8.1.0 → 8.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/client.js CHANGED
@@ -72,6 +72,7 @@ function createInventory(_ref) {
72
72
  documentTypes: require("./endpoints/inventory/document-types.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
73
73
  externalPasses: require("./endpoints/inventory/external-passes.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
74
74
  externalWallets: require("./endpoints/inventory/external-wallets.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
75
+ fallbackCodes: require("./endpoints/inventory/fallback-codes.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
75
76
  fareClasses: require("./endpoints/inventory/fare-classes.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
76
77
  fares: require("./endpoints/inventory/fares.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
77
78
  fees: require("./endpoints/inventory/fees.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+
3
+ var _require = require("./../endpoints_helpers.js"),
4
+ authorizationHeaders = _require.authorizationHeaders;
5
+
6
+ function fallbackCodesFactory(_ref) {
7
+ var client = _ref.client,
8
+ internalAuthTokenProvider = _ref.internalAuthTokenProvider;
9
+
10
+ function all(_ref2) {
11
+ var token = _ref2.token,
12
+ jwtToken = _ref2.jwtToken,
13
+ _ref2$query = _ref2.query,
14
+ query = _ref2$query === undefined ? {} : _ref2$query,
15
+ headers = _ref2.headers;
16
+
17
+ return client.get("/fallback-codes", {
18
+ params: query,
19
+ headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
20
+ });
21
+ }
22
+
23
+ function get(_ref3) {
24
+ var token = _ref3.token,
25
+ id = _ref3.id,
26
+ headers = _ref3.headers;
27
+
28
+ return client.get("/fallback-code/" + id, {
29
+ headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
30
+ });
31
+ }
32
+
33
+ function create(_ref4) {
34
+ var token = _ref4.token,
35
+ jwtToken = _ref4.jwtToken,
36
+ fallbackCode = _ref4.fallbackCode,
37
+ headers = _ref4.headers;
38
+
39
+ return client({
40
+ url: "/fallback-codes",
41
+ method: "post",
42
+ headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
43
+ data: { fallbackCode: fallbackCode }
44
+ });
45
+ }
46
+
47
+ function update(_ref5) {
48
+ var token = _ref5.token,
49
+ jwtToken = _ref5.jwtToken,
50
+ fallbackCodeId = _ref5.fallbackCodeId,
51
+ fallbackCode = _ref5.fallbackCode,
52
+ headers = _ref5.headers;
53
+
54
+ return client({
55
+ url: "/fallback-code/" + fallbackCodeId,
56
+ method: "put",
57
+ headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
58
+ data: { fallbackCode: fallbackCode }
59
+ });
60
+ }
61
+
62
+ return {
63
+ all: all,
64
+ get: get,
65
+ create: create,
66
+ update: update
67
+ };
68
+ }
69
+
70
+ module.exports = fallbackCodesFactory;
@@ -1,19 +1,31 @@
1
1
  "use strict";
2
2
 
3
- var _require = require("./../endpoints_helpers"),
3
+ var _require = require("./../endpoints_helpers.js"),
4
4
  authorizationHeaders = _require.authorizationHeaders;
5
5
 
6
6
  function filteredTripsFactory(_ref) {
7
7
  var client = _ref.client,
8
8
  internalAuthTokenProvider = _ref.internalAuthTokenProvider;
9
9
 
10
-
11
- function create(_ref2) {
10
+ function all(_ref2) {
12
11
  var token = _ref2.token,
13
12
  jwtToken = _ref2.jwtToken,
14
- tripSegmentsId = _ref2.tripSegmentsId,
13
+ _ref2$query = _ref2.query,
14
+ query = _ref2$query === undefined ? {} : _ref2$query,
15
15
  headers = _ref2.headers;
16
16
 
17
+ return client.get("/filtered-trips", {
18
+ params: query,
19
+ headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
20
+ });
21
+ }
22
+
23
+ function create(_ref3) {
24
+ var token = _ref3.token,
25
+ jwtToken = _ref3.jwtToken,
26
+ tripSegmentsId = _ref3.tripSegmentsId,
27
+ headers = _ref3.headers;
28
+
17
29
  return client({
18
30
  url: "/filtered-trips",
19
31
  method: "post",
@@ -23,6 +35,7 @@ function filteredTripsFactory(_ref) {
23
35
  }
24
36
 
25
37
  return {
38
+ all: all,
26
39
  create: create
27
40
  };
28
41
  }
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
 
3
- var _require = require("./../endpoints_helpers"),
3
+ var _require = require("./../endpoints_helpers.js"),
4
4
  authorizationHeaders = _require.authorizationHeaders;
5
5
 
6
6
  function productsFactory(_ref) {
@@ -65,6 +65,21 @@ function notifyTicketFactory(_ref) {
65
65
  headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
66
66
  });
67
67
  }
68
+ },
69
+ manifest: {
70
+ create: function create(_ref5) {
71
+ var token = _ref5.token,
72
+ jwtToken = _ref5.jwtToken,
73
+ data = _ref5.data,
74
+ headers = _ref5.headers;
75
+
76
+ return client({
77
+ url: "/notify-manifest",
78
+ method: "post",
79
+ data: data,
80
+ headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
81
+ });
82
+ }
68
83
  }
69
84
  };
70
85
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "btrz-api-client",
3
- "version": "8.1.0",
3
+ "version": "8.3.0",
4
4
  "description": "Api client for Betterez endpoints",
5
5
  "main": "index.js",
6
6
  "scripts": {
package/src/client.js CHANGED
@@ -59,6 +59,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
59
59
  documentTypes: require("./endpoints/inventory/document-types.js")({client, internalAuthTokenProvider}),
60
60
  externalPasses: require("./endpoints/inventory/external-passes.js")({client, internalAuthTokenProvider}),
61
61
  externalWallets: require("./endpoints/inventory/external-wallets.js")({client, internalAuthTokenProvider}),
62
+ fallbackCodes: require("./endpoints/inventory/fallback-codes.js")({client, internalAuthTokenProvider}),
62
63
  fareClasses: require("./endpoints/inventory/fare-classes.js")({client, internalAuthTokenProvider}),
63
64
  fares: require("./endpoints/inventory/fares.js")({client, internalAuthTokenProvider}),
64
65
  fees: require("./endpoints/inventory/fees.js")({client, internalAuthTokenProvider}),
@@ -0,0 +1,43 @@
1
+ const {authorizationHeaders} = require("./../endpoints_helpers.js");
2
+
3
+ function fallbackCodesFactory({client, internalAuthTokenProvider}) {
4
+ function all({token, jwtToken, query = {}, headers}) {
5
+ return client.get("/fallback-codes", {
6
+ params: query,
7
+ headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
8
+ });
9
+ }
10
+
11
+ function get({token, id, headers}) {
12
+ return client.get(`/fallback-code/${id}`, {
13
+ headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
14
+ });
15
+ }
16
+
17
+ function create({token, jwtToken, fallbackCode, headers}) {
18
+ return client({
19
+ url: "/fallback-codes",
20
+ method: "post",
21
+ headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
22
+ data: {fallbackCode}
23
+ });
24
+ }
25
+
26
+ function update({token, jwtToken, fallbackCodeId, fallbackCode, headers}) {
27
+ return client({
28
+ url: `/fallback-code/${fallbackCodeId}`,
29
+ method: "put",
30
+ headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
31
+ data: {fallbackCode}
32
+ });
33
+ }
34
+
35
+ return {
36
+ all,
37
+ get,
38
+ create,
39
+ update
40
+ };
41
+ }
42
+
43
+ module.exports = fallbackCodesFactory;
@@ -1,19 +1,26 @@
1
- const { authorizationHeaders } = require("./../endpoints_helpers");
1
+ const {authorizationHeaders} = require("./../endpoints_helpers.js");
2
2
 
3
- function filteredTripsFactory({ client, internalAuthTokenProvider }) {
4
-
5
- function create({ token, jwtToken, tripSegmentsId, headers }) {
6
- return client({
3
+ function filteredTripsFactory({client, internalAuthTokenProvider}) {
4
+ function all({token, jwtToken, query = {}, headers}) {
5
+ return client.get("/filtered-trips", {
6
+ params: query,
7
+ headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
8
+ });
9
+ }
10
+
11
+ function create({token, jwtToken, tripSegmentsId, headers}) {
12
+ return client({
7
13
  url: "/filtered-trips",
8
14
  method: "post",
9
15
  headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
10
- data: { tripSegmentsId }
16
+ data: {tripSegmentsId}
11
17
  });
12
18
  }
13
19
 
14
- return {
20
+ return {
21
+ all,
15
22
  create
16
23
  };
17
24
  }
18
25
 
19
- module.exports = filteredTripsFactory;
26
+ module.exports = filteredTripsFactory;
@@ -1,4 +1,4 @@
1
- const {authorizationHeaders} = require("./../endpoints_helpers");
1
+ const {authorizationHeaders} = require("./../endpoints_helpers.js");
2
2
 
3
3
  function productsFactory({client, internalAuthTokenProvider}) {
4
4
  function all({token, query = {}, headers}) {
@@ -36,7 +36,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
36
36
  }
37
37
 
38
38
  const domains = {
39
- remove: ({token, jwtToken, domain, headers}) =>{
39
+ remove: ({token, jwtToken, domain, headers}) => {
40
40
  return client({
41
41
  url: `/products/domains/${domain}`,
42
42
  method: "delete",
@@ -43,6 +43,16 @@ function notifyTicketFactory({
43
43
  headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
44
44
  });
45
45
  }
46
+ },
47
+ manifest: {
48
+ create({token, jwtToken, data, headers}) {
49
+ return client({
50
+ url: "/notify-manifest",
51
+ method: "post",
52
+ data,
53
+ headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
54
+ });
55
+ }
46
56
  }
47
57
  };
48
58
  }
@@ -0,0 +1,56 @@
1
+ const {axiosMock, expectRequest} = require("./../../test-helpers.js");
2
+ const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
3
+
4
+ describe("inventory/fallback-codes", () => {
5
+ const token = "I owe you a token";
6
+ const jwtToken = "I owe you a JWT token";
7
+
8
+ afterEach(() => {
9
+ axiosMock.reset();
10
+ });
11
+
12
+ it("should list fallback codes", () => {
13
+ axiosMock.onGet("/fallback-codes").reply(expectRequest({statusCode: 200, token}));
14
+ return api.inventory.fallbackCodes.all({token});
15
+ });
16
+
17
+ it("should list fallback codes with query parameters", () => {
18
+ const query = {
19
+ orderBy: "name",
20
+ orderDir: "asc",
21
+ page: 1
22
+ };
23
+ axiosMock.onGet("/fallback-codes", {params: query}).reply(expectRequest({statusCode: 200, token}));
24
+ return api.inventory.fallbackCodes.all({token, query});
25
+ });
26
+
27
+ it("should get a fallback code by id", () => {
28
+ const id = "fallbackCodeId1";
29
+ axiosMock.onGet(`/fallback-code/${id}`).reply(expectRequest({statusCode: 200, token}));
30
+ return api.inventory.fallbackCodes.get({token, id});
31
+ });
32
+
33
+ it("should create a fallback code", () => {
34
+ const fallbackCode = {
35
+ name: "newFallbackCode",
36
+ code: "FBC001"
37
+ };
38
+
39
+ axiosMock.onPost("/fallback-codes").reply(expectRequest({statusCode: 200, token, jwtToken}));
40
+ return api.inventory.fallbackCodes.create({
41
+ jwtToken,
42
+ token,
43
+ fallbackCode
44
+ });
45
+ });
46
+
47
+ it("should update a fallback code", () => {
48
+ const fallbackCodeId = "123123123123";
49
+ const fallbackCode = {
50
+ name: "updatedFallbackCode",
51
+ code: "FBC001"
52
+ };
53
+ axiosMock.onPut(`/fallback-code/${fallbackCodeId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
54
+ return api.inventory.fallbackCodes.update({jwtToken, token, fallbackCodeId, fallbackCode});
55
+ });
56
+ });
@@ -1,17 +1,31 @@
1
- const { axiosMock, expectRequest } = require("./../../test-helpers");
2
- const api = require("./../../../src/client").createApiClient({ baseURL: "http://test.com" });
1
+ const {axiosMock, expectRequest} = require("./../../test-helpers.js");
2
+ const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
3
3
 
4
- describe('inventory/filtered-trips', function() {
5
- const token = 'I owe you a token',
6
- jwtToken = 'I owe you a JWT token';
7
-
8
- afterEach(function() {
4
+ describe("inventory/filtered-trips", () => {
5
+ const token = "I owe you a token";
6
+ const jwtToken = "I owe you a JWT token";
7
+
8
+ afterEach(() => {
9
9
  axiosMock.reset();
10
- })
10
+ });
11
11
 
12
- it("should create a filter trip", function() {
13
- axiosMock.onPost(`/filtered-trips`).reply(expectRequest({ statusCode: 200, token, jwtToken }));
14
- return api.inventory.filteredTrips.create({ token, jwtToken, tripSegmentsId: "myTripSegmentId" });
12
+ it("should list filtered trips", () => {
13
+ axiosMock.onGet("/filtered-trips").reply(expectRequest({statusCode: 200, token}));
14
+ return api.inventory.filteredTrips.all({token});
15
15
  });
16
16
 
17
- });
17
+ it("should list filtered trips with query parameters", () => {
18
+ const query = {
19
+ origin: "A",
20
+ destination: "B",
21
+ productId: "product123"
22
+ };
23
+ axiosMock.onGet("/filtered-trips", {params: query}).reply(expectRequest({statusCode: 200, token}));
24
+ return api.inventory.filteredTrips.all({token, query});
25
+ });
26
+
27
+ it("should create a filter trip", () => {
28
+ axiosMock.onPost("/filtered-trips").reply(expectRequest({statusCode: 200, token, jwtToken}));
29
+ return api.inventory.filteredTrips.create({token, jwtToken, tripSegmentsId: "myTripSegmentId"});
30
+ });
31
+ });
@@ -75,3 +75,28 @@ describe("notifications/notify-child-user", () => {
75
75
  });
76
76
  });
77
77
  });
78
+
79
+ describe("notifications/notify-manifest", () => {
80
+ const token = "my-api-key";
81
+ const jwtToken = "my-jwt";
82
+
83
+ afterEach(() => {
84
+ axiosMock.reset();
85
+ });
86
+
87
+ it("should post a notification for manifest", () => {
88
+ axiosMock.onPost("/notify-manifest").reply(({headers}) => {
89
+ if (headers["x-api-key"] === token && headers.authorization === `Bearer ${jwtToken}`) {
90
+ return [200];
91
+ }
92
+ return [403];
93
+ });
94
+
95
+ return api.notifications.notify.manifest.create({
96
+ token,
97
+ jwtToken,
98
+ data: {},
99
+ headers: {}
100
+ });
101
+ });
102
+ });
package/types/client.d.ts CHANGED
@@ -485,6 +485,32 @@ export function createApiClient(options: {
485
485
  };
486
486
  };
487
487
  };
488
+ fallbackCodes: {
489
+ all: ({ token, jwtToken, query, headers }: {
490
+ token: any;
491
+ jwtToken: any;
492
+ query?: {};
493
+ headers: any;
494
+ }) => any;
495
+ get: ({ token, id, headers }: {
496
+ token: any;
497
+ id: any;
498
+ headers: any;
499
+ }) => any;
500
+ create: ({ token, jwtToken, fallbackCode, headers }: {
501
+ token: any;
502
+ jwtToken: any;
503
+ fallbackCode: any;
504
+ headers: any;
505
+ }) => any;
506
+ update: ({ token, jwtToken, fallbackCodeId, fallbackCode, headers }: {
507
+ token: any;
508
+ jwtToken: any;
509
+ fallbackCodeId: any;
510
+ fallbackCode: any;
511
+ headers: any;
512
+ }) => any;
513
+ };
488
514
  fareClasses: {
489
515
  all: ({ token, jwtToken, query, headers }: {
490
516
  token: any;
@@ -574,6 +600,12 @@ export function createApiClient(options: {
574
600
  }) => any;
575
601
  };
576
602
  filteredTrips: {
603
+ all: ({ token, jwtToken, query, headers }: {
604
+ token: any;
605
+ jwtToken: any;
606
+ query?: {};
607
+ headers: any;
608
+ }) => any;
577
609
  create: ({ token, jwtToken, tripSegmentsId, headers }: {
578
610
  token: any;
579
611
  jwtToken: any;
@@ -4452,6 +4484,14 @@ export function createApiClient(options: {
4452
4484
  headers: any;
4453
4485
  }): any;
4454
4486
  };
4487
+ manifest: {
4488
+ create({ token, jwtToken, data, headers }: {
4489
+ token: any;
4490
+ jwtToken: any;
4491
+ data: any;
4492
+ headers: any;
4493
+ }): any;
4494
+ };
4455
4495
  };
4456
4496
  ordersRulesValidations: {
4457
4497
  create: ({ token, jwtToken, query, orderRulesValidation, headers }: {
@@ -0,0 +1,30 @@
1
+ export = fallbackCodesFactory;
2
+ declare function fallbackCodesFactory({ client, internalAuthTokenProvider }: {
3
+ client: any;
4
+ internalAuthTokenProvider: any;
5
+ }): {
6
+ all: ({ token, jwtToken, query, headers }: {
7
+ token: any;
8
+ jwtToken: any;
9
+ query?: {};
10
+ headers: any;
11
+ }) => any;
12
+ get: ({ token, id, headers }: {
13
+ token: any;
14
+ id: any;
15
+ headers: any;
16
+ }) => any;
17
+ create: ({ token, jwtToken, fallbackCode, headers }: {
18
+ token: any;
19
+ jwtToken: any;
20
+ fallbackCode: any;
21
+ headers: any;
22
+ }) => any;
23
+ update: ({ token, jwtToken, fallbackCodeId, fallbackCode, headers }: {
24
+ token: any;
25
+ jwtToken: any;
26
+ fallbackCodeId: any;
27
+ fallbackCode: any;
28
+ headers: any;
29
+ }) => any;
30
+ };
@@ -3,6 +3,12 @@ declare function filteredTripsFactory({ client, internalAuthTokenProvider }: {
3
3
  client: any;
4
4
  internalAuthTokenProvider: any;
5
5
  }): {
6
+ all: ({ token, jwtToken, query, headers }: {
7
+ token: any;
8
+ jwtToken: any;
9
+ query?: {};
10
+ headers: any;
11
+ }) => any;
6
12
  create: ({ token, jwtToken, tripSegmentsId, headers }: {
7
13
  token: any;
8
14
  jwtToken: any;
@@ -32,4 +32,12 @@ declare function notifyTicketFactory({ client, internalAuthTokenProvider }: {
32
32
  headers: any;
33
33
  }): any;
34
34
  };
35
+ manifest: {
36
+ create({ token, jwtToken, data, headers }: {
37
+ token: any;
38
+ jwtToken: any;
39
+ data: any;
40
+ headers: any;
41
+ }): any;
42
+ };
35
43
  };
@@ -439,6 +439,32 @@ declare const _exports: {
439
439
  };
440
440
  };
441
441
  };
442
+ fallbackCodes: {
443
+ all: ({ token, jwtToken, query, headers }: {
444
+ token: any;
445
+ jwtToken: any;
446
+ query?: {};
447
+ headers: any;
448
+ }) => any;
449
+ get: ({ token, id, headers }: {
450
+ token: any;
451
+ id: any;
452
+ headers: any;
453
+ }) => any;
454
+ create: ({ token, jwtToken, fallbackCode, headers }: {
455
+ token: any;
456
+ jwtToken: any;
457
+ fallbackCode: any;
458
+ headers: any;
459
+ }) => any;
460
+ update: ({ token, jwtToken, fallbackCodeId, fallbackCode, headers }: {
461
+ token: any;
462
+ jwtToken: any;
463
+ fallbackCodeId: any;
464
+ fallbackCode: any;
465
+ headers: any;
466
+ }) => any;
467
+ };
442
468
  fareClasses: {
443
469
  all: ({ token, jwtToken, query, headers }: {
444
470
  token: any;
@@ -528,6 +554,12 @@ declare const _exports: {
528
554
  }) => any;
529
555
  };
530
556
  filteredTrips: {
557
+ all: ({ token, jwtToken, query, headers }: {
558
+ token: any;
559
+ jwtToken: any;
560
+ query?: {};
561
+ headers: any;
562
+ }) => any;
531
563
  create: ({ token, jwtToken, tripSegmentsId, headers }: {
532
564
  token: any;
533
565
  jwtToken: any;
@@ -4406,6 +4438,14 @@ declare const _exports: {
4406
4438
  headers: any;
4407
4439
  }): any;
4408
4440
  };
4441
+ manifest: {
4442
+ create({ token, jwtToken, data, headers }: {
4443
+ token: any;
4444
+ jwtToken: any;
4445
+ data: any;
4446
+ headers: any;
4447
+ }): any;
4448
+ };
4409
4449
  };
4410
4450
  ordersRulesValidations: {
4411
4451
  create: ({ token, jwtToken, query, orderRulesValidation, headers }: {