snaptrade-typescript-sdk 6.1.0 → 6.3.0

package/dist/models/session-event.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface SessionEvent
+ */
+export interface SessionEvent {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'session_event_type'?: SessionEventSessionEventTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'session_id'?: string;
+    /**
+     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'user_id'?: string;
+    /**
+     * Time
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'created_date'?: string;
+}
+export declare const SessionEventSessionEventTypeEnum: {
+    readonly DisclaimerAccepted: "DISCLAIMER_ACCEPTED";
+    readonly BrokerageConnectionInitiated: "BROKERAGE_CONNECTION_INITIATED";
+    readonly BrokerageAuthentication: "BROKERAGE_AUTHENTICATION";
+    readonly MfaAuthorization: "MFA_AUTHORIZATION";
+    readonly ConnectionSuccessful: "CONNECTION_SUCCESSFUL";
+    readonly ConnectionFailed: "CONNECTION_FAILED";
+    readonly PartnerRedirect: "PARTNER_REDIRECT";
+};
+export type SessionEventSessionEventTypeEnum = typeof SessionEventSessionEventTypeEnum[keyof typeof SessionEventSessionEventTypeEnum];

package/dist/models/session-event.js

@@ -0,0 +1,25 @@
+"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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionEventSessionEventTypeEnum = void 0;
+exports.SessionEventSessionEventTypeEnum = {
+    DisclaimerAccepted: 'DISCLAIMER_ACCEPTED',
+    BrokerageConnectionInitiated: 'BROKERAGE_CONNECTION_INITIATED',
+    BrokerageAuthentication: 'BROKERAGE_AUTHENTICATION',
+    MfaAuthorization: 'MFA_AUTHORIZATION',
+    ConnectionSuccessful: 'CONNECTION_SUCCESSFUL',
+    ConnectionFailed: 'CONNECTION_FAILED',
+    PartnerRedirect: 'PARTNER_REDIRECT'
+};

package/dist/requestBeforeHook.d.ts

@@ -1,6 +1,7 @@
 import { Configuration } from "./configuration";
 import { AxiosRequestConfig } from "axios";
 export declare function requestBeforeHook(request: {
+    requestBody?: any;
     queryParameters: Record<string, any>;
     path: string;
     requestConfig: AxiosRequestConfig;

package/docs/ConnectionsApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**detailBrokerageAuthorization**](ConnectionsApi.md#detailBrokerageAuthorization) | **GET** /authorizations/{authorizationId} | Get detail of a specific brokerage authorizations for the user
 [**listBrokerageAuthorizations**](ConnectionsApi.md#listBrokerageAuthorizations) | **GET** /authorizations | List all brokerage authorizations for the user
 [**removeBrokerageAuthorization**](ConnectionsApi.md#removeBrokerageAuthorization) | **DELETE** /authorizations/{authorizationId} | Remove a brokerage authorization.
+[**sessionEvents**](ConnectionsApi.md#sessionEvents) | **GET** /sessionEvents | List all session events for the partner
 
 
 # **detailBrokerageAuthorization**
@@ -177,4 +178,58 @@ void (empty response body)
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
+# **sessionEvents**
+
+#### **GET** /sessionEvents
+
+
+### Example
+
+
+```typescript
+import { Snaptrade } from "snaptrade-typescript-sdk"
+
+const snaptrade = new Snaptrade({
+    // Defining the base path is optional and defaults to https://api.snaptrade.com/api/v1
+    // basePath: "https://api.snaptrade.com/api/v1",
+    consumerKey: "YOUR_CONSUMER_KEY",
+    clientId: "YOUR_CLIENT_ID",
+})
+
+const sessionEventsResponse = await snaptrade.connections.sessionEvents({
+        "partnerClientId": "PASSIVTEST",
+        "userId": "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
+    })
+
+console.log(sessionEventsResponse)
+
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **partnerClientId** | [**string**] |  | defaults to undefined
+ **userId** | [**string**] | Optional comma seperated list of user IDs used to filter the request on specific users | (optional) defaults to undefined
+
+
+### Return type
+
+**Array<ConnectionsSessionEvents200ResponseInner>**
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | A list of all Session Events for the Partner. |  -  |
+**0** | Unexpected error. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
 

package/docs/TransactionsAndReportingApi.md

@@ -32,6 +32,7 @@ const getActivitiesResponse = await snaptrade.transactionsAndReporting.getActivi
         "startDate": "2022-01-24",
         "endDate": "2022-01-24",
         "accounts": "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
+        "brokerageAuthorizations": "917c8734-8470-4a3e-a18f-57c3f2ee6631,65e839a3-9103-4cfb-9b72-2071ef80c5f2",
         "userId": "John.doe@snaptrade.com",
         "userSecret": "USERSECRET123",
     })
@@ -50,6 +51,7 @@ Name | Type | Description  | Notes
  **startDate** | [**string**] |  | (optional) defaults to undefined
  **endDate** | [**string**] |  | (optional) defaults to undefined
  **accounts** | [**string**] | Optional comma seperated list of account IDs used to filter the request on specific accounts | (optional) defaults to undefined
+ **brokerageAuthorizations** | [**string**] | Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations | (optional) defaults to undefined
 
 
 ### Return type

package/models/account-order-record.ts

@@ -20,6 +20,9 @@ import { AccountOrderRecordStatus } from './account-order-record-status';
 import { Action } from './action';
 // May contain unused imports in some cases
 // @ts-ignore
+import { OptionsSymbol } from './options-symbol';
+// May contain unused imports in some cases
+// @ts-ignore
 import { OrderType } from './order-type';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -60,6 +63,12 @@ export interface AccountOrderRecord {
      * @memberof AccountOrderRecord
      */
     'universal_symbol'?: UniversalSymbol;
+    /**
+     * 
+     * @type {OptionsSymbol}
+     * @memberof AccountOrderRecord
+     */
+    'option_symbol'?: OptionsSymbol;
     /**
      * 
      * @type {Action}

package/models/connections-session-events200-response-inner.ts

@@ -0,0 +1,25 @@
+/* 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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+// May contain unused imports in some cases
+// @ts-ignore
+import { SessionEvent } from './session-event';
+
+/**
+ * @type ConnectionsSessionEvents200ResponseInner
+ * @export
+ */
+export type ConnectionsSessionEvents200ResponseInner = SessionEvent;
+
+

package/models/index.ts

@@ -16,6 +16,7 @@ export * from './brokerage-symbol';
 export * from './brokerage-type';
 export * from './calculated-trade';
 export * from './cash-restriction';
+export * from './connections-session-events200-response-inner';
 export * from './currency';
 export * from './delete-user-response';
 export * from './dividend-at-date';
@@ -68,6 +69,7 @@ export * from './position';
 export * from './position-symbol';
 export * from './redirect-tokenand-pin';
 export * from './security-type';
+export * from './session-event';
 export * from './snap-trade-apidisclaimer-accept-status';
 export * from './snap-trade-holdings-account';
 export * from './snap-trade-holdings-total-value';

package/models/session-event.ts

@@ -0,0 +1,68 @@
+/* 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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ * @interface SessionEvent
+ */
+export interface SessionEvent {
+    [key: string]: any;
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'session_event_type'?: SessionEventSessionEventTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'session_id'?: string;
+    /**
+     * SnapTrade User ID. Provided by SnapTrade Partner. Can be any string, as long as it\'s unique to a user
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'user_id'?: string;
+    /**
+     * Time
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'created_date'?: string;
+}
+
+export const SessionEventSessionEventTypeEnum = {
+    DisclaimerAccepted: 'DISCLAIMER_ACCEPTED',
+    BrokerageConnectionInitiated: 'BROKERAGE_CONNECTION_INITIATED',
+    BrokerageAuthentication: 'BROKERAGE_AUTHENTICATION',
+    MfaAuthorization: 'MFA_AUTHORIZATION',
+    ConnectionSuccessful: 'CONNECTION_SUCCESSFUL',
+    ConnectionFailed: 'CONNECTION_FAILED',
+    PartnerRedirect: 'PARTNER_REDIRECT'
+} as const;
+
+export type SessionEventSessionEventTypeEnum = typeof SessionEventSessionEventTypeEnum[keyof typeof SessionEventSessionEventTypeEnum];
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snaptrade-typescript-sdk",
-  "version": "6.1.0",
+  "version": "6.3.0",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "repository": {

package/requestBeforeHook.ts

@@ -2,6 +2,7 @@ import { Configuration } from "./configuration";
 import { AxiosRequestConfig } from "axios";
 
 export function requestBeforeHook(request: {
+  requestBody?: any;
   queryParameters: Record<string, any>;
   path: string;
   requestConfig: AxiosRequestConfig;