snaptrade-typescript-sdk 9.0.16 → 9.0.18

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

@@ -13,8 +13,8 @@ import { StrategyQuotes } from '../models';
  */
 export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
-     * @summary Creates an option strategy object that will be used to place an option strategy order
+     * Creates an option strategy object that will be used to place an option strategy order.
+     * @summary Create options strategy
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId The ID of the account to create the option strategy object in.
@@ -24,8 +24,8 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
      */
     getOptionStrategy: (userId: string, userSecret: string, accountId: string, optionsGetOptionStrategyRequest: OptionsGetOptionStrategyRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary Get the options chain
+     * Returns the option chain for the specified symbol in the specified account.
+     * @summary Get the options chain for a symbol
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId The ID of the account to get the options chain from.
@@ -35,8 +35,8 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
      */
     getOptionsChain: (userId: string, userSecret: string, accountId: string, symbol: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary Get latest market data of option strategy
+     * Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+     * @summary Get options strategy quotes
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId The ID of the account the strategy will be placed in.
@@ -46,8 +46,8 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
      */
     getOptionsStrategyQuote: (userId: string, userSecret: string, accountId: string, optionStrategyId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary Get the options holdings in the account
+     * Returns a list of Options Positions.
+     * @summary Get account option holdings
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId The ID of the account to fetch options holdings for.
@@ -56,8 +56,8 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
      */
     listOptionHoldings: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary Place an option strategy order on the brokerage
+     * Places the option strategy order and returns the order record received from the brokerage.
+     * @summary Place an option strategy order
      * @param {string} userId
      * @param {string} userSecret
      * @param {string} accountId The ID of the account to execute the strategy in.
@@ -74,40 +74,40 @@ export declare const OptionsApiAxiosParamCreator: (configuration?: Configuration
  */
 export declare const OptionsApiFp: (configuration?: Configuration) => {
     /**
-     *
-     * @summary Creates an option strategy object that will be used to place an option strategy order
+     * Creates an option strategy object that will be used to place an option strategy order.
+     * @summary Create options strategy
      * @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
+     * Returns the option chain for the specified symbol in the specified account.
+     * @summary Get the options chain for a symbol
      * @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
+     * Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+     * @summary Get options strategy quotes
      * @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
+     * Returns a list of Options Positions.
+     * @summary Get account option holdings
      * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionsPosition>>>;
     /**
-     *
-     * @summary Place an option strategy order on the brokerage
+     * Places the option strategy order and returns the order record received from the brokerage.
+     * @summary Place an option strategy order
      * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -120,40 +120,40 @@ export declare const OptionsApiFp: (configuration?: Configuration) => {
  */
 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
+     * Creates an option strategy object that will be used to place an option strategy order.
+     * @summary Create options strategy
      * @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
+     * Returns the option chain for the specified symbol in the specified account.
+     * @summary Get the options chain for a symbol
      * @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
+     * Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+     * @summary Get options strategy quotes
      * @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
+     * Returns a list of Options Positions.
+     * @summary Get account option holdings
      * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<OptionsPosition>>;
     /**
-     *
-     * @summary Place an option strategy order on the brokerage
+     * Places the option strategy order and returns the order record received from the brokerage.
+     * @summary Place an option strategy order
      * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -311,8 +311,8 @@ export type OptionsApiPlaceOptionStrategyRequest = {
  */
 export declare class OptionsApiGenerated extends BaseAPI {
     /**
-     *
-     * @summary Creates an option strategy object that will be used to place an option strategy order
+     * Creates an option strategy object that will be used to place an option strategy order.
+     * @summary Create options strategy
      * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -320,8 +320,8 @@ export declare class OptionsApiGenerated extends BaseAPI {
      */
     getOptionStrategy(requestParameters: OptionsApiGetOptionStrategyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StrategyQuotes, any>>;
     /**
-     *
-     * @summary Get the options chain
+     * Returns the option chain for the specified symbol in the specified account.
+     * @summary Get the options chain for a symbol
      * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -329,8 +329,8 @@ export declare class OptionsApiGenerated extends BaseAPI {
      */
     getOptionsChain(requestParameters: OptionsApiGetOptionsChainRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChainInner[], any>>;
     /**
-     *
-     * @summary Get latest market data of option strategy
+     * Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+     * @summary Get options strategy quotes
      * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -338,8 +338,8 @@ export declare class OptionsApiGenerated extends BaseAPI {
      */
     getOptionsStrategyQuote(requestParameters: OptionsApiGetOptionsStrategyQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StrategyQuotes, any>>;
     /**
-     *
-     * @summary Get the options holdings in the account
+     * Returns a list of Options Positions.
+     * @summary Get account option holdings
      * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -347,8 +347,8 @@ export declare class OptionsApiGenerated extends BaseAPI {
      */
     listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionsPosition[], any>>;
     /**
-     *
-     * @summary Place an option strategy order on the brokerage
+     * Places the option strategy order and returns the order record received from the brokerage.
+     * @summary Place an option strategy order
      * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api/options-api-generated.js

@@ -36,8 +36,8 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
 const OptionsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         *
-         * @summary Creates an option strategy object that will be used to place an option strategy order
+         * Creates an option strategy object that will be used to place an option strategy order.
+         * @summary Create options strategy
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId The ID of the account to create the option strategy object in.
@@ -97,8 +97,8 @@ const OptionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary Get the options chain
+         * Returns the option chain for the specified symbol in the specified account.
+         * @summary Get the options chain for a symbol
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId The ID of the account to get the options chain from.
@@ -158,8 +158,8 @@ const OptionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary Get latest market data of option strategy
+         * Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+         * @summary Get options strategy quotes
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId The ID of the account the strategy will be placed in.
@@ -217,8 +217,8 @@ const OptionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary Get the options holdings in the account
+         * Returns a list of Options Positions.
+         * @summary Get account option holdings
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId The ID of the account to fetch options holdings for.
@@ -272,8 +272,8 @@ const OptionsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         *
-         * @summary Place an option strategy order on the brokerage
+         * Places the option strategy order and returns the order record received from the brokerage.
+         * @summary Place an option strategy order
          * @param {string} userId
          * @param {string} userSecret
          * @param {string} accountId The ID of the account to execute the strategy in.
@@ -347,8 +347,8 @@ const OptionsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.OptionsApiAxiosParamCreator)(configuration);
     return {
         /**
-         *
-         * @summary Creates an option strategy object that will be used to place an option strategy order
+         * Creates an option strategy object that will be used to place an option strategy order.
+         * @summary Create options strategy
          * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -365,8 +365,8 @@ const OptionsApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary Get the options chain
+         * Returns the option chain for the specified symbol in the specified account.
+         * @summary Get the options chain for a symbol
          * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -378,8 +378,8 @@ const OptionsApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary Get latest market data of option strategy
+         * Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+         * @summary Get options strategy quotes
          * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -391,8 +391,8 @@ const OptionsApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary Get the options holdings in the account
+         * Returns a list of Options Positions.
+         * @summary Get account option holdings
          * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -404,8 +404,8 @@ const OptionsApiFp = function (configuration) {
             });
         },
         /**
-         *
-         * @summary Place an option strategy order on the brokerage
+         * Places the option strategy order and returns the order record received from the brokerage.
+         * @summary Place an option strategy order
          * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -432,8 +432,8 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.OptionsApiFp)(configuration);
     return {
         /**
-         *
-         * @summary Creates an option strategy object that will be used to place an option strategy order
+         * Creates an option strategy object that will be used to place an option strategy order.
+         * @summary Create options strategy
          * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -442,8 +442,8 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getOptionStrategy(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary Get the options chain
+         * Returns the option chain for the specified symbol in the specified account.
+         * @summary Get the options chain for a symbol
          * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -452,8 +452,8 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getOptionsChain(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary Get latest market data of option strategy
+         * Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+         * @summary Get options strategy quotes
          * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -462,8 +462,8 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getOptionsStrategyQuote(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary Get the options holdings in the account
+         * Returns a list of Options Positions.
+         * @summary Get account option holdings
          * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -472,8 +472,8 @@ const OptionsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listOptionHoldings(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         *
-         * @summary Place an option strategy order on the brokerage
+         * Places the option strategy order and returns the order record received from the brokerage.
+         * @summary Place an option strategy order
          * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -492,8 +492,8 @@ exports.OptionsApiFactory = OptionsApiFactory;
  */
 class OptionsApiGenerated extends base_1.BaseAPI {
     /**
-     *
-     * @summary Creates an option strategy object that will be used to place an option strategy order
+     * Creates an option strategy object that will be used to place an option strategy order.
+     * @summary Create options strategy
      * @param {OptionsApiGetOptionStrategyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -503,8 +503,8 @@ class OptionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.OptionsApiFp)(this.configuration).getOptionStrategy(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary Get the options chain
+     * Returns the option chain for the specified symbol in the specified account.
+     * @summary Get the options chain for a symbol
      * @param {OptionsApiGetOptionsChainRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -514,8 +514,8 @@ class OptionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.OptionsApiFp)(this.configuration).getOptionsChain(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary Get latest market data of option strategy
+     * Returns a Strategy Quotes object which has latest market data of the specified option strategy.
+     * @summary Get options strategy quotes
      * @param {OptionsApiGetOptionsStrategyQuoteRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -525,8 +525,8 @@ class OptionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.OptionsApiFp)(this.configuration).getOptionsStrategyQuote(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary Get the options holdings in the account
+     * Returns a list of Options Positions.
+     * @summary Get account option holdings
      * @param {OptionsApiListOptionHoldingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -536,8 +536,8 @@ class OptionsApiGenerated extends base_1.BaseAPI {
         return (0, exports.OptionsApiFp)(this.configuration).listOptionHoldings(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary Place an option strategy order on the brokerage
+     * Places the option strategy order and returns the order record received from the brokerage.
+     * @summary Place an option strategy order
      * @param {OptionsApiPlaceOptionStrategyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}