snaptrade-typescript-sdk 8.19.0 → 8.20.0

package/dist/api/reference-data-api-generated.d.ts

@@ -0,0 +1,467 @@
+/**
+ * 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, BaseAPI } from '../base';
+import { Brokerage } from '../models';
+import { BrokerageAuthorizationTypeReadOnly } from '../models';
+import { Currency } from '../models';
+import { Exchange } from '../models';
+import { ExchangeRatePairs } from '../models';
+import { PartnerData } from '../models';
+import { SecurityType } from '../models';
+import { SymbolQuery } from '../models';
+import { UniversalSymbol } from '../models';
+/**
+ * ReferenceDataApi - axios parameter creator
+ * @export
+ */
+export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Return the exchange rate of a currency pair
+     * @param {string} currencyPair A currency pair based on currency code for example, {CAD-USD}
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCurrencyExchangeRatePair: (currencyPair: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get metadata related to Snaptrade partner
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerInfo: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List of all security types.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSecurityTypes: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Return list of stock exchanges on Passiv and their suffixes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStockExchanges: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Search for symbols
+     * @param {SymbolQuery} [symbolQuery]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSymbols: (symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get details of a symbol by the ticker
+     * @param {string} ticker The ticker of the UniversalSymbol to get.
+     * @param {string} [symbolId] OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSymbolsByTicker: (ticker: string, symbolId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List of all brokerage authorization types
+     * @param {string} [brokerage] Comma separated value of brokerage slugs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllBrokerageAuthorizationType: (brokerage?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List of all brokerages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllBrokerages: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List of all supported currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllCurrencies: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Return the exchange rates of all supported currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllCurrenciesRates: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Search for symbols that are supported by a brokerage account using a substring
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {string} accountId The ID of the account get positions.
+     * @param {SymbolQuery} [symbolQuery]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    symbolSearchUserAccount: (userId: string, userSecret: string, accountId: string, symbolQuery?: SymbolQuery, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ReferenceDataApi - functional programming interface
+ * @export
+ */
+export declare const ReferenceDataApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Return the exchange rate of a currency pair
+     * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExchangeRatePairs>>;
+    /**
+     *
+     * @summary Get metadata related to Snaptrade partner
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerData>>;
+    /**
+     *
+     * @summary List of all security types.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSecurityTypes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SecurityType>>>;
+    /**
+     *
+     * @summary Return list of stock exchanges on Passiv and their suffixes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStockExchanges(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Exchange>>>;
+    /**
+     *
+     * @summary Search for symbols
+     * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
+    /**
+     *
+     * @summary Get details of a symbol by the ticker
+     * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UniversalSymbol>>;
+    /**
+     *
+     * @summary List of all brokerage authorization types
+     * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>>;
+    /**
+     *
+     * @summary List of all brokerages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllBrokerages(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Brokerage>>>;
+    /**
+     *
+     * @summary List of all supported currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllCurrencies(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Currency>>>;
+    /**
+     *
+     * @summary Return the exchange rates of all supported currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExchangeRatePairs>>>;
+    /**
+     *
+     * @summary Search for symbols that are supported by a brokerage account using a substring
+     * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UniversalSymbol>>>;
+};
+/**
+ * ReferenceDataApi - factory interface
+ * @export
+ */
+export declare const ReferenceDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Return the exchange rate of a currency pair
+     * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): AxiosPromise<ExchangeRatePairs>;
+    /**
+     *
+     * @summary Get metadata related to Snaptrade partner
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerInfo(options?: AxiosRequestConfig): AxiosPromise<PartnerData>;
+    /**
+     *
+     * @summary List of all security types.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSecurityTypes(options?: AxiosRequestConfig): AxiosPromise<Array<SecurityType>>;
+    /**
+     *
+     * @summary Return list of stock exchanges on Passiv and their suffixes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStockExchanges(options?: AxiosRequestConfig): AxiosPromise<Array<Exchange>>;
+    /**
+     *
+     * @summary Search for symbols
+     * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
+    /**
+     *
+     * @summary Get details of a symbol by the ticker
+     * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): AxiosPromise<UniversalSymbol>;
+    /**
+     *
+     * @summary List of all brokerage authorization types
+     * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorizationTypeReadOnly>>;
+    /**
+     *
+     * @summary List of all brokerages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllBrokerages(options?: AxiosRequestConfig): AxiosPromise<Array<Brokerage>>;
+    /**
+     *
+     * @summary List of all supported currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllCurrencies(options?: AxiosRequestConfig): AxiosPromise<Array<Currency>>;
+    /**
+     *
+     * @summary Return the exchange rates of all supported currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAllCurrenciesRates(options?: AxiosRequestConfig): AxiosPromise<Array<ExchangeRatePairs>>;
+    /**
+     *
+     * @summary Search for symbols that are supported by a brokerage account using a substring
+     * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): AxiosPromise<Array<UniversalSymbol>>;
+};
+/**
+ * Request parameters for getCurrencyExchangeRatePair operation in ReferenceDataApi.
+ * @export
+ * @interface ReferenceDataApiGetCurrencyExchangeRatePairRequest
+ */
+export type ReferenceDataApiGetCurrencyExchangeRatePairRequest = {
+    /**
+    * A currency pair based on currency code for example, {CAD-USD}
+    * @type {string}
+    * @memberof ReferenceDataApiGetCurrencyExchangeRatePair
+    */
+    readonly currencyPair: string;
+};
+/**
+ * Request parameters for getSymbols operation in ReferenceDataApi.
+ * @export
+ * @interface ReferenceDataApiGetSymbolsRequest
+ */
+export type ReferenceDataApiGetSymbolsRequest = {} & SymbolQuery;
+/**
+ * Request parameters for getSymbolsByTicker operation in ReferenceDataApi.
+ * @export
+ * @interface ReferenceDataApiGetSymbolsByTickerRequest
+ */
+export type ReferenceDataApiGetSymbolsByTickerRequest = {
+    /**
+    * The ticker of the UniversalSymbol to get.
+    * @type {string}
+    * @memberof ReferenceDataApiGetSymbolsByTicker
+    */
+    readonly ticker: string;
+    /**
+    * OPTIONAL IN PATH Can be used instead of the ticker ; The ID of the UniversalSymbol to get.
+    * @type {string}
+    * @memberof ReferenceDataApiGetSymbolsByTicker
+    */
+    readonly symbolId?: string;
+};
+/**
+ * Request parameters for listAllBrokerageAuthorizationType operation in ReferenceDataApi.
+ * @export
+ * @interface ReferenceDataApiListAllBrokerageAuthorizationTypeRequest
+ */
+export type ReferenceDataApiListAllBrokerageAuthorizationTypeRequest = {
+    /**
+    * Comma separated value of brokerage slugs
+    * @type {string}
+    * @memberof ReferenceDataApiListAllBrokerageAuthorizationType
+    */
+    readonly brokerage?: string;
+};
+/**
+ * Request parameters for symbolSearchUserAccount operation in ReferenceDataApi.
+ * @export
+ * @interface ReferenceDataApiSymbolSearchUserAccountRequest
+ */
+export type ReferenceDataApiSymbolSearchUserAccountRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof ReferenceDataApiSymbolSearchUserAccount
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof ReferenceDataApiSymbolSearchUserAccount
+    */
+    readonly userSecret: string;
+    /**
+    * The ID of the account get positions.
+    * @type {string}
+    * @memberof ReferenceDataApiSymbolSearchUserAccount
+    */
+    readonly accountId: string;
+} & SymbolQuery;
+/**
+ * ReferenceDataApiGenerated - object-oriented interface
+ * @export
+ * @class ReferenceDataApiGenerated
+ * @extends {BaseAPI}
+ */
+export declare class ReferenceDataApiGenerated extends BaseAPI {
+    /**
+     *
+     * @summary Return the exchange rate of a currency pair
+     * @param {ReferenceDataApiGetCurrencyExchangeRatePairRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    getCurrencyExchangeRatePair(requestParameters: ReferenceDataApiGetCurrencyExchangeRatePairRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs, any>>;
+    /**
+     *
+     * @summary Get metadata related to Snaptrade partner
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    getPartnerInfo(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerData, any>>;
+    /**
+     *
+     * @summary List of all security types.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    getSecurityTypes(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecurityType[], any>>;
+    /**
+     *
+     * @summary Return list of stock exchanges on Passiv and their suffixes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    getStockExchanges(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Exchange[], any>>;
+    /**
+     *
+     * @summary Search for symbols
+     * @param {ReferenceDataApiGetSymbolsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    getSymbols(requestParameters?: ReferenceDataApiGetSymbolsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
+    /**
+     *
+     * @summary Get details of a symbol by the ticker
+     * @param {ReferenceDataApiGetSymbolsByTickerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    getSymbolsByTicker(requestParameters: ReferenceDataApiGetSymbolsByTickerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol, any>>;
+    /**
+     *
+     * @summary List of all brokerage authorization types
+     * @param {ReferenceDataApiListAllBrokerageAuthorizationTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    listAllBrokerageAuthorizationType(requestParameters?: ReferenceDataApiListAllBrokerageAuthorizationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorizationTypeReadOnly[], any>>;
+    /**
+     *
+     * @summary List of all brokerages.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    listAllBrokerages(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Brokerage[], any>>;
+    /**
+     *
+     * @summary List of all supported currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    listAllCurrencies(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Currency[], any>>;
+    /**
+     *
+     * @summary Return the exchange rates of all supported currencies
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    listAllCurrenciesRates(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExchangeRatePairs[], any>>;
+    /**
+     *
+     * @summary Search for symbols that are supported by a brokerage account using a substring
+     * @param {ReferenceDataApiSymbolSearchUserAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReferenceDataApiGenerated
+     */
+    symbolSearchUserAccount(requestParameters: ReferenceDataApiSymbolSearchUserAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UniversalSymbol[], any>>;
+}