snaptrade-typescript-sdk 9.0.168 → 9.0.169

package/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/npm-v9.0.168-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.168)
+[![npm](https://img.shields.io/badge/npm-v9.0.169-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.169)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -36,6 +36,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.authentication.loginSnapTradeUser`](#snaptradeauthenticationloginsnaptradeuser)
   * [`snaptrade.authentication.registerSnapTradeUser`](#snaptradeauthenticationregistersnaptradeuser)
   * [`snaptrade.authentication.resetSnapTradeUserSecret`](#snaptradeauthenticationresetsnaptradeusersecret)
+  * [`snaptrade.connections.deleteConnection`](#snaptradeconnectionsdeleteconnection)
   * [`snaptrade.connections.detailBrokerageAuthorization`](#snaptradeconnectionsdetailbrokerageauthorization)
   * [`snaptrade.connections.disableBrokerageAuthorization`](#snaptradeconnectionsdisablebrokerageauthorization)
   * [`snaptrade.connections.listBrokerageAuthorizations`](#snaptradeconnectionslistbrokerageauthorizations)
@@ -957,6 +958,41 @@ SnapTrade User Secret. This is a randomly generated string and should be stored
 ---
 
 
+### `snaptrade.connections.deleteConnection`<a id="snaptradeconnectionsdeleteconnection"></a>
+
+Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```typescript
+const deleteConnectionResponse = await snaptrade.connections.deleteConnection({
+  connectionId: "87b24961-b51e-4db8-9226-f198f6518a89",
+  userId: "snaptrade-user-123",
+  userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+});
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### connectionId: `string`<a id="connectionid-string"></a>
+
+##### userId: `string`<a id="userid-string"></a>
+
+##### userSecret: `string`<a id="usersecret-string"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[DeleteConnectionConfirmation](./models/delete-connection-confirmation.ts)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/connection/{connectionId}` `DELETE`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.connections.detailBrokerageAuthorization`<a id="snaptradeconnectionsdetailbrokerageauthorization"></a>
 
 Returns a single connection for the specified ID.

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

@@ -5,12 +5,23 @@ import { BrokerageAuthorization } from '../models';
 import { BrokerageAuthorizationDisabledConfirmation } from '../models';
 import { BrokerageAuthorizationRefreshConfirmation } from '../models';
 import { ConnectionsSessionEvents200ResponseInner } from '../models';
+import { DeleteConnectionConfirmation } from '../models';
 import { RateOfReturnResponse } from '../models';
 /**
  * ConnectionsApi - axios parameter creator
  * @export
  */
 export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+     * @summary Delete connection
+     * @param {string} connectionId
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteConnection: (connectionId: string, userId: string, userSecret: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a single connection for the specified ID.
      * @summary Get connection detail
@@ -86,6 +97,14 @@ export declare const ConnectionsApiAxiosParamCreator: (configuration?: Configura
  * @export
  */
 export declare const ConnectionsApiFp: (configuration?: Configuration) => {
+    /**
+     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+     * @summary Delete connection
+     * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteConnection(requestParameters: ConnectionsApiDeleteConnectionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteConnectionConfirmation>>;
     /**
      * Returns a single connection for the specified ID.
      * @summary Get connection detail
@@ -148,6 +167,14 @@ export declare const ConnectionsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const ConnectionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+     * @summary Delete connection
+     * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteConnection(requestParameters: ConnectionsApiDeleteConnectionRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteConnectionConfirmation>;
     /**
      * Returns a single connection for the specified ID.
      * @summary Get connection detail
@@ -205,6 +232,31 @@ export declare const ConnectionsApiFactory: (configuration?: Configuration, base
      */
     sessionEvents(requestParameters: ConnectionsApiSessionEventsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<ConnectionsSessionEvents200ResponseInner>>;
 };
+/**
+ * Request parameters for deleteConnection operation in ConnectionsApi.
+ * @export
+ * @interface ConnectionsApiDeleteConnectionRequest
+ */
+export type ConnectionsApiDeleteConnectionRequest = {
+    /**
+    *
+    * @type {string}
+    * @memberof ConnectionsApiDeleteConnection
+    */
+    readonly connectionId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof ConnectionsApiDeleteConnection
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof ConnectionsApiDeleteConnection
+    */
+    readonly userSecret: string;
+};
 /**
  * Request parameters for detailBrokerageAuthorization operation in ConnectionsApi.
  * @export
@@ -381,6 +433,15 @@ export type ConnectionsApiSessionEventsRequest = {
  * @extends {BaseAPI}
  */
 export declare class ConnectionsApiGenerated extends BaseAPI {
+    /**
+     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+     * @summary Delete connection
+     * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConnectionsApiGenerated
+     */
+    deleteConnection(requestParameters: ConnectionsApiDeleteConnectionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteConnectionConfirmation, any>>;
     /**
      * Returns a single connection for the specified ID.
      * @summary Get connection detail

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

@@ -35,6 +35,61 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
  */
 const ConnectionsApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+         * @summary Delete connection
+         * @param {string} connectionId
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteConnection: (connectionId, userId, userSecret, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'connectionId' is not null or undefined
+            (0, common_1.assertParamExists)('deleteConnection', 'connectionId', connectionId);
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('deleteConnection', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('deleteConnection', 'userSecret', userSecret);
+            const localVarPath = `/connection/{connectionId}`
+                .replace(`{${"connectionId"}}`, encodeURIComponent(String(connectionId !== undefined ? connectionId : `-connectionId-`)));
+            // 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, key: "clientId", keyParamName: "clientId", configuration });
+            // authentication PartnerSignature required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
+            // authentication PartnerTimestamp required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", 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,
+                pathTemplate: '/connection/{connectionId}',
+                httpMethod: 'DELETE'
+            });
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns a single connection for the specified ID.
          * @summary Get connection detail
@@ -424,6 +479,19 @@ exports.ConnectionsApiAxiosParamCreator = ConnectionsApiAxiosParamCreator;
 const ConnectionsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.ConnectionsApiAxiosParamCreator)(configuration);
     return {
+        /**
+         * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+         * @summary Delete connection
+         * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteConnection(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteConnection(requestParameters.connectionId, requestParameters.userId, requestParameters.userSecret, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns a single connection for the specified ID.
          * @summary Get connection detail
@@ -525,6 +593,16 @@ exports.ConnectionsApiFp = ConnectionsApiFp;
 const ConnectionsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.ConnectionsApiFp)(configuration);
     return {
+        /**
+         * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+         * @summary Delete connection
+         * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteConnection(requestParameters, options) {
+            return localVarFp.deleteConnection(requestParameters, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns a single connection for the specified ID.
          * @summary Get connection detail
@@ -605,6 +683,17 @@ exports.ConnectionsApiFactory = ConnectionsApiFactory;
  * @extends {BaseAPI}
  */
 class ConnectionsApiGenerated extends base_1.BaseAPI {
+    /**
+     * Deletes the SnapTrade connection specified by the ID. This will also remove the accounts and holdings data associated with the connection from SnapTrade. This action is irreversible. This endpoint is asynchronous, a 200 response indicates that a task has been queued to delete the connection. Listen for the [`CONNECTION_DELETED` webhook](https://docs.snaptrade.com/docs/webhooks#webhooks-connection_deleted) webhook to know when the deletion has been completed and the data has been removed.
+     * @summary Delete connection
+     * @param {ConnectionsApiDeleteConnectionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConnectionsApiGenerated
+     */
+    deleteConnection(requestParameters, options) {
+        return (0, exports.ConnectionsApiFp)(this.configuration).deleteConnection(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns a single connection for the specified ID.
      * @summary Get connection detail