@stacks/blockchain-api-client 0.71.2 → 1.0.0

package/src/generated/apis/TokensApi.ts

@@ -1,266 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Stacks 2.0 Blockchain API
- * This is the documentation for the Stacks 2.0 Blockchain API.  It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API.  <a href=\"collection.json\" download=\"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,
-    NonFungibleTokenMetadata,
-    NonFungibleTokenMetadataFromJSON,
-    NonFungibleTokenMetadataToJSON,
-    NonFungibleTokensMetadataList,
-    NonFungibleTokensMetadataListFromJSON,
-    NonFungibleTokensMetadataListToJSON,
-} from '../models';
-
-export interface GetContractFtMetadataRequest {
-    contractId: string;
-}
-
-export interface GetContractNftMetadataRequest {
-    contractId: string;
-}
-
-export interface GetFtMetadataListRequest {
-    limit?: number;
-    offset?: number;
-}
-
-export interface GetNftMetadataListRequest {
-    limit?: number;
-    offset?: number;
-}
-
-/**
- * TokensApi - interface
- * 
- * @export
- * @interface TokensApiInterface
- */
-export interface TokensApiInterface {
-    /**
-     * Get fungible tokens metadata for 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 TokensApiInterface
-     */
-    getContractFtMetadataRaw(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokenMetadata>>;
-
-    /**
-     * Get fungible tokens metadata for given contract id
-     * Fungible tokens metadata for contract id
-     */
-    getContractFtMetadata(requestParameters: GetContractFtMetadataRequest, initOverrides?: RequestInit): Promise<FungibleTokenMetadata>;
-
-    /**
-     * Get non fungible tokens metadata for given contract id
-     * @summary Non fungible tokens metadata for contract id
-     * @param {string} contractId token\&#39;s contract id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TokensApiInterface
-     */
-    getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>>;
-
-    /**
-     * Get non fungible tokens metadata for given contract id
-     * Non fungible tokens metadata for contract id
-     */
-    getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
-
-    /**
-     * Get list of fungible tokens metadata
-     * @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 TokensApiInterface
-     */
-    getFtMetadataListRaw(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<FungibleTokensMetadataList>>;
-
-    /**
-     * Get list of fungible tokens metadata
-     * Fungible tokens metadata list
-     */
-    getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList>;
-
-    /**
-     * Get list of non fungible tokens metadata
-     * @summary Non 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 TokensApiInterface
-     */
-    getNftMetadataListRaw(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokensMetadataList>>;
-
-    /**
-     * Get list of non fungible tokens metadata
-     * Non fungible tokens metadata list
-     */
-    getNftMetadataList(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<NonFungibleTokensMetadataList>;
-
-}
-
-/**
- * 
- */
-export class TokensApi extends runtime.BaseAPI implements TokensApiInterface {
-
-    /**
-     * Get fungible tokens metadata for 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));
-    }
-
-    /**
-     * Get fungible tokens metadata for 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();
-    }
-
-    /**
-     * Get non fungible tokens metadata for given contract id
-     * Non fungible tokens metadata for contract id
-     */
-    async getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>> {
-        if (requestParameters.contractId === null || requestParameters.contractId === undefined) {
-            throw new runtime.RequiredError('contractId','Required parameter requestParameters.contractId was null or undefined when calling getContractNftMetadata.');
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        const response = await this.request({
-            path: `/extended/v1/tokens/{contractId}/nft/metadata`.replace(`{${"contractId"}}`, encodeURIComponent(String(requestParameters.contractId))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => NonFungibleTokenMetadataFromJSON(jsonValue));
-    }
-
-    /**
-     * Get non fungible tokens metadata for given contract id
-     * Non fungible tokens metadata for contract id
-     */
-    async getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata> {
-        const response = await this.getContractNftMetadataRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Get list of fungible tokens metadata
-     * 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));
-    }
-
-    /**
-     * Get list of fungible tokens metadata
-     * Fungible tokens metadata list
-     */
-    async getFtMetadataList(requestParameters: GetFtMetadataListRequest, initOverrides?: RequestInit): Promise<FungibleTokensMetadataList> {
-        const response = await this.getFtMetadataListRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Get list of non fungible tokens metadata
-     * Non fungible tokens metadata list
-     */
-    async getNftMetadataListRaw(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokensMetadataList>> {
-        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/nft/metadata`,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => NonFungibleTokensMetadataListFromJSON(jsonValue));
-    }
-
-    /**
-     * Get list of non fungible tokens metadata
-     * Non fungible tokens metadata list
-     */
-    async getNftMetadataList(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<NonFungibleTokensMetadataList> {
-        const response = await this.getNftMetadataListRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}