snaptrade-typescript-sdk 4.0.0 → 6.0.0

package/docs/AccountInformationApi.md

@@ -15,7 +15,8 @@ Method | HTTP request | Description
 
 
 # **getAllUserHoldings**
-> Array<AccountHoldings> getAllUserHoldings()
+
+#### **GET** /holdings
 
 
 ### Example
@@ -31,12 +32,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.accountInformation.getAllUserHoldings({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'brokerageAuthorizations': "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-})
-console.log(response)
+const getAllUserHoldingsResponse = await snaptrade.accountInformation.getAllUserHoldings({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "brokerageAuthorizations": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    })
+
+console.log(getAllUserHoldingsResponse)
 
 ```
 
@@ -54,10 +56,6 @@ Name | Type | Description  | Notes
 
 **Array<AccountHoldings>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -75,7 +73,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getUserAccountBalance**
-> Array<Balance> getUserAccountBalance()
+
+#### **GET** /accounts/{accountId}/balances
 
 
 ### Example
@@ -91,12 +90,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.accountInformation.getUserAccountBalance({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-})
-console.log(response)
+const getUserAccountBalanceResponse = await snaptrade.accountInformation.getUserAccountBalance({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "accountId_example",
+    })
+
+console.log(getUserAccountBalanceResponse)
 
 ```
 
@@ -114,10 +114,6 @@ Name | Type | Description  | Notes
 
 **Array<Balance>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -133,7 +129,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getUserAccountDetails**
-> Array<Account> getUserAccountDetails()
+
+#### **GET** /accounts/{accountId}
 
 
 ### Example
@@ -149,12 +146,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.accountInformation.getUserAccountDetails({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-})
-console.log(response)
+const getUserAccountDetailsResponse = await snaptrade.accountInformation.getUserAccountDetails({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "accountId_example",
+    })
+
+console.log(getUserAccountDetailsResponse)
 
 ```
 
@@ -172,10 +170,6 @@ Name | Type | Description  | Notes
 
 **Array<Account>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -191,7 +185,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getUserAccountOrders**
-> Array<AccountOrderRecord> getUserAccountOrders()
+
+#### **GET** /accounts/{accountId}/orders
 
 
 ### Example
@@ -207,13 +202,14 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.accountInformation.getUserAccountOrders({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-    'state': "all",
-})
-console.log(response)
+const getUserAccountOrdersResponse = await snaptrade.accountInformation.getUserAccountOrders({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "state": "all",
+        "accountId": "accountId_example",
+    })
+
+console.log(getUserAccountOrdersResponse)
 
 ```
 
@@ -232,10 +228,6 @@ Name | Type | Description  | Notes
 
 **Array<AccountOrderRecord>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -251,7 +243,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getUserAccountPositions**
-> Array<Position> getUserAccountPositions()
+
+#### **GET** /accounts/{accountId}/positions
 
 
 ### Example
@@ -267,12 +260,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.accountInformation.getUserAccountPositions({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-})
-console.log(response)
+const getUserAccountPositionsResponse = await snaptrade.accountInformation.getUserAccountPositions({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "accountId_example",
+    })
+
+console.log(getUserAccountPositionsResponse)
 
 ```
 
@@ -290,10 +284,6 @@ Name | Type | Description  | Notes
 
 **Array<Position>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -309,7 +299,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getUserHoldings**
-> AccountHoldings getUserHoldings()
+
+#### **GET** /accounts/{accountId}/holdings
 
 
 ### Example
@@ -325,12 +316,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.accountInformation.getUserHoldings({
-    'accountId': "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-})
-console.log(response)
+const getUserHoldingsResponse = await snaptrade.accountInformation.getUserHoldings({
+        "accountId": "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(getUserHoldingsResponse)
 
 ```
 
@@ -348,10 +340,6 @@ Name | Type | Description  | Notes
 
 **AccountHoldings**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -369,7 +357,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **listUserAccounts**
-> Array<Account> listUserAccounts()
+
+#### **GET** /accounts
 
 
 ### Example
@@ -385,11 +374,12 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.accountInformation.listUserAccounts({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-})
-console.log(response)
+const listUserAccountsResponse = await snaptrade.accountInformation.listUserAccounts({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(listUserAccountsResponse)
 
 ```
 
@@ -406,10 +396,6 @@ Name | Type | Description  | Notes
 
 **Array<Account>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -425,7 +411,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **updateUserAccount**
-> Array<Account> updateUserAccount()
+
+#### **PUT** /accounts/{accountId}
 
 
 ### Example
@@ -441,12 +428,13 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.accountInformation.updateUserAccount({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'accountId': "accountId_example",
-})
-console.log(response)
+const updateUserAccountResponse = await snaptrade.accountInformation.updateUserAccount({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+        "accountId": "accountId_example",
+    })
+
+console.log(updateUserAccountResponse)
 
 ```
 
@@ -464,10 +452,6 @@ Name | Type | Description  | Notes
 
 **Array<Account>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined

package/docs/ApiDisclaimerApi.md

@@ -8,7 +8,8 @@ Method | HTTP request | Description
 
 
 # **accept**
-> SnapTradeAPIDisclaimerAcceptStatus accept(aPIDisclaimerAcceptRequest)
+
+#### **POST** /snapTrade/acceptDisclaimer
 
 
 ### Example
@@ -24,13 +25,12 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.apiDisclaimer.accept({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'requestBody': {
-    },
-})
-console.log(response)
+const acceptResponse = await snaptrade.apiDisclaimer.accept({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(acceptResponse)
 
 ```
 
@@ -48,10 +48,6 @@ Name | Type | Description  | Notes
 
 **SnapTradeAPIDisclaimerAcceptStatus**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: application/json

package/docs/ApiStatusApi.md

@@ -8,8 +8,10 @@ Method | HTTP request | Description
 
 
 # **check**
-> Status check()
 
+#### **GET** /
+
+### Description
 Check whether the API is operational and verify timestamps.
 
 ### Example
@@ -25,8 +27,9 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.apiStatus.check()
-console.log(response)
+const checkResponse = await snaptrade.apiStatus.check()
+
+console.log(checkResponse)
 
 ```
 
@@ -39,10 +42,6 @@ This endpoint does not need any parameter.
 
 **Status**
 
-### Authorization
-
-No authorization required
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined

package/docs/AuthenticationApi.md

@@ -12,7 +12,8 @@ Method | HTTP request | Description
 
 
 # **deleteSnapTradeUser**
-> DeleteUserResponse deleteSnapTradeUser()
+
+#### **DELETE** /snapTrade/deleteUser
 
 
 ### Example
@@ -28,10 +29,11 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.deleteSnapTradeUser({
-    'userId': "John.doe@snaptrade.com",
-})
-console.log(response)
+const deleteSnapTradeUserResponse = await snaptrade.authentication.deleteSnapTradeUser({
+        "userId": "John.doe@snaptrade.com",
+    })
+
+console.log(deleteSnapTradeUserResponse)
 
 ```
 
@@ -47,10 +49,6 @@ Name | Type | Description  | Notes
 
 **DeleteUserResponse**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -69,7 +67,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **getUserJWT**
-> EncryptedResponse getUserJWT()
+
+#### **GET** /snapTrade/encryptedJWT
 
 
 ### Example
@@ -85,11 +84,12 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.getUserJWT({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-})
-console.log(response)
+const getUserJWTResponse = await snaptrade.authentication.getUserJWT({
+        "userId": "John.doe@snaptrade.com",
+        "userSecret": "USERSECRET123",
+    })
+
+console.log(getUserJWTResponse)
 
 ```
 
@@ -106,10 +106,6 @@ Name | Type | Description  | Notes
 
 **EncryptedResponse**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -128,7 +124,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **listSnapTradeUsers**
-> Array<string> listSnapTradeUsers()
+
+#### **GET** /snapTrade/listUsers
 
 
 ### Example
@@ -144,8 +141,9 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.listSnapTradeUsers()
-console.log(response)
+const listSnapTradeUsersResponse = await snaptrade.authentication.listSnapTradeUsers()
+
+console.log(listSnapTradeUsersResponse)
 
 ```
 
@@ -158,10 +156,6 @@ This endpoint does not need any parameter.
 
 **Array<string>**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: Not defined
@@ -179,7 +173,8 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **loginSnapTradeUser**
-> AuthenticationLoginSnapTradeUser200Response loginSnapTradeUser()
+
+#### **POST** /snapTrade/login
 
 
 ### Example
@@ -195,18 +190,17 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.loginSnapTradeUser({
-    'userId': "John.doe@snaptrade.com",
-    'userSecret': "USERSECRET123",
-    'requestBody': {
-        'broker': "ALPACA",
-        'immediate_redirect': true,
-        'custom_redirect': "https://passiv.com",
-        'reconnect': "8b5f262d-4bb9-365d-888a-202bd3b15fa1",
-        'connection_type': "read",
-    },
-})
-console.log(response)
+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)
 
 ```
 
@@ -224,10 +218,6 @@ Name | Type | Description  | Notes
 
 **AuthenticationLoginSnapTradeUser200Response**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: application/json
@@ -246,7 +236,8 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
 # **registerSnapTradeUser**
-> UserIDandSecret registerSnapTradeUser(snapTradeRegisterUserRequestBody)
+
+#### **POST** /snapTrade/registerUser
 
 
 ### Example
@@ -262,13 +253,12 @@ const snaptrade = new Snaptrade({
     clientId: "YOUR_CLIENT_ID",
 })
 
-const response = await snaptrade.authentication.registerSnapTradeUser({
-    'requestBody': {
-        'user_id': "snaptrade-user-123",
-        'rsa_public_key': "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC7vbqajDw4o6gJy8UtmIbkcpnkO3Kwc4qsEnSZp/TR+fQi62F79RHWmwKOtFmwteURgLbj7D/WGuNLGOfa/2vse3G2eHnHl5CB8ruRX9fBl/KgwCVr2JaEuUm66bBQeP5XeBotdR4cvX38uPYivCDdPjJ1QWPdspTBKcxeFbccDw==",
-    },
-})
-console.log(response)
+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)
 
 ```
 
@@ -284,10 +274,6 @@ Name | Type | Description  | Notes
 
 **UserIDandSecret**
 
-### Authorization
-
-[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
-
 ### HTTP request headers
 
  - **Content-Type**: application/json