@northstake/northstakeapi 1.0.38 → 1.0.40

package/dist/api/validatorMarketplaceFacilitatorApi.js

@@ -1,280 +0,0 @@
-"use strict";
-/**
- * Northstake
- * Northstake api
- *
- * The version of the OpenAPI document: 1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidatorMarketplaceFacilitatorApi = exports.ValidatorMarketplaceFacilitatorApiApiKeys = void 0;
-const request_1 = __importDefault(require("request"));
-const models_1 = require("../model/models");
-const models_2 = require("../model/models");
-let defaultBasePath = 'https://api.northstake.dk/v1';
-// ===============================================
-// This file is autogenerated - Please do not edit
-// ===============================================
-var ValidatorMarketplaceFacilitatorApiApiKeys;
-(function (ValidatorMarketplaceFacilitatorApiApiKeys) {
-    ValidatorMarketplaceFacilitatorApiApiKeys[ValidatorMarketplaceFacilitatorApiApiKeys["ApiKeyAuth"] = 0] = "ApiKeyAuth";
-})(ValidatorMarketplaceFacilitatorApiApiKeys || (exports.ValidatorMarketplaceFacilitatorApiApiKeys = ValidatorMarketplaceFacilitatorApiApiKeys = {}));
-class ValidatorMarketplaceFacilitatorApi {
-    constructor(basePathOrUsername, password, basePath) {
-        this._basePath = defaultBasePath;
-        this._defaultHeaders = {};
-        this._useQuerystring = false;
-        this.authentications = {
-            'default': new models_2.JWTAuth('your_api_key', 'your_private_key'),
-            'bearerTokenAuth': new models_2.HttpBearerAuth(),
-            'ApiKeyAuth': new models_2.ApiKeyAuth('header', 'x-api-key'),
-        };
-        this.interceptors = [];
-        if (password) {
-            if (basePath) {
-                this.basePath = basePath;
-            }
-        }
-        else {
-            if (basePathOrUsername) {
-                this.basePath = basePathOrUsername;
-            }
-        }
-    }
-    set useQuerystring(value) {
-        this._useQuerystring = value;
-    }
-    set basePath(basePath) {
-        this._basePath = basePath;
-    }
-    set defaultHeaders(defaultHeaders) {
-        this._defaultHeaders = defaultHeaders;
-    }
-    get defaultHeaders() {
-        return this._defaultHeaders;
-    }
-    get basePath() {
-        return this._basePath;
-    }
-    setDefaultAuthentication(auth) {
-        this.authentications.default = auth;
-    }
-    setApiKey(key, value) {
-        this.authentications[ValidatorMarketplaceFacilitatorApiApiKeys[key]].apiKey = value;
-    }
-    set accessToken(accessToken) {
-        this.authentications.bearerTokenAuth.accessToken = accessToken;
-    }
-    addInterceptor(interceptor) {
-        this.interceptors.push(interceptor);
-    }
-    /**
-     * Retrieves metadata information for the entire marketplace.
-     * @summary Get metadata for the entire marketplace
-     */
-    async getMarketplaceMetadata(options = { headers: {} }) {
-        const localVarPath = this.basePath + '/validatorMarketplace/facilitator/metadata';
-        let localVarQueryParameters = {};
-        let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
-        const produces = ['application/json'];
-        if (produces.indexOf('application/json') >= 0) {
-            localVarHeaderParams.Accept = 'application/json';
-        }
-        else {
-            localVarHeaderParams.Accept = produces.join(',');
-        }
-        let localVarFormParams = {};
-        Object.assign(localVarHeaderParams, options.headers);
-        let localVarUseFormData = false;
-        let localVarRequestOptions = {
-            method: 'GET',
-            qs: localVarQueryParameters,
-            headers: localVarHeaderParams,
-            uri: localVarPath,
-            useQuerystring: this._useQuerystring,
-            json: true,
-        };
-        let authenticationPromise = Promise.resolve();
-        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
-        let interceptorPromise = authenticationPromise;
-        for (const interceptor of this.interceptors) {
-            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
-        }
-        return interceptorPromise.then(() => {
-            if (Object.keys(localVarFormParams).length) {
-                if (localVarUseFormData) {
-                    localVarRequestOptions.formData = localVarFormParams;
-                }
-                else {
-                    localVarRequestOptions.form = localVarFormParams;
-                }
-            }
-            return new Promise((resolve, reject) => {
-                (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
-                    if (error) {
-                        console.error('API call error:', error);
-                        reject(error);
-                    }
-                    else {
-                        if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "GetMarketplaceMetadata200Response");
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                        else {
-                            console.error('API response error:', response.statusCode);
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                    }
-                });
-            });
-        });
-    }
-    /**
-     * Retrieves detailed information about an RFQ by its ID.
-     * @summary Get detailed information about a specific RFQ
-     * @param rfqId The unique identifier of the RFQ
-     */
-    async getRFQDetailsForFacilitator(rfqId, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/validatorMarketplace/facilitator/{rfqId}'
-            .replace('{' + 'rfqId' + '}', encodeURIComponent(String(rfqId)));
-        let localVarQueryParameters = {};
-        let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
-        const produces = ['application/json'];
-        if (produces.indexOf('application/json') >= 0) {
-            localVarHeaderParams.Accept = 'application/json';
-        }
-        else {
-            localVarHeaderParams.Accept = produces.join(',');
-        }
-        let localVarFormParams = {};
-        // Verify required parameter 'rfqId' is not null or undefined
-        if (rfqId === null || rfqId === undefined) {
-            throw new Error('Required parameter "rfqId" was null or undefined when calling getRFQDetailsForFacilitator.');
-        }
-        Object.assign(localVarHeaderParams, options.headers);
-        let localVarUseFormData = false;
-        let localVarRequestOptions = {
-            method: 'GET',
-            qs: localVarQueryParameters,
-            headers: localVarHeaderParams,
-            uri: localVarPath,
-            useQuerystring: this._useQuerystring,
-            json: true,
-        };
-        let authenticationPromise = Promise.resolve();
-        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
-        let interceptorPromise = authenticationPromise;
-        for (const interceptor of this.interceptors) {
-            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
-        }
-        return interceptorPromise.then(() => {
-            if (Object.keys(localVarFormParams).length) {
-                if (localVarUseFormData) {
-                    localVarRequestOptions.formData = localVarFormParams;
-                }
-                else {
-                    localVarRequestOptions.form = localVarFormParams;
-                }
-            }
-            return new Promise((resolve, reject) => {
-                (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
-                    if (error) {
-                        console.error('API call error:', error);
-                        reject(error);
-                    }
-                    else {
-                        if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "RFQDocumentFacilitator");
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                        else {
-                            console.error('API response error:', response.statusCode);
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                    }
-                });
-            });
-        });
-    }
-    /**
-     * Retrieves a list of all RFQs available in the Northstake marketplace.
-     * @summary List all RFQs in the marketplace
-     * @param status
-     * @param page
-     * @param limit
-     */
-    async listAllRFQsForFacilitator(status, page, limit, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/validatorMarketplace/facilitator';
-        let localVarQueryParameters = {};
-        let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
-        const produces = ['application/json'];
-        if (produces.indexOf('application/json') >= 0) {
-            localVarHeaderParams.Accept = 'application/json';
-        }
-        else {
-            localVarHeaderParams.Accept = produces.join(',');
-        }
-        let localVarFormParams = {};
-        if (status !== undefined) {
-            localVarQueryParameters['status'] = models_1.ObjectSerializer.serialize(status, "'active' | 'expired' | 'finished'");
-        }
-        if (page !== undefined) {
-            localVarQueryParameters['page'] = models_1.ObjectSerializer.serialize(page, "number");
-        }
-        if (limit !== undefined) {
-            localVarQueryParameters['limit'] = models_1.ObjectSerializer.serialize(limit, "number");
-        }
-        Object.assign(localVarHeaderParams, options.headers);
-        let localVarUseFormData = false;
-        let localVarRequestOptions = {
-            method: 'GET',
-            qs: localVarQueryParameters,
-            headers: localVarHeaderParams,
-            uri: localVarPath,
-            useQuerystring: this._useQuerystring,
-            json: true,
-        };
-        let authenticationPromise = Promise.resolve();
-        authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
-        let interceptorPromise = authenticationPromise;
-        for (const interceptor of this.interceptors) {
-            interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
-        }
-        return interceptorPromise.then(() => {
-            if (Object.keys(localVarFormParams).length) {
-                if (localVarUseFormData) {
-                    localVarRequestOptions.formData = localVarFormParams;
-                }
-                else {
-                    localVarRequestOptions.form = localVarFormParams;
-                }
-            }
-            return new Promise((resolve, reject) => {
-                (0, request_1.default)(localVarRequestOptions, (error, response, body) => {
-                    if (error) {
-                        console.error('API call error:', error);
-                        reject(error);
-                    }
-                    else {
-                        if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "ListAllRFQsForFacilitator200Response");
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                        else {
-                            console.error('API response error:', response.statusCode);
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                    }
-                });
-            });
-        });
-    }
-}
-exports.ValidatorMarketplaceFacilitatorApi = ValidatorMarketplaceFacilitatorApi;

