snaptrade-typescript-sdk 9.0.130 → 9.0.132

package/README.md

@@ -6,7 +6,7 @@
 
 Connect brokerage accounts to your app for live positions and trading
 
-[![npm](https://img.shields.io/badge/npm-v9.0.130-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.130)
+[![npm](https://img.shields.io/badge/npm-v9.0.132-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.132)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -377,7 +377,7 @@ const getUserAccountDetailsResponse =
 
 ### `snaptrade.accountInformation.getUserAccountOrderDetail`<a id="snaptradeaccountinformationgetuseraccountorderdetail"></a>
 
-Returns the detail of a single order in the specified account.
+Returns the detail of a single order using the external order ID provided in the request body.
 
 This endpoint is always realtime and does not rely on cached data.
 
@@ -389,22 +389,24 @@ This endpoint only returns orders placed through SnapTrade. In other words, orde
 ```typescript
 const getUserAccountOrderDetailResponse =
   await snaptrade.accountInformation.getUserAccountOrderDetail({
+    accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
     userId: "snaptrade-user-123",
     userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
-    accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
-    brokerageOrderId: "66a033fa-da74-4fcf-b527-feefdec9257e",
+    external_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
   });
 ```
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### userId: `string`<a id="userid-string"></a>
+##### external_order_id: `string`<a id="external_order_id-string"></a>
 
-##### userSecret: `string`<a id="usersecret-string"></a>
+Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
 
 ##### accountId: `string`<a id="accountid-string"></a>
 
-##### brokerageOrderId: `string`<a id="brokerageorderid-string"></a>
+##### userId: `string`<a id="userid-string"></a>
+
+##### userSecret: `string`<a id="usersecret-string"></a>
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -412,7 +414,7 @@ const getUserAccountOrderDetailResponse =
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/accounts/{accountId}/orders/{brokerageOrderId}` `GET`
+`/accounts/{accountId}/orders/details` `POST`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 
@@ -1465,13 +1467,15 @@ Returns a list of all brokerage instruments available for a given brokerage. Not
 ```typescript
 const listAllBrokerageInstrumentsResponse =
   await snaptrade.referenceData.listAllBrokerageInstruments({
-    brokerageId: "87b24961-b51e-4db8-9226-f198f6518a89",
+    slug: "QUESTRADE",
   });
 ```
 
 #### ⚙️ Parameters<a id="⚙️-parameters"></a>
 
-##### brokerageId: `string`<a id="brokerageid-string"></a>
+##### slug: `string`<a id="slug-string"></a>
+
+A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
 
 #### 🔄 Return<a id="🔄-return"></a>
 
@@ -1479,7 +1483,7 @@ const listAllBrokerageInstrumentsResponse =
 
 #### 🌐 Endpoint<a id="🌐-endpoint"></a>
 
-`/brokerages/{brokerageId}/instruments` `GET`
+`/brokerages/{slug}/instruments` `GET`
 
 [🔙 **Back to Table of Contents**](#table-of-contents)
 

package/dist/api/account-information-api-generated.d.ts

@@ -4,6 +4,7 @@ import { RequestArgs, BaseAPI } from '../base';
 import { Account } from '../models';
 import { AccountHoldings } from '../models';
 import { AccountHoldingsAccount } from '../models';
+import { AccountInformationGetUserAccountOrderDetailRequest } from '../models';
 import { AccountOrderRecord } from '../models';
 import { Balance } from '../models';
 import { PaginatedUniversalActivity } from '../models';
@@ -62,16 +63,16 @@ export declare const AccountInformationApiAxiosParamCreator: (configuration?: Co
      */
     getUserAccountDetails: (userId: string, userSecret: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+     * Returns the detail of a single order using the external order ID provided in the request body.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
      * @summary Get account order detail
+     * @param {string} accountId
      * @param {string} userId
      * @param {string} userSecret
-     * @param {string} accountId
-     * @param {string} brokerageOrderId
+     * @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getUserAccountOrderDetail: (userId: string, userSecret: string, accountId: string, brokerageOrderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getUserAccountOrderDetail: (accountId: string, userId: string, userSecret: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a list of recent orders in the specified account.  The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for \"Cache Expiry Time\" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
      * @summary List account orders
@@ -184,7 +185,7 @@ export declare const AccountInformationApiFp: (configuration?: Configuration) =>
      */
     getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Account>>;
     /**
-     * Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+     * Returns the detail of a single order using the external order ID provided in the request body.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
      * @summary Get account order detail
      * @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -287,7 +288,7 @@ export declare const AccountInformationApiFactory: (configuration?: Configuratio
      */
     getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<Account>;
     /**
-     * Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+     * Returns the detail of a single order using the external order ID provided in the request body.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
      * @summary Get account order detail
      * @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -492,26 +493,20 @@ export type AccountInformationApiGetUserAccountOrderDetailRequest = {
     * @type {string}
     * @memberof AccountInformationApiGetUserAccountOrderDetail
     */
-    readonly userId: string;
-    /**
-    *
-    * @type {string}
-    * @memberof AccountInformationApiGetUserAccountOrderDetail
-    */
-    readonly userSecret: string;
+    readonly accountId: string;
     /**
     *
     * @type {string}
     * @memberof AccountInformationApiGetUserAccountOrderDetail
     */
-    readonly accountId: string;
+    readonly userId: string;
     /**
     *
     * @type {string}
     * @memberof AccountInformationApiGetUserAccountOrderDetail
     */
-    readonly brokerageOrderId: string;
-};
+    readonly userSecret: string;
+} & AccountInformationGetUserAccountOrderDetailRequest;
 /**
  * Request parameters for getUserAccountOrders operation in AccountInformationApi.
  * @export
@@ -744,7 +739,7 @@ export declare class AccountInformationApiGenerated extends BaseAPI {
      */
     getUserAccountDetails(requestParameters: AccountInformationApiGetUserAccountDetailsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account, any>>;
     /**
-     * Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+     * Returns the detail of a single order using the external order ID provided in the request body.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
      * @summary Get account order detail
      * @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/account-information-api-generated.js

@@ -281,34 +281,33 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+         * Returns the detail of a single order using the external order ID provided in the request body.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
          * @summary Get account order detail
+         * @param {string} accountId
          * @param {string} userId
          * @param {string} userSecret
-         * @param {string} accountId
-         * @param {string} brokerageOrderId
+         * @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getUserAccountOrderDetail: (userId, userSecret, accountId, brokerageOrderId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        getUserAccountOrderDetail: (accountId, userId, userSecret, accountInformationGetUserAccountOrderDetailRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'accountId' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOrderDetail', 'accountId', accountId);
             // verify required parameter 'userId' is not null or undefined
             (0, common_1.assertParamExists)('getUserAccountOrderDetail', 'userId', userId);
             // verify required parameter 'userSecret' is not null or undefined
             (0, common_1.assertParamExists)('getUserAccountOrderDetail', 'userSecret', userSecret);
-            // verify required parameter 'accountId' is not null or undefined
-            (0, common_1.assertParamExists)('getUserAccountOrderDetail', 'accountId', accountId);
-            // verify required parameter 'brokerageOrderId' is not null or undefined
-            (0, common_1.assertParamExists)('getUserAccountOrderDetail', 'brokerageOrderId', brokerageOrderId);
-            const localVarPath = `/accounts/{accountId}/orders/{brokerageOrderId}`
-                .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)))
-                .replace(`{${"brokerageOrderId"}}`, encodeURIComponent(String(brokerageOrderId !== undefined ? brokerageOrderId : `-brokerageOrderId-`)));
+            // verify required parameter 'accountInformationGetUserAccountOrderDetailRequest' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOrderDetail', 'accountInformationGetUserAccountOrderDetailRequest', accountInformationGetUserAccountOrderDetailRequest);
+            const localVarPath = `/accounts/{accountId}/orders/details`
+                .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId !== undefined ? accountId : `-accountId-`)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
             if (configuration) {
                 baseOptions = configuration.baseOptions;
             }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
             const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
             const localVarQueryParameter = {};
             // authentication PartnerClientId required
@@ -323,16 +322,19 @@ const AccountInformationApiAxiosParamCreator = function (configuration) {
             if (userSecret !== undefined) {
                 localVarQueryParameter['userSecret'] = userSecret;
             }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
             (0, requestBeforeHook_1.requestBeforeHook)({
+                requestBody: accountInformationGetUserAccountOrderDetailRequest,
                 queryParameters: localVarQueryParameter,
                 requestConfig: localVarRequestOptions,
                 path: localVarPath,
                 configuration,
-                pathTemplate: '/accounts/{accountId}/orders/{brokerageOrderId}',
-                httpMethod: 'GET'
+                pathTemplate: '/accounts/{accountId}/orders/details',
+                httpMethod: 'POST'
             });
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(accountInformationGetUserAccountOrderDetailRequest, localVarRequestOptions, configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             return {
                 url: (0, common_1.toPathString)(localVarUrlObj),
@@ -796,7 +798,7 @@ const AccountInformationApiFp = function (configuration) {
             });
         },
         /**
-         * Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+         * Returns the detail of a single order using the external order ID provided in the request body.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
          * @summary Get account order detail
          * @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -804,7 +806,10 @@ const AccountInformationApiFp = function (configuration) {
          */
         getUserAccountOrderDetail(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountOrderDetail(requestParameters.userId, requestParameters.userSecret, requestParameters.accountId, requestParameters.brokerageOrderId, options);
+                const accountInformationGetUserAccountOrderDetailRequest = {
+                    external_order_id: requestParameters.external_order_id
+                };
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountOrderDetail(requestParameters.accountId, requestParameters.userId, requestParameters.userSecret, accountInformationGetUserAccountOrderDetailRequest, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -951,7 +956,7 @@ const AccountInformationApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getUserAccountDetails(requestParameters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+         * Returns the detail of a single order using the external order ID provided in the request body.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
          * @summary Get account order detail
          * @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -1086,7 +1091,7 @@ class AccountInformationApiGenerated extends base_1.BaseAPI {
         return (0, exports.AccountInformationApiFp)(this.configuration).getUserAccountDetails(requestParameters, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns the detail of a single order in the specified account.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
+     * Returns the detail of a single order using the external order ID provided in the request body.  This endpoint is always realtime and does not rely on cached data.  This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.
      * @summary Get account order detail
      * @param {AccountInformationApiGetUserAccountOrderDetailRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/api/reference-data-api-generated.d.ts

@@ -72,11 +72,11 @@ export declare const ReferenceDataApiAxiosParamCreator: (configuration?: Configu
     /**
      * Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
      * @summary Get brokerage instruments
-     * @param {string} brokerageId
+     * @param {string} slug A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listAllBrokerageInstruments: (brokerageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listAllBrokerageInstruments: (slug: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a list of all defined Brokerage objects.
      * @summary Get brokerages
@@ -354,11 +354,11 @@ export type ReferenceDataApiListAllBrokerageAuthorizationTypeRequest = {
  */
 export type ReferenceDataApiListAllBrokerageInstrumentsRequest = {
     /**
-    *
+    * A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
     * @type {string}
     * @memberof ReferenceDataApiListAllBrokerageInstruments
     */
-    readonly brokerageId: string;
+    readonly slug: string;
 };
 /**
  * Request parameters for symbolSearchUserAccount operation in ReferenceDataApi.

package/dist/api/reference-data-api-generated.js

@@ -327,15 +327,15 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
         /**
          * Returns a list of all brokerage instruments available for a given brokerage. Not all brokerages support this. The ones that don\'t will return an empty list.
          * @summary Get brokerage instruments
-         * @param {string} brokerageId
+         * @param {string} slug A short, unique identifier for the brokerage. It is usually the name of the brokerage in capital letters and will never change.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listAllBrokerageInstruments: (brokerageId, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'brokerageId' is not null or undefined
-            (0, common_1.assertParamExists)('listAllBrokerageInstruments', 'brokerageId', brokerageId);
-            const localVarPath = `/brokerages/{brokerageId}/instruments`
-                .replace(`{${"brokerageId"}}`, encodeURIComponent(String(brokerageId !== undefined ? brokerageId : `-brokerageId-`)));
+        listAllBrokerageInstruments: (slug, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'slug' is not null or undefined
+            (0, common_1.assertParamExists)('listAllBrokerageInstruments', 'slug', slug);
+            const localVarPath = `/brokerages/{slug}/instruments`
+                .replace(`{${"slug"}}`, encodeURIComponent(String(slug !== undefined ? slug : `-slug-`)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -358,7 +358,7 @@ const ReferenceDataApiAxiosParamCreator = function (configuration) {
                 requestConfig: localVarRequestOptions,
                 path: localVarPath,
                 configuration,
-                pathTemplate: '/brokerages/{brokerageId}/instruments',
+                pathTemplate: '/brokerages/{slug}/instruments',
                 httpMethod: 'GET'
             });
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -653,7 +653,7 @@ const ReferenceDataApiFp = function (configuration) {
          */
         listAllBrokerageInstruments(requestParameters, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listAllBrokerageInstruments(requestParameters.brokerageId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listAllBrokerageInstruments(requestParameters.slug, options);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },