@stacks/blockchain-api-client 7.2.0-beta.3 → 7.2.0

package/src/generated/apis/StackingApi.ts

@@ -1,113 +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 {
-    PoolDelegationsResponse,
-    PoolDelegationsResponseFromJSON,
-    PoolDelegationsResponseToJSON,
-} from '../models';
-
-export interface GetPoolDelegationsRequest {
-    poolPrincipal: string;
-    afterBlock?: number;
-    unanchored?: boolean;
-    limit?: number;
-    offset?: number;
-}
-
-/**
- * StackingApi - interface
- * 
- * @export
- * @interface StackingApiInterface
- */
-export interface StackingApiInterface {
-    /**
-     * Retrieves the list of stacking pool members for a given delegator principal.
-     * @summary Stacking pool members
-     * @param {string} poolPrincipal Address principal of the stacking pool delegator
-     * @param {number} [afterBlock] If specified, only delegation events after the given block will be included
-     * @param {boolean} [unanchored] whether or not to include Stackers from unconfirmed transactions
-     * @param {number} [limit] number of items to return
-     * @param {number} [offset] number of items to skip
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof StackingApiInterface
-     */
-    getPoolDelegationsRaw(requestParameters: GetPoolDelegationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoolDelegationsResponse>>;
-
-    /**
-     * Retrieves the list of stacking pool members for a given delegator principal.
-     * Stacking pool members
-     */
-    getPoolDelegations(requestParameters: GetPoolDelegationsRequest, initOverrides?: RequestInit): Promise<PoolDelegationsResponse>;
-
-}
-
-/**
- * 
- */
-export class StackingApi extends runtime.BaseAPI implements StackingApiInterface {
-
-    /**
-     * Retrieves the list of stacking pool members for a given delegator principal.
-     * Stacking pool members
-     */
-    async getPoolDelegationsRaw(requestParameters: GetPoolDelegationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PoolDelegationsResponse>> {
-        if (requestParameters.poolPrincipal === null || requestParameters.poolPrincipal === undefined) {
-            throw new runtime.RequiredError('poolPrincipal','Required parameter requestParameters.poolPrincipal was null or undefined when calling getPoolDelegations.');
-        }
-
-        const queryParameters: any = {};
-
-        if (requestParameters.afterBlock !== undefined) {
-            queryParameters['after_block'] = requestParameters.afterBlock;
-        }
-
-        if (requestParameters.unanchored !== undefined) {
-            queryParameters['unanchored'] = requestParameters.unanchored;
-        }
-
-        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/beta/stacking/{pool_principal}/delegations`.replace(`{${"pool_principal"}}`, encodeURIComponent(String(requestParameters.poolPrincipal))),
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PoolDelegationsResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Retrieves the list of stacking pool members for a given delegator principal.
-     * Stacking pool members
-     */
-    async getPoolDelegations(requestParameters: GetPoolDelegationsRequest, initOverrides?: RequestInit): Promise<PoolDelegationsResponse> {
-        const response = await this.getPoolDelegationsRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}

package/src/generated/models/InlineResponse403.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';
-/**
- * 
- * @export
- * @interface InlineResponse403
- */
-export interface InlineResponse403 {
-    /**
-     * 
-     * @type {string}
-     * @memberof InlineResponse403
-     */
-    error?: string;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof InlineResponse403
-     */
-    success?: boolean;
-}
-
-export function InlineResponse403FromJSON(json: any): InlineResponse403 {
-    return InlineResponse403FromJSONTyped(json, false);
-}
-
-export function InlineResponse403FromJSONTyped(json: any, ignoreDiscriminator: boolean): InlineResponse403 {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'error': !exists(json, 'error') ? undefined : json['error'],
-        'success': !exists(json, 'success') ? undefined : json['success'],
-    };
-}
-
-export function InlineResponse403ToJSON(value?: InlineResponse403 | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'error': value.error,
-        'success': value.success,
-    };
-}
-

package/src/generated/models/PoolDelegation.ts

@@ -1,96 +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 PoolDelegation
- */
-export interface PoolDelegation {
-    /**
-     * The principal of the pool member that issued the delegation
-     * @type {string}
-     * @memberof PoolDelegation
-     */
-    stacker: string;
-    /**
-     * The pox-addr value specified by the stacker in the delegation operation
-     * @type {string}
-     * @memberof PoolDelegation
-     */
-    pox_addr?: string;
-    /**
-     * The amount of uSTX delegated by the stacker
-     * @type {string}
-     * @memberof PoolDelegation
-     */
-    amount_ustx: string;
-    /**
-     * The optional burnchain block unlock height that the stacker may have specified
-     * @type {number}
-     * @memberof PoolDelegation
-     */
-    burn_block_unlock_height?: number;
-    /**
-     * The block height at which the stacker delegation transaction was mined at
-     * @type {number}
-     * @memberof PoolDelegation
-     */
-    block_height: number;
-    /**
-     * The tx_id of the stacker delegation operation
-     * @type {string}
-     * @memberof PoolDelegation
-     */
-    tx_id: string;
-}
-
-export function PoolDelegationFromJSON(json: any): PoolDelegation {
-    return PoolDelegationFromJSONTyped(json, false);
-}
-
-export function PoolDelegationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PoolDelegation {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'stacker': json['stacker'],
-        'pox_addr': !exists(json, 'pox_addr') ? undefined : json['pox_addr'],
-        'amount_ustx': json['amount_ustx'],
-        'burn_block_unlock_height': !exists(json, 'burn_block_unlock_height') ? undefined : json['burn_block_unlock_height'],
-        'block_height': json['block_height'],
-        'tx_id': json['tx_id'],
-    };
-}
-
-export function PoolDelegationToJSON(value?: PoolDelegation | null): any {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
-    }
-    return {
-        
-        'stacker': value.stacker,
-        'pox_addr': value.pox_addr,
-        'amount_ustx': value.amount_ustx,
-        'burn_block_unlock_height': value.burn_block_unlock_height,
-        'block_height': value.block_height,
-        'tx_id': value.tx_id,
-    };
-}
-

package/src/generated/models/PoolDelegationsResponse.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 {
-    PoolDelegation,
-    PoolDelegationFromJSON,
-    PoolDelegationFromJSONTyped,
-    PoolDelegationToJSON,
-} from './';
-
-/**
- * GET request that returns stacking pool member details for a given pool (delegator) principal
- * @export
- * @interface PoolDelegationsResponse
- */
-export interface PoolDelegationsResponse {
-    /**
-     * The number of Stackers to return
-     * @type {number}
-     * @memberof PoolDelegationsResponse
-     */
-    limit: number;
-    /**
-     * The number to Stackers to skip (starting at `0`)
-     * @type {number}
-     * @memberof PoolDelegationsResponse
-     */
-    offset: number;
-    /**
-     * The total number of Stackers
-     * @type {number}
-     * @memberof PoolDelegationsResponse
-     */
-    total: number;
-    /**
-     * 
-     * @type {Array<PoolDelegation>}
-     * @memberof PoolDelegationsResponse
-     */
-    results: Array<PoolDelegation>;
-}
-
-export function PoolDelegationsResponseFromJSON(json: any): PoolDelegationsResponse {
-    return PoolDelegationsResponseFromJSONTyped(json, false);
-}
-
-export function PoolDelegationsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PoolDelegationsResponse {
-    if ((json === undefined) || (json === null)) {
-        return json;
-    }
-    return {
-        
-        'limit': json['limit'],
-        'offset': json['offset'],
-        'total': json['total'],
-        'results': ((json['results'] as Array<any>).map(PoolDelegationFromJSON)),
-    };
-}
-
-export function PoolDelegationsResponseToJSON(value?: PoolDelegationsResponse | 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(PoolDelegationToJSON)),
-    };
-}
-