algosdk 1.15.0 → 1.18.0

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

@@ -1,10 +1,26 @@
 import JSONRequest from '../jsonrequest';
 export default class LookupAccountAppLocalStates extends JSONRequest {
+    /**
+     * Returns application local state about the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountAppLocalStates = await indexerClient.lookupAccountAppLocalStates(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idapps-local-state)
+     * @param account - The address of the account to look up.
+     * @category GET
+     */
     constructor(c, intDecoding, account) {
         super(c, intDecoding);
         this.account = account;
         this.account = account;
     }
+    /**
+     * @returns `/v2/accounts/${account}/apps-local-state`
+     */
     path() {
         return `/v2/accounts/${this.account}/apps-local-state`;
     }
@@ -22,6 +38,7 @@ export default class LookupAccountAppLocalStates extends JSONRequest {
      * ```
      *
      * @param limit - maximum number of results to return.
+     * @category query
      */
     limit(limit) {
         this.query.limit = limit;
@@ -40,6 +57,7 @@ export default class LookupAccountAppLocalStates extends JSONRequest {
      *        .do();
      * ```
      * @param round
+     * @category query
      */
     round(round) {
         this.query.round = round;
@@ -52,11 +70,16 @@ export default class LookupAccountAppLocalStates extends JSONRequest {
      * ```typescript
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const maxResults = 20;
-     * const nextToken = "APA6C7C3NCANRPIBUWQOF7WSKLJMK6RPQUVFLLDV4U5WCQE4DEF26D4E3E";
-     * const accountAssets = await indexerClient
+     *
+     * const accountAssetsPage1 = await indexerClient
+     *        .lookupAccountAppLocalStates(address)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const accountAssetsPage2 = await indexerClient
      *        .lookupAccountAppLocalStates(address)
      *        .limit(maxResults)
-     *        .next(nextToken)
+     *        .next(accountAssetsPage1["next-token"])
      *        .do();
      * ```
      * @param nextToken - provided by the previous results.
@@ -77,13 +100,14 @@ export default class LookupAccountAppLocalStates extends JSONRequest {
      *        .do();
      * ```
      * @param value
+     * @category query
      */
     includeAll(value = true) {
         this.query['include-all'] = value;
         return this;
     }
     /**
-     * Specify an applicationID to search for
+     * Specify an applicationID to search for.
      *
      * #### Example
      * ```typescript
@@ -95,6 +119,7 @@ export default class LookupAccountAppLocalStates extends JSONRequest {
      *        .do();
      * ```
      * @param index - the applicationID
+     * @category query
      */
     applicationID(index) {
         this.query['application-id'] = index;

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

@@ -1 +1 @@
-{"version":3,"file":"lookupAccountAppLocalStates.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountAppLocalStates.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,2BAA4B,SAAQ,WAAW;IAClE,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,mBAAmB,CAAC;IACzD,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;;;;;;;;;;;;;;;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;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,KAAa;QACzB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"lookupAccountAppLocalStates.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountAppLocalStates.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,2BAA4B,SAAQ,WAAW;IAClE;;;;;;;;;;;;OAYG;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,mBAAmB,CAAC;IACzD,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,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,KAAa;QACzB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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

@@ -1,10 +1,26 @@
 import JSONRequest from '../jsonrequest';
 export default class LookupAccountAssets extends JSONRequest {
+    /**
+     * Returns asset about the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountAssets = await indexerClient.lookupAccountAssets(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idassets)
+     * @param account - The address of the account to look up.
+     * @category GET
+     */
     constructor(c, intDecoding, account) {
         super(c, intDecoding);
         this.account = account;
         this.account = account;
     }
+    /**
+     * @returns `/v2/accounts/${account}/assets`
+     */
     path() {
         return `/v2/accounts/${this.account}/assets`;
     }
@@ -22,6 +38,7 @@ export default class LookupAccountAssets extends JSONRequest {
      * ```
      *
      * @param limit - maximum number of results to return.
+     * @category query
      */
     limit(limit) {
         this.query.limit = limit;
@@ -40,6 +57,7 @@ export default class LookupAccountAssets extends JSONRequest {
      *        .do();
      * ```
      * @param round
+     * @category query
      */
     round(round) {
         this.query.round = round;
@@ -52,14 +70,20 @@ export default class LookupAccountAssets extends JSONRequest {
      * ```typescript
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const maxResults = 20;
-     * const nextToken = "APA6C7C3NCANRPIBUWQOF7WSKLJMK6RPQUVFLLDV4U5WCQE4DEF26D4E3E";
-     * const accountAssets = await indexerClient
+     *
+     * const accountAssetsPage1 = await indexerClient
+     *        .lookupAccountAssets(address)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const accountAssetsPage2 = await indexerClient
      *        .lookupAccountAssets(address)
      *        .limit(maxResults)
-     *        .next(nextToken)
+     *        .next(accountAssetsPage1["next-token"])
      *        .do();
      * ```
      * @param nextToken - provided by the previous results.
+     * @category query
      */
     nextToken(nextToken) {
         this.query.next = nextToken;
@@ -77,6 +101,7 @@ export default class LookupAccountAssets extends JSONRequest {
      *        .do();
      * ```
      * @param value
+     * @category query
      */
     includeAll(value = true) {
         this.query['include-all'] = value;
@@ -95,6 +120,7 @@ export default class LookupAccountAssets extends JSONRequest {
      *        .do();
      * ```
      * @param index - the assetID
+     * @category query
      */
     assetId(index) {
         this.query['asset-id'] = index;

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

@@ -1 +1 @@
-{"version":3,"file":"lookupAccountAssets.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountAssets.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,WAAW;IAC1D,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,SAAS,CAAC;IAC/C,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;;;;;;;;;;;;;;;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;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"lookupAccountAssets.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountAssets.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,WAAW;IAC1D;;;;;;;;;;;;OAYG;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,SAAS,CAAC;IAC/C,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,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,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;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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

@@ -1,24 +1,97 @@
 import JSONRequest from '../jsonrequest';
 export default class LookupAccountByID extends JSONRequest {
+    /**
+     * Returns information about the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient.lookupAccountByID(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-id)
+     * @param account - The address of the account to look up.
+     * @category GET
+     */
     constructor(c, intDecoding, account) {
         super(c, intDecoding);
         this.account = account;
         this.account = account;
     }
+    /**
+     * @returns `/v2/accounts/${account}`
+     */
     path() {
         return `/v2/accounts/${this.account}`;
     }
-    // specific round to search
+    /**
+     * Specify round to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const targetBlock = 18309917;
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @param round
+     */
     round(round) {
         this.query.round = round;
         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 1
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .includeAll()
+     *        .do();
+     * ```
+     * @param value
+     */
     includeAll(value = true) {
         this.query['include-all'] = value;
         return this;
     }
-    // exclude
+    /**
+     * Exclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.
+     *
+     * #### Example 1
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .exclude("all")
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountInfo = await indexerClient
+     *        .lookupAccountByID(address)
+     *        .exclude("assets,created-assets")
+     *        .do();
+     * ```
+     * @remarks By default, it behaves as exclude=none
+     * @param exclude - Array of `all`, `assets`, `created-assets`, `apps-local-state`, `created-apps`, `none`
+     * @category query
+     */
     exclude(exclude) {
         this.query.exclude = exclude;
         return this;

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

@@ -1 +1 @@
-{"version":3,"file":"lookupAccountByID.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountByID.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,WAAW;IACxD,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;IACxC,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,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;IAED,UAAU;IACV,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"lookupAccountByID.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountByID.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,WAAW;IACxD;;;;;;;;;;;;OAYG;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;IACxC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,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;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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

@@ -1,10 +1,26 @@
 import JSONRequest from '../jsonrequest';
 export default class LookupAccountCreatedApplications extends JSONRequest {
+    /**
+     * Returns application information created by the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountCreatedApps = await indexerClient.lookupAccountCreatedApplications(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idcreated-applications)
+     * @param account - The address of the account to look up.
+     * @category GET
+     */
     constructor(c, intDecoding, account) {
         super(c, intDecoding);
         this.account = account;
         this.account = account;
     }
+    /**
+     * @returns `/v2/accounts/${account}/created-applications`
+     */
     path() {
         return `/v2/accounts/${this.account}/created-applications`;
     }
@@ -22,6 +38,7 @@ export default class LookupAccountCreatedApplications extends JSONRequest {
      * ```
      *
      * @param limit - maximum number of results to return.
+     * @category query
      */
     limit(limit) {
         this.query.limit = limit;
@@ -40,6 +57,7 @@ export default class LookupAccountCreatedApplications extends JSONRequest {
      *        .do();
      * ```
      * @param round
+     * @category query
      */
     round(round) {
         this.query.round = round;
@@ -52,14 +70,20 @@ export default class LookupAccountCreatedApplications extends JSONRequest {
      * ```typescript
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const maxResults = 20;
-     * const nextToken = "APA6C7C3NCANRPIBUWQOF7WSKLJMK6RPQUVFLLDV4U5WCQE4DEF26D4E3E";
-     * const accountAssets = await indexerClient
+     *
+     * const accountAssetsPage1 = await indexerClient
+     *        .lookupAccountCreatedApplications(address)
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const accountAssetsPage2 = await indexerClient
      *        .lookupAccountCreatedApplications(address)
      *        .limit(maxResults)
-     *        .next(nextToken)
+     *        .next(accountAssetsPage1["next-token"])
      *        .do();
      * ```
      * @param nextToken - provided by the previous results.
+     * @category query
      */
     nextToken(nextToken) {
         this.query.next = nextToken;
@@ -77,13 +101,14 @@ export default class LookupAccountCreatedApplications extends JSONRequest {
      *        .do();
      * ```
      * @param value
+     * @category query
      */
     includeAll(value = true) {
         this.query['include-all'] = value;
         return this;
     }
     /**
-     * Specify an applicationID to search for
+     * Specify an applicationID to search for.
      *
      * #### Example
      * ```typescript
@@ -95,6 +120,7 @@ export default class LookupAccountCreatedApplications extends JSONRequest {
      *        .do();
      * ```
      * @param index - the applicationID
+     * @category query
      */
     applicationID(index) {
         this.query['application-id'] = index;

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

@@ -1 +1 @@
-{"version":3,"file":"lookupAccountCreatedApplications.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountCreatedApplications.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,gCAAiC,SAAQ,WAAW;IACvE,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,uBAAuB,CAAC;IAC7D,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;;;;;;;;;;;;;;;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;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,KAAa;QACzB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"lookupAccountCreatedApplications.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountCreatedApplications.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,gCAAiC,SAAQ,WAAW;IACvE;;;;;;;;;;;;OAYG;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,uBAAuB,CAAC;IAC7D,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,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,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;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,KAAa;QACzB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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

@@ -1,10 +1,26 @@
 import JSONRequest from '../jsonrequest';
 export default class LookupAccountCreatedAssets extends JSONRequest {
+    /**
+     * Returns asset information created by the given account.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accountCreatedAssets = await indexerClient.lookupAccountCreatedAssets(address).do();
+     * ```
+     *
+     * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accountsaccount-idcreated-assets)
+     * @param account - The address of the account to look up.
+     * @category GET
+     */
     constructor(c, intDecoding, account) {
         super(c, intDecoding);
         this.account = account;
         this.account = account;
     }
+    /**
+     * @returns `/v2/accounts/${account}/created-assets`
+     */
     path() {
         return `/v2/accounts/${this.account}/created-assets`;
     }
@@ -22,6 +38,7 @@ export default class LookupAccountCreatedAssets extends JSONRequest {
      * ```
      *
      * @param limit - maximum number of results to return.
+     * @category query
      */
     limit(limit) {
         this.query.limit = limit;
@@ -40,6 +57,7 @@ export default class LookupAccountCreatedAssets extends JSONRequest {
      *        .do();
      * ```
      * @param round
+     * @category query
      */
     round(round) {
         this.query.round = round;
@@ -52,14 +70,21 @@ export default class LookupAccountCreatedAssets extends JSONRequest {
      * ```typescript
      * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
      * const maxResults = 20;
-     * const nextToken = "APA6C7C3NCANRPIBUWQOF7WSKLJMK6RPQUVFLLDV4U5WCQE4DEF26D4E3E";
-     * const accountAssets = await indexerClient
+     *
+     * const accountAssetsPage1 = await indexerClient
+     *        .lookupAccountCreatedAssets(address)
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * const accountAssetsPage2 = await indexerClient
      *        .lookupAccountCreatedAssets(address)
      *        .limit(maxResults)
-     *        .next(nextToken)
+     *        .next(accountAssetsPage1["next-token"])
      *        .do();
      * ```
      * @param nextToken - provided by the previous results.
+     * @category query
      */
     nextToken(nextToken) {
         this.query.next = nextToken;
@@ -77,6 +102,7 @@ export default class LookupAccountCreatedAssets extends JSONRequest {
      *        .do();
      * ```
      * @param value
+     * @category query
      */
     includeAll(value = true) {
         this.query['include-all'] = value;
@@ -95,6 +121,7 @@ export default class LookupAccountCreatedAssets extends JSONRequest {
      *        .do();
      * ```
      * @param index - the assetID
+     * @category query
      */
     assetID(index) {
         this.query['asset-id'] = index;

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

@@ -1 +1 @@
-{"version":3,"file":"lookupAccountCreatedAssets.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountCreatedAssets.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,WAAW;IACjE,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,iBAAiB,CAAC;IACvD,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;;;;;;;;;;;;;;;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;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"lookupAccountCreatedAssets.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/lookupAccountCreatedAssets.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,WAAW;IACjE;;;;;;;;;;;;OAYG;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,iBAAiB,CAAC;IACvD,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,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,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;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

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