@northstake/northstakeapi 1.0.24 → 1.0.25

package/dist/api/managedUsersLinkedWalletsApi.js

@@ -1,290 +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.ManagedUsersLinkedWalletsApi = exports.ManagedUsersLinkedWalletsApiApiKeys = 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 ManagedUsersLinkedWalletsApiApiKeys;
-(function (ManagedUsersLinkedWalletsApiApiKeys) {
-    ManagedUsersLinkedWalletsApiApiKeys[ManagedUsersLinkedWalletsApiApiKeys["ApiKeyAuth"] = 0] = "ApiKeyAuth";
-})(ManagedUsersLinkedWalletsApiApiKeys || (exports.ManagedUsersLinkedWalletsApiApiKeys = ManagedUsersLinkedWalletsApiApiKeys = {}));
-class ManagedUsersLinkedWalletsApi {
-    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[ManagedUsersLinkedWalletsApiApiKeys[key]].apiKey = value;
-    }
-    set accessToken(accessToken) {
-        this.authentications.bearerTokenAuth.accessToken = accessToken;
-    }
-    addInterceptor(interceptor) {
-        this.interceptors.push(interceptor);
-    }
-    /**
-     *
-     * @summary Add a new linked wallet for a managed user
-     * @param userId The unique identifier for the managed user
-     * @param addLinkedWalletForUserRequest
-     */
-    async addLinkedWalletForUser(userId, addLinkedWalletForUserRequest, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/managedUsers/{userId}/linkedWallets'
-            .replace('{' + 'userId' + '}', encodeURIComponent(String(userId)));
-        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 'userId' is not null or undefined
-        if (userId === null || userId === undefined) {
-            throw new Error('Required parameter "userId" was null or undefined when calling addLinkedWalletForUser.');
-        }
-        // Verify required parameter 'addLinkedWalletForUserRequest' is not null or undefined
-        if (addLinkedWalletForUserRequest === null || addLinkedWalletForUserRequest === undefined) {
-            throw new Error('Required parameter "addLinkedWalletForUserRequest" was null or undefined when calling addLinkedWalletForUser.');
-        }
-        Object.assign(localVarHeaderParams, options.headers);
-        let localVarUseFormData = false;
-        let localVarRequestOptions = {
-            method: 'POST',
-            qs: localVarQueryParameters,
-            headers: localVarHeaderParams,
-            uri: localVarPath,
-            useQuerystring: this._useQuerystring,
-            json: true,
-            body: models_1.ObjectSerializer.serialize(addLinkedWalletForUserRequest, "AddLinkedWalletForUserRequest")
-        };
-        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) {
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                        else {
-                            console.error('API response error:', response.statusCode);
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                    }
-                });
-            });
-        });
-    }
-    /**
-     *
-     * @summary Delete a linked wallet for a managed user
-     * @param walletId The id of the linked wallet to delete
-     * @param userId The unique identifier for the managed user
-     */
-    async deleteLinkedWalletForUser(walletId, userId, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/managedUsers/{userId}/linkedWallets/{walletId}'
-            .replace('{' + 'walletId' + '}', encodeURIComponent(String(walletId)))
-            .replace('{' + 'userId' + '}', encodeURIComponent(String(userId)));
-        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 'walletId' is not null or undefined
-        if (walletId === null || walletId === undefined) {
-            throw new Error('Required parameter "walletId" was null or undefined when calling deleteLinkedWalletForUser.');
-        }
-        // Verify required parameter 'userId' is not null or undefined
-        if (userId === null || userId === undefined) {
-            throw new Error('Required parameter "userId" was null or undefined when calling deleteLinkedWalletForUser.');
-        }
-        Object.assign(localVarHeaderParams, options.headers);
-        let localVarUseFormData = false;
-        let localVarRequestOptions = {
-            method: 'DELETE',
-            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) {
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                        else {
-                            console.error('API response error:', response.statusCode);
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                    }
-                });
-            });
-        });
-    }
-    /**
-     *
-     * @summary List linked wallets for a managed user
-     * @param userId The unique identifier for the managed user
-     */
-    async listLinkedWalletsForUser(userId, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/managedUsers/{userId}/linkedWallets'
-            .replace('{' + 'userId' + '}', encodeURIComponent(String(userId)));
-        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 'userId' is not null or undefined
-        if (userId === null || userId === undefined) {
-            throw new Error('Required parameter "userId" was null or undefined when calling listLinkedWalletsForUser.');
-        }
-        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, "Array<Wallet>");
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                        else {
-                            console.error('API response error:', response.statusCode);
-                            resolve({ body: body, status: response.statusCode });
-                        }
-                    }
-                });
-            });
-        });
-    }
-}
-exports.ManagedUsersLinkedWalletsApi = ManagedUsersLinkedWalletsApi;

