btrz-api-client 9.3.0 → 9.4.0

package/lib/endpoints/notifications/pdf-data.js

@@ -7,7 +7,7 @@ const {
  * Query params for GET pdf-templates-processing routes (btrz-api-notifications). Client uses type/family to resolve path.
  * @typedef {Object} PdfDataGetQuery
  * @property {string} type - Document type; determines path (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, order_confirmation, cancellation, change, shift, invoice, parcelManifest, startingBalance, partialShiftDeposits, bankDepositSlip, terminalVoucher, manualTickets, etc.). For pre_trip_notification and post_trip_notification the request uses GET /queue-notifications/manifest-notification-data/{itemId}.
- * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle" | "open-return"
  */
 
 /**
@@ -61,6 +61,7 @@ function pdfDataFactory({
           url = `/pdf-flexpasses/${itemId}`;
           break;
         case "bundle":
+        case "open-return":
           url = `/pdf-redeemable-items/${itemId}`;
           break;
         default:

package/lib/endpoints/notifications/pdfs.js

@@ -7,7 +7,7 @@ const {
  * Query params for GET pdf-templates-processing binary routes (btrz-api-notifications). Client uses type/family to resolve path.
  * @typedef {Object} PdfGetQuery
  * @property {string} type - Document type (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, shift, remainderSlip, exchange, invoice, locationClosure, parcelManifest, startingBalance, partialShiftDeposits, shiftLocationClosure, bankDepositSlip, terminalVoucher, manualTickets, externalWalletVoucher)
- * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle" | "open-return"
  */
 
 /**
@@ -63,6 +63,7 @@ function pdfFactory({
           url = `/pdf-flexpasses/${itemId}`;
           break;
         case "bundle":
+        case "open-return":
           url = `/pdf-redeemable-items/${itemId}`;
           break;
         default:

package/package.json

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

package/src/endpoints/notifications/pdf-data.js

@@ -7,7 +7,7 @@ const {
  * Query params for GET pdf-templates-processing routes (btrz-api-notifications). Client uses type/family to resolve path.
  * @typedef {Object} PdfDataGetQuery
  * @property {string} type - Document type; determines path (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, order_confirmation, cancellation, change, shift, invoice, parcelManifest, startingBalance, partialShiftDeposits, bankDepositSlip, terminalVoucher, manualTickets, etc.). For pre_trip_notification and post_trip_notification the request uses GET /queue-notifications/manifest-notification-data/{itemId}.
- * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle" | "open-return"
  */
 
 /**
@@ -61,6 +61,7 @@ function pdfDataFactory({
           url = `/pdf-flexpasses/${itemId}`;
           break;
         case "bundle":
+        case "open-return":
           url = `/pdf-redeemable-items/${itemId}`;
           break;
         default:

package/src/endpoints/notifications/pdfs.js

@@ -7,7 +7,7 @@ const {
  * Query params for GET pdf-templates-processing binary routes (btrz-api-notifications). Client uses type/family to resolve path.
  * @typedef {Object} PdfGetQuery
  * @property {string} type - Document type (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, shift, remainderSlip, exchange, invoice, locationClosure, parcelManifest, startingBalance, partialShiftDeposits, shiftLocationClosure, bankDepositSlip, terminalVoucher, manualTickets, externalWalletVoucher)
- * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle" | "open-return"
  */
 
 /**
@@ -63,6 +63,7 @@ function pdfFactory({
           url = `/pdf-flexpasses/${itemId}`;
           break;
         case "bundle":
+        case "open-return":
           url = `/pdf-redeemable-items/${itemId}`;
           break;
         default:

package/test/endpoints/notifications/pdf-data.test.js

@@ -274,6 +274,21 @@ describe("notifications/pdf-data", () => {
     });
   });
 
+  it("should return the proper data for an open-return redeemableItem", () => {
+    const itemId = "12345";
+    const query = {
+      type: "product",
+      family: "open-return"
+    };
+    axiosMock.onGet(`/pdf-redeemable-items/${itemId}`)
+      .reply(expectRequest({
+        statusCode: 200, token
+      }));
+    return api.notifications.pdfData.get({
+      token, query, itemId
+    });
+  });
+
   it("should return the proper data for a gift-certificates", () => {
     const itemId = "12345";
     const query = {

package/test/endpoints/notifications/pdfs.test.js

@@ -203,6 +203,21 @@ describe("notifications/pdfs", () => {
     });
   });
 
+  it("should return the proper data for an open-return redeemableItem", () => {
+    const itemId = "12345";
+    const query = {
+      type: "product",
+      family: "open-return"
+    };
+    axiosMock.onGet(`/pdf-redeemable-items/${itemId}`)
+      .reply(expectRequest({
+        statusCode: 200, token
+      }));
+    return api.notifications.pdfs.get({
+      token, query, itemId
+    });
+  });
+
   it("should return the proper data for a gift-certificates", () => {
     const itemId = "12345";
     const query = {

package/types/endpoints/notifications/pdf-data.d.ts

@@ -2,7 +2,7 @@ export = pdfDataFactory;
 /**
  * @typedef {Object} PdfDataGetQuery
  * @property {string} type - Document type; determines path. E.g. "product", "giftCertificate", "voucher", "transaction", "ssr", "manifest", "passengersManifest", "order", "order_confirmation", "cancellation", "change", "shift", "invoice", "parcelManifest", "parcel_confirmation", "redeemable_items_confirmation", "sold_item_confirmation", "customer_card_membership", "user_password_reset", "new_account", "operator_manifest_capacity", "reaccomodation", "ticket_movement", "manifest_notification", "startingBalance", "partialShiftDeposits", "shiftLocationClosure", "bankDepositSlip", "terminalVoucher", "manualTickets", etc.
- * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle" | "open-return"
  */
 /**
  * Factory for PDF data (JSON) endpoints (btrz-api-notifications). Resolves URL by query.type (and query.family when type is "product").

package/types/endpoints/notifications/pdfs.d.ts

@@ -2,7 +2,7 @@ export = pdfFactory;
 /**
  * @typedef {Object} PdfGetQuery
  * @property {string} type - Document type: "product" | "giftCertificate" | "voucher" | "transaction" | "ssr" | "manifest" | "passengersManifest" | "order" | "shift" | "remainderSlip" | "exchange" | "invoice" | "locationClosure" | "parcelManifest" | "startingBalance" | "partialShiftDeposits" | "shiftLocationClosure" | "bankDepositSlip" | "terminalVoucher" | "manualTickets"
- * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle" | "open-return"
  */
 /**
  * Factory for PDF binary endpoints (btrz-api-notifications). Resolves URL by query.type (and query.family when type is "product").