@stacks/blockchain-api-client 6.0.0-beta.9 → 6.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "6.0.0-beta.9",
+  "version": "6.0.1",
   "access": "public",
   "description": "Client for the Stacks Blockchain API",
   "homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",

package/src/generated/.openapi-generator/FILES

@@ -18,6 +18,8 @@ index.ts
 models/AccountDataResponse.ts
 models/AddressAssetsListResponse.ts
 models/AddressBalanceResponse.ts
+models/AddressNftListResponse.ts
+models/AddressNftListResponseValue.ts
 models/AddressNonces.ts
 models/AddressStxInboundListResponse.ts
 models/AddressTokenOfferingLocked.ts
@@ -71,6 +73,7 @@ models/MicroblockListResponse.ts
 models/NetworkBlockTimeResponse.ts
 models/NetworkBlockTimesResponse.ts
 models/NetworkIdentifier.ts
+models/NftEvent.ts
 models/NonFungibleTokenHistoryEventList.ts
 models/NonFungibleTokenHoldingsList.ts
 models/NonFungibleTokenMetadata.ts

package/src/generated/apis/AccountsApi.ts

@@ -24,6 +24,9 @@ import {
     AddressBalanceResponse,
     AddressBalanceResponseFromJSON,
     AddressBalanceResponseToJSON,
+    AddressNftListResponse,
+    AddressNftListResponseFromJSON,
+    AddressNftListResponseToJSON,
     AddressNonces,
     AddressNoncesFromJSON,
     AddressNoncesToJSON,
@@ -70,6 +73,14 @@ export interface GetAccountInfoRequest {
     tip?: string;
 }
 
+export interface GetAccountNftRequest {
+    principal: string;
+    limit?: number;
+    offset?: number;
+    unanchored?: boolean;
+    untilBlock?: string;
+}
+
 export interface GetAccountNoncesRequest {
     principal: string;
     blockHeight?: number;
@@ -189,6 +200,26 @@ export interface AccountsApiInterface {
      */
     getAccountInfo(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<AccountDataResponse>;
 
+    /**
+     * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings).  Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft. 
+     * @summary Get nft events
+     * @param {string} principal Stacks address or a Contract identifier
+     * @param {number} [limit] number of items to return
+     * @param {number} [offset] number of items to skip
+     * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountsApiInterface
+     */
+    getAccountNftRaw(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNftListResponse>>;
+
+    /**
+     * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings).  Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft. 
+     * Get nft events
+     */
+    getAccountNft(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<AddressNftListResponse>;
+
     /**
      * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
      * @summary Get the latest nonce used by an account
@@ -471,6 +502,54 @@ export class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface
         return await response.value();
     }
 
+    /**
+     * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings).  Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft. 
+     * Get nft events
+     */
+    async getAccountNftRaw(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNftListResponse>> {
+        if (requestParameters.principal === null || requestParameters.principal === undefined) {
+            throw new runtime.RequiredError('principal','Required parameter requestParameters.principal was null or undefined when calling getAccountNft.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        if (requestParameters.unanchored !== undefined) {
+            queryParameters['unanchored'] = requestParameters.unanchored;
+        }
+
+        if (requestParameters.untilBlock !== undefined) {
+            queryParameters['until_block'] = requestParameters.untilBlock;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v1/address/{principal}/nft_events`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AddressNftListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * **NOTE:** This endpoint is deprecated in favor of [Non-Fungible Token holdings](#operation/get_nft_holdings).  Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft. 
+     * Get nft events
+     */
+    async getAccountNft(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<AddressNftListResponse> {
+        const response = await this.getAccountNftRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
      * Get the latest nonce used by an account

package/src/generated/models/AddressNftListResponse.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ *
+ * 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    NftEvent,
+    NftEventFromJSON,
+    NftEventFromJSONTyped,
+    NftEventToJSON,
+} from './';
+
+/**
+ * 
+ * @export
+ * @interface AddressNftListResponse
+ */
+export interface AddressNftListResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof AddressNftListResponse
+     */
+    limit: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AddressNftListResponse
+     */
+    offset: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AddressNftListResponse
+     */
+    total: number;
+    /**
+     * 
+     * @type {Array<NftEvent>}
+     * @memberof AddressNftListResponse
+     */
+    nft_events: Array<NftEvent>;
+}
+
+export function AddressNftListResponseFromJSON(json: any): AddressNftListResponse {
+    return AddressNftListResponseFromJSONTyped(json, false);
+}
+
+export function AddressNftListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddressNftListResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'limit': json['limit'],
+        'offset': json['offset'],
+        'total': json['total'],
+        'nft_events': ((json['nft_events'] as Array<any>).map(NftEventFromJSON)),
+    };
+}
+
+export function AddressNftListResponseToJSON(value?: AddressNftListResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'limit': value.limit,
+        'offset': value.offset,
+        'total': value.total,
+        'nft_events': ((value.nft_events as Array<any>).map(NftEventToJSON)),
+    };
+}
+

package/src/generated/models/AddressNftListResponseValue.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ *
+ * 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * Identifier of the NFT
+ * @export
+ * @interface AddressNftListResponseValue
+ */
+export interface AddressNftListResponseValue {
+    /**
+     * Hex string representing the identifier of the NFT
+     * @type {string}
+     * @memberof AddressNftListResponseValue
+     */
+    hex: string;
+    /**
+     * Readable string of the NFT identifier
+     * @type {string}
+     * @memberof AddressNftListResponseValue
+     */
+    repr: string;
+}
+
+export function AddressNftListResponseValueFromJSON(json: any): AddressNftListResponseValue {
+    return AddressNftListResponseValueFromJSONTyped(json, false);
+}
+
+export function AddressNftListResponseValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddressNftListResponseValue {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'hex': json['hex'],
+        'repr': json['repr'],
+    };
+}
+
+export function AddressNftListResponseValueToJSON(value?: AddressNftListResponseValue | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'hex': value.hex,
+        'repr': value.repr,
+    };
+}
+

package/src/generated/models/NftEvent.ts

@@ -0,0 +1,127 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"https://hirosystems.github.io/stacks-blockchain-api/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ *
+ * 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    AddressNftListResponseValue,
+    AddressNftListResponseValueFromJSON,
+    AddressNftListResponseValueFromJSONTyped,
+    AddressNftListResponseValueToJSON,
+} from './';
+
+/**
+ * 
+ * @export
+ * @interface NftEvent
+ */
+export interface NftEvent {
+    /**
+     * 
+     * @type {string}
+     * @memberof NftEvent
+     */
+    sender?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof NftEvent
+     */
+    recipient?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof NftEvent
+     */
+    asset_identifier: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof NftEvent
+     */
+    asset_event_type: string;
+    /**
+     * 
+     * @type {AddressNftListResponseValue}
+     * @memberof NftEvent
+     */
+    value: AddressNftListResponseValue;
+    /**
+     * 
+     * @type {string}
+     * @memberof NftEvent
+     */
+    tx_id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof NftEvent
+     */
+    tx_index: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof NftEvent
+     */
+    block_height: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof NftEvent
+     */
+    event_index: number;
+}
+
+export function NftEventFromJSON(json: any): NftEvent {
+    return NftEventFromJSONTyped(json, false);
+}
+
+export function NftEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): NftEvent {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'sender': !exists(json, 'sender') ? undefined : json['sender'],
+        'recipient': !exists(json, 'recipient') ? undefined : json['recipient'],
+        'asset_identifier': json['asset_identifier'],
+        'asset_event_type': json['asset_event_type'],
+        'value': AddressNftListResponseValueFromJSON(json['value']),
+        'tx_id': json['tx_id'],
+        'tx_index': json['tx_index'],
+        'block_height': json['block_height'],
+        'event_index': json['event_index'],
+    };
+}
+
+export function NftEventToJSON(value?: NftEvent | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'sender': value.sender,
+        'recipient': value.recipient,
+        'asset_identifier': value.asset_identifier,
+        'asset_event_type': value.asset_event_type,
+        'value': AddressNftListResponseValueToJSON(value.value),
+        'tx_id': value.tx_id,
+        'tx_index': value.tx_index,
+        'block_height': value.block_height,
+        'event_index': value.event_index,
+    };
+}
+

package/src/generated/models/index.ts

@@ -3,6 +3,8 @@
 export * from './AccountDataResponse';
 export * from './AddressAssetsListResponse';
 export * from './AddressBalanceResponse';
+export * from './AddressNftListResponse';
+export * from './AddressNftListResponseValue';
 export * from './AddressNonces';
 export * from './AddressStxInboundListResponse';
 export * from './AddressTokenOfferingLocked';
@@ -56,6 +58,7 @@ export * from './MicroblockListResponse';
 export * from './NetworkBlockTimeResponse';
 export * from './NetworkBlockTimesResponse';
 export * from './NetworkIdentifier';
+export * from './NftEvent';
 export * from './NonFungibleTokenHistoryEventList';
 export * from './NonFungibleTokenHoldingsList';
 export * from './NonFungibleTokenMetadata';