algosdk 1.14.0 → 1.16.0

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

@@ -29,13 +29,13 @@ export default class LookupAccountTransactions extends JSONRequest {
         this.account = account;
     }
     /**
-     * @returns /v2/accounts/`${account}`/transactions
+     * @returns `/v2/accounts/${account}/transactions`
      */
     path() {
         return `/v2/accounts/${this.account}/transactions`;
     }
     /**
-     * Specifies a prefix which must be contained in the note field
+     * Specifies a prefix which must be contained in the note field.
      *
      * #### Example
      * ```typescript
@@ -55,7 +55,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Type of transaction to filter with
+     * Type of transaction to filter with.
      *
      * #### Example
      * ```typescript
@@ -66,7 +66,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      *        .do();
      * ```
      *
-     * @param type - one of “pay”, “keyreg”, “acfg”, “axfer”, “afrz”, "appl"
+     * @param type - one of `pay`, `keyreg`, `acfg`, `axfer`, `afrz`, `appl`
      * @category query
      */
     txType(type) {
@@ -74,7 +74,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Type of signature to filter with
+     * Type of signature to filter with.
      * - sig: Standard
      * - msig: MultiSig
      * - lsig: LogicSig
@@ -88,7 +88,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      *        .do();
      * ```
      *
-     * @param type - one of “sig”, “msig”, “lsig”
+     * @param type - one of `sig`, `msig`, `lsig`
      * @category query
      */
     sigType(type) {
@@ -96,7 +96,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Lookup the specific transaction by ID
+     * Lookup the specific transaction by ID.
      *
      * #### Example
      * ```typescript
@@ -107,7 +107,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      *        .txid(txId)
      *        .do();
      * ```
-     *
+     * @remarks Alternatively, use `indexerClient.lookupTransactionByID(txnId).do()`
      * @param txid
      * @category query
      */
@@ -116,7 +116,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Include results for the specified round
+     * Include results for the specified round.
      *
      * #### Example
      * ```typescript
@@ -136,7 +136,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Include results at or after the specified min-round
+     * Include results at or after the specified min-round.
      *
      * #### Example
      * ```typescript
@@ -156,7 +156,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Include results at or before the specified max-round
+     * Include results at or before the specified max-round.
      *
      * #### Example
      * ```typescript
@@ -176,7 +176,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Asset ID to filter with
+     * Asset ID to filter with.
      *
      * #### Example
      * ```typescript
@@ -196,15 +196,15 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Maximum number of results to return
+     * Maximum number of results to return.
      *
      * #### Example
      * ```typescript
-     * const limit = 25;
+     * const maxResults = 25;
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const accountTxns = await indexerClient
      *        .lookupAccountTransactions(address)
-     *        .limit(limit)
+     *        .limit(maxResults)
      *        .do();
      * ```
      *
@@ -216,7 +216,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Include results before the given time
+     * Include results before the given time.
      *
      * #### Example
      * ```typescript
@@ -236,7 +236,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Include results after the given time
+     * Include results after the given time.
      *
      * #### Example
      * ```typescript
@@ -290,7 +290,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         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
@@ -326,17 +326,22 @@ export default class LookupAccountTransactions extends JSONRequest {
      *
      * #### Example
      * ```typescript
-     * const limit = 25;
-     * const nextToken = "the next token returned in the previous query response";
+     * const maxResults = 25;
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
-     * const accountTxns = await indexerClient
+     *
+     * const accountTxnsPage1 = await indexerClient
+     *        .lookupAccountTransactions(address)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const accountTxnsPage2 = await indexerClient
      *        .lookupAccountTransactions(address)
-     *        .limit(limit)
-     *        .nextToken(nextToken)
+     *        .limit(maxResults)
+     *        .nextToken(accountTxnsPage1["next-token"])
      *        .do();
      * ```
      *
-     * @param nextToken
+     * @param nextToken - provided by the previous results.
      * @category query
      */
     nextToken(nextToken) {
@@ -344,7 +349,7 @@ export default class LookupAccountTransactions extends JSONRequest {
         return this;
     }
     /**
-     * Include results which include the rekey-to field
+     * Whether or not to include rekeying transactions.
      *
      * #### Example
      * ```typescript

package/dist/esm/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,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC;;;;GAIG;AACH,MAAM,UAAU,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;AAED,MAAM,CAAC,OAAO,OAAO,yBAA0B,SAAQ,WAAW;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"}
+{"version":3,"file":"lookupAccountTransactions.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountTransactions.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC;;;;GAIG;AACH,MAAM,UAAU,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;AAED,MAAM,CAAC,OAAO,OAAO,yBAA0B,SAAQ,WAAW;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;;;;;;;;;;;;;;;;;;;;;;OAsBG;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"}

package/dist/esm/src/client/v2/indexer/lookupApplicationLogs.js

@@ -1,39 +1,145 @@
 import JSONRequest from '../jsonrequest';
 export default class LookupApplicationLogs extends JSONRequest {
+    /**
+     * Returns log messages generated by the passed in application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const appLogs = await indexerClient.lookupApplicationLogs(appId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-idlogs)
+     * @param appID - The ID of the application which generated the logs.
+     * @category GET
+     */
     constructor(c, intDecoding, appID) {
         super(c, intDecoding);
         this.appID = appID;
         this.appID = appID;
     }
+    /**
+     * @returns `/v2/applications/${appID}/logs`
+     */
     path() {
         return `/v2/applications/${this.appID}/logs`;
     }
-    /** limit for filter, as int */
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     */
     limit(limit) {
         this.query.limit = limit;
         return this;
     }
-    /** min round to filter with, as int */
+    /**
+     * Include results at or after the specified min-round.
+     *
+     * #### Example
+     * ```typescript
+     * const minRound = 18309917;
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .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 appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .maxRound(maxRound)
+     *        .do();
+     * ```
+     *
+     * @param round
+     * @category query
+     */
     maxRound(round) {
         this.query['max-round'] = round;
         return this;
     }
-    /** used for pagination */
+    /**
+     * The next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     *
+     * const appLogsPage1 = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const appLogsPage2 = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .limit(maxResults)
+     *        .nextToken(appLogsPage1["next-token"])
+     *        .do();
+     * ```
+     *
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(nextToken) {
         this.query.next = nextToken;
         return this;
     }
-    /** only include transactions with this sender address */
+    /**
+     * Only include transactions with this sender address.
+     *
+     * #### Example
+     * ```typescript
+     * const sender = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .sender(sender)
+     *        .do();
+     * ```
+     *
+     * @param senderAddress
+     * @category query
+     */
     sender(senderAddress) {
         this.query['sender-address'] = senderAddress;
         return this;
     }
-    /** txid to filter with, as string */
+    /**
+     * Lookup the specific transaction by ID.
+     *
+     * #### Example
+     * ```typescript
+     * const txId = "MEUOC4RQJB23CQZRFRKYEI6WBO73VTTPST5A7B3S5OKBUY6LFUDA";
+     * const appLogs = await indexerClient
+     *        .lookupApplicationLogs(appId)
+     *        .txid(txId)
+     *        .do();
+     * ```
+     *
+     * @param txid
+     * @category query
+     */
     txid(txid) {
         this.query.txid = txid;
         return this;

package/dist/esm/src/client/v2/indexer/lookupApplicationLogs.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupApplicationLogs.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupApplicationLogs.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,WAAW;IAC5D,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,oBAAoB,IAAI,CAAC,KAAK,OAAO,CAAC;IAC/C,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,uCAAuC;IACvC,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uCAAuC;IACvC,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,0BAA0B;IAC1B,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,yDAAyD;IACzD,MAAM,CAAC,aAAqB;QAC1B,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qCAAqC;IACrC,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"lookupApplicationLogs.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupApplicationLogs.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,WAAW;IAC5D;;;;;;;;;;;;OAYG;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,oBAAoB,IAAI,CAAC,KAAK,OAAO,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,aAAqB;QAC1B,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/esm/src/client/v2/indexer/lookupApplications.js

@@ -1,14 +1,53 @@
 import JSONRequest from '../jsonrequest';
 export default class LookupApplications extends JSONRequest {
+    /**
+     * Returns information about the passed application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const appInfo = await indexerClient.lookupApplications(appId).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applicationsapplication-id)
+     * @param index - The ID of the application to look up.
+     * @category GET
+     */
     constructor(c, intDecoding, index) {
         super(c, intDecoding);
         this.index = index;
         this.index = index;
     }
+    /**
+     * @returns `/v2/applications/${index}`
+     */
     path() {
         return `/v2/applications/${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 appId = 60553466;
+     * const appInfo = await indexerClient
+     *        .lookupApplications(appId)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const appId = 60553466;
+     * const appInfo = await indexerClient
+     *        .lookupApplications(appId)
+     *        .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/esm/src/client/v2/indexer/lookupApplications.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupApplications.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupApplications.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,WAAW;IACzD,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,oBAAoB,IAAI,CAAC,KAAK,EAAE,CAAC;IAC1C,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"}
+{"version":3,"file":"lookupApplications.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupApplications.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,WAAW;IACzD;;;;;;;;;;;;OAYG;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,oBAAoB,IAAI,CAAC,KAAK,EAAE,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/esm/src/client/v2/indexer/lookupAssetBalances.js

@@ -17,11 +17,14 @@ export default class LookupAssetBalances extends JSONRequest {
         this.index = index;
         this.index = index;
     }
+    /**
+     * @returns `/v2/assets/${index}/balances`
+     */
     path() {
         return `/v2/assets/${this.index}/balances`;
     }
     /**
-     * Add a limit for filter.
+     * Limit results for pagination.
      *
      * #### Example
      * ```typescript
@@ -34,29 +37,12 @@ export default class LookupAssetBalances extends JSONRequest {
      * ```
      *
      * @param limit - maximum number of results to return.
+     * @category query
      */
     limit(limit) {
         this.query.limit = limit;
         return this;
     }
-    /**
-     * Specify round to filter with.
-     *
-     * #### Example
-     * ```typescript
-     * const assetId = 163650;
-     * const targetBlock = 18309917;
-     * const assetBalances = await indexerClient
-     *        .lookupAssetBalances(assetId)
-     *        .round(targetBlock)
-     *        .do();
-     * ```
-     * @param round
-     */
-    round(round) {
-        this.query.round = round;
-        return this;
-    }
     /**
      * Filtered results should have an asset balance greater than this value.
      *
@@ -70,6 +56,7 @@ export default class LookupAssetBalances extends JSONRequest {
      *        .do();
      * ```
      * @param greater
+     * @category query
      */
     currencyGreaterThan(greater) {
         this.query['currency-greater-than'] = greater;
@@ -88,6 +75,7 @@ export default class LookupAssetBalances extends JSONRequest {
      *        .do();
      * ```
      * @param lesser
+     * @category query
      */
     currencyLessThan(lesser) {
         this.query['currency-less-than'] = lesser;
@@ -100,23 +88,29 @@ export default class LookupAssetBalances extends JSONRequest {
      * ```typescript
      * const assetId = 163650;
      * const maxResults = 20;
-     * const nextToken = "APA6C7C3NCANRPIBUWQOF7WSKLJMK6RPQUVFLLDV4U5WCQE4DEF26D4E3E";
-     * const assetBalances = await indexerClient
+     *
+     * const assetBalancesPage1 = await indexerClient
      *        .lookupAssetBalances(assetId)
      *        .limit(maxResults)
-     *        .next(nextToken)
+     *        .do();
+     *
+     * const assetBalancesPage2 = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .limit(maxResults)
+     *        .nextToken(assetBalancesPage1["next-token"])
      *        .do();
      * ```
      * @param nextToken - provided by the previous results.
+     * @category query
      */
     nextToken(nextToken) {
         this.query.next = nextToken;
         return this;
     }
     /**
-     * Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     * Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates.
      *
-     * #### Example
+     * #### Example 1
      * ```typescript
      * const assetId = 163650;
      * const assetBalances = await indexerClient
@@ -124,7 +118,18 @@ export default class LookupAssetBalances extends JSONRequest {
      *        .includeAll(false)
      *        .do();
      * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetId = 163650;
+     * const assetBalances = await indexerClient
+     *        .lookupAssetBalances(assetId)
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
      * @param value
+     * @category query
      */
     includeAll(value = true) {
         this.query['include-all'] = value;

package/dist/esm/src/client/v2/indexer/lookupAssetBalances.js.map

@@ -1 +1 @@
-{"version":3,"file":"lookupAssetBalances.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetBalances.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,WAAW;IAC1D;;;;;;;;;;;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,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,WAAW,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"lookupAssetBalances.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetBalances.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,WAAW;IAC1D;;;;;;;;;;;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,WAAW,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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

@@ -28,6 +28,7 @@ export default class LookupAssetByID extends JSONRequest {
      *
      * #### Example 1
      * ```typescript
+     * const assetId = 163650;
      * const assetInfo = await indexerClient
      *        .lookupAssetByID(assetId)
      *        .includeAll(false)
@@ -36,6 +37,7 @@ export default class LookupAssetByID extends JSONRequest {
      *
      * #### Example 2
      * ```typescript
+     * const assetId = 163650;
      * const assetInfo = await indexerClient
      *        .lookupAssetByID(assetId)
      *        .includeAll()

package/dist/esm/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,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,WAAW;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"}
+{"version":3,"file":"lookupAssetByID.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAssetByID.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,WAAW;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;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}