snaptrade-typescript-sdk 8.18.0 → 8.20.0

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

@@ -1,369 +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 { OptionChainInner } from '../models';
-import { OptionsGetOptionStrategyRequest } from '../models';
-import { OptionsHoldings } from '../models';
-import { OptionsPlaceOptionStrategyRequest } from '../models';
-import { StrategyOrderRecord } from '../models';
-import { StrategyQuotes } from '../models';
-import { OptionsApiCustom } from "./options-api-custom";
-/**
- * OptionsApi - axios parameter creator
- * @export
- */
-export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Creates an option strategy object that will be used to place an option strategy order
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {string} accountId The ID of the account get positions.
-     * @param {OptionsGetOptionStrategyRequest} optionsGetOptionStrategyRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionStrategy: (userId: string, userSecret: string, accountId: string, optionsGetOptionStrategyRequest: OptionsGetOptionStrategyRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Get the options chain
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {string} accountId The ID of the account get positions.
-     * @param {string} symbol Universal symbol ID if symbol
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionsChain: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Get latest market data of option strategy
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {string} accountId The ID of the account get positions.
-     * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionsStrategyQuote: (userId: string, userSecret: string, accountId: string, optionStrategyId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Get the options holdings in the account
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {string} accountId The ID of the account get positions.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listOptionHoldings: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Place an option strategy order on the brokerage
-     * @param {string} userId
-     * @param {string} userSecret
-     * @param {string} accountId The ID of the account get positions.
-     * @param {string} optionStrategyId Option strategy id obtained from response when creating option strategy object
-     * @param {OptionsPlaceOptionStrategyRequest} optionsPlaceOptionStrategyRequest
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOptionStrategy: (userId: string, userSecret: string, accountId: string, optionStrategyId: string, optionsPlaceOptionStrategyRequest: OptionsPlaceOptionStrategyRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * OptionsApi - functional programming interface
- * @export
- */
-export declare const OptionsApiFp: (configuration?: Configuration) => {
-    /**
-     *
-     * @summary Creates an option strategy object that will be used to place an option strategy order
-     * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionStrategy(requestParameters: OptionsApiGetOptionStrategyRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StrategyQuotes>>;
-    /**
-     *
-     * @summary Get the options chain
-     * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionsChain(requestParameters: OptionsApiGetOptionsChainRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChainInner>>>;
-    /**
-     *
-     * @summary Get latest market data of option strategy
-     * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StrategyQuotes>>;
-    /**
-     *
-     * @summary Get the options holdings in the account
-     * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionsHoldings>>;
-    /**
-     *
-     * @summary Place an option strategy order on the brokerage
-     * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOptionStrategy(requestParameters: OptionsApiPlaceOptionStrategyRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StrategyOrderRecord>>;
-};
-/**
- * OptionsApi - factory interface
- * @export
- */
-export declare const OptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     *
-     * @summary Creates an option strategy object that will be used to place an option strategy order
-     * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionStrategy(requestParameters: OptionsApiGetOptionStrategyRequest, options?: AxiosRequestConfig): AxiosPromise<StrategyQuotes>;
-    /**
-     *
-     * @summary Get the options chain
-     * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionsChain(requestParameters: OptionsApiGetOptionsChainRequest, options?: AxiosRequestConfig): AxiosPromise<Array<OptionChainInner>>;
-    /**
-     *
-     * @summary Get latest market data of option strategy
-     * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): AxiosPromise<StrategyQuotes>;
-    /**
-     *
-     * @summary Get the options holdings in the account
-     * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<OptionsHoldings>;
-    /**
-     *
-     * @summary Place an option strategy order on the brokerage
-     * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    placeOptionStrategy(requestParameters: OptionsApiPlaceOptionStrategyRequest, options?: AxiosRequestConfig): AxiosPromise<StrategyOrderRecord>;
-};
-/**
- * Request parameters for getOptionStrategy operation in OptionsApi.
- * @export
- * @interface OptionsApiGetOptionStrategyRequest
- */
-export type OptionsApiGetOptionStrategyRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiGetOptionStrategy
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiGetOptionStrategy
-    */
-    readonly userSecret: string;
-    /**
-    * The ID of the account get positions.
-    * @type {string}
-    * @memberof OptionsApiGetOptionStrategy
-    */
-    readonly accountId: string;
-} & OptionsGetOptionStrategyRequest;
-/**
- * Request parameters for getOptionsChain operation in OptionsApi.
- * @export
- * @interface OptionsApiGetOptionsChainRequest
- */
-export type OptionsApiGetOptionsChainRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiGetOptionsChain
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiGetOptionsChain
-    */
-    readonly userSecret: string;
-    /**
-    * The ID of the account get positions.
-    * @type {string}
-    * @memberof OptionsApiGetOptionsChain
-    */
-    readonly accountId: string;
-    /**
-    * Universal symbol ID if symbol
-    * @type {string}
-    * @memberof OptionsApiGetOptionsChain
-    */
-    readonly symbol: string;
-};
-/**
- * Request parameters for getOptionsStrategyQuote operation in OptionsApi.
- * @export
- * @interface OptionsApiGetOptionsStrategyQuoteRequest
- */
-export type OptionsApiGetOptionsStrategyQuoteRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiGetOptionsStrategyQuote
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiGetOptionsStrategyQuote
-    */
-    readonly userSecret: string;
-    /**
-    * The ID of the account get positions.
-    * @type {string}
-    * @memberof OptionsApiGetOptionsStrategyQuote
-    */
-    readonly accountId: string;
-    /**
-    * Option strategy id obtained from response when creating option strategy object
-    * @type {string}
-    * @memberof OptionsApiGetOptionsStrategyQuote
-    */
-    readonly optionStrategyId: string;
-};
-/**
- * Request parameters for listOptionHoldings operation in OptionsApi.
- * @export
- * @interface OptionsApiListOptionHoldingsRequest
- */
-export type OptionsApiListOptionHoldingsRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiListOptionHoldings
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiListOptionHoldings
-    */
-    readonly userSecret: string;
-    /**
-    * The ID of the account get positions.
-    * @type {string}
-    * @memberof OptionsApiListOptionHoldings
-    */
-    readonly accountId: string;
-};
-/**
- * Request parameters for placeOptionStrategy operation in OptionsApi.
- * @export
- * @interface OptionsApiPlaceOptionStrategyRequest
- */
-export type OptionsApiPlaceOptionStrategyRequest = {
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiPlaceOptionStrategy
-    */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof OptionsApiPlaceOptionStrategy
-    */
-    readonly userSecret: string;
-    /**
-    * The ID of the account get positions.
-    * @type {string}
-    * @memberof OptionsApiPlaceOptionStrategy
-    */
-    readonly accountId: string;
-    /**
-    * Option strategy id obtained from response when creating option strategy object
-    * @type {string}
-    * @memberof OptionsApiPlaceOptionStrategy
-    */
-    readonly optionStrategyId: string;
-} & OptionsPlaceOptionStrategyRequest;
-/**
- * OptionsApi - object-oriented interface
- * @export
- * @class OptionsApi
- * @extends {BaseAPI}
- */
-export declare class OptionsApi extends OptionsApiCustom {
-    /**
-     *
-     * @summary Creates an option strategy object that will be used to place an option strategy order
-     * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OptionsApi
-     */
-    getOptionStrategy(requestParameters: OptionsApiGetOptionStrategyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StrategyQuotes, any>>;
-    /**
-     *
-     * @summary Get the options chain
-     * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OptionsApi
-     */
-    getOptionsChain(requestParameters: OptionsApiGetOptionsChainRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChainInner[], any>>;
-    /**
-     *
-     * @summary Get latest market data of option strategy
-     * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OptionsApi
-     */
-    getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StrategyQuotes, any>>;
-    /**
-     *
-     * @summary Get the options holdings in the account
-     * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OptionsApi
-     */
-    listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionsHoldings, any>>;
-    /**
-     *
-     * @summary Place an option strategy order on the brokerage
-     * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OptionsApi
-     */
-    placeOptionStrategy(requestParameters: OptionsApiPlaceOptionStrategyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StrategyOrderRecord, any>>;
-}
+import { OptionsApiGenerated } from "./options-api-generated";
+export * from "./options-api-generated";
+export declare class OptionsApi extends OptionsApiGenerated {
+}