snaptrade-typescript-sdk 8.19.0 → 8.20.0

package/dist/api/trading-api.d.ts

@@ -1,403 +1,4 @@
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * Do not edit the class manually.
- */
-import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
-import { RequestArgs } from '../base';
-import { AccountOrderRecord } from '../models';
-import { ManualTradeAndImpact } from '../models';
-import { ManualTradeForm } from '../models';
-import { SymbolsQuotesInner } from '../models';
-import { TradingCancelUserAccountOrderRequest } from '../models';
-import { TradingPlaceOCOOrderRequest } from '../models';
-import { TradingApiCustom } from "./trading-api-custom";
-/**
- * TradingApi - axios parameter creator
- * @export
- */
-export declare const TradingApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Cancel open order in account
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {string} accountId The ID of the account get positions.
-     * @param {TradingCancelUserAccountOrderRequest} tradingCancelUserAccountOrderRequest The Order ID to be canceled
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    cancelUserAccountOrder: (userId: string, userSecret: string, accountId: string, tradingCancelUserAccountOrderRequest: TradingCancelUserAccountOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Check impact of trades on account.
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {ManualTradeForm} manualTradeForm
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrderImpact: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Get symbol quotes
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {string} symbols List of universal_symbol_id or tickers to get quotes for.
-     * @param {string} accountId The ID of the account to get quotes.
-     * @param {boolean} [useTicker] Should be set to True if providing tickers.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getUserAccountQuotes: (userId: string, userSecret: string, symbols: string, accountId: string, useTicker?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Place a trade with NO validation.
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {ManualTradeForm} manualTradeForm
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeForceOrder: (userId: string, userSecret: string, manualTradeForm: ManualTradeForm, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Place a OCO (One Cancels Other) order
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {TradingPlaceOCOOrderRequest} tradingPlaceOCOOrderRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOCOOrder: (userId: string, userSecret: string, tradingPlaceOCOOrderRequest: TradingPlaceOCOOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Place order
-     * @param {string} tradeId The ID of trade object obtained from trade/impact endpoint
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOrder: (tradeId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * TradingApi - functional programming interface
- * @export
- */
-export declare const TradingApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Cancel open order in account
-     * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
-    /**
-     *
-     * @summary Check impact of trades on account.
-     * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualTradeAndImpact>>;
-    /**
-     *
-     * @summary Get symbol quotes
-     * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SymbolsQuotesInner>>>;
-    /**
-     *
-     * @summary Place a trade with NO validation.
-     * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
-    /**
-     *
-     * @summary Place a OCO (One Cancels Other) order
-     * @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOCOOrder(requestParameters: TradingApiPlaceOCOOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
-    /**
-     *
-     * @summary Place order
-     * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecord>>;
-};
-/**
- * TradingApi - factory interface
- * @export
- */
-export declare const TradingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Cancel open order in account
-     * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
-    /**
-     *
-     * @summary Check impact of trades on account.
-     * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): AxiosPromise<ManualTradeAndImpact>;
-    /**
-     *
-     * @summary Get symbol quotes
-     * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<SymbolsQuotesInner>>;
-    /**
-     *
-     * @summary Place a trade with NO validation.
-     * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
-    /**
-     *
-     * @summary Place a OCO (One Cancels Other) order
-     * @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOCOOrder(requestParameters: TradingApiPlaceOCOOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
-    /**
-     *
-     * @summary Place order
-     * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecord>;
-};
-/**
- * Request parameters for cancelUserAccountOrder operation in TradingApi.
- * @export
- * @interface TradingApiCancelUserAccountOrderRequest
- */
-export type TradingApiCancelUserAccountOrderRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiCancelUserAccountOrder
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiCancelUserAccountOrder
-    */
-    readonly userSecret: string;
-    /**
-    * The ID of the account get positions.
-    * @type {string}
-    * @memberof TradingApiCancelUserAccountOrder
-    */
-    readonly accountId: string;
-} & TradingCancelUserAccountOrderRequest;
-/**
- * Request parameters for getOrderImpact operation in TradingApi.
- * @export
- * @interface TradingApiGetOrderImpactRequest
- */
-export type TradingApiGetOrderImpactRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiGetOrderImpact
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiGetOrderImpact
-    */
-    readonly userSecret: string;
-} & ManualTradeForm;
-/**
- * Request parameters for getUserAccountQuotes operation in TradingApi.
- * @export
- * @interface TradingApiGetUserAccountQuotesRequest
- */
-export type TradingApiGetUserAccountQuotesRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiGetUserAccountQuotes
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiGetUserAccountQuotes
-    */
-    readonly userSecret: string;
-    /**
-    * List of universal_symbol_id or tickers to get quotes for.
-    * @type {string}
-    * @memberof TradingApiGetUserAccountQuotes
-    */
-    readonly symbols: string;
-    /**
-    * The ID of the account to get quotes.
-    * @type {string}
-    * @memberof TradingApiGetUserAccountQuotes
-    */
-    readonly accountId: string;
-    /**
-    * Should be set to True if providing tickers.
-    * @type {boolean}
-    * @memberof TradingApiGetUserAccountQuotes
-    */
-    readonly useTicker?: boolean;
-};
-/**
- * Request parameters for placeForceOrder operation in TradingApi.
- * @export
- * @interface TradingApiPlaceForceOrderRequest
- */
-export type TradingApiPlaceForceOrderRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiPlaceForceOrder
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiPlaceForceOrder
-    */
-    readonly userSecret: string;
-} & ManualTradeForm;
-/**
- * Request parameters for placeOCOOrder operation in TradingApi.
- * @export
- * @interface TradingApiPlaceOCOOrderRequest
- */
-export type TradingApiPlaceOCOOrderRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiPlaceOCOOrder
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiPlaceOCOOrder
-    */
-    readonly userSecret: string;
-} & TradingPlaceOCOOrderRequest;
-/**
- * Request parameters for placeOrder operation in TradingApi.
- * @export
- * @interface TradingApiPlaceOrderRequest
- */
-export type TradingApiPlaceOrderRequest = {
-    /**
-    * The ID of trade object obtained from trade/impact endpoint
-    * @type {string}
-    * @memberof TradingApiPlaceOrder
-    */
-    readonly tradeId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiPlaceOrder
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof TradingApiPlaceOrder
-    */
-    readonly userSecret: string;
-};
-/**
- * TradingApi - object-oriented interface
- * @export
- * @class TradingApi
- * @extends {BaseAPI}
- */
-export declare class TradingApi extends TradingApiCustom {
-    /**
-     *
-     * @summary Cancel open order in account
-     * @param {TradingApiCancelUserAccountOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TradingApi
-     */
-    cancelUserAccountOrder(requestParameters: TradingApiCancelUserAccountOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
-    /**
-     *
-     * @summary Check impact of trades on account.
-     * @param {TradingApiGetOrderImpactRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TradingApi
-     */
-    getOrderImpact(requestParameters: TradingApiGetOrderImpactRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualTradeAndImpact, any>>;
-    /**
-     *
-     * @summary Get symbol quotes
-     * @param {TradingApiGetUserAccountQuotesRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TradingApi
-     */
-    getUserAccountQuotes(requestParameters: TradingApiGetUserAccountQuotesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SymbolsQuotesInner[], any>>;
-    /**
-     *
-     * @summary Place a trade with NO validation.
-     * @param {TradingApiPlaceForceOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TradingApi
-     */
-    placeForceOrder(requestParameters: TradingApiPlaceForceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
-    /**
-     *
-     * @summary Place a OCO (One Cancels Other) order
-     * @param {TradingApiPlaceOCOOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TradingApi
-     */
-    placeOCOOrder(requestParameters: TradingApiPlaceOCOOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
-    /**
-     *
-     * @summary Place order
-     * @param {TradingApiPlaceOrderRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TradingApi
-     */
-    placeOrder(requestParameters: TradingApiPlaceOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecord, any>>;
+import { TradingApiGenerated } from "./trading-api-generated";
+export * from "./trading-api-generated";
+export declare class TradingApi extends TradingApiGenerated {
 }