snaptrade-typescript-sdk 9.0.42 → 9.0.44

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.
@@ -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/9.0.42/typescript" : param.userAgent;
35
+ this.userAgent = param.userAgent === undefined ? "Konfig/9.0.44/typescript" : param.userAgent;
36
36
  this.formDataCtor = param.formDataCtor;
37
37
  }
38
38
  /**
@@ -1,81 +1,82 @@
1
1
  import { Brokerage } from './brokerage';
2
2
  /**
3
- * SnapTrade Partner metadata
3
+ * Configurations for your SnapTrade Client ID, including allowed brokerages and data access.
4
4
  * @export
5
5
  * @interface PartnerData
6
6
  */
7
7
  export interface PartnerData {
8
8
  [key: string]: any;
9
9
  /**
10
- * URI to redirect user back to after user is done adding brokerage connections
10
+ * A short, unique identifier for your company or product.
11
11
  * @type {string}
12
12
  * @memberof PartnerData
13
13
  */
14
- 'redirect_uri'?: string;
15
- /**
16
- * Brokerages that can be accessed by partners
17
- * @type {Array<Brokerage>}
18
- * @memberof PartnerData
19
- */
20
- 'allowed_brokerages'?: Array<Brokerage>;
14
+ 'slug'?: string;
21
15
  /**
22
- * Name of Snaptrade Partner
16
+ * Your company or product name.
23
17
  * @type {string}
24
18
  * @memberof PartnerData
25
19
  */
26
20
  'name'?: string;
27
21
  /**
28
- * Slug of Snaptrade Partner
29
- * @type {string}
30
- * @memberof PartnerData
31
- */
32
- 'slug'?: string;
33
- /**
34
- * URL to partner\'s logo
22
+ * URL to your company or product logo.
35
23
  * @type {string}
36
24
  * @memberof PartnerData
37
25
  */
38
26
  'logo_url'?: string;
39
27
  /**
40
- * Shows if pin is required by users to access connection page
41
- * @type {boolean}
28
+ * Brokerages that can be accessed by your Client ID.
29
+ * @type {Array<Brokerage>}
42
30
  * @memberof PartnerData
43
31
  */
44
- 'pin_required'?: boolean;
32
+ 'allowed_brokerages'?: Array<Brokerage>;
45
33
  /**
46
- * Shows if users of Snaptrade partners can access trade endpoints
34
+ * Whether trading is enabled for your SnapTrade Client ID.
47
35
  * @type {boolean}
48
36
  * @memberof PartnerData
49
37
  */
50
38
  'can_access_trades'?: boolean;
51
39
  /**
52
- * Shows if Snaptrade partners can get user holdings data
40
+ * Whether holdings data is enabled for your SnapTrade Client ID.
53
41
  * @type {boolean}
54
42
  * @memberof PartnerData
55
43
  */
56
44
  'can_access_holdings'?: boolean;
57
45
  /**
58
- * Shows if Snaptrade partners can get users account history data
46
+ * Whether account historical transactions is enabled for your SnapTrade Client ID.
59
47
  * @type {boolean}
60
48
  * @memberof PartnerData
61
49
  */
62
50
  'can_access_account_history'?: boolean;
63
51
  /**
64
- * Shows if Snaptrade partners can get users holdings data
52
+ * Whether reference data is enabled for your SnapTrade Client ID.
65
53
  * @type {boolean}
66
54
  * @memberof PartnerData
67
55
  */
68
56
  'can_access_reference_data'?: boolean;
69
57
  /**
70
- * Shows if users Snaptrade partners can access portfolio group management features
58
+ * Whether portfolio management is enabled for your SnapTrade Client ID.
71
59
  * @type {boolean}
72
60
  * @memberof PartnerData
73
61
  */
74
62
  'can_access_portfolio_management'?: boolean;
75
63
  /**
76
- * Shows if Snaptrade partners can get users account order history
64
+ * Whether recent order history is enabled for your SnapTrade Client ID.
77
65
  * @type {boolean}
78
66
  * @memberof PartnerData
79
67
  */
80
68
  'can_access_orders'?: boolean;
69
+ /**
70
+ * URI to redirect user back to after user is done adding brokerage connections.
71
+ * @type {string}
72
+ * @memberof PartnerData
73
+ */
74
+ 'redirect_uri'?: string;
75
+ /**
76
+ * Shows if pin is required by users to access connection page. This field has been deprecated.
77
+ * @type {boolean}
78
+ * @memberof PartnerData
79
+ * @deprecated
80
+ */
81
+ 'pin_required'?: boolean;
81
82
  }
@@ -1,11 +1,11 @@
1
1
  /**
2
- * Symbol query for searching for symbols
2
+ *
3
3
  * @export
4
4
  * @interface SymbolQuery
5
5
  */
6
6
  export interface SymbolQuery {
7
7
  /**
8
- *
8
+ * The search query for symbols.
9
9
  * @type {string}
10
10
  * @memberof SymbolQuery
11
11
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "snaptrade-typescript-sdk",
3
- "version": "9.0.42",
3
+ "version": "9.0.44",
4
4
  "description": "Client for SnapTrade",
5
5
  "author": "Konfig",
6
6
  "engines": {