snaptrade-typescript-sdk 3.0.0 → 5.0.0

package/dist/api/connections-api.d.ts

@@ -0,0 +1,214 @@
+/**
+ * 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).
+ * 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 { BrokerageAuthorization } from '../models';
+/**
+ * ConnectionsApi - axios parameter creator
+ * @export
+ */
+export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List all brokerage authorizations for the user
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBrokerageAuthorizations: (userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ConnectionsApi - functional programming interface
+ * @export
+ */
+export declare const ConnectionsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @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: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrokerageAuthorization>>;
+    /**
+     *
+     * @summary List all brokerage authorizations for the user
+     * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BrokerageAuthorization>>>;
+    /**
+     *
+     * @summary Remove a brokerage authorization.
+     * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ConnectionsApi - factory interface
+ * @export
+ */
+export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @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: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<BrokerageAuthorization>;
+    /**
+     *
+     * @summary List all brokerage authorizations for the user
+     * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<BrokerageAuthorization>>;
+    /**
+     *
+     * @summary Remove a brokerage authorization.
+     * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for detailBrokerageAuthorization operation in ConnectionsApi.
+ * @export
+ * @interface ConnectionsApiDetailBrokerageAuthorizationRequest
+ */
+export interface ConnectionsApiDetailBrokerageAuthorizationRequest {
+    /**
+     * The ID of a brokerage authorization object.
+     * @type {string}
+     * @memberof ConnectionsApiDetailBrokerageAuthorization
+     */
+    readonly authorizationId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionsApiDetailBrokerageAuthorization
+     */
+    readonly userId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionsApiDetailBrokerageAuthorization
+     */
+    readonly userSecret: string;
+}
+/**
+ * Request parameters for listBrokerageAuthorizations operation in ConnectionsApi.
+ * @export
+ * @interface ConnectionsApiListBrokerageAuthorizationsRequest
+ */
+export interface ConnectionsApiListBrokerageAuthorizationsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionsApiListBrokerageAuthorizations
+     */
+    readonly userId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionsApiListBrokerageAuthorizations
+     */
+    readonly userSecret: string;
+}
+/**
+ * Request parameters for removeBrokerageAuthorization operation in ConnectionsApi.
+ * @export
+ * @interface ConnectionsApiRemoveBrokerageAuthorizationRequest
+ */
+export interface ConnectionsApiRemoveBrokerageAuthorizationRequest {
+    /**
+     * The ID of the Authorization to delete.
+     * @type {string}
+     * @memberof ConnectionsApiRemoveBrokerageAuthorization
+     */
+    readonly authorizationId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionsApiRemoveBrokerageAuthorization
+     */
+    readonly userId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionsApiRemoveBrokerageAuthorization
+     */
+    readonly userSecret: string;
+}
+/**
+ * ConnectionsApi - object-oriented interface
+ * @export
+ * @class ConnectionsApi
+ * @extends {BaseAPI}
+ */
+export declare class ConnectionsApi extends 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 ConnectionsApi
+     */
+    detailBrokerageAuthorization(requestParameters: ConnectionsApiDetailBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization, any>>;
+    /**
+     *
+     * @summary List all brokerage authorizations for the user
+     * @param {ConnectionsApiListBrokerageAuthorizationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConnectionsApi
+     */
+    listBrokerageAuthorizations(requestParameters: ConnectionsApiListBrokerageAuthorizationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BrokerageAuthorization[], any>>;
+    /**
+     *
+     * @summary Remove a brokerage authorization.
+     * @param {ConnectionsApiRemoveBrokerageAuthorizationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConnectionsApi
+     */
+    removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}