snaptrade-typescript-sdk 8.18.0 → 8.20.0

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

@@ -0,0 +1,266 @@
+/**
+ * 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 { AuthenticationLoginSnapTradeUser200Response } from '../models';
+import { DeleteUserResponse } from '../models';
+import { EncryptedResponse } from '../models';
+import { SnapTradeLoginUserRequestBody } from '../models';
+import { SnapTradeRegisterUserRequestBody } from '../models';
+import { UserIDandSecret } from '../models';
+/**
+ * AuthenticationApi - axios parameter creator
+ * @export
+ */
+export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a list of all SnapTrade users you\'ve registered on our platform
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSnapTradeUsers: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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: string, userSecret: string, snapTradeLoginUserRequestBody?: SnapTradeLoginUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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: SnapTradeRegisterUserRequestBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AuthenticationApi - functional programming interface
+ * @export
+ */
+export declare const AuthenticationApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteUserResponse>>;
+    /**
+     *
+     * @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: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptedResponse>>;
+    /**
+     *
+     * @summary Get a list of all SnapTrade users you\'ve registered on our platform
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSnapTradeUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    /**
+     *
+     * @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: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationLoginSnapTradeUser200Response>>;
+    /**
+     *
+     * @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: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserIDandSecret>>;
+};
+/**
+ * AuthenticationApi - factory interface
+ * @export
+ */
+export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @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: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse>;
+    /**
+     *
+     * @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: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): AxiosPromise<EncryptedResponse>;
+    /**
+     *
+     * @summary Get a list of all SnapTrade users you\'ve registered on our platform
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSnapTradeUsers(options?: AxiosRequestConfig): AxiosPromise<Array<string>>;
+    /**
+     *
+     * @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: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<AuthenticationLoginSnapTradeUser200Response>;
+    /**
+     *
+     * @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: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): AxiosPromise<UserIDandSecret>;
+};
+/**
+ * Request parameters for deleteSnapTradeUser operation in AuthenticationApi.
+ * @export
+ * @interface AuthenticationApiDeleteSnapTradeUserRequest
+ */
+export type AuthenticationApiDeleteSnapTradeUserRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AuthenticationApiDeleteSnapTradeUser
+    */
+    readonly userId: string;
+};
+/**
+ * Request parameters for getUserJWT operation in AuthenticationApi.
+ * @export
+ * @interface AuthenticationApiGetUserJWTRequest
+ */
+export type AuthenticationApiGetUserJWTRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AuthenticationApiGetUserJWT
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AuthenticationApiGetUserJWT
+    */
+    readonly userSecret: string;
+};
+/**
+ * Request parameters for loginSnapTradeUser operation in AuthenticationApi.
+ * @export
+ * @interface AuthenticationApiLoginSnapTradeUserRequest
+ */
+export type AuthenticationApiLoginSnapTradeUserRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof AuthenticationApiLoginSnapTradeUser
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof AuthenticationApiLoginSnapTradeUser
+    */
+    readonly userSecret: string;
+} & SnapTradeLoginUserRequestBody;
+/**
+ * Request parameters for registerSnapTradeUser operation in AuthenticationApi.
+ * @export
+ * @interface AuthenticationApiRegisterSnapTradeUserRequest
+ */
+export type AuthenticationApiRegisterSnapTradeUserRequest = {} & SnapTradeRegisterUserRequestBody;
+/**
+ * AuthenticationApiGenerated - object-oriented interface
+ * @export
+ * @class AuthenticationApiGenerated
+ * @extends {BaseAPI}
+ */
+export declare class AuthenticationApiGenerated extends 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: AuthenticationApiDeleteSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteUserResponse, any>>;
+    /**
+     *
+     * @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: AuthenticationApiGetUserJWTRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EncryptedResponse, any>>;
+    /**
+     *
+     * @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?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
+    /**
+     *
+     * @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: AuthenticationApiLoginSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticationLoginSnapTradeUser200Response, any>>;
+    /**
+     *
+     * @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: AuthenticationApiRegisterSnapTradeUserRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserIDandSecret, any>>;
+}