snaptrade-typescript-sdk 8.18.0 → 8.20.0

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

@@ -0,0 +1,461 @@
+"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.AuthenticationApiGenerated = exports.AuthenticationApiFactory = exports.AuthenticationApiFp = exports.AuthenticationApiAxiosParamCreator = 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");
+/**
+ * AuthenticationApi - axios parameter creator
+ * @export
+ */
+const AuthenticationApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+         * @param {string} userId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSnapTradeUser: (userId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('deleteSnapTradeUser', 'userId', userId);
+            const localVarPath = `/snapTrade/deleteUser`;
+            // 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;
+            }
+            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 Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserJWT: (userId, userSecret, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('getUserJWT', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('getUserJWT', 'userSecret', userSecret);
+            const localVarPath = `/snapTrade/encryptedJWT`;
+            // 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 Get a list of all SnapTrade users you\'ve registered on our platform
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSnapTradeUsers: (options = {}) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/snapTrade/listUsers`;
+            // 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 });
+            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 Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {SnapTradeLoginUserRequestBody} [snapTradeLoginUserRequestBody]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        loginSnapTradeUser: (userId, userSecret, snapTradeLoginUserRequestBody, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('loginSnapTradeUser', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('loginSnapTradeUser', 'userSecret', userSecret);
+            const localVarPath = `/snapTrade/login`;
+            // 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: 'POST' }, 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;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            (0, requestBeforeHook_1.requestBeforeHook)({
+                requestBody: snapTradeLoginUserRequestBody,
+                queryParameters: localVarQueryParameter,
+                requestConfig: localVarRequestOptions,
+                path: localVarPath,
+                configuration
+            });
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(snapTradeLoginUserRequestBody, localVarRequestOptions, configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary Register user with SnapTrade in order to create secure brokerage authorizations
+         * @param {SnapTradeRegisterUserRequestBody} snapTradeRegisterUserRequestBody
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        registerSnapTradeUser: (snapTradeRegisterUserRequestBody, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'snapTradeRegisterUserRequestBody' is not null or undefined
+            (0, common_1.assertParamExists)('registerSnapTradeUser', 'snapTradeRegisterUserRequestBody', snapTradeRegisterUserRequestBody);
+            const localVarPath = `/snapTrade/registerUser`;
+            // 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: 'POST' }, 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 });
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            (0, requestBeforeHook_1.requestBeforeHook)({
+                requestBody: snapTradeRegisterUserRequestBody,
+                queryParameters: localVarQueryParameter,
+                requestConfig: localVarRequestOptions,
+                path: localVarPath,
+                configuration
+            });
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(snapTradeRegisterUserRequestBody, localVarRequestOptions, configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.AuthenticationApiAxiosParamCreator = AuthenticationApiAxiosParamCreator;
+/**
+ * AuthenticationApi - functional programming interface
+ * @export
+ */
+const AuthenticationApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.AuthenticationApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+         * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSnapTradeUser(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteSnapTradeUser(requestParameters.userId, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
+         * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserJWT(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserJWT(requestParameters.userId, requestParameters.userSecret, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Get a list of all SnapTrade users you\'ve registered on our platform
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSnapTradeUsers(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listSnapTradeUsers(options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+         * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        loginSnapTradeUser(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.loginSnapTradeUser(requestParameters.userId, requestParameters.userSecret, requestParameters, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+        /**
+         *
+         * @summary Register user with SnapTrade in order to create secure brokerage authorizations
+         * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        registerSnapTradeUser(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.registerSnapTradeUser(requestParameters, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
+    };
+};
+exports.AuthenticationApiFp = AuthenticationApiFp;
+/**
+ * AuthenticationApi - factory interface
+ * @export
+ */
+const AuthenticationApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.AuthenticationApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+         * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteSnapTradeUser(requestParameters, options) {
+            return localVarFp.deleteSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
+         * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserJWT(requestParameters, options) {
+            return localVarFp.getUserJWT(requestParameters, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Get a list of all SnapTrade users you\'ve registered on our platform
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSnapTradeUsers(options) {
+            return localVarFp.listSnapTradeUsers(options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+         * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        loginSnapTradeUser(requestParameters, options) {
+            return localVarFp.loginSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary Register user with SnapTrade in order to create secure brokerage authorizations
+         * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        registerSnapTradeUser(requestParameters, options) {
+            return localVarFp.registerSnapTradeUser(requestParameters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.AuthenticationApiFactory = AuthenticationApiFactory;
+/**
+ * AuthenticationApiGenerated - object-oriented interface
+ * @export
+ * @class AuthenticationApiGenerated
+ * @extends {BaseAPI}
+ */
+class AuthenticationApiGenerated extends base_1.BaseAPI {
+    /**
+     *
+     * @summary Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
+     * @param {AuthenticationApiDeleteSnapTradeUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiGenerated
+     */
+    deleteSnapTradeUser(requestParameters, options) {
+        return (0, exports.AuthenticationApiFp)(this.configuration).deleteSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
+     * @param {AuthenticationApiGetUserJWTRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiGenerated
+     */
+    getUserJWT(requestParameters, options) {
+        return (0, exports.AuthenticationApiFp)(this.configuration).getUserJWT(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Get a list of all SnapTrade users you\'ve registered on our platform
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiGenerated
+     */
+    listSnapTradeUsers(options) {
+        return (0, exports.AuthenticationApiFp)(this.configuration).listSnapTradeUsers(options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
+     * @param {AuthenticationApiLoginSnapTradeUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiGenerated
+     */
+    loginSnapTradeUser(requestParameters, options) {
+        return (0, exports.AuthenticationApiFp)(this.configuration).loginSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary Register user with SnapTrade in order to create secure brokerage authorizations
+     * @param {AuthenticationApiRegisterSnapTradeUserRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiGenerated
+     */
+    registerSnapTradeUser(requestParameters, options) {
+        return (0, exports.AuthenticationApiFp)(this.configuration).registerSnapTradeUser(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.AuthenticationApiGenerated = AuthenticationApiGenerated;