snaptrade-typescript-sdk 8.18.0 → 8.20.0

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

@@ -0,0 +1,411 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionsApiGenerated = exports.ConnectionsApiFactory = exports.ConnectionsApiFp = exports.ConnectionsApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+const requestBeforeHook_1 = require("../requestBeforeHook");
+/**
+ * ConnectionsApi - axios parameter creator
+ * @export
+ */
+const ConnectionsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Get detail of a specific brokerage authorizations for the user
+         * @param {string} authorizationId The ID of a brokerage authorization object.
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        detailBrokerageAuthorization: (authorizationId, userId, userSecret, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'authorizationId' is not null or undefined
+            (0, common_1.assertParamExists)('detailBrokerageAuthorization', 'authorizationId', authorizationId);
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('detailBrokerageAuthorization', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('detailBrokerageAuthorization', 'userSecret', userSecret);
+            const localVarPath = `/authorizations/{authorizationId}`
+                .replace(`{${"authorizationId"}}`, encodeURIComponent(String(authorizationId !== undefined ? authorizationId : `-authorizationId-`)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
+            const localVarQueryParameter = {};
+            // authentication PartnerClientId required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "clientId", configuration });
+            // authentication PartnerSignature required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, keyParamName: "Signature", configuration });
+            // authentication PartnerTimestamp required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "timestamp", configuration });
+            if (userId !== undefined) {
+                localVarQueryParameter['userId'] = userId;
+            }
+            if (userSecret !== undefined) {
+                localVarQueryParameter['userSecret'] = userSecret;
+            }
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            (0, requestBeforeHook_1.requestBeforeHook)({
+                queryParameters: localVarQueryParameter,
+                requestConfig: localVarRequestOptions,
+                path: localVarPath,
+                configuration
+            });
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary List all brokerage authorizations for the user
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listBrokerageAuthorizations: (userId, userSecret, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('listBrokerageAuthorizations', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('listBrokerageAuthorizations', 'userSecret', userSecret);
+            const localVarPath = `/authorizations`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
+            const localVarQueryParameter = {};
+            // authentication PartnerClientId required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "clientId", configuration });
+            // authentication PartnerSignature required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, keyParamName: "Signature", configuration });
+            // authentication PartnerTimestamp required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "timestamp", configuration });
+            if (userId !== undefined) {
+                localVarQueryParameter['userId'] = userId;
+            }
+            if (userSecret !== undefined) {
+                localVarQueryParameter['userSecret'] = userSecret;
+            }
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            (0, requestBeforeHook_1.requestBeforeHook)({
+                queryParameters: localVarQueryParameter,
+                requestConfig: localVarRequestOptions,
+                path: localVarPath,
+                configuration
+            });
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Remove a brokerage authorization.
+         * @param {string} authorizationId The ID of the Authorization to delete.
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        removeBrokerageAuthorization: (authorizationId, userId, userSecret, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'authorizationId' is not null or undefined
+            (0, common_1.assertParamExists)('removeBrokerageAuthorization', 'authorizationId', authorizationId);
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('removeBrokerageAuthorization', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('removeBrokerageAuthorization', 'userSecret', userSecret);
+            const localVarPath = `/authorizations/{authorizationId}`
+                .replace(`{${"authorizationId"}}`, encodeURIComponent(String(authorizationId !== undefined ? authorizationId : `-authorizationId-`)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
+            const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
+            const localVarQueryParameter = {};
+            // authentication PartnerClientId required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "clientId", configuration });
+            // authentication PartnerSignature required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, keyParamName: "Signature", configuration });
+            // authentication PartnerTimestamp required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "timestamp", configuration });
+            if (userId !== undefined) {
+                localVarQueryParameter['userId'] = userId;
+            }
+            if (userSecret !== undefined) {
+                localVarQueryParameter['userSecret'] = userSecret;
+            }
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            (0, requestBeforeHook_1.requestBeforeHook)({
+                queryParameters: localVarQueryParameter,
+                requestConfig: localVarRequestOptions,
+                path: localVarPath,
+                configuration
+            });
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary List all session events for the partner
+         * @param {string} partnerClientId
+         * @param {string} [userId] Optional comma seperated list of user IDs used to filter the request on specific users
+         * @param {string} [sessionId] Optional comma seperated list of session IDs used to filter the request on specific users
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sessionEvents: (partnerClientId, userId, sessionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'partnerClientId' is not null or undefined
+            (0, common_1.assertParamExists)('sessionEvents', 'partnerClientId', partnerClientId);
+            const localVarPath = `/sessionEvents`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
+            const localVarQueryParameter = {};
+            // authentication PartnerClientId required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "clientId", configuration });
+            // authentication PartnerSignature required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, keyParamName: "Signature", configuration });
+            // authentication PartnerTimestamp required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "timestamp", configuration });
+            if (partnerClientId !== undefined) {
+                localVarQueryParameter['PartnerClientId'] = partnerClientId;
+            }
+            if (userId !== undefined) {
+                localVarQueryParameter['userId'] = userId;
+            }
+            if (sessionId !== undefined) {
+                localVarQueryParameter['sessionId'] = sessionId;
+            }
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            (0, requestBeforeHook_1.requestBeforeHook)({
+                queryParameters: localVarQueryParameter,
+                requestConfig: localVarRequestOptions,
+                path: localVarPath,
+                configuration
+            });
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.ConnectionsApiAxiosParamCreator = ConnectionsApiAxiosParamCreator;
+/**
+ * ConnectionsApi - functional programming interface
+ * @export
+ */
+const ConnectionsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.ConnectionsApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary Get detail of a specific brokerage authorizations for the user
+         * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        detailBrokerageAuthorization(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.detailBrokerageAuthorization(requestParameters.authorizationId, requestParameters.userId, requestParameters.userSecret, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary List all brokerage authorizations for the user
+         * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listBrokerageAuthorizations(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listBrokerageAuthorizations(requestParameters.userId, requestParameters.userSecret, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Remove a brokerage authorization.
+         * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        removeBrokerageAuthorization(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.removeBrokerageAuthorization(requestParameters.authorizationId, requestParameters.userId, requestParameters.userSecret, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary List all session events for the partner
+         * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sessionEvents(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.sessionEvents(requestParameters.partnerClientId, requestParameters.userId, requestParameters.sessionId, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+    };
+};
+exports.ConnectionsApiFp = ConnectionsApiFp;
+/**
+ * ConnectionsApi - factory interface
+ * @export
+ */
+const ConnectionsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.ConnectionsApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary Get detail of a specific brokerage authorizations for the user
+         * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        detailBrokerageAuthorization(requestParameters, options) {
+            return localVarFp.detailBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary List all brokerage authorizations for the user
+         * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listBrokerageAuthorizations(requestParameters, options) {
+            return localVarFp.listBrokerageAuthorizations(requestParameters, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Remove a brokerage authorization.
+         * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        removeBrokerageAuthorization(requestParameters, options) {
+            return localVarFp.removeBrokerageAuthorization(requestParameters, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary List all session events for the partner
+         * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        sessionEvents(requestParameters, options) {
+            return localVarFp.sessionEvents(requestParameters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.ConnectionsApiFactory = ConnectionsApiFactory;
+/**
+ * ConnectionsApiGenerated - object-oriented interface
+ * @export
+ * @class ConnectionsApiGenerated
+ * @extends {BaseAPI}
+ */
+class ConnectionsApiGenerated extends base_1.BaseAPI {
+    /**
+     *
+     * @summary Get detail of a specific brokerage authorizations for the user
+     * @param {ConnectionsApiDetailBrokerageAuthorizationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConnectionsApiGenerated
+     */
+    detailBrokerageAuthorization(requestParameters, options) {
+        return (0, exports.ConnectionsApiFp)(this.configuration).detailBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary List all brokerage authorizations for the user
+     * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConnectionsApiGenerated
+     */
+    listBrokerageAuthorizations(requestParameters, options) {
+        return (0, exports.ConnectionsApiFp)(this.configuration).listBrokerageAuthorizations(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Remove a brokerage authorization.
+     * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConnectionsApiGenerated
+     */
+    removeBrokerageAuthorization(requestParameters, options) {
+        return (0, exports.ConnectionsApiFp)(this.configuration).removeBrokerageAuthorization(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary List all session events for the partner
+     * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConnectionsApiGenerated
+     */
+    sessionEvents(requestParameters, options) {
+        return (0, exports.ConnectionsApiFp)(this.configuration).sessionEvents(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.ConnectionsApiGenerated = ConnectionsApiGenerated;