build: add generated docs

hirosystems · Jan 23, 2024 · f13006d · f13006d
1 parent af463b0
commit f13006d
Show file tree

Hide file tree

Showing 21 changed files with 788 additions and 937 deletions.
diff --git a/client/src/generated/.openapi-generator/FILES b/client/src/generated/.openapi-generator/FILES
@@ -1,9 +1,9 @@
 .openapi-generator-ignore
 apis/AccountsApi.ts
 apis/BlocksApi.ts
+apis/BurnBlocksApi.ts
 apis/FaucetsApi.ts
 apis/FeesApi.ts
-apis/FungibleTokensApi.ts
 apis/InfoApi.ts
 apis/MempoolApi.ts
 apis/MicroblocksApi.ts
@@ -20,8 +20,6 @@ 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
@@ -41,6 +39,8 @@ models/BnsGetNameInfoResponse.ts
 models/BnsGetNamePriceResponse.ts
 models/BnsGetNamespacePriceResponse.ts
 models/BnsNamesOwnByAddressResponse.ts
+models/BurnBlock.ts
+models/BurnBlockListResponse.ts
 models/BurnchainReward.ts
 models/BurnchainRewardListResponse.ts
 models/BurnchainRewardSlotHolder.ts
@@ -54,8 +54,6 @@ models/CoreNodeInfoResponse.ts
 models/CoreNodePoxResponse.ts
 models/FeeRate.ts
 models/FeeRateRequest.ts
-models/FungibleTokenMetadata.ts
-models/FungibleTokensMetadataList.ts
 models/GetRawTransactionResult.ts
 models/GetStxSupplyLegacyFormatResponse.ts
 models/GetStxSupplyResponse.ts
@@ -74,15 +72,14 @@ models/MempoolTransactionStatsResponseTxSimpleFeeAveragesTokenTransfer.ts
 models/MempoolTransactionStatsResponseTxTypeCounts.ts
 models/Microblock.ts
 models/MicroblockListResponse.ts
+models/NakamotoBlock.ts
+models/NakamotoBlockListResponse.ts
 models/NetworkBlockTimeResponse.ts
 models/NetworkBlockTimesResponse.ts
 models/NetworkIdentifier.ts
-models/NftEvent.ts
 models/NonFungibleTokenHistoryEventList.ts
 models/NonFungibleTokenHoldingsList.ts
-models/NonFungibleTokenMetadata.ts
 models/NonFungibleTokenMintList.ts
-models/NonFungibleTokensMetadataList.ts
 models/OtherTransactionIdentifier.ts
 models/PoolDelegation.ts
 models/PoolDelegationsResponse.ts

diff --git a/client/src/generated/apis/AccountsApi.ts b/client/src/generated/apis/AccountsApi.ts
@@ -24,9 +24,6 @@ import {
     AddressBalanceResponse,
     AddressBalanceResponseFromJSON,
     AddressBalanceResponseToJSON,
-    AddressNftListResponse,
-    AddressNftListResponseFromJSON,
-    AddressNftListResponseToJSON,
     AddressNonces,
     AddressNoncesFromJSON,
     AddressNoncesToJSON,
@@ -73,14 +70,6 @@ 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;
@@ -200,26 +189,6 @@ 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
@@ -502,54 +471,6 @@ 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