snaptrade-typescript-sdk 8.21.0 → 8.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # snaptrade-typescript-sdk@8.21.0
1
+ # snaptrade-typescript-sdk@8.23.0
2
2
 
3
3
  Connect brokerage accounts to your app for live positions and trading
4
4
  ## Installing
@@ -13,8 +13,8 @@ import { Configuration } from '../configuration';
13
13
  import { RequestArgs, BaseAPI } from '../base';
14
14
  import { OptionChainInner } from '../models';
15
15
  import { OptionsGetOptionStrategyRequest } from '../models';
16
- import { OptionsHoldings } from '../models';
17
16
  import { OptionsPlaceOptionStrategyRequest } from '../models';
17
+ import { OptionsPosition } from '../models';
18
18
  import { StrategyOrderRecord } from '../models';
19
19
  import { StrategyQuotes } from '../models';
20
20
  /**
@@ -114,7 +114,7 @@ export declare const OptionsApiFp: (configuration?: Configuration) => {
114
114
  * @param {*} [options] Override http request option.
115
115
  * @throws {RequiredError}
116
116
  */
117
- listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionsHoldings>>>;
117
+ listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionsPosition>>>;
118
118
  /**
119
119
  *
120
120
  * @summary Place an option strategy order on the brokerage
@@ -160,7 +160,7 @@ export declare const OptionsApiFactory: (configuration?: Configuration, basePath
160
160
  * @param {*} [options] Override http request option.
161
161
  * @throws {RequiredError}
162
162
  */
163
- listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<OptionsHoldings>>;
163
+ listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<OptionsPosition>>;
164
164
  /**
165
165
  *
166
166
  * @summary Place an option strategy order on the brokerage
@@ -355,7 +355,7 @@ export declare class OptionsApiGenerated extends BaseAPI {
355
355
  * @throws {RequiredError}
356
356
  * @memberof OptionsApiGenerated
357
357
  */
358
- listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionsHoldings[], any>>;
358
+ listOptionHoldings(requestParameters: OptionsApiListOptionHoldingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionsPosition[], any>>;
359
359
  /**
360
360
  *
361
361
  * @summary Place an option strategy order on the brokerage
@@ -27,7 +27,7 @@ export declare const TransactionsAndReportingApiAxiosParamCreator: (configuratio
27
27
  * @param {string | Date} [endDate]
28
28
  * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
29
29
  * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
30
- * @param {string} [type] Optional comma seperated list of types to filter activities by. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
30
+ * @param {string} [type] Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
31
31
  * @param {*} [options] Override http request option.
32
32
  * @throws {RequiredError}
33
33
  */
@@ -134,7 +134,7 @@ export type TransactionsAndReportingApiGetActivitiesRequest = {
134
134
  */
135
135
  readonly brokerageAuthorizations?: string;
136
136
  /**
137
- * Optional comma seperated list of types to filter activities by. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
137
+ * Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
138
138
  * @type {string}
139
139
  * @memberof TransactionsAndReportingApiGetActivities
140
140
  */
@@ -44,7 +44,7 @@ const TransactionsAndReportingApiAxiosParamCreator = function (configuration) {
44
44
  * @param {string | Date} [endDate]
45
45
  * @param {string} [accounts] Optional comma seperated list of account IDs used to filter the request on specific accounts
46
46
  * @param {string} [brokerageAuthorizations] Optional comma seperated list of brokerage authorization IDs used to filter the request on only accounts that belong to those authorizations
47
- * @param {string} [type] Optional comma seperated list of types to filter activities by. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
47
+ * @param {string} [type] Optional comma seperated list of types to filter activities by. This is not an exhaustive list, if we fail to match to these types, we will return the raw description from the brokerage. Potential values include - DIVIDEND - BUY - SELL - CONTRIBUTION - WITHDRAWAL - EXTERNAL_ASSET_TRANSFER_IN - EXTERNAL_ASSET_TRANSFER_OUT - INTERNAL_CASH_TRANSFER_IN - INTERNAL_CASH_TRANSFER_OUT - INTERNAL_ASSET_TRANSFER_IN - INTERNAL_ASSET_TRANSFER_OUT - INTEREST - REBATE - GOV_GRANT - TAX - FEE - REI - FXT
48
48
  * @param {*} [options] Override http request option.
49
49
  * @throws {RequiredError}
50
50
  */
@@ -32,7 +32,7 @@ class Configuration {
32
32
  this.accessToken = param.accessToken;
33
33
  this.basePath = param.basePath;
34
34
  this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
35
- this.userAgent = param.userAgent === undefined ? "Konfig/8.21.0/typescript" : param.userAgent;
35
+ this.userAgent = param.userAgent === undefined ? "Konfig/8.23.0/typescript" : param.userAgent;
36
36
  this.formDataCtor = param.formDataCtor;
37
37
  }
38
38
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "snaptrade-typescript-sdk",
3
- "version": "8.21.0",
3
+ "version": "8.23.0",
4
4
  "description": "Client for SnapTrade",
5
5
  "author": "Konfig",
6
6
  "engines": {