algosdk 1.14.0-beta.1 → 1.14.0

package/dist/cjs/src/client/client.js

@@ -62,30 +62,6 @@ function getAcceptFormat(query) {
     else
         return 'application/json';
 }
-/**
- * Check is a response is JSON or not
- * Inspired from superagent code
- */
-function isResponseJSON(res) {
-    let contentType = tolowerCaseKeys(res.headers)['content-type'];
-    if (contentType) {
-        /* eslint-disable prefer-destructuring */
-        contentType = contentType.split(';')[0];
-        /* eslint-enable prefer-destructuring */
-    }
-    // regex should match /json or +json
-    // but not /json-seq
-    // from https://github.com/visionmedia/superagent/blob/048cf185d954028b1dccde0717d2488b2284c297/src/client.js#L276
-    return /[/+]json($|[^-\w])/i.test(contentType);
-}
-/**
- * Check is a response is text
- * Inspired from superagent code
- */
-function isResponseText(res) {
-    const contentType = tolowerCaseKeys(res.headers)['content-type'] || 'text/plain';
-    return /^\w*text\//i.test(contentType);
-}
 /**
  * HTTPClient is a wrapper around a BaseHTTPClient
  * It takes care of setting the proper "Accept" header and of
@@ -104,9 +80,9 @@ class HTTPClient {
      * Parse JSON using either the built-in JSON.parse or utils.parseJSON
      * depending on whether jsonOptions are provided or not
      *
-     * @param text JSON data
-     * @param status Status of the response (used in case parseJSON fails)
-     * @param jsonOptions Options object to use to decode JSON responses. See
+     * @param text - JSON data
+     * @param status - Status of the response (used in case parseJSON fails)
+     * @param jsonOptions - Options object to use to decode JSON responses. See
      *   utils.parseJSON for the options available.
      */
     static parseJSON(text, status, jsonOptions = {}) {
@@ -153,15 +129,14 @@ class HTTPClient {
      * Parse the body in
      * Modifies in place res and return the result
      */
-    static prepareResponse(res, jsonOptions = {}) {
+    static prepareResponse(res, format, jsonOptions = {}) {
         let { body } = res;
         let text;
-        if (isResponseJSON(res)) {
-            text = (body && new TextDecoder().decode(body)) || '';
-            body = HTTPClient.parseJSON(text, res.status, jsonOptions);
+        if (format !== 'application/msgpack') {
+            text = (body && Buffer.from(body).toString()) || '';
         }
-        else if (isResponseText(res)) {
-            text = (body && new TextDecoder().decode(body)) || '';
+        if (format === 'application/json') {
+            body = HTTPClient.parseJSON(text, res.status, jsonOptions);
         }
         return {
             ...res,
@@ -179,7 +154,7 @@ class HTTPClient {
     static prepareResponseError(err) {
         if (err.response) {
             // eslint-disable-next-line no-param-reassign
-            err.response = HTTPClient.prepareResponse(err.response);
+            err.response = HTTPClient.prepareResponse(err.response, 'application/json');
             // eslint-disable-next-line no-param-reassign
             err.status = err.response.status;
         }
@@ -187,10 +162,10 @@ class HTTPClient {
     }
     /**
      * Send a GET request.
-     * @param {string} relativePath The path of the request.
-     * @param {object} query An object containing the query paramters of the request.
-     * @param {object} requestHeaders An object containing additional request headers to use.
-     * @param {object} jsonOptions Options object to use to decode JSON responses. See
+     * @param relativePath - The path of the request.
+     * @param query - An object containing the query parameters of the request.
+     * @param requestHeaders - An object containing additional request headers to use.
+     * @param jsonOptions - Options object to use to decode JSON responses. See
      *   utils.parseJSON for the options available.
      * @returns Response object.
      */
@@ -199,7 +174,7 @@ class HTTPClient {
         const fullHeaders = { ...requestHeaders, accept: format };
         try {
             const res = await this.bc.get(relativePath, removeFalsyOrEmpty(query), fullHeaders);
-            return HTTPClient.prepareResponse(res, jsonOptions);
+            return HTTPClient.prepareResponse(res, format, jsonOptions);
         }
         catch (err) {
             throw HTTPClient.prepareResponseError(err);
@@ -217,7 +192,7 @@ class HTTPClient {
         };
         try {
             const res = await this.bc.post(relativePath, HTTPClient.serializeData(data, fullHeaders), undefined, fullHeaders);
-            return HTTPClient.prepareResponse(res);
+            return HTTPClient.prepareResponse(res, 'application/json');
         }
         catch (err) {
             throw HTTPClient.prepareResponseError(err);
@@ -234,7 +209,7 @@ class HTTPClient {
             ...tolowerCaseKeys(requestHeaders),
         };
         const res = await this.bc.delete(relativePath, HTTPClient.serializeData(data, fullHeaders), undefined, fullHeaders);
-        return HTTPClient.prepareResponse(res);
+        return HTTPClient.prepareResponse(res, 'application/json');
     }
 }
 exports.default = HTTPClient;

package/dist/cjs/src/client/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/client/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,sDAAwC;AAMxC,qEAA+E;AAe/E;;GAEG;AACH,SAAS,kBAAkB,CAAC,GAAwB;IAClD,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;QACrB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;YAClD,6CAA6C;YAC7C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;SACzD;KACF;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,CAAS;IAChC,oEAAoE;IACpE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7E,mEAAmE;AACrE,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CACtB,KAAiC;IAEjC,IACE,KAAK,KAAK,SAAS;QACnB,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EACrD;QACA,QAAQ,KAAK,CAAC,MAAM,EAAE;YACpB,KAAK,SAAS;gBACZ,OAAO,qBAAqB,CAAC;YAC/B,KAAK,MAAM,CAAC;YACZ;gBACE,OAAO,kBAAkB,CAAC;SAC7B;KACF;;QAAM,OAAO,kBAAkB,CAAC;AACnC,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,GAA2B;IACjD,IAAI,WAAW,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,CAAC;IAC/D,IAAI,WAAW,EAAE;QACf,yCAAyC;QACzC,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,wCAAwC;KACzC;IACD,oCAAoC;IACpC,oBAAoB;IACpB,kHAAkH;IAClH,OAAO,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,GAA2B;IACjD,MAAM,WAAW,GACf,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,IAAI,YAAY,CAAC;IAC/D,OAAO,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAqB,UAAU;IAkB7B,YACE,eAA6C,EAC7C,UAAmB,EACnB,IAAsB,EACtB,iBAAyC,EAAE;QAE3C,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,EAAE,GAAG,IAAI,+CAAsB,CAClC,eAA8B,EAC9B,UAAU,EACV,IAAI,EACJ,cAAc,CACf,CAAC;SACH;aAAM;YACL,IAAI,CAAC,EAAE,GAAG,eAAiC,CAAC;SAC7C;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,SAAS,CACrB,IAAY,EACZ,MAAc,EACd,cAAiC,EAAE;QAEnC,IAAI;YACF,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzC,OAAO,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aACjC;YACD,OAAO,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;SACnD;QAAC,OAAO,IAAI,EAAE;YACb,MAAM,GAAG,GAA4B,IAAI,CAAC;YAC1C,wDAAwD;YACxD,GAAG,CAAC,WAAW,GAAG,IAAI,IAAI,IAAI,CAAC;YAC/B,4DAA4D;YAC5D,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC;YACxB,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,aAAa,CAC1B,IAAY,EACZ,cAAsC;QAEtC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAmB;SAC9C;QACD,IAAI,cAAc,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE;YACzD,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAC1D;QACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1C;QACD,IAAI,IAAI,YAAY,UAAU,EAAE;YAC9B,OAAO,IAAI,CAAC;SACb;QACD,MAAM,IAAI,KAAK,CACb,6FAA6F,CAC9F,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,eAAe,CAC5B,GAA2B,EAC3B,cAAiC,EAAE;QAEnC,IAAI,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;QACnB,IAAI,IAAI,CAAC;QACT,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE;YACvB,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;YACtD,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;SAC5D;aAAM,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE;YAC9B,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;SACvD;QAED,OAAO;YACL,GAAG,GAAG;YACN,IAAI;YACJ,IAAI;YACJ,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC;SACvC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,oBAAoB,CAAC,GAAG;QACrC,IAAI,GAAG,CAAC,QAAQ,EAAE;YAChB,6CAA6C;YAC7C,GAAG,CAAC,QAAQ,GAAG,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxD,6CAA6C;YAC7C,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;SAClC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CACP,YAAoB,EACpB,KAAkB,EAClB,iBAAyC,EAAE,EAC3C,cAAiC,EAAE;QAEnC,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,WAAW,GAAG,EAAE,GAAG,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAE1D,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,GAAG,CAC3B,YAAY,EACZ,kBAAkB,CAAC,KAAK,CAAC,EACzB,WAAW,CACZ,CAAC;YAEF,OAAO,UAAU,CAAC,eAAe,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;SACrD;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,UAAU,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;SAC5C;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,IAAS,EACT,iBAAyC,EAAE;QAE3C,MAAM,WAAW,GAAG;YAClB,cAAc,EAAE,kBAAkB;YAClC,GAAG,eAAe,CAAC,cAAc,CAAC;SACnC,CAAC;QAEF,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAC5B,YAAY,EACZ,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,EAC3C,SAAS,EACT,WAAW,CACZ,CAAC;YAEF,OAAO,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;SACxC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,UAAU,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;SAC5C;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,IAAS,EACT,iBAAyC,EAAE;QAE3C,MAAM,WAAW,GAAG;YAClB,cAAc,EAAE,kBAAkB;YAClC,GAAG,eAAe,CAAC,cAAc,CAAC;SACnC,CAAC;QAEF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAC9B,YAAY,EACZ,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,EAC3C,SAAS,EACT,WAAW,CACZ,CAAC;QAEF,OAAO,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;CACF;AA5ND,6BA4NC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/client/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,sDAAwC;AAMxC,qEAA+E;AAe/E;;GAEG;AACH,SAAS,kBAAkB,CAAC,GAAwB;IAClD,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE;QACrB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE;YAClD,6CAA6C;YAC7C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;SACzD;KACF;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,CAAS;IAChC,oEAAoE;IACpE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7E,mEAAmE;AACrE,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CACtB,KAAiC;IAEjC,IACE,KAAK,KAAK,SAAS;QACnB,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,EACrD;QACA,QAAQ,KAAK,CAAC,MAAM,EAAE;YACpB,KAAK,SAAS;gBACZ,OAAO,qBAAqB,CAAC;YAC/B,KAAK,MAAM,CAAC;YACZ;gBACE,OAAO,kBAAkB,CAAC;SAC7B;KACF;;QAAM,OAAO,kBAAkB,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,MAAqB,UAAU;IAkB7B,YACE,eAA6C,EAC7C,UAAmB,EACnB,IAAsB,EACtB,iBAAyC,EAAE;QAE3C,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,EAAE,GAAG,IAAI,+CAAsB,CAClC,eAA8B,EAC9B,UAAU,EACV,IAAI,EACJ,cAAc,CACf,CAAC;SACH;aAAM;YACL,IAAI,CAAC,EAAE,GAAG,eAAiC,CAAC;SAC7C;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,SAAS,CACrB,IAAY,EACZ,MAAc,EACd,cAAiC,EAAE;QAEnC,IAAI;YACF,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzC,OAAO,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aACjC;YACD,OAAO,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;SACnD;QAAC,OAAO,IAAI,EAAE;YACb,MAAM,GAAG,GAA4B,IAAI,CAAC;YAC1C,wDAAwD;YACxD,GAAG,CAAC,WAAW,GAAG,IAAI,IAAI,IAAI,CAAC;YAC/B,4DAA4D;YAC5D,GAAG,CAAC,UAAU,GAAG,MAAM,CAAC;YACxB,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,aAAa,CAC1B,IAAY,EACZ,cAAsC;QAEtC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAmB;SAC9C;QACD,IAAI,cAAc,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE;YACzD,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SAC1D;QACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1C;QACD,IAAI,IAAI,YAAY,UAAU,EAAE;YAC9B,OAAO,IAAI,CAAC;SACb;QACD,MAAM,IAAI,KAAK,CACb,6FAA6F,CAC9F,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,eAAe,CAC5B,GAA2B,EAC3B,MAAkD,EAClD,cAAiC,EAAE;QAEnC,IAAI,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC;QACnB,IAAI,IAAI,CAAC;QAET,IAAI,MAAM,KAAK,qBAAqB,EAAE;YACpC,IAAI,GAAG,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;SACrD;QAED,IAAI,MAAM,KAAK,kBAAkB,EAAE;YACjC,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;SAC5D;QAED,OAAO;YACL,GAAG,GAAG;YACN,IAAI;YACJ,IAAI;YACJ,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC;SACvC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,oBAAoB,CAAC,GAAG;QACrC,IAAI,GAAG,CAAC,QAAQ,EAAE;YAChB,6CAA6C;YAC7C,GAAG,CAAC,QAAQ,GAAG,UAAU,CAAC,eAAe,CACvC,GAAG,CAAC,QAAQ,EACZ,kBAAkB,CACnB,CAAC;YACF,6CAA6C;YAC7C,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;SAClC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,GAAG,CACP,YAAoB,EACpB,KAAkB,EAClB,iBAAyC,EAAE,EAC3C,cAAiC,EAAE;QAEnC,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,WAAW,GAAG,EAAE,GAAG,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAE1D,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,GAAG,CAC3B,YAAY,EACZ,kBAAkB,CAAC,KAAK,CAAC,EACzB,WAAW,CACZ,CAAC;YAEF,OAAO,UAAU,CAAC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;SAC7D;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,UAAU,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;SAC5C;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,IAAS,EACT,iBAAyC,EAAE;QAE3C,MAAM,WAAW,GAAG;YAClB,cAAc,EAAE,kBAAkB;YAClC,GAAG,eAAe,CAAC,cAAc,CAAC;SACnC,CAAC;QAEF,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAC5B,YAAY,EACZ,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,EAC3C,SAAS,EACT,WAAW,CACZ,CAAC;YAEF,OAAO,UAAU,CAAC,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;SAC5D;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,UAAU,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;SAC5C;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,IAAS,EACT,iBAAyC,EAAE;QAE3C,MAAM,WAAW,GAAG;YAClB,cAAc,EAAE,kBAAkB;YAClC,GAAG,eAAe,CAAC,cAAc,CAAC;SACnC,CAAC;QAEF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAC9B,YAAY,EACZ,UAAU,CAAC,aAAa,CAAC,IAAI,EAAE,WAAW,CAAC,EAC3C,SAAS,EACT,WAAW,CACZ,CAAC;QAEF,OAAO,UAAU,CAAC,eAAe,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;IAC7D,CAAC;CACF;AAlOD,6BAkOC"}

package/dist/cjs/src/client/v2/indexer/lookupAccountTransactions.js

@@ -18,88 +18,353 @@ function base64StringFunnel(data) {
 }
 exports.base64StringFunnel = base64StringFunnel;
 class LookupAccountTransactions extends jsonrequest_1.default {
+    /**
+     * Returns transactions relating to the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient.lookupAccountTransactions(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idtransactions)
+     * @param account - The address of the account.
+     */
     constructor(c, intDecoding, account) {
         super(c, intDecoding);
         this.account = account;
         this.account = account;
     }
+    /**
+     * @returns /v2/accounts/`${account}`/transactions
+     */
     path() {
         return `/v2/accounts/${this.account}/transactions`;
     }
     /**
-     * notePrefix to filter with
+     * Specifies a prefix which must be contained in the note field
+     *
+     * #### Example
+     * ```typescript
+     * const notePrefixBase64Encoded = "Y3JlYXRl";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .notePrefix(notePrefixBase64Encoded)
+     *        .do();
+     * ```
+     *
      * @param prefix - base64 string or uint8array
+     * @category query
      */
     notePrefix(prefix) {
         this.query['note-prefix'] = base64StringFunnel(prefix);
         return this;
     }
-    // txtype to filter with, as string
+    /**
+     * Type of transaction to filter with
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .txType("appl")
+     *        .do();
+     * ```
+     *
+     * @param type - one of “pay”, “keyreg”, “acfg”, “axfer”, “afrz”, "appl"
+     * @category query
+     */
     txType(type) {
         this.query['tx-type'] = type;
         return this;
     }
-    // sigtype to filter with, as string
+    /**
+     * Type of signature to filter with
+     * - sig: Standard
+     * - msig: MultiSig
+     * - lsig: LogicSig
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .sigType("msig")
+     *        .do();
+     * ```
+     *
+     * @param type - one of “sig”, “msig”, “lsig”
+     * @category query
+     */
     sigType(type) {
         this.query['sig-type'] = type;
         return this;
     }
-    // txid to filter with, as string
+    /**
+     * Lookup the specific transaction by ID
+     *
+     * #### Example
+     * ```typescript
+     * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .txid(txId)
+     *        .do();
+     * ```
+     *
+     * @param txid
+     * @category query
+     */
     txid(txid) {
         this.query.txid = txid;
         return this;
     }
-    // round to filter with, as int
+    /**
+     * Include results for the specified round
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     round(round) {
         this.query.round = round;
         return this;
     }
-    // min round to filter with, as int
+    /**
+     * Include results at or after the specified min-round
+     *
+     * #### Example
+     * ```typescript
+     * const minRound = 18309917;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .minRound(minRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     minRound(round) {
         this.query['min-round'] = round;
         return this;
     }
-    // max round to filter with, as int
+    /**
+     * Include results at or before the specified max-round
+     *
+     * #### Example
+     * ```typescript
+     * const maxRound = 18309917;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     maxRound(round) {
         this.query['max-round'] = round;
         return this;
     }
-    // asset ID to filter with, as int
+    /**
+     * Asset ID to filter with
+     *
+     * #### Example
+     * ```typescript
+     * const assetID = 163650;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .assetID(assetID)
+     *        .do();
+     * ```
+     *
+     * @param id
+     * @category query
+     */
     assetID(id) {
         this.query['asset-id'] = id;
         return this;
     }
-    // limit for filter, as int
+    /**
+     * Maximum number of results to return
+     *
+     * #### Example
+     * ```typescript
+     * const limit = 25;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .limit(limit)
+     *        .do();
+     * ```
+     *
+     * @param limit
+     * @category query
+     */
     limit(limit) {
         this.query.limit = limit;
         return this;
     }
-    // before-time to filter with, as rfc3339 string
+    /**
+     * Include results before the given time
+     *
+     * #### Example
+     * ```typescript
+     * const beforeTime = "2022-02-02T20:20:22.02Z";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .beforeTime(beforeTime)
+     *        .do();
+     * ```
+     *
+     * @param before - rfc3339 string
+     * @category query
+     */
     beforeTime(before) {
         this.query['before-time'] = before;
         return this;
     }
-    // after-time to filter with, as rfc3339 string
+    /**
+     * Include results after the given time
+     *
+     * #### Example
+     * ```typescript
+     * const afterTime = "2022-10-21T00:00:11.55Z";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .afterTime(afterTime)
+     *        .do();
+     * ```
+     *
+     * @param after - rfc3339 string
+     * @category query
+     */
     afterTime(after) {
         this.query['after-time'] = after;
         return this;
     }
-    // filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units
+    /**
+     * Filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
+     *
+     * #### Example 1
+     * ```typescript
+     * const minBalance = 300000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const minBalance = 300000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .assetID(assetID)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     * @remarks
+     * If you are looking for transactions with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount.
+     *
+     * @param greater
+     * @category query
+     */
     currencyGreaterThan(greater) {
         this.query['currency-greater-than'] = greater;
         return this;
     }
-    // filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units
+    /**
+     * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units
+     *
+     * #### Example 1
+     * ```typescript
+     * const maxBalance = 500000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const maxBalance = 500000;
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .assetID(assetID)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
     currencyLessThan(lesser) {
         this.query['currency-less-than'] = lesser;
         return this;
     }
-    // used for pagination
+    /**
+     * The next page of results. Use the next token provided by the previous results.
+     *
+     * #### Example
+     * ```typescript
+     * const limit = 25;
+     * const nextToken = "the next token returned in the previous query response";
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .limit(limit)
+     *        .nextToken(nextToken)
+     *        .do();
+     * ```
+     *
+     * @param nextToken
+     * @category query
+     */
     nextToken(nextToken) {
         this.query.next = nextToken;
         return this;
     }
-    // whether or not to include rekeying transactions
+    /**
+     * Include results which include the rekey-to field
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountTxns = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .rekeyTo(false)
+     *        .do();
+     * ```
+     *
+     * @param rekeyTo
+     * @category query
+     */
     rekeyTo(rekeyTo) {
         this.query['rekey-to'] = rekeyTo;
         return this;

package/dist/cjs/src/client/v2/indexer/lookupAccountTransactions.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupAccountTransactions.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountTransactions.ts"],"names":[],"mappings":";;;;;;AAAA,iEAAyC;AAIzC;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,IAAyB;IAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,OAAO,IAAI,CAAC;KACb;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC;AALD,gDAKC;AAED,MAAqB,yBAA0B,SAAQ,qBAAW;IAChE,YACE,CAAa,EACb,WAAwB,EAChB,OAAe;QAEvB,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAFd,YAAO,GAAP,OAAO,CAAQ;QAGvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,IAAI;QACF,OAAO,gBAAgB,IAAI,CAAC,OAAO,eAAe,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,MAA2B;QACpC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mCAAmC;IACnC,MAAM,CAAC,IAAY;QACjB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oCAAoC;IACpC,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iCAAiC;IACjC,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mCAAmC;IACnC,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mCAAmC;IACnC,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kCAAkC;IAClC,OAAO,CAAC,EAAU;QAChB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gDAAgD;IAChD,UAAU,CAAC,MAAc;QACvB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+CAA+C;IAC/C,SAAS,CAAC,KAAa;QACrB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gLAAgL;IAChL,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6KAA6K;IAC7K,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sBAAsB;IACtB,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAClD,OAAO,CAAC,OAAgB;QACtB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA1GD,4CA0GC"}
+{"version":3,"file":"lookupAccountTransactions.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountTransactions.ts"],"names":[],"mappings":";;;;;;AAAA,iEAAyC;AAIzC;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,IAAyB;IAC1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,OAAO,IAAI,CAAC;KACb;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC;AALD,gDAKC;AAED,MAAqB,yBAA0B,SAAQ,qBAAW;IAChE;;;;;;;;;;;OAWG;IACH,YACE,CAAa,EACb,WAAwB,EAChB,OAAe;QAEvB,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAFd,YAAO,GAAP,OAAO,CAAQ;QAGvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,OAAO,gBAAgB,IAAI,CAAC,OAAO,eAAe,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,MAA2B;QACpC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAY;QACjB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,EAAU;QAChB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,MAAc;QACvB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,KAAa;QACrB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAAgB;QACtB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAnXD,4CAmXC"}

package/dist/cjs/src/client/v2/indexer/lookupAssetByID.js

@@ -5,15 +5,51 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonrequest_1 = __importDefault(require("../jsonrequest"));
 class LookupAssetByID extends jsonrequest_1.default {
+    /**
+     * Returns asset information of the queried asset.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assetInfo = await indexerClient.lookupAssetByID(assetId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assetsasset-id)
+     * @param index - The asset ID to look up.
+     */
     constructor(c, intDecoding, index) {
         super(c, intDecoding);
         this.index = index;
         this.index = index;
     }
+    /**
+     * @returns `/v2/assets/${index}`
+     */
     path() {
         return `/v2/assets/${this.index}`;
     }
-    // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const assetInfo = await indexerClient
+     *        .lookupAssetByID(assetId)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetInfo = await indexerClient
+     *        .lookupAssetByID(assetId)
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value = true) {
         this.query['include-all'] = value;
         return this;

package/dist/cjs/src/client/v2/indexer/lookupAssetByID.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupAssetByID.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetByID.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAIzC,MAAqB,eAAgB,SAAQ,qBAAW;IACtD,YAAY,CAAa,EAAE,WAAwB,EAAU,KAAa;QACxE,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QADqC,UAAK,GAAL,KAAK,CAAQ;QAExE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED,wJAAwJ;IACxJ,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAfD,kCAeC"}
+{"version":3,"file":"lookupAssetByID.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetByID.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAIzC,MAAqB,eAAgB,SAAQ,qBAAW;IACtD;;;;;;;;;;;OAWG;IACH,YAAY,CAAa,EAAE,WAAwB,EAAU,KAAa;QACxE,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QADqC,UAAK,GAAL,KAAK,CAAQ;QAExE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAnDD,kCAmDC"}

package/dist/cjs/src/client/v2/jsonrequest.js

@@ -29,6 +29,7 @@ class JSONRequest {
      * Use this method to change and restructure response
      * data as needed after receiving it from the `do()` method.
      * @param body - Response body received
+     * @category JSONRequest
      */
     // eslint-disable-next-line class-methods-use-this
     prepare(body) {
@@ -38,6 +39,7 @@ class JSONRequest {
      * Execute the request.
      * @param headers - Additional headers to send in the request. Optional.
      * @returns A promise which resolves to the response data.
+     * @category JSONRequest
      */
     async do(headers = {}) {
         const jsonOptions = {};
@@ -61,6 +63,7 @@ class JSONRequest {
      *
      * @param method - The method to use when parsing the
      *   response for this request. Must be one of "default", "safe", "mixed", or "bigint".
+     * @category JSONRequest
      */
     setIntDecoding(method) {
         if (method !== 'default' &&

package/dist/cjs/src/client/v2/jsonrequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"jsonrequest.js","sourceRoot":"","sources":["../../../../../src/client/v2/jsonrequest.ts"],"names":[],"mappings":";;;;;AACA,0EAAkD;AAElD;;;;;;GAMG;AACH,MAA8B,WAAW;IAQvC;;;;;OAKG;IACH,YAAY,MAAkB,EAAE,WAAyB;QACvD,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC;QAChB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,qBAAW,CAAC,OAAO,CAAC;IACxD,CAAC;IAOD;;;;;;OAMG;IACH,kDAAkD;IAClD,OAAO,CAAC,IAAU;QAChB,OAAQ,IAAwB,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,UAA+B,EAAE;QACxC,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAClC,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SAC5C;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,MAAmB;QAChC,IACE,MAAM,KAAK,SAAS;YACpB,MAAM,KAAK,MAAM;YACjB,MAAM,KAAK,OAAO;YAClB,MAAM,KAAK,QAAQ;YAEnB,MAAM,IAAI,KAAK,CAAC,oCAAoC,MAAM,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA7ED,8BA6EC"}
+{"version":3,"file":"jsonrequest.js","sourceRoot":"","sources":["../../../../../src/client/v2/jsonrequest.ts"],"names":[],"mappings":";;;;;AACA,0EAAkD;AAElD;;;;;;GAMG;AACH,MAA8B,WAAW;IAQvC;;;;;OAKG;IACH,YAAY,MAAkB,EAAE,WAAyB;QACvD,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC;QAChB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,qBAAW,CAAC,OAAO,CAAC;IACxD,CAAC;IAQD;;;;;;;OAOG;IACH,kDAAkD;IAClD,OAAO,CAAC,IAAU;QAChB,OAAQ,IAAwB,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,UAA+B,EAAE;QACxC,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAClC,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;SAC5C;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,MAAmB;QAChC,IACE,MAAM,KAAK,SAAS;YACpB,MAAM,KAAK,MAAM;YACjB,MAAM,KAAK,OAAO;YAClB,MAAM,KAAK,QAAQ;YAEnB,MAAM,IAAI,KAAK,CAAC,oCAAoC,MAAM,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAjFD,8BAiFC"}