package/dist/api/validatorMarketplaceSellersApi.d.ts

@@ -1,122 +0,0 @@
-/**
- * Northstake
- * Northstake api
- *
- * The version of the OpenAPI document: 1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { CreateRFQRequest } from '../model/createRFQRequest';
-import { RFQDocumentSeller } from '../model/rFQDocumentSeller';
-import { RFQDocumentSellerStatusFilter } from '../model/rFQDocumentSellerStatusFilter';
-import { RegisterWithdrawalRecipientSettlementRequest } from '../model/registerWithdrawalRecipientSettlementRequest';
-import { Authentication, Interceptor } from '../model/models';
-import { HttpBearerAuth, ApiKeyAuth } from '../model/models';
-export declare enum ValidatorMarketplaceSellersApiApiKeys {
-    ApiKeyAuth = 0
-}
-export declare class ValidatorMarketplaceSellersApi {
-    protected _basePath: string;
-    protected _defaultHeaders: any;
-    protected _useQuerystring: boolean;
-    protected authentications: {
-        default: Authentication;
-        bearerTokenAuth: HttpBearerAuth;
-        ApiKeyAuth: ApiKeyAuth;
-    };
-    protected interceptors: Interceptor[];
-    constructor(basePath?: string);
-    set useQuerystring(value: boolean);
-    set basePath(basePath: string);
-    set defaultHeaders(defaultHeaders: any);
-    get defaultHeaders(): any;
-    get basePath(): string;
-    setDefaultAuthentication(auth: Authentication): void;
-    setApiKey(key: ValidatorMarketplaceSellersApiApiKeys, value: string): void;
-    set accessToken(accessToken: string | (() => string));
-    addInterceptor(interceptor: Interceptor): void;
-    /**
-     *
-     * @summary Accept RFQ quote
-     * @param rfqId
-     * @param quoteId
-     */
-    acceptQuote(rfqId: string, quoteId: string, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: any;
-        status: number;
-    }>;
-    /**
-     *
-     * @summary Create a new RFQ
-     * @param createRFQRequest
-     */
-    createRFQ(createRFQRequest: CreateRFQRequest, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: RFQDocumentSeller;
-        status: number;
-    }>;
-    /**
-     *
-     * @summary Retrieve a specific RFQ by ID for the seller
-     * @param rfqId
-     */
-    getRFQ(rfqId: string, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: RFQDocumentSeller;
-        status: number;
-    }>;
-    /**
-     *
-     * @summary List all RFQs posted by the seller with optional status filter
-     * @param status Filter by RFQ status
-     */
-    listRFQs(status?: RFQDocumentSellerStatusFilter, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: Array<RFQDocumentSeller>;
-        status: number;
-    }>;
-    /**
-     *
-     * @summary Register withdrawal recipient settlement hash for an RFQ
-     * @param rfqId
-     * @param registerWithdrawalRecipientSettlementRequest
-     */
-    registerWithdrawalRecipientSettlement(rfqId: string, registerWithdrawalRecipientSettlementRequest: RegisterWithdrawalRecipientSettlementRequest, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: any;
-        status: number;
-    }>;
-    /**
-     *
-     * @summary Reject RFQ quote
-     * @param rfqId
-     * @param quoteId
-     */
-    rejectQuote(rfqId: string, quoteId: string, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: any;
-        status: number;
-    }>;
-}

