@stacks/blockchain-api-client 7.5.0-beta.2 → 7.6.0-nakamoto.1

package/src/generated/apis/FungibleTokensApi.ts

@@ -1,150 +0,0 @@
-/* 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 * as runtime from '../runtime';
-import {
-    FungibleTokenMetadata,
-    FungibleTokenMetadataFromJSON,
-    FungibleTokenMetadataToJSON,
-    FungibleTokensMetadataList,
-    FungibleTokensMetadataListFromJSON,
-    FungibleTokensMetadataListToJSON,
-} from '../models';
-
-export interface GetContractFtMetadataRequest {
-    contractId: string;
-}
-
-export interface GetFtMetadataListRequest {
-    limit?: number;
-    offset?: number;
-}
-
-/**
- * FungibleTokensApi - interface
- * 
- * @export
- * @interface FungibleTokensApiInterface
- */
-export interface FungibleTokensApiInterface {
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves the metadata for fungible tokens for a given contract id 
-     * @summary Fungible tokens metadata for contract id
-     * @param {string} contractId token\&#39;s contract id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof FungibleTokensApiInterface
-     */
-    getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>>;
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves the metadata for fungible tokens for a given contract id 
-     * Fungible tokens metadata for contract id
-     */
-    getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata>;
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens). 
-     * @summary Fungible tokens metadata list
-     * @param {number} [limit] max number of tokens to fetch.
-     * @param {number} [offset] index of first tokens to fetch
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof FungibleTokensApiInterface
-     */
-    getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>>;
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens). 
-     * Fungible tokens metadata list
-     */
-    getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList>;
-
-}
-
-/**
- * 
- */
-export class FungibleTokensApi extends runtime.BaseAPI implements FungibleTokensApiInterface {
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves the metadata for fungible tokens for a given contract id 
-     * Fungible tokens metadata for contract id
-     */
-    async getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>> {
-        if (requestParameters.contractId === null || requestParameters.contractId === undefined) {
-            throw new runtime.RequiredError('contractId','Required parameter requestParameters.contractId was null or undefined when calling getContractFtMetadata.');
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        const response = await this.request({
-            path: `/extended/v1/tokens/{contractId}/ft/metadata`.replace(`{${"contractId"}}`, encodeURIComponent(String(requestParameters.contractId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => FungibleTokenMetadataFromJSON(jsonValue));
-    }
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves the metadata for fungible tokens for a given contract id 
-     * Fungible tokens metadata for contract id
-     */
-    async getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata> {
-        const response = await this.getContractFtMetadataRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens). 
-     * Fungible tokens metadata list
-     */
-    async getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>> {
-        const queryParameters: any = {};
-
-        if (requestParameters.limit !== undefined) {
-            queryParameters['limit'] = requestParameters.limit;
-        }
-
-        if (requestParameters.offset !== undefined) {
-            queryParameters['offset'] = requestParameters.offset;
-        }
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        const response = await this.request({
-            path: `/extended/v1/tokens/ft/metadata`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => FungibleTokensMetadataListFromJSON(jsonValue));
-    }
-
-    /**
-     * **NOTE:** This endpoint is deprecated in favor of the [Token Metadata Service](https://github.com/hirosystems/token-metadata-service).  Retrieves list of fungible tokens with their metadata. More information on Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#fungible-tokens). 
-     * Fungible tokens metadata list
-     */
-    async getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList> {
-        const response = await this.getFtMetadataListRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}

package/src/generated/models/AddressNftListResponseValue.ts

@@ -1,64 +0,0 @@
-/* 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/FungibleTokenMetadata.ts

@@ -1,120 +0,0 @@
-/* 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';
-/**
- * 
- * @export
- * @interface FungibleTokenMetadata
- */
-export interface FungibleTokenMetadata {
-    /**
-     * An optional string that is a valid URI which resolves to this token's metadata. Can be empty.
-     * @type {string}
-     * @memberof FungibleTokenMetadata
-     */
-    token_uri: string;
-    /**
-     * Identifies the asset to which this token represents
-     * @type {string}
-     * @memberof FungibleTokenMetadata
-     */
-    name: string;
-    /**
-     * Describes the asset to which this token represents
-     * @type {string}
-     * @memberof FungibleTokenMetadata
-     */
-    description: string;
-    /**
-     * A URI pointing to a resource with mime type image/* representing the asset to which this token represents. The API may provide a URI to a cached resource, dependending on configuration. Otherwise, this can be the same value as the canonical image URI.
-     * @type {string}
-     * @memberof FungibleTokenMetadata
-     */
-    image_uri: string;
-    /**
-     * The original image URI specified by the contract. A URI pointing to a resource with mime type image/* representing the asset to which this token represents. Consider making any images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive.
-     * @type {string}
-     * @memberof FungibleTokenMetadata
-     */
-    image_canonical_uri: string;
-    /**
-     * A shorter representation of a token. This is sometimes referred to as a "ticker". Examples: "STX", "COOL", etc. Typically, a token could be referred to as $SYMBOL when referencing it in writing.
-     * @type {string}
-     * @memberof FungibleTokenMetadata
-     */
-    symbol: string;
-    /**
-     * The number of decimal places in a token.
-     * @type {number}
-     * @memberof FungibleTokenMetadata
-     */
-    decimals: number;
-    /**
-     * Tx id that deployed the contract
-     * @type {string}
-     * @memberof FungibleTokenMetadata
-     */
-    tx_id: string;
-    /**
-     * principle that deployed the contract
-     * @type {string}
-     * @memberof FungibleTokenMetadata
-     */
-    sender_address: string;
-}
-
-export function FungibleTokenMetadataFromJSON(json: any): FungibleTokenMetadata {
-    return FungibleTokenMetadataFromJSONTyped(json, false);
-}
-
-export function FungibleTokenMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): FungibleTokenMetadata {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'token_uri': json['token_uri'],
-        'name': json['name'],
-        'description': json['description'],
-        'image_uri': json['image_uri'],
-        'image_canonical_uri': json['image_canonical_uri'],
-        'symbol': json['symbol'],
-        'decimals': json['decimals'],
-        'tx_id': json['tx_id'],
-        'sender_address': json['sender_address'],
-    };
-}
-
-export function FungibleTokenMetadataToJSON(value?: FungibleTokenMetadata | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'token_uri': value.token_uri,
-        'name': value.name,
-        'description': value.description,
-        'image_uri': value.image_uri,
-        'image_canonical_uri': value.image_canonical_uri,
-        'symbol': value.symbol,
-        'decimals': value.decimals,
-        'tx_id': value.tx_id,
-        'sender_address': value.sender_address,
-    };
-}
-

package/src/generated/models/NftEvent.ts

@@ -1,127 +0,0 @@
-/* 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/NonFungibleTokenMetadata.ts

@@ -1,104 +0,0 @@
-/* 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';
-/**
- * 
- * @export
- * @interface NonFungibleTokenMetadata
- */
-export interface NonFungibleTokenMetadata {
-    /**
-     * An optional string that is a valid URI which resolves to this token's metadata. Can be empty.
-     * @type {string}
-     * @memberof NonFungibleTokenMetadata
-     */
-    token_uri: string;
-    /**
-     * Identifies the asset to which this token represents
-     * @type {string}
-     * @memberof NonFungibleTokenMetadata
-     */
-    name: string;
-    /**
-     * Describes the asset to which this token represents
-     * @type {string}
-     * @memberof NonFungibleTokenMetadata
-     */
-    description: string;
-    /**
-     * A URI pointing to a resource with mime type image/* representing the asset to which this token represents. The API may provide a URI to a cached resource, dependending on configuration. Otherwise, this can be the same value as the canonical image URI.
-     * @type {string}
-     * @memberof NonFungibleTokenMetadata
-     */
-    image_uri: string;
-    /**
-     * The original image URI specified by the contract. A URI pointing to a resource with mime type image/* representing the asset to which this token represents. Consider making any images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive.
-     * @type {string}
-     * @memberof NonFungibleTokenMetadata
-     */
-    image_canonical_uri: string;
-    /**
-     * Tx id that deployed the contract
-     * @type {string}
-     * @memberof NonFungibleTokenMetadata
-     */
-    tx_id: string;
-    /**
-     * principle that deployed the contract
-     * @type {string}
-     * @memberof NonFungibleTokenMetadata
-     */
-    sender_address: string;
-}
-
-export function NonFungibleTokenMetadataFromJSON(json: any): NonFungibleTokenMetadata {
-    return NonFungibleTokenMetadataFromJSONTyped(json, false);
-}
-
-export function NonFungibleTokenMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): NonFungibleTokenMetadata {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'token_uri': json['token_uri'],
-        'name': json['name'],
-        'description': json['description'],
-        'image_uri': json['image_uri'],
-        'image_canonical_uri': json['image_canonical_uri'],
-        'tx_id': json['tx_id'],
-        'sender_address': json['sender_address'],
-    };
-}
-
-export function NonFungibleTokenMetadataToJSON(value?: NonFungibleTokenMetadata | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'token_uri': value.token_uri,
-        'name': value.name,
-        'description': value.description,
-        'image_uri': value.image_uri,
-        'image_canonical_uri': value.image_canonical_uri,
-        'tx_id': value.tx_id,
-        'sender_address': value.sender_address,
-    };
-}
-

package/src/generated/models/NonFungibleTokensMetadataList.ts

@@ -1,87 +0,0 @@
-/* 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 {
-    NonFungibleTokenMetadata,
-    NonFungibleTokenMetadataFromJSON,
-    NonFungibleTokenMetadataFromJSONTyped,
-    NonFungibleTokenMetadataToJSON,
-} from './';
-
-/**
- * List of non fungible tokens metadata
- * @export
- * @interface NonFungibleTokensMetadataList
- */
-export interface NonFungibleTokensMetadataList {
-    /**
-     * The number of tokens metadata to return
-     * @type {number}
-     * @memberof NonFungibleTokensMetadataList
-     */
-    limit: number;
-    /**
-     * The number to tokens metadata to skip (starting at `0`)
-     * @type {number}
-     * @memberof NonFungibleTokensMetadataList
-     */
-    offset: number;
-    /**
-     * The number of tokens metadata available
-     * @type {number}
-     * @memberof NonFungibleTokensMetadataList
-     */
-    total: number;
-    /**
-     * 
-     * @type {Array<NonFungibleTokenMetadata>}
-     * @memberof NonFungibleTokensMetadataList
-     */
-    results: Array<NonFungibleTokenMetadata>;
-}
-
-export function NonFungibleTokensMetadataListFromJSON(json: any): NonFungibleTokensMetadataList {
-    return NonFungibleTokensMetadataListFromJSONTyped(json, false);
-}
-
-export function NonFungibleTokensMetadataListFromJSONTyped(json: any, ignoreDiscriminator: boolean): NonFungibleTokensMetadataList {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'limit': json['limit'],
-        'offset': json['offset'],
-        'total': json['total'],
-        'results': ((json['results'] as Array<any>).map(NonFungibleTokenMetadataFromJSON)),
-    };
-}
-
-export function NonFungibleTokensMetadataListToJSON(value?: NonFungibleTokensMetadataList | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'limit': value.limit,
-        'offset': value.offset,
-        'total': value.total,
-        'results': ((value.results as Array<any>).map(NonFungibleTokenMetadataToJSON)),
-    };
-}
-