package/dist/api/managedUsersOrdersApi.d.ts

@@ -1,94 +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 { Order } from '../model/order';
-import { OrderDocument } from '../model/orderDocument';
-import { Authentication, Interceptor } from '../model/models';
-import { HttpBearerAuth, ApiKeyAuth } from '../model/models';
-export declare enum ManagedUsersOrdersApiApiKeys {
-    ApiKeyAuth = 0
-}
-export declare class ManagedUsersOrdersApi {
-    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: ManagedUsersOrdersApiApiKeys, value: string): void;
-    set accessToken(accessToken: string | (() => string));
-    addInterceptor(interceptor: Interceptor): void;
-    /**
-     *
-     * @summary Cancel a submitted order by ID for a particular managed user
-     * @param userId
-     * @param orderId
-     */
-    cancelOrderForUser(userId: string, orderId: string, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: any;
-        status: number;
-    }>;
-    /**
-     * This endpoint allows the client to create a staking, unstaking, or withdrawal order on behalf of a managed user. One key feature of this endpoint is the ability to include an optional `validatorKey` field when creating a staking order.  ### Including a Validator Key (Ethereum only) By including a `validatorKey` in the staking order, the client specifies a pre-generated and signed Ethereum validator key that should be used for the staking transaction. This key must meet all required security and operational standards, as it will be directly used for staking on the Ethereum blockchain.  The `validatorKey` object includes cryptographic details such as the keystore information, public key, and the cryptographic path. Including this key is beneficial for users who prefer to maintain a level of control over their staking operations and ensure that their specific validators are utilized.  ### Without a Validator Key If no `validatorKey` is provided, Northstake handles the staking operation internally. This process requires that the managed user\'s account must have sufficient balance in their deposit account to cover the staking transaction and any associated fees. In this case, Northstake will generate the necessary validator keys, handle the cryptographic operations, and ensure the validator is registered correctly on the blockchain.  ### Usage Scenarios - **With Validator Key**: Ensures that a specific, pre-approved validator key is used, providing transparency and control to the user. - **Without Validator Key**: Ideal for users who prefer a hands-off approach, allowing Northstake to manage the technical and operational complexities of staking on their behalf.  Clients are advised to ensure that all provided validator keys are secure and generated according to best security practices. Improper handling or exposure of validator keys can lead to significant security risks, including loss of staked assets.
-     * @summary Create an order on behalf of a managed user
-     * @param userId
-     * @param order
-     */
-    createOrderForUser(userId: string, order: Order, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: OrderDocument;
-        status: number;
-    }>;
-    /**
-     *
-     * @summary Get all orders for a particular managed user
-     * @param userId
-     */
-    getAllOrdersForUser(userId: string, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: Array<OrderDocument>;
-        status: number;
-    }>;
-    /**
-     *
-     * @summary Get details of an order by ID for a particular managed user
-     * @param userId
-     * @param orderId
-     */
-    getOrderDetailsForUser(userId: string, orderId: string, options?: {
-        headers: {
-            [name: string]: string;
-        };
-    }): Promise<{
-        body: OrderDocument;
-        status: number;
-    }>;
-}