btrz-api-client 8.26.0 → 8.27.0

package/lib/endpoints/sales/cancellations.js

@@ -19,6 +19,18 @@ var _require = require("./../endpoints_helpers.js"),
  *      reason: string
  *   }
  * }} CancelSetData
+ *
+ * @typedef {{
+ *   provider: string,
+ *   type: string,
+ *   result: object,
+ *   createdAt: object,
+ *   displayName: string,
+ *   status: string,
+ *   amount: number,
+ *   referenceNumber: string,
+ *   authCode?: string
+ * }} CompletePaymentCancellationData
 */
 
 function cancellationEndpointsFactory(_ref) {
@@ -73,13 +85,39 @@ function cancellationEndpointsFactory(_ref) {
     });
   }
 
+  /**
+   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund).
+   * @param {Object} params
+   * @param {string} params.token Public key
+   * @param {string} params.jwtToken Auth token
+   * @param {string} params.pendingTransactionId Negative transaction id (ObjectId)
+   * @param {CompletePaymentCancellationData} params.paymentResult Payment result for one completed terminal refund
+   * @param {Object} params.headers HTTP Headers
+   * @returns {Promise} Updated negative transaction (with remaining pending payments if any)
+   */
+  function updateCompletePayment(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        pendingTransactionId = _ref4.pendingTransactionId,
+        paymentResult = _ref4.paymentResult,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/cancellations/" + pendingTransactionId,
+      method: "PUT",
+      data: { paymentResult: paymentResult },
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
   return {
     sets: {
       create: createCancelSet
     },
     refunds: {
       create: createRefund
-    }
+    },
+    update: updateCompletePayment
   };
 }
 

package/package.json

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

package/src/endpoints/sales/cancellations.js

@@ -16,6 +16,18 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  *      reason: string
  *   }
  * }} CancelSetData
+ *
+ * @typedef {{
+ *   provider: string,
+ *   type: string,
+ *   result: object,
+ *   createdAt: object,
+ *   displayName: string,
+ *   status: string,
+ *   amount: number,
+ *   referenceNumber: string,
+ *   authCode?: string
+ * }} CompletePaymentCancellationData
 */
 
 function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
@@ -57,13 +69,33 @@ function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund).
+   * @param {Object} params
+   * @param {string} params.token Public key
+   * @param {string} params.jwtToken Auth token
+   * @param {string} params.pendingTransactionId Negative transaction id (ObjectId)
+   * @param {CompletePaymentCancellationData} params.paymentResult Payment result for one completed terminal refund
+   * @param {Object} params.headers HTTP Headers
+   * @returns {Promise} Updated negative transaction (with remaining pending payments if any)
+   */
+  function updateCompletePayment({token, jwtToken, pendingTransactionId, paymentResult, headers}) {
+    return client({
+      url: `/cancellations/${pendingTransactionId}`,
+      method: "PUT",
+      data: {paymentResult},
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
   return {
     sets: {
       create: createCancelSet
     },
     refunds: {
       create: createRefund
-    }
+    },
+    update: updateCompletePayment
   };
 }
 

package/test/endpoints/sales/cancellations.test.js

@@ -47,4 +47,32 @@ describe("sales/cancellations", () => {
       headers: {}
     });
   });
+
+  it("should PUT to update (complete) a pending payment for a cancellation transaction", () => {
+    const pendingTransactionId = "507f1f77bcf86cd799439011";
+    const paymentResult = {
+      provider: "prisma",
+      type: "prisma_terminal",
+      referenceNumber: "ref1",
+      result: {id: "1", paymentStatus: "CONFIRMED"},
+      createdAt: {},
+      displayName: "Prisma Terminal",
+      status: "refunded",
+      amount: 10.5
+    };
+    axiosMock.onPut(`/cancellations/${pendingTransactionId}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: {paymentResult}
+    }));
+
+    return api.sales.cancellations.update({
+      token,
+      jwtToken,
+      pendingTransactionId,
+      paymentResult,
+      headers: {}
+    });
+  });
 });

package/types/client.d.ts

@@ -3789,6 +3789,13 @@ export function createApiClient(options: {
                     headers: any;
                 }) => Promise<any>;
             };
+            update: ({ token, jwtToken, pendingTransactionId, paymentResult, headers }: {
+                token: string;
+                jwtToken: string;
+                pendingTransactionId: string;
+                paymentResult: CompletePaymentCancellationData;
+                headers: any;
+            }) => Promise<any>;
         };
         __test: {
             client: axios.AxiosInstance;

package/types/endpoints/sales/cancellations.d.ts

@@ -15,6 +15,18 @@ export = cancellationEndpointsFactory;
  *      reason: string
  *   }
  * }} CancelSetData
+ *
+ * @typedef {{
+ *   provider: string,
+ *   type: string,
+ *   result: object,
+ *   createdAt: object,
+ *   displayName: string,
+ *   status: string,
+ *   amount: number,
+ *   referenceNumber: string,
+ *   authCode?: string
+ * }} CompletePaymentCancellationData
 */
 declare function cancellationEndpointsFactory({ client, internalAuthTokenProvider }: {
     client: any;
@@ -36,9 +48,16 @@ declare function cancellationEndpointsFactory({ client, internalAuthTokenProvide
             headers: any;
         }) => Promise<any>;
     };
+    update: ({ token, jwtToken, pendingTransactionId, paymentResult, headers }: {
+        token: string;
+        jwtToken: string;
+        pendingTransactionId: string;
+        paymentResult: CompletePaymentCancellationData;
+        headers: any;
+    }) => Promise<any>;
 };
 declare namespace cancellationEndpointsFactory {
-    export { CancelSetData };
+    export { CancelSetData, CompletePaymentCancellationData };
 }
 type CancelSetData = {
     fees: string[];
@@ -55,3 +74,14 @@ type CancelSetData = {
         reason: string;
     };
 };
+type CompletePaymentCancellationData = {
+    provider: string;
+    type: string;
+    result: object;
+    createdAt: object;
+    displayName: string;
+    status: string;
+    amount: number;
+    referenceNumber: string;
+    authCode?: string;
+};

package/types/initializedClient.d.ts

@@ -3743,6 +3743,13 @@ declare const _exports: {
                     headers: any;
                 }) => Promise<any>;
             };
+            update: ({ token, jwtToken, pendingTransactionId, paymentResult, headers }: {
+                token: string;
+                jwtToken: string;
+                pendingTransactionId: string;
+                paymentResult: CompletePaymentCancellationData;
+                headers: any;
+            }) => Promise<any>;
         };
         __test: {
             client: import("axios").AxiosInstance;