@stacks/blockchain-api-client 7.12.0 → 7.13.0

package/lib/index.umd.js

@@ -2565,6 +2565,84 @@
 
   /* eslint-disable */
 
+  /**
+   * Stacks Blockchain API
+   * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json)
+   *
+   * The version of the OpenAPI document: STACKS_API_VERSION
+   *
+   *
+   * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+   * https://openapi-generator.tech
+   * Do not edit the class manually.
+   */
+  function FtHolderEntryFromJSON(json) {
+    return FtHolderEntryFromJSONTyped(json);
+  }
+  function FtHolderEntryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+      return json;
+    }
+
+    return {
+      'address': json['address'],
+      'balance': json['balance']
+    };
+  }
+  function FtHolderEntryToJSON(value) {
+    if (value === undefined) {
+      return undefined;
+    }
+
+    if (value === null) {
+      return null;
+    }
+
+    return {
+      'address': value.address,
+      'balance': value.balance
+    };
+  }
+
+  /* tslint:disable */
+  function FungibleTokenHolderListFromJSON(json) {
+    return FungibleTokenHolderListFromJSONTyped(json);
+  }
+  function FungibleTokenHolderListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json === undefined || json === null) {
+      return json;
+    }
+
+    return {
+      'limit': json['limit'],
+      'offset': json['offset'],
+      'total': json['total'],
+      'total_supply': json['total_supply'],
+      'results': json['results'].map(FtHolderEntryFromJSON)
+    };
+  }
+  function FungibleTokenHolderListToJSON(value) {
+    if (value === undefined) {
+      return undefined;
+    }
+
+    if (value === null) {
+      return null;
+    }
+
+    return {
+      'limit': value.limit,
+      'offset': value.offset,
+      'total': value.total,
+      'total_supply': value.total_supply,
+      'results': value.results.map(FtHolderEntryToJSON)
+    };
+  }
+
+  /* tslint:disable */
+
+  /* eslint-disable */
+
   /**
    * Stacks Blockchain API
    * Welcome to the API reference overview for the [Stacks Blockchain API](https://docs.hiro.so/stacks-blockchain-api).  [Download Postman collection](https://hirosystems.github.io/stacks-blockchain-api/collection.json)
@@ -7309,7 +7387,7 @@
       }
     }
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     ;
@@ -7360,7 +7438,7 @@
       }
     }
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     ;
@@ -7445,7 +7523,7 @@
       }
     }
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     ;
@@ -7479,7 +7557,7 @@
       }
     }
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     ;
@@ -8341,6 +8419,68 @@
     return FeesApi;
   }(BaseAPI);
 
+  /**
+   *
+   */
+
+  var FungibleTokensApi = /*#__PURE__*/function (_runtime$BaseAPI) {
+    _inheritsLoose(FungibleTokensApi, _runtime$BaseAPI);
+
+    function FungibleTokensApi() {
+      return _runtime$BaseAPI.apply(this, arguments) || this;
+    }
+
+    var _proto = FungibleTokensApi.prototype;
+
+    /**
+     * Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders.
+     * Fungible token holders
+     */
+    _proto.getFtHoldersRaw = function getFtHoldersRaw(requestParameters, initOverrides) {
+      try {
+        var _this2 = this;
+
+        if (requestParameters.token === null || requestParameters.token === undefined) {
+          throw new RequiredError('token', 'Required parameter requestParameters.token was null or undefined when calling getFtHolders.');
+        }
+
+        var queryParameters = {};
+        var headerParameters = {};
+        return Promise.resolve(_this2.request({
+          path: "/extended/v1/tokens/ft/{token}/holders".replace("{" + "token" + "}", encodeURIComponent(String(requestParameters.token))),
+          method: 'GET',
+          headers: headerParameters,
+          query: queryParameters
+        }, initOverrides)).then(function (response) {
+          return new JSONApiResponse(response, function (jsonValue) {
+            return FungibleTokenHolderListFromJSON(jsonValue);
+          });
+        });
+      } catch (e) {
+        return Promise.reject(e);
+      }
+    }
+    /**
+     * Retrieves the list of Fungible Token holders for a given token ID. Specify `stx` for the `token` parameter to get the list of STX holders.
+     * Fungible token holders
+     */
+    ;
+
+    _proto.getFtHolders = function getFtHolders(requestParameters, initOverrides) {
+      try {
+        var _this4 = this;
+
+        return Promise.resolve(_this4.getFtHoldersRaw(requestParameters, initOverrides)).then(function (response) {
+          return Promise.resolve(response.value());
+        });
+      } catch (e) {
+        return Promise.reject(e);
+      }
+    };
+
+    return FungibleTokensApi;
+  }(BaseAPI);
+
   /**
    *
    */
@@ -17911,6 +18051,13 @@
   exports.FeeRateRequestToJSON = FeeRateRequestToJSON;
   exports.FeeRateToJSON = FeeRateToJSON;
   exports.FeesApi = FeesApi;
+  exports.FtHolderEntryFromJSON = FtHolderEntryFromJSON;
+  exports.FtHolderEntryFromJSONTyped = FtHolderEntryFromJSONTyped;
+  exports.FtHolderEntryToJSON = FtHolderEntryToJSON;
+  exports.FungibleTokenHolderListFromJSON = FungibleTokenHolderListFromJSON;
+  exports.FungibleTokenHolderListFromJSONTyped = FungibleTokenHolderListFromJSONTyped;
+  exports.FungibleTokenHolderListToJSON = FungibleTokenHolderListToJSON;
+  exports.FungibleTokensApi = FungibleTokensApi;
   exports.GetRawTransactionResultFromJSON = GetRawTransactionResultFromJSON;
   exports.GetRawTransactionResultFromJSONTyped = GetRawTransactionResultFromJSONTyped;
   exports.GetRawTransactionResultToJSON = GetRawTransactionResultToJSON;