algosdk 1.14.0 → 1.16.0

package/dist/types/src/client/v2/indexer/searchAccounts.d.ts

@@ -1,13 +1,224 @@
 import JSONRequest from '../jsonrequest';
+/**
+ * Returns information about indexed accounts.
+ *
+ * #### Example
+ * ```typescript
+ * const accounts = await indexerClient.searchAccounts().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accounts)
+ * @category GET
+ */
 export default class SearchAccounts extends JSONRequest {
+    /**
+     * @returns `/v2/accounts`
+     */
     path(): string;
+    /**
+     * 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 accounts = await indexerClient
+     *        .searchAccounts()
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const minBalance = 300000;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .assetID(assetID)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     * @remarks
+     * If you are looking for accounts 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: number): 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.
+     *
+     * #### Example 1
+     * ```typescript
+     * const maxBalance = 500000;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const maxBalance = 500000;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .assetID(assetID)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
     currencyLessThan(lesser: number): this;
+    /**
+     * Maximum number of results to return.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit
+     * @category query
+     */
     limit(limit: number): this;
+    /**
+     * Asset ID to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const assetID = 163650;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .assetID(assetID)
+     *        .do();
+     * ```
+     *
+     * @param id
+     * @category query
+     */
     assetID(id: number): this;
+    /**
+     * The next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     *
+     * const accountsPage1 = await indexerClient
+     *        .searchAccounts()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const accountsPage2 = await indexerClient
+     *        .searchAccounts()
+     *        .limit(maxResults)
+     *        .nextToken(accountsPage1["next-token"])
+     *        .do();
+     * ```
+     *
+     * @param nextToken - provided by the previous results
+     * @category query
+     */
     nextToken(nextToken: string): this;
+    /**
+     * Include results for the specified round.
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @remarks For performance reasons, this parameter may be disabled on some configurations.
+     * @param round
+     * @category query
+     */
     round(round: number): this;
+    /**
+     * Include accounts that use this spending key.
+     *
+     * #### Example
+     * ```typescript
+     * const authAddr = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .authAddr(authAddr)
+     *        .do();
+     * ```
+     *
+     * @param authAddr
+     */
     authAddr(authAddr: string): this;
+    /**
+     * Filter for this application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .applicationID(appId)
+     *        .do();
+     * ```
+     *
+     * @param applicationID
+     * @category query
+     */
     applicationID(applicationID: number): this;
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const assetId = 163650;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetId = 163650;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value?: boolean): this;
+    /**
+     * 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 accounts = await indexerClient
+     *        .searchAccounts()
+     *        .exclude("all")
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .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: string): this;
 }

package/dist/types/src/client/v2/indexer/searchForApplications.d.ts

@@ -1,8 +1,110 @@
 import JSONRequest from '../jsonrequest';
+/**
+ * Returns information about indexed applications.
+ *
+ * #### Example
+ * ```typescript
+ * const apps = await indexerClient.searchForApplications().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applications)
+ * @category GET
+ */
 export default class SearchForApplications extends JSONRequest {
+    /**
+     * @returns `/v2/applications`
+     */
     path(): string;
+    /**
+     * Application ID for filter, as int
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .index(appId)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupApplications(appId).do()`
+     * @param index
+     * @category query
+     */
     index(index: number): this;
+    /**
+     * Creator for filter, as string
+     *
+     * #### Example
+     * ```typescript
+     * const creator = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .creator(creator)
+     *        .do();
+     * ```
+     * @param creator
+     * @category query
+     */
+    creator(creator: string): this;
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     *
+     * const appsPage1 = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const appsPage2 = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .nextToken(appsPage1["next-token"])
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(next: string): this;
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
     limit(limit: number): this;
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value?: boolean): this;
 }

package/dist/types/src/client/v2/indexer/searchForAssets.d.ts

@@ -1,11 +1,143 @@
 import JSONRequest from '../jsonrequest';
+/**
+ * Returns information about indexed assets.
+ *
+ * #### Example
+ * ```typescript
+ * const assets = await indexerClient.searchForAssets().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assets)
+ * @category GET
+ */
 export default class SearchForAssets extends JSONRequest {
+    /**
+     * @returns `/v2/assets`
+     */
     path(): string;
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
     limit(limit: number): this;
+    /**
+     * Filter just assets with the given creator address.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .creator(address)
+     *        .do();
+     * ```
+     *
+     * @param creator
+     * @category query
+     */
     creator(creator: string): this;
+    /**
+     * Filter just assets with the given name.
+     *
+     * #### Example
+     * ```typescript
+     * const name = "Test Token";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .name(name)
+     *        .do();
+     * ```
+     *
+     * @param name
+     * @category query
+     */
     name(name: string): this;
+    /**
+     * Filter just assets with the given unit.
+     *
+     * #### Example
+     * ```typescript
+     * const unit = "test";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .unit(unit)
+     *        .do();
+     * ```
+     *
+     * @param unit
+     * @category query
+     */
     unit(unit: string): this;
+    /**
+     * Asset ID for filter, as int.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .index(assetId)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupAssetByID(assetId).do();`
+     * @param index
+     * @category query
+     */
     index(index: number): this;
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     *
+     * const assetsPage1 = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const assetsPage2 = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .nextToken(assetsPage1["next-token"])
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(nextToken: string): this;
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value?: boolean): this;
 }