Merge pull request #144 from starkbank/feature/add-pdf-deposit

Add pdf on reversed deposit log

Author: paulo-stark

CHANGELOG.md

@@ -13,6 +13,8 @@ Given a version number MAJOR.MINOR.PATCH, increment:
 
 
 ## [Unreleased]
+### Added
+- PDF method for DepositLog resource
 
 ## [2.31.0] - 2025-03-27
 ### Added

sdk/deposit/log/index.js

@@ -1,6 +1,7 @@
 const log = require('./log.js');
 
 exports.get = log.get;
+exports.pdf = log.pdf;
 exports.query = log.query;
 exports.page = log.page;
-exports.Log = log.Log;
+exports.Log = log.Log;

sdk/deposit/log/log.js

@@ -115,3 +115,24 @@ exports.page = async function ({ cursor, limit, after, before, types, depositIds
     };
     return rest.getPage(resource, query, user);
 };
+
+exports.pdf = async function (id, {user} = {}) {
+  /**
+   *
+   * Retrieve a specific reversal receipt pdf file
+   *
+   * @description Whenever a Deposit is successfully reversed, a reversed log will be created. To retrieve a specific reversal receipt, you can request the corresponding log PDF.
+   *
+   * Parameters (required):
+   * @param id [string]: object unique id. ex: '5656565656565656'
+   *
+   * Parameters (optional):
+
+   * @param user [Project object]: Project object. Not necessary if starkbank.user was set before function call
+   *
+   * Return:
+   * @returns Reversed deposit log pdf file
+   *
+   */
+  return rest.getContent(resource, id, user, null, 'pdf');
+};

tests/testDepositLog.js

@@ -49,3 +49,28 @@ describe('TestDepositLogGetPage', function () {
         assert(ids.length == 10);
     });
 });
+
+describe('TestDepositLogGet', function(){
+    this.timeout(10000);
+    it('test_success', async () => {
+        let i = 0;
+        const logs = await starkbank.deposit.log.query({limit: 150});
+        for await (let log of logs) {
+            assert(typeof log.id == 'string');
+            i += 1;
+        }
+        assert(i === 150);
+    });
+});
+
+describe('TestDepositPdfGet', function(){
+    this.timeout(10000);
+    it('test_success', async () => {
+        let deposits = await starkbank.deposit.log.query({limit: 1, types: 'reversed'});
+        for await (let deposit of deposits) {
+            let pdf = await starkbank.deposit.log.pdf(deposit.id);
+            const pdfSignature = pdf.toString('utf8', 0, 5);
+            assert(pdfSignature === '%PDF-');
+        }
+    });
+});