package/dist/api/validatorMarketplaceWebhooksApi.d.ts

@@ -1,77 +0,0 @@
-/**
- * Northstake
- * Northstake api
- *
- * The version of the OpenAPI document: 1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import { WebHookLookupAnswer } from '../model/webHookLookupAnswer';
-import { WebhookRegistration } from '../model/webhookRegistration';
-import { Authentication, Interceptor } from '../model/models';
-import { HttpBearerAuth, ApiKeyAuth } from '../model/models';
-export declare enum ValidatorMarketplaceWebhooksApiApiKeys {
-    ApiKeyAuth = 0
-}
-export declare class ValidatorMarketplaceWebhooksApi {
-    protected _basePath: string;
-    protected _defaultHeaders: any;
-    protected _useQuerystring: boolean;
-    protected authentications: {
-        default: Authentication;
-        bearerTokenAuth: HttpBearerAuth;
-        ApiKeyAuth: ApiKeyAuth;
-    };
-    protected interceptors: Interceptor[];
-    constructor(basePath?: string);
-    set useQuerystring(value: boolean);
-    set basePath(basePath: string);
-    set defaultHeaders(defaultHeaders: any);
-    get defaultHeaders(): any;
-    get basePath(): string;
-    setDefaultAuthentication(auth: Authentication): void;
-    setApiKey(key: ValidatorMarketplaceWebhooksApiApiKeys, value: string): void;
-    set accessToken(accessToken: string | (() => string));
-    addInterceptor(interceptor: Interceptor): void;
-    /**
-     *
-     * @summary Delete a registered Validator Marketplace webhook
-     * @param webhookId Unique identifier of the registered webhook
-     */
-    deleteWebhook(webhookId: string, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: any;
-        status: number;
-    }>;
-    /**
-     *
-     * @summary List all registered validator marketplace webhooks for the user
-     */
-    listRegisteredWebhooks(options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: Array<WebHookLookupAnswer>;
-        status: number;
-    }>;
-    /**
-     * Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL.  A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint.  (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation)  - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQAvailable\",     \"details\": {       \"id\": \"rfq123\",       \"validators\": [         {           \"validator_index\": 1,           \"balance\": 32,           \"exit_estimates\": [             {               \"estimated_exit_time\": \"2025-03-01T12:00:00Z\",               \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",               \"timestamp\": \"2024-03-01T12:00:00Z\"             }           ]         }       ],       \"total_balance\": 32,       \"payment_address\": \"0xabcd\",       \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",       \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\",       \"unique_escrow_vault\": \"vault123\"     }   }   ```  - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidReceived\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-01T13:00:00Z\"     }   }   ```  - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidAccepted\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-02T14:30:00Z\",       \"escrow_address\": \"0x12345\"     }   }   ```  - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowEvent\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"amount\": 5000,       \"timestamp\": \"2024-03-03T15:45:00Z\"     }   }   ```  - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQTransferProposalReceived\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"timestamp\": \"2024-03-03T15:45:00Z\",       \"proposal_id\": \"0x12345\"\"     }   }   ```  - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorWithdrawalChange\",     \"details\": [{       \"transaction_hash\": \"0xdef456\",       \"validator_index\": 1,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     {       \"transaction_hash\": \"0xdef457\",       \"validator_index\": 2,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },                 {       \"transaction_hash\": \"0xdef458\",       \"validator_index\": 3,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     ]   }   ```  - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowReleased\",     \"details\": {       \"transaction_hash\": \"0xghi789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorExited\",     \"details\": {       \"validator_index\": \"0xghi789\",       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
-     * @summary Register a webhook to track Northstake validator marketplace events
-     * @param webhookRegistration
-     */
-    registerWebhook(webhookRegistration: WebhookRegistration, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: any;
-        status: number;
-    }>;
-}