snaptrade-typescript-sdk 8.7.0 → 8.9.0

package/docs/AuthenticationApi.md

@@ -1,293 +0,0 @@
-# AuthenticationApi
-
-All URIs are relative to *https://api.snaptrade.com/api/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**deleteSnapTradeUser**](AuthenticationApi.md#deleteSnapTradeUser) | **DELETE** /snapTrade/deleteUser | Delete user from SnapTrade, disabling all brokerage authorizations and permanently deleting all data associated with the user
-[**getUserJWT**](AuthenticationApi.md#getUserJWT) | **GET** /snapTrade/encryptedJWT | Obtains an encrypted JWT tokens that should be decrypted on a user\'s local device
-[**listSnapTradeUsers**](AuthenticationApi.md#listSnapTradeUsers) | **GET** /snapTrade/listUsers | Get a list of all SnapTrade users you\'ve registered on our platform
-[**loginSnapTradeUser**](AuthenticationApi.md#loginSnapTradeUser) | **POST** /snapTrade/login | Generate a redirect URI to securely login a user to the SnapTrade Connection Portal
-[**registerSnapTradeUser**](AuthenticationApi.md#registerSnapTradeUser) | **POST** /snapTrade/registerUser | Register user with SnapTrade in order to create secure brokerage authorizations
-
-
-# **deleteSnapTradeUser**
-
-#### **DELETE** /snapTrade/deleteUser
-
-
-### 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 deleteSnapTradeUserResponse =
-  await snaptrade.authentication.deleteSnapTradeUser({
-    userId: "John.doe@snaptrade.com",
-  });
-
-console.log(deleteSnapTradeUserResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **userId** | [**string**] |  | defaults to undefined
-
-
-### Return type
-
-**DeleteUserResponse**
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Delete successful |  -  |
-**400** | Bad Request |  -  |
-**403** | Forbidden |  -  |
-**404** | Not Found |  -  |
-**500** | Unexpected Error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-# **getUserJWT**
-
-#### **GET** /snapTrade/encryptedJWT
-
-
-### 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 getUserJWTResponse = await snaptrade.authentication.getUserJWT({
-  userId: "John.doe@snaptrade.com",
-  userSecret: "USERSECRET123",
-});
-
-console.log(getUserJWTResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **userId** | [**string**] |  | defaults to undefined
- **userSecret** | [**string**] |  | defaults to undefined
-
-
-### Return type
-
-**EncryptedResponse**
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully obtained encrypted JWT data. See description on how to object JWT token |  -  |
-**400** | Bad Request |  -  |
-**403** | Forbidden |  -  |
-**404** | Not Found |  -  |
-**500** | Unexpected Error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-# **listSnapTradeUsers**
-
-#### **GET** /snapTrade/listUsers
-
-
-### 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 listSnapTradeUsersResponse =
-  await snaptrade.authentication.listSnapTradeUsers();
-
-console.log(listSnapTradeUsersResponse);
-```
-
-
-### Parameters
-This endpoint does not need any parameter.
-
-
-### Return type
-
-**Array<string>**
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully generated a list of users |  -  |
-**400** | Bad Request. Could be caused by various reasons. Error message is provided in response |  -  |
-**404** | Invalid SnapTrade Client ID provided in query |  -  |
-**500** | Unexpected error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-# **loginSnapTradeUser**
-
-#### **POST** /snapTrade/login
-
-
-### 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 loginSnapTradeUserResponse =
-  await snaptrade.authentication.loginSnapTradeUser({
-    userId: "John.doe@snaptrade.com",
-    userSecret: "USERSECRET123",
-    broker: "ALPACA",
-    immediate_redirect: true,
-    custom_redirect: "https://passiv.com",
-    reconnect: "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
-    connection_type: "read",
-  });
-
-console.log(loginSnapTradeUserResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **snapTradeLoginUserRequestBody** | **SnapTradeLoginUserRequestBody**|  |
- **userId** | [**string**] |  | defaults to undefined
- **userSecret** | [**string**] |  | defaults to undefined
-
-
-### Return type
-
-**AuthenticationLoginSnapTradeUser200Response**
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Login successful. Redirect user to provided URI in response |  -  |
-**400** | Bad Request |  -  |
-**403** | Forbidden |  -  |
-**404** | Not Found |  -  |
-**500** | Unexpected Error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-# **registerSnapTradeUser**
-
-#### **POST** /snapTrade/registerUser
-
-
-### 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 registerSnapTradeUserResponse =
-  await snaptrade.authentication.registerSnapTradeUser({
-    user_id: "snaptrade-user-123",
-    rsa_public_key:
-      "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw==",
-  });
-
-console.log(registerSnapTradeUserResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **snapTradeRegisterUserRequestBody** | **SnapTradeRegisterUserRequestBody**|  |
-
-
-### Return type
-
-**UserIDandSecret**
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Successfully registered user |  -  |
-**400** | Bad Request. Could be caused by various reasons. Error message is provided in response |  -  |
-**404** | Invalid SnapTrade Client ID provided in query |  -  |
-**500** | Unexpected error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-

package/docs/ConnectionsApi.md

@@ -1,238 +0,0 @@
-# ConnectionsApi
-
-All URIs are relative to *https://api.snaptrade.com/api/v1*
-
-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**
-
-#### **GET** /authorizations/{authorizationId}
-
-
-### 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 detailBrokerageAuthorizationResponse =
-  await snaptrade.connections.detailBrokerageAuthorization({
-    authorizationId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    userId: "John.doe@snaptrade.com",
-    userSecret: "USERSECRET123",
-  });
-
-console.log(detailBrokerageAuthorizationResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authorizationId** | [**string**] | The ID of a brokerage authorization object. | defaults to undefined
- **userId** | [**string**] |  | defaults to undefined
- **userSecret** | [**string**] |  | defaults to undefined
-
-
-### Return type
-
-**BrokerageAuthorization**
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | Authorization object for the authenticated user. |  -  |
-**0** | Unexpected error. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-# **listBrokerageAuthorizations**
-
-#### **GET** /authorizations
-
-
-### 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 listBrokerageAuthorizationsResponse =
-  await snaptrade.connections.listBrokerageAuthorizations({
-    userId: "John.doe@snaptrade.com",
-    userSecret: "USERSECRET123",
-  });
-
-console.log(listBrokerageAuthorizationsResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **userId** | [**string**] |  | defaults to undefined
- **userSecret** | [**string**] |  | defaults to undefined
-
-
-### Return type
-
-**Array<BrokerageAuthorization>**
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | A list of all Authorization objects for the authenticated user. |  -  |
-**0** | Unexpected error. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-# **removeBrokerageAuthorization**
-
-#### **DELETE** /authorizations/{authorizationId}
-
-
-### 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 removeBrokerageAuthorizationResponse =
-  await snaptrade.connections.removeBrokerageAuthorization({
-    authorizationId: "2bcd7cc3-e922-4976-bce1-9858296801c3",
-    userId: "John.doe@snaptrade.com",
-    userSecret: "USERSECRET123",
-  });
-
-console.log(removeBrokerageAuthorizationResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **authorizationId** | [**string**] | The ID of the Authorization to delete. | defaults to undefined
- **userId** | [**string**] |  | defaults to undefined
- **userSecret** | [**string**] |  | defaults to undefined
-
-
-### Return type
-
-void (empty response body)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**204** | Brokerage authorization object has been successfully deleted |  -  |
-**400** | The specified authorizationId is invalid (not a UUID string). |  -  |
-**404** | The specified authorizationId was not found. |  -  |
-**0** | Unexpected error. |  -  |
-
-[[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",
-  sessionId:
-    "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
- **sessionId** | [**string**] | Optional comma seperated list of session 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/ErrorLogsApi.md

@@ -1,62 +0,0 @@
-# ErrorLogsApi
-
-All URIs are relative to *https://api.snaptrade.com/api/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**listUserErrors**](ErrorLogsApi.md#listUserErrors) | **GET** /snapTrade/listUserErrors | Retrieve error logs on behalf of your SnapTrade users
-
-
-# **listUserErrors**
-
-#### **GET** /snapTrade/listUserErrors
-
-
-### 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 listUserErrorsResponse = await snaptrade.errorLogs.listUserErrors({
-  userId: "John.doe@snaptrade.com",
-  userSecret: "USERSECRET123",
-});
-
-console.log(listUserErrorsResponse);
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **userId** | [**string**] |  | defaults to undefined
- **userSecret** | [**string**] |  | defaults to undefined
-
-
-### Return type
-
-**Array<UserErrorLog>**
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | A list of all user errors for a particular user in the last 90 days. |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
-