snaptrade-typescript-sdk 9.0.161 → 9.0.162

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.161-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.161)
+[![npm](https://img.shields.io/badge/npm-v9.0.162-blue)](https://www.npmjs.com/package/snaptrade-typescript-sdk/v/9.0.162)
 [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
 
 </div>
@@ -43,6 +43,7 @@ Connect brokerage accounts to your app for live positions and trading
   * [`snaptrade.connections.removeBrokerageAuthorization`](#snaptradeconnectionsremovebrokerageauthorization)
   * [`snaptrade.connections.returnRates`](#snaptradeconnectionsreturnrates)
   * [`snaptrade.connections.sessionEvents`](#snaptradeconnectionssessionevents)
+  * [`snaptrade.experimentalEndpoints.getUserAccountOrderDetailV2`](#snaptradeexperimentalendpointsgetuseraccountorderdetailv2)
   * [`snaptrade.experimentalEndpoints.getUserAccountOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountordersv2)
   * [`snaptrade.experimentalEndpoints.getUserAccountRecentOrdersV2`](#snaptradeexperimentalendpointsgetuseraccountrecentordersv2)
   * [`snaptrade.options.getOptionsChain`](#snaptradeoptionsgetoptionschain)
@@ -1215,6 +1216,55 @@ Optional comma separated list of session IDs used to filter the request on speci
 ---
 
 
+### `snaptrade.experimentalEndpoints.getUserAccountOrderDetailV2`<a id="snaptradeexperimentalendpointsgetuseraccountorderdetailv2"></a>
+
+Returns the detail of a single order using the external order ID provided in the request body.
+
+The V2 order response format includes all legs of the order in the `legs` list field.
+If the order is single legged, `legs` will be a list of one leg.
+
+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.
+
+
+#### 🛠️ Usage<a id="🛠️-usage"></a>
+
+```typescript
+const getUserAccountOrderDetailV2Response =
+  await snaptrade.experimentalEndpoints.getUserAccountOrderDetailV2({
+    accountId: "917c8734-8470-4a3e-a18f-57c3f2ee6631",
+    userId: "snaptrade-user-123",
+    userSecret: "adf2aa34-8219-40f7-a6b3-60156985cc61",
+    brokerage_order_id: "66a033fa-da74-4fcf-b527-feefdec9257e",
+  });
+```
+
+#### ⚙️ Parameters<a id="⚙️-parameters"></a>
+
+##### brokerage_order_id: `string`<a id="brokerage_order_id-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>
+
+##### userId: `string`<a id="userid-string"></a>
+
+##### userSecret: `string`<a id="usersecret-string"></a>
+
+#### 🔄 Return<a id="🔄-return"></a>
+
+[AccountOrderRecordV2](./models/account-order-record-v2.ts)
+
+#### 🌐 Endpoint<a id="🌐-endpoint"></a>
+
+`/accounts/{accountId}/orders/details/v2` `POST`
+
+[🔙 **Back to Table of Contents**](#table-of-contents)
+
+---
+
+
 ### `snaptrade.experimentalEndpoints.getUserAccountOrdersV2`<a id="snaptradeexperimentalendpointsgetuseraccountordersv2"></a>
 
 Returns a list of recent orders in the specified account.

package/dist/api/experimental-endpoints-api-generated.d.ts

@@ -1,12 +1,25 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
+import { AccountInformationGetUserAccountOrderDetailRequest } from '../models';
+import { AccountOrderRecordV2 } from '../models';
 import { AccountOrdersV2Response } from '../models';
 /**
  * ExperimentalEndpointsApi - axios parameter creator
  * @export
  */
 export declare const ExperimentalEndpointsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  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 (V2)
+     * @param {string} accountId
+     * @param {string} userId
+     * @param {string} userSecret
+     * @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOrderDetailV2: (accountId: string, userId: string, userSecret: string, accountInformationGetUserAccountOrderDetailRequest: AccountInformationGetUserAccountOrderDetailRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
      * @summary List account orders v2
@@ -36,6 +49,14 @@ export declare const ExperimentalEndpointsApiAxiosParamCreator: (configuration?:
  * @export
  */
 export declare const ExperimentalEndpointsApiFp: (configuration?: Configuration) => {
+    /**
+     * Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  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 (V2)
+     * @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOrderDetailV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountOrderRecordV2>>;
     /**
      * Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
      * @summary List account orders v2
@@ -58,6 +79,14 @@ export declare const ExperimentalEndpointsApiFp: (configuration?: Configuration)
  * @export
  */
 export declare const ExperimentalEndpointsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  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 (V2)
+     * @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUserAccountOrderDetailV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, options?: AxiosRequestConfig): AxiosPromise<AccountOrderRecordV2>;
     /**
      * Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
      * @summary List account orders v2
@@ -75,6 +104,31 @@ export declare const ExperimentalEndpointsApiFactory: (configuration?: Configura
      */
     getUserAccountRecentOrdersV2(requestParameters: ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request, options?: AxiosRequestConfig): AxiosPromise<AccountOrdersV2Response>;
 };
+/**
+ * Request parameters for getUserAccountOrderDetailV2 operation in ExperimentalEndpointsApi.
+ * @export
+ * @interface ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request
+ */
+export type ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request = {
+    /**
+    *
+    * @type {string}
+    * @memberof ExperimentalEndpointsApiGetUserAccountOrderDetailV2
+    */
+    readonly accountId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof ExperimentalEndpointsApiGetUserAccountOrderDetailV2
+    */
+    readonly userId: string;
+    /**
+    *
+    * @type {string}
+    * @memberof ExperimentalEndpointsApiGetUserAccountOrderDetailV2
+    */
+    readonly userSecret: string;
+} & AccountInformationGetUserAccountOrderDetailRequest;
 /**
  * Request parameters for getUserAccountOrdersV2 operation in ExperimentalEndpointsApi.
  * @export
@@ -150,6 +204,15 @@ export type ExperimentalEndpointsApiGetUserAccountRecentOrdersV2Request = {
  * @extends {BaseAPI}
  */
 export declare class ExperimentalEndpointsApiGenerated extends BaseAPI {
+    /**
+     * Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  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 (V2)
+     * @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExperimentalEndpointsApiGenerated
+     */
+    getUserAccountOrderDetailV2(requestParameters: ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountOrderRecordV2, any>>;
     /**
      * Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
      * @summary List account orders v2

package/dist/api/experimental-endpoints-api-generated.js

@@ -35,6 +35,67 @@ const requestBeforeHook_1 = require("../requestBeforeHook");
  */
 const ExperimentalEndpointsApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  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 (V2)
+         * @param {string} accountId
+         * @param {string} userId
+         * @param {string} userSecret
+         * @param {AccountInformationGetUserAccountOrderDetailRequest} accountInformationGetUserAccountOrderDetailRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserAccountOrderDetailV2: (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)('getUserAccountOrderDetailV2', 'accountId', accountId);
+            // verify required parameter 'userId' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOrderDetailV2', 'userId', userId);
+            // verify required parameter 'userSecret' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOrderDetailV2', 'userSecret', userSecret);
+            // verify required parameter 'accountInformationGetUserAccountOrderDetailRequest' is not null or undefined
+            (0, common_1.assertParamExists)('getUserAccountOrderDetailV2', 'accountInformationGetUserAccountOrderDetailRequest', accountInformationGetUserAccountOrderDetailRequest);
+            const localVarPath = `/accounts/{accountId}/orders/details/v2`
+                .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: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = configuration && !(0, common_1.isBrowser)() ? { "User-Agent": configuration.userAgent } : {};
+            const localVarQueryParameter = {};
+            // authentication PartnerClientId required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "clientId", keyParamName: "clientId", configuration });
+            // authentication PartnerSignature required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarHeaderParameter, key: "Signature", keyParamName: "signature", configuration });
+            // authentication PartnerTimestamp required
+            yield (0, common_1.setApiKeyToObject)({ object: localVarQueryParameter, key: "timestamp", keyParamName: "timestamp", configuration });
+            if (userId !== undefined) {
+                localVarQueryParameter['userId'] = userId;
+            }
+            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/details/v2',
+                httpMethod: 'POST'
+            });
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(accountInformationGetUserAccountOrderDetailRequest, localVarRequestOptions, configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
          * @summary List account orders v2
@@ -167,6 +228,22 @@ exports.ExperimentalEndpointsApiAxiosParamCreator = ExperimentalEndpointsApiAxio
 const ExperimentalEndpointsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.ExperimentalEndpointsApiAxiosParamCreator)(configuration);
     return {
+        /**
+         * Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  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 (V2)
+         * @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserAccountOrderDetailV2(requestParameters, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const accountInformationGetUserAccountOrderDetailRequest = {
+                    brokerage_order_id: requestParameters.brokerage_order_id
+                };
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserAccountOrderDetailV2(requestParameters.accountId, requestParameters.userId, requestParameters.userSecret, accountInformationGetUserAccountOrderDetailRequest, options);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
          * @summary List account orders v2
@@ -203,6 +280,16 @@ exports.ExperimentalEndpointsApiFp = ExperimentalEndpointsApiFp;
 const ExperimentalEndpointsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.ExperimentalEndpointsApiFp)(configuration);
     return {
+        /**
+         * Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  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 (V2)
+         * @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUserAccountOrderDetailV2(requestParameters, options) {
+            return localVarFp.getUserAccountOrderDetailV2(requestParameters, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
          * @summary List account orders v2
@@ -233,6 +320,17 @@ exports.ExperimentalEndpointsApiFactory = ExperimentalEndpointsApiFactory;
  * @extends {BaseAPI}
  */
 class ExperimentalEndpointsApiGenerated extends base_1.BaseAPI {
+    /**
+     * Returns the detail of a single order using the external order ID provided in the request body.  The V2 order response format includes all legs of the order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  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 (V2)
+     * @param {ExperimentalEndpointsApiGetUserAccountOrderDetailV2Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ExperimentalEndpointsApiGenerated
+     */
+    getUserAccountOrderDetailV2(requestParameters, options) {
+        return (0, exports.ExperimentalEndpointsApiFp)(this.configuration).getUserAccountOrderDetailV2(requestParameters, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns a list of recent orders in the specified account.  The V2 order response format will include all legs of each order in the `legs` list field. If the order is single legged, `legs` will be a list of one leg.  If the connection has become disabled, it can no longer access the latest data from the brokerage, but will continue to return the last available cached state. Please see [this guide](/docs/fix-broken-connections) on how to fix a disabled connection.
      * @summary List account orders v2