snaptrade-typescript-sdk 8.19.0 → 8.20.0

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

@@ -0,0 +1,274 @@
+/**
+ * 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 { BrokerageAuthorization } from '../models';
+import { ConnectionsSessionEvents200ResponseInner } 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>;
+    /**
+     *
+     * @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: string, userId?: string, sessionId?: 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>>;
+    /**
+     *
+     * @summary List all session events for the partner
+     * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>>;
+};
+/**
+ * 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>;
+    /**
+     *
+     * @summary List all session events for the partner
+     * @param {ConnectionsApiSessionEventsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>;
+};
+/**
+ * Request parameters for detailBrokerageAuthorization operation in ConnectionsApi.
+ * @export
+ * @interface ConnectionsApiDetailBrokerageAuthorizationRequest
+ */
+export type 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 type 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 type 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;
+};
+/**
+ * Request parameters for sessionEvents operation in ConnectionsApi.
+ * @export
+ * @interface ConnectionsApiSessionEventsRequest
+ */
+export type ConnectionsApiSessionEventsRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof ConnectionsApiSessionEvents
+    */
+    readonly partnerClientId: string;
+    /**
+    * Optional comma seperated list of user IDs used to filter the request on specific users
+    * @type {string}
+    * @memberof ConnectionsApiSessionEvents
+    */
+    readonly userId?: string;
+    /**
+    * Optional comma seperated list of session IDs used to filter the request on specific users
+    * @type {string}
+    * @memberof ConnectionsApiSessionEvents
+    */
+    readonly sessionId?: string;
+};
+/**
+ * ConnectionsApiGenerated - object-oriented interface
+ * @export
+ * @class ConnectionsApiGenerated
+ * @extends {BaseAPI}
+ */
+export declare class ConnectionsApiGenerated 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 ConnectionsApiGenerated
+     */
+    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 ConnectionsApiGenerated
+     */
+    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 ConnectionsApiGenerated
+     */
+    removeBrokerageAuthorization(requestParameters: ConnectionsApiRemoveBrokerageAuthorizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @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: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").SessionEvent[], any>>;
+}