snaptrade-typescript-sdk 8.6.0 → 8.8.0

package/README.md

@@ -1,25 +1,24 @@
-## snaptrade-typescript-sdk@8.6.0
-Connect brokerage accounts to your app for live positions and trading
-
-
-**Important note: this library is can be used in both the client-side or server-side, but using it
-in client-side browser code is not recommended as you would expose security credentials.**
+# snaptrade-typescript-sdk@8.8.0
 
-### Installing
+Connect brokerage accounts to your app for live positions and trading
+## Installing
 
-#### npm
+### npm
 ```
 npm install snaptrade-typescript-sdk --save
 ```
 
-#### yarn
+### yarn
 ```
 yarn add snaptrade-typescript-sdk
 ```
 
+**Important note: this library is can be used in both the client-side or server-side, but using it
+in client-side browser code is not recommended as you would expose security credentials.**
 
 
-### Getting Started
+
+## Getting Started
 
 ```typescript
 const { Snaptrade } = require("snaptrade-typescript-sdk");
@@ -94,7 +93,6 @@ function getUserId() {
 }
 
 main();
-
 ```
 
 ## Documentation for API Endpoints
@@ -143,7 +141,6 @@ Class | Method | HTTP request | Description
 *PortfolioManagementApi* | [**getPortfolioBalances**](docs/PortfolioManagementApi.md#getPortfolioBalances) | **GET** /portfolioGroups/{portfolioGroupId}/balances | Get sum of cash balances in portfolio group
 *PortfolioManagementApi* | [**getPortfolioDetailsById**](docs/PortfolioManagementApi.md#getPortfolioDetailsById) | **GET** /portfolioGroups/{portfolioGroupId} | Get details of a target portfolio
 *PortfolioManagementApi* | [**getPortfolioInfo**](docs/PortfolioManagementApi.md#getPortfolioInfo) | **GET** /portfolioGroups/{portfolioGroupId}/info | Return a whole bunch of relevant information relating to a portfolio group.
-*PortfolioManagementApi* | [**getPortfolioPositions**](docs/PortfolioManagementApi.md#getPortfolioPositions) | **GET** /portfolioGroups/{portfolioGroupId}/positions | Get total of each postions owned in portfolio group
 *PortfolioManagementApi* | [**getPortfolioSettings**](docs/PortfolioManagementApi.md#getPortfolioSettings) | **GET** /portfolioGroups/{portfolioGroupId}/settings | Get portfolio group settings
 *PortfolioManagementApi* | [**getPortfolioTargetById**](docs/PortfolioManagementApi.md#getPortfolioTargetById) | **GET** /portfolioGroups/{portfolioGroupId}/targets/{targetAssetId} | Get a specific target from a portfolio group
 *PortfolioManagementApi* | [**getPortfolioTargets**](docs/PortfolioManagementApi.md#getPortfolioTargets) | **GET** /portfolioGroups/{portfolioGroupId}/targets | Get all target assets under the specified PortfolioGroup.

package/dist/api/portfolio-management-api.d.ts

@@ -20,7 +20,6 @@ import { ModelAssetClassDetails } from '../models';
 import { ModelPortfolioDetails } from '../models';
 import { PortfolioGroup } from '../models';
 import { PortfolioGroupInfo } from '../models';
-import { PortfolioGroupPosition } from '../models';
 import { PortfolioGroupSettings } from '../models';
 import { SymbolQuery } from '../models';
 import { TargetAsset } from '../models';
@@ -159,14 +158,6 @@ export declare const PortfolioManagementApiAxiosParamCreator: (configuration?: C
      * @throws {RequiredError}
      */
     getPortfolioInfo: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Get total of each postions owned in portfolio group
-     * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to create the target asset.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPortfolioPositions: (portfolioGroupId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get portfolio group settings
@@ -436,14 +427,6 @@ export declare const PortfolioManagementApiFp: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     getPortfolioInfo(requestParameters: PortfolioManagementApiGetPortfolioInfoRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioGroupInfo>>;
-    /**
-     *
-     * @summary Get total of each postions owned in portfolio group
-     * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPortfolioPositions(requestParameters: PortfolioManagementApiGetPortfolioPositionsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioGroupPosition>>>;
     /**
      *
      * @summary Get portfolio group settings
@@ -702,14 +685,6 @@ export declare const PortfolioManagementApiFactory: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getPortfolioInfo(requestParameters: PortfolioManagementApiGetPortfolioInfoRequest, options?: AxiosRequestConfig): AxiosPromise<PortfolioGroupInfo>;
-    /**
-     *
-     * @summary Get total of each postions owned in portfolio group
-     * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getPortfolioPositions(requestParameters: PortfolioManagementApiGetPortfolioPositionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<PortfolioGroupPosition>>;
     /**
      *
      * @summary Get portfolio group settings
@@ -1046,19 +1021,6 @@ export type PortfolioManagementApiGetPortfolioInfoRequest = {
     */
     readonly portfolioGroupId: string;
 };
-/**
- * Request parameters for getPortfolioPositions operation in PortfolioManagementApi.
- * @export
- * @interface PortfolioManagementApiGetPortfolioPositionsRequest
- */
-export type PortfolioManagementApiGetPortfolioPositionsRequest = {
-    /**
-    * The ID of the PortfolioGroup under which to create the target asset.
-    * @type {string}
-    * @memberof PortfolioManagementApiGetPortfolioPositions
-    */
-    readonly portfolioGroupId: string;
-};
 /**
  * Request parameters for getPortfolioSettings operation in PortfolioManagementApi.
  * @export
@@ -1420,15 +1382,6 @@ export declare class PortfolioManagementApi extends PortfolioManagementApiCustom
      * @memberof PortfolioManagementApi
      */
     getPortfolioInfo(requestParameters: PortfolioManagementApiGetPortfolioInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroupInfo, any>>;
-    /**
-     *
-     * @summary Get total of each postions owned in portfolio group
-     * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PortfolioManagementApi
-     */
-    getPortfolioPositions(requestParameters: PortfolioManagementApiGetPortfolioPositionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioGroupPosition[], any>>;
     /**
      *
      * @summary Get portfolio group settings

package/dist/api/portfolio-management-api.js

@@ -1032,67 +1032,6 @@ var PortfolioManagementApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
-        /**
-         *
-         * @summary Get total of each postions owned in portfolio group
-         * @param {string} portfolioGroupId The ID of the PortfolioGroup under which to create the target asset.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getPortfolioPositions: function (portfolioGroupId, options) {
-            if (options === void 0) { options = {}; }
-            return __awaiter(_this, void 0, void 0, function () {
-                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0:
-                            // verify required parameter 'portfolioGroupId' is not null or undefined
-                            (0, common_1.assertParamExists)('getPortfolioPositions', 'portfolioGroupId', portfolioGroupId);
-                            localVarPath = "/portfolioGroups/{portfolioGroupId}/positions"
-                                .replace("{".concat("portfolioGroupId", "}"), encodeURIComponent(String(portfolioGroupId)));
-                            localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
-                            if (configuration) {
-                                baseOptions = configuration.baseOptions;
-                            }
-                            localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
-                            localVarHeaderParameter = configuration ? { "User-Agent": configuration.userAgent } : {};
-                            localVarQueryParameter = {};
-                            // authentication PartnerClientId required
-                            return [4 /*yield*/, (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "clientId", configuration: configuration })
-                                // authentication PartnerSignature required
-                            ];
-                        case 1:
-                            // authentication PartnerClientId required
-                            _a.sent();
-                            // authentication PartnerSignature required
-                            return [4 /*yield*/, (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, keyParamName: "Signature", configuration: configuration })
-                                // authentication PartnerTimestamp required
-                            ];
-                        case 2:
-                            // authentication PartnerSignature required
-                            _a.sent();
-                            // authentication PartnerTimestamp required
-                            return [4 /*yield*/, (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, keyParamName: "timestamp", configuration: configuration })];
-                        case 3:
-                            // authentication PartnerTimestamp required
-                            _a.sent();
-                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-                            (0, requestBeforeHook_1.requestBeforeHook)({
-                                queryParameters: localVarQueryParameter,
-                                requestConfig: localVarRequestOptions,
-                                path: localVarPath,
-                                configuration: configuration
-                            });
-                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
-                            return [2 /*return*/, {
-                                    url: (0, common_1.toPathString)(localVarUrlObj),
-                                    options: localVarRequestOptions,
-                                }];
-                    }
-                });
-            });
-        },
         /**
          *
          * @summary Get portfolio group settings
@@ -2478,26 +2417,6 @@ var PortfolioManagementApiFp = function (configuration) {
                 });
             });
         },
-        /**
-         *
-         * @summary Get total of each postions owned in portfolio group
-         * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getPortfolioPositions: function (requestParameters, options) {
-            return __awaiter(this, void 0, void 0, function () {
-                var localVarAxiosArgs;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPortfolioPositions(requestParameters.portfolioGroupId, options)];
-                        case 1:
-                            localVarAxiosArgs = _a.sent();
-                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
-                    }
-                });
-            });
-        },
         /**
          *
          * @summary Get portfolio group settings
@@ -2994,16 +2913,6 @@ var PortfolioManagementApiFactory = function (configuration, basePath, axios) {
         getPortfolioInfo: function (requestParameters, options) {
             return localVarFp.getPortfolioInfo(requestParameters, options).then(function (request) { return request(axios, basePath); });
         },
-        /**
-         *
-         * @summary Get total of each postions owned in portfolio group
-         * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getPortfolioPositions: function (requestParameters, options) {
-            return localVarFp.getPortfolioPositions(requestParameters, options).then(function (request) { return request(axios, basePath); });
-        },
         /**
          *
          * @summary Get portfolio group settings
@@ -3364,18 +3273,6 @@ var PortfolioManagementApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.PortfolioManagementApiFp)(this.configuration).getPortfolioInfo(requestParameters, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
-    /**
-     *
-     * @summary Get total of each postions owned in portfolio group
-     * @param {PortfolioManagementApiGetPortfolioPositionsRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof PortfolioManagementApi
-     */
-    PortfolioManagementApi.prototype.getPortfolioPositions = function (requestParameters, options) {
-        var _this = this;
-        return (0, exports.PortfolioManagementApiFp)(this.configuration).getPortfolioPositions(requestParameters, options).then(function (request) { return request(_this.axios, _this.basePath); });
-    };
     /**
      *
      * @summary Get portfolio group settings

package/dist/configuration.js

@@ -34,7 +34,7 @@ var Configuration = /** @class */ (function () {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/8.6.0/typescript" : param.userAgent;
+        this.userAgent = param.userAgent === undefined ? "Konfig/8.8.0/typescript" : param.userAgent;
         this.formDataCtor = param.formDataCtor;
     }
     /**

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

@@ -52,6 +52,12 @@ export interface SessionEvent {
      * @memberof SessionEvent
      */
     'brokerage_status_code'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SessionEvent
+     */
+    'brokerage_authorization_id'?: string;
 }
 export declare const SessionEventSessionEventTypeEnum: {
     readonly ConnectionFailed: "CONNECTION_FAILED";

package/dist/models/symbol.d.ts

@@ -11,6 +11,7 @@
  */
 import { Currency } from './currency';
 import { Exchange } from './exchange';
+import { SecurityType } from './security-type';
 /**
  * Symbol
  * @export
@@ -54,4 +55,10 @@ export interface Symbol {
      * @memberof Symbol
      */
     'exchange'?: Exchange;
+    /**
+     *
+     * @type {SecurityType}
+     * @memberof Symbol
+     */
+    'type'?: SecurityType;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snaptrade-typescript-sdk",
-  "version": "8.6.0",
+  "version": "8.8.0",
   "description": "Client for SnapTrade",
   "author": "Konfig",
   "engines": {
@@ -17,6 +17,9 @@
     "snaptrade-typescript-sdk"
   ],
   "license": "Unlicense",
+  "files": [
+    "./dist/**/*"
+  ],
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
   "scripts": {

package/.konfig/generate-id.txt

@@ -1 +0,0 @@
-b943c377-1fe4-4a39-ac00-cb4924fe07a5

package/.konfigignore

@@ -1,3 +0,0 @@
-index.test.ts
-requestAfterHook.ts
-requestBeforeHook.ts

package/api/account-information-api-custom.ts

@@ -1,3 +0,0 @@
-import { BaseAPI } from "../base";
-
-export class AccountInformationApiCustom extends BaseAPI {}