@narative/oanda-v20 - npm Package Compare versions

Comparing version 3.0.47 to 3.0.48

dist/definitions/account.d.ts

@@ -24,2 +24,7 @@ import * as primitives from './primitives';
 }
+export declare const GuaranteedStopLossOrderModeDescription: {
+    DISABLED: string;
+    ALLOWED: string;
+    REQUIRED: string;
+};
 /**
@@ -42,2 +47,7 @@ * The financing mode of an Account https://developer.oanda.com/rest-live-v20/account-df/
 }
+export declare const AccountFinancingModeDescription: {
+    NO_FINANCING: string;
+    SECOND_BY_SECOND: string;
+    DAILY: string;
+};
 /**
@@ -60,2 +70,7 @@ * The way that position values for an Account are calculated and aggregated. https://developer.oanda.com/rest-live-v20/account-df/
 }
+export declare const PositionAggregationModeDescription: {
+    ABSOLUTE_SUM: string;
+    MAXIMAL_SIDE: string;
+    NET_SUM: string;
+};
 export declare class AccumulatedAccountState {
@@ -62,0 +77,0 @@ /**

dist/definitions/account.js

@@ -28,2 +28,7 @@ "use strict";
 })(GuaranteedStopLossOrderMode = exports.GuaranteedStopLossOrderMode || (exports.GuaranteedStopLossOrderMode = {}));
+exports.GuaranteedStopLossOrderModeDescription = {
+    'DISABLED': 'The Account is not permitted to create guaranteed Stop Loss Orders.',
+    'ALLOWED': 'The Account is able, but not required to have guaranteed Stop Loss Orders for open Trades.',
+    'REQUIRED': 'The Account is required to have guaranteed Stop Loss Orders for all open Trades.',
+};
 /**
@@ -47,2 +52,7 @@ * The financing mode of an Account https://developer.oanda.com/rest-live-v20/account-df/
 })(AccountFinancingMode = exports.AccountFinancingMode || (exports.AccountFinancingMode = {}));
+exports.AccountFinancingModeDescription = {
+    'NO_FINANCING': 'No financing is paid/charged for open Trades in the Account',
+    'SECOND_BY_SECOND': 'Second-by-second financing is paid/charged for open Trades in the Account, both daily and when the the Trade is closed',
+    'DAILY': 'A full day’s worth of financing is paid/charged for open Trades in the Account daily at 5pm New York time',
+};
 /**
@@ -66,2 +76,7 @@ * The way that position values for an Account are calculated and aggregated. https://developer.oanda.com/rest-live-v20/account-df/
 })(PositionAggregationMode = exports.PositionAggregationMode || (exports.PositionAggregationMode = {}));
+exports.PositionAggregationModeDescription = {
+    'ABSOLUTE_SUM': 'The Position value or margin for each side (long and short) of the Position are computed independently and added together.',
+    'MAXIMAL_SIDE': 'The Position value or margin for each side (long and short) of the Position are computed independently. The Position value or margin chosen is the maximal absolute value of the two.',
+    'NET_SUM': 'The units for each side (long and short) of the Position are netted together and the resulting value (long or short) is used to compute the Position value or margin.',
+};
 var AccumulatedAccountState = /** @class */ (function () {
@@ -68,0 +83,0 @@ function AccumulatedAccountState() {

dist/definitions/instrument.d.ts

@@ -93,2 +93,25 @@ import * as primitives from './primitives';
 }
+export declare const CandlestickGranularityDescription: {
+    S5: string;
+    S10: string;
+    S15: string;
+    S30: string;
+    M1: string;
+    M2: string;
+    M4: string;
+    M5: string;
+    M10: string;
+    M15: string;
+    M30: string;
+    H1: string;
+    H2: string;
+    H3: string;
+    H4: string;
+    H6: string;
+    H8: string;
+    H12: string;
+    D: string;
+    W: string;
+    M: string;
+};
 /**
@@ -127,2 +150,11 @@ * The day of the week to use for candlestick granularities with weekly alignment. https://developer.oanda.com/rest-live-v20/instrument-df/
 }
+export declare const WeeklyAlignmentDescription: {
+    Monday: string;
+    Tuesday: string;
+    Wednesday: string;
+    Thursday: string;
+    Friday: string;
+    Saturday: string;
+    Sunday: string;
+};
 /**
@@ -149,2 +181,8 @@ * The type of price adjustment. https://developer.oanda.com/rest-live-v20/instrument-df/
 }
+export declare const PriceAdjustmentTypeDescription: {
+    PRESENT_VALUE: string;
+    DIVIDEND: string;
+    BASIS: string;
+    FAIR_VALUE: string;
+};
 /**
@@ -159,2 +197,5 @@ * Time interval at which data is sampled. https://developer.oanda.com/rest-live-v20/instrument-df/
 }
+export declare const SamplingIntervalDescription: {
+    M1: string;
+};
 export declare class CandlestickResponse {
@@ -161,0 +202,0 @@ /**

dist/definitions/instrument.js

@@ -100,2 +100,25 @@ "use strict";
 })(CandlestickGranularity = exports.CandlestickGranularity || (exports.CandlestickGranularity = {}));
+exports.CandlestickGranularityDescription = {
+    'S5': '5 second candlesticks, minute alignment',
+    'S10': '10 second candlesticks, minute alignment',
+    'S15': '15 second candlesticks, minute alignment',
+    'S30': '30 second candlesticks, minute alignment',
+    'M1': '1 minute candlesticks, minute alignment',
+    'M2': '2 minute candlesticks, hour alignment',
+    'M4': '4 minute candlesticks, hour alignment',
+    'M5': '5 minute candlesticks, hour alignment',
+    'M10': '10 minute candlesticks, hour alignment',
+    'M15': '15 minute candlesticks, hour alignment',
+    'M30': '30 minute candlesticks, hour alignment',
+    'H1': '1 hour candlesticks, hour alignment',
+    'H2': '2 hour candlesticks, day alignment',
+    'H3': '3 hour candlesticks, day alignment',
+    'H4': '4 hour candlesticks, day alignment',
+    'H6': '6 hour candlesticks, day alignment',
+    'H8': '8 hour candlesticks, day alignment',
+    'H12': '12 hour candlesticks, day alignment',
+    'D': '1 day candlesticks, day alignment',
+    'W': '1 week candlesticks, aligned to start of week',
+    'M': '1 month candlesticks, aligned to first day of the month',
+};
 /**
@@ -135,2 +158,11 @@ * The day of the week to use for candlestick granularities with weekly alignment. https://developer.oanda.com/rest-live-v20/instrument-df/
 })(WeeklyAlignment = exports.WeeklyAlignment || (exports.WeeklyAlignment = {}));
+exports.WeeklyAlignmentDescription = {
+    'Monday': 'Monday',
+    'Tuesday': 'Tuesday',
+    'Wednesday': 'Wednesday',
+    'Thursday': 'Thursday',
+    'Friday': 'Friday',
+    'Saturday': 'Saturday',
+    'Sunday': 'Sunday',
+};
 /**
@@ -158,2 +190,8 @@ * The type of price adjustment. https://developer.oanda.com/rest-live-v20/instrument-df/
 })(PriceAdjustmentType = exports.PriceAdjustmentType || (exports.PriceAdjustmentType = {}));
+exports.PriceAdjustmentTypeDescription = {
+    'PRESENT_VALUE': 'The present value adjustment is intended to back-out the interest component of the future-date contract expiry.',
+    'DIVIDEND': 'The dividend adjustment is intended to include the impact of the dividend payment from the equities that make up the index.',
+    'BASIS': 'The basis adjustment is intended to offset the difference in the basis between the futures price and the index price.',
+    'FAIR_VALUE': 'The fair value adjustment is intended to be configured manually by the Trading team to adjust the price of the CFD for any reason which is not captured by the other adjustments, and will typically be the 0.',
+};
 /**
@@ -169,2 +207,5 @@ * Time interval at which data is sampled. https://developer.oanda.com/rest-live-v20/instrument-df/
 })(SamplingInterval = exports.SamplingInterval || (exports.SamplingInterval = {}));
+exports.SamplingIntervalDescription = {
+    'M1': 'One minute sampling.',
+};
 var CandlestickResponse = /** @class */ (function () {
@@ -171,0 +212,0 @@ function CandlestickResponse() {

dist/definitions/order.d.ts

@@ -52,2 +52,12 @@ import { MarketOrderRequest, LimitOrderRequest, StopOrderRequest, MarketIfTouchedOrderRequest, TakeProfitOrderRequest, StopLossOrderRequest, TrailingStopLossOrderRequest } from '../order';
 }
+export declare const OrderTypeDescription: {
+    MARKET: string;
+    LIMIT: string;
+    STOP: string;
+    MARKET_IF_TOUCHED: string;
+    TAKE_PROFIT: string;
+    STOP_LOSS: string;
+    TRAILING_STOP_LOSS: string;
+    FIXED_PRICE: string;
+};
 /**
@@ -82,2 +92,10 @@ * The type of the Order. https://developer.oanda.com/rest-live-v20/order-df/
 }
+export declare const CancellableOrderTypeDescription: {
+    LIMIT: string;
+    STOP: string;
+    MARKET_IF_TOUCHED: string;
+    TAKE_PROFIT: string;
+    STOP_LOSS: string;
+    TRAILING_STOP_LOSS: string;
+};
 /**
@@ -104,2 +122,8 @@ * The current state of the Order. https://developer.oanda.com/rest-live-v20/order-df/
 }
+export declare const OrderStateDescription: {
+    PENDING: string;
+    FILLED: string;
+    TRIGGERED: string;
+    CANCELLED: string;
+};
 /**
@@ -130,2 +154,9 @@ * The state to filter the requested Orders by. https://developer.oanda.com/rest-live-v20/order-df/
 }
+export declare const OrderStateFilterDescription: {
+    PENDING: string;
+    FILLED: string;
+    TRIGGERED: string;
+    CANCELLED: string;
+    ALL: string;
+};
 /**
@@ -156,2 +187,9 @@ * The time-in-force of an Order. TimeInForce describes how long an Order should remain pending before being automatically cancelled by the execution system. https://developer.oanda.com/rest-live-v20/order-df/
 }
+export declare const TimeInForceDescription: {
+    GTC: string;
+    GTD: string;
+    GFD: string;
+    FOK: string;
+    IOC: string;
+};
 /**
@@ -178,2 +216,8 @@ * Specification of how Positions in the Account are modified when the Order is filled. https://developer.oanda.com/rest-live-v20/order-df/
 }
+export declare const OrderPositionFillDescription: {
+    OPEN_ONLY: string;
+    REDUCE_FIRST: string;
+    REDUCE_ONLY: string;
+    DEFAULT: string;
+};
 /**
@@ -206,1 +250,8 @@ * Specification of which price component should be used when determining if an Order should be triggered and filled. This allows Orders to be triggered based on the bid, ask, mid, default (ask for buy, bid for sell) or inverse (ask for sell, bid for buy) price depending on the desired behaviour. Orders are always filled using their default price component.
 }
+export declare const OrderTriggerConditionDescription: {
+    DEFAULT: string;
+    INVERSE: string;
+    BID: string;
+    ASK: string;
+    MID: string;
+};

dist/definitions/order.js

@@ -63,2 +63,12 @@ "use strict";
 })(OrderType = exports.OrderType || (exports.OrderType = {}));
+exports.OrderTypeDescription = {
+    'MARKET': 'A Market Order',
+    'LIMIT': 'A Limit Order',
+    'STOP': 'A Stop Order',
+    'MARKET_IF_TOUCHED': 'A Market-if-touched Order',
+    'TAKE_PROFIT': 'A Take Profit Order',
+    'STOP_LOSS': 'A Stop Loss Order',
+    'TRAILING_STOP_LOSS': 'A Trailing Stop Loss Order',
+    'FIXED_PRICE': 'A Fixed Price Order',
+};
 /**
@@ -94,2 +104,10 @@ * The type of the Order. https://developer.oanda.com/rest-live-v20/order-df/
 })(CancellableOrderType = exports.CancellableOrderType || (exports.CancellableOrderType = {}));
+exports.CancellableOrderTypeDescription = {
+    'LIMIT': 'A Limit Order',
+    'STOP': 'A Stop Order',
+    'MARKET_IF_TOUCHED': 'A Market-if-touched Order',
+    'TAKE_PROFIT': 'A Take Profit Order',
+    'STOP_LOSS': 'A Stop Loss Order',
+    'TRAILING_STOP_LOSS': 'A Trailing Stop Loss Order',
+};
 /**
@@ -117,2 +135,8 @@ * The current state of the Order. https://developer.oanda.com/rest-live-v20/order-df/
 })(OrderState = exports.OrderState || (exports.OrderState = {}));
+exports.OrderStateDescription = {
+    'PENDING': 'The Order is currently pending execution',
+    'FILLED': 'The Order has been filled',
+    'TRIGGERED': 'The Order has been triggered',
+    'CANCELLED': 'The Order has been cancelled',
+};
 /**
@@ -144,2 +168,9 @@ * The state to filter the requested Orders by. https://developer.oanda.com/rest-live-v20/order-df/
 })(OrderStateFilter = exports.OrderStateFilter || (exports.OrderStateFilter = {}));
+exports.OrderStateFilterDescription = {
+    'PENDING': 'The Orders that are currently pending execution',
+    'FILLED': 'The Orders that have been filled',
+    'TRIGGERED': 'The Orders that have been triggered',
+    'CANCELLED': 'The Orders that have been cancelled',
+    'ALL': 'The Orders that are in any of the possible states listed above',
+};
 /**
@@ -171,2 +202,9 @@ * The time-in-force of an Order. TimeInForce describes how long an Order should remain pending before being automatically cancelled by the execution system. https://developer.oanda.com/rest-live-v20/order-df/
 })(TimeInForce = exports.TimeInForce || (exports.TimeInForce = {}));
+exports.TimeInForceDescription = {
+    'GTC': 'The Order is “Good unTil Cancelled”',
+    'GTD': 'The Order is “Good unTil Date” and will be cancelled at the provided time',
+    'GFD': 'The Order is “Good For Day” and will be cancelled at 5pm New York time',
+    'FOK': 'The Order must be immediately “Filled Or Killed”',
+    'IOC': 'The Order must be “Immediately partially filled Or Cancelled”',
+};
 /**
@@ -194,2 +232,8 @@ * Specification of how Positions in the Account are modified when the Order is filled. https://developer.oanda.com/rest-live-v20/order-df/
 })(OrderPositionFill = exports.OrderPositionFill || (exports.OrderPositionFill = {}));
+exports.OrderPositionFillDescription = {
+    'OPEN_ONLY': 'When the Order is filled, only allow Positions to be opened or extended.',
+    'REDUCE_FIRST': 'When the Order is filled, always fully reduce an existing Position before opening a new Position.',
+    'REDUCE_ONLY': 'When the Order is filled, only reduce an existing Position.',
+    'DEFAULT': 'When the Order is filled, use REDUCE_FIRST behaviour for non-client hedging Accounts, and OPEN_ONLY behaviour for client hedging Accounts.',
+};
 /**
@@ -223,2 +267,9 @@ * Specification of which price component should be used when determining if an Order should be triggered and filled. This allows Orders to be triggered based on the bid, ask, mid, default (ask for buy, bid for sell) or inverse (ask for sell, bid for buy) price depending on the desired behaviour. Orders are always filled using their default price component.
 })(OrderTriggerCondition = exports.OrderTriggerCondition || (exports.OrderTriggerCondition = {}));
+exports.OrderTriggerConditionDescription = {
+    'DEFAULT': 'Trigger an Order the “natural” way: compare its price to the ask for long Orders and bid for short Orders.',
+    'INVERSE': 'Trigger an Order the opposite of the “natural” way: compare its price the bid for long Orders and ask for short Orders.',
+    'BID': 'Trigger an Order by comparing its price to the bid regardless of whether it is long or short.',
+    'ASK': 'Trigger an Order by comparing its price to the ask regardless of whether it is long or short.',
+    'MID': 'Trigger an Order by comparing its price to the midpoint regardless of whether it is long or short.',
+};
 //# sourceMappingURL=order.js.map

dist/definitions/pricing.d.ts

@@ -23,1 +23,6 @@ export { ClientPrice, QuoteHomeConversionFactors, HomeConversions, PricingHeartbeat } from '../pricing';
 }
+export declare const PriceStatusDescription: {
+    tradeable: string;
+    'non-tradeable': string;
+    invalid: string;
+};

dist/definitions/pricing.js

@@ -26,2 +26,7 @@ "use strict";
 })(PriceStatus = exports.PriceStatus || (exports.PriceStatus = {}));
+exports.PriceStatusDescription = {
+    'tradeable': 'The Instrument’s price is tradeable.',
+    'non-tradeable': 'The Instrument’s price is not tradeable.',
+    'invalid': 'The Instrument of the price is invalid or there is no valid Price for the Instrument.',
+};
 //# sourceMappingURL=pricing.js.map

dist/definitions/primitives.d.ts

@@ -43,2 +43,7 @@ export { Instrument, InstrumentCommission, GuaranteedStopLossOrderLevelRestriction } from '../primitives';
 }
+export declare const InstrumentTypeDescription: {
+    CURRENCY: string;
+    CFD: string;
+    METAL: string;
+};
 /**
@@ -77,2 +82,11 @@ * The DayOfWeek provides a representation of the day of the week. https://developer.oanda.com/rest-live-v20/primitives-df/
 }
+export declare const DayOfWeekDescription: {
+    SUNDAY: string;
+    MONDAY: string;
+    TUESDAY: string;
+    WEDNESDAY: string;
+    THURSDAY: string;
+    FRIDAY: string;
+    SATURDAY: string;
+};
 /**
@@ -91,2 +105,6 @@ * DateTime header https://developer.oanda.com/rest-live-v20/primitives-df/
 }
+export declare const AcceptDatetimeFormatDescription: {
+    UNIX: string;
+    RFC3339: string;
+};
 /**
@@ -105,2 +123,6 @@ * In the context of an Order or a Trade, defines whether the units are positive or negative. https://developer.oanda.com/rest-live-v20/primitives-df/
 }
+export declare const DirectionDescription: {
+    LONG: string;
+    SHORT: string;
+};
 export declare class Tag {
@@ -107,0 +129,0 @@ /**

dist/definitions/primitives.js

@@ -25,2 +25,7 @@ "use strict";
 })(InstrumentType = exports.InstrumentType || (exports.InstrumentType = {}));
+exports.InstrumentTypeDescription = {
+    'CURRENCY': 'Currency',
+    'CFD': 'Contract For Difference',
+    'METAL': 'Metal',
+};
 /**
@@ -60,2 +65,11 @@ * The DayOfWeek provides a representation of the day of the week. https://developer.oanda.com/rest-live-v20/primitives-df/
 })(DayOfWeek = exports.DayOfWeek || (exports.DayOfWeek = {}));
+exports.DayOfWeekDescription = {
+    'SUNDAY': 'Sunday',
+    'MONDAY': 'Monday',
+    'TUESDAY': 'Tuesday',
+    'WEDNESDAY': 'Wednesday',
+    'THURSDAY': 'Thursday',
+    'FRIDAY': 'Friday',
+    'SATURDAY': 'Saturday',
+};
 /**
@@ -75,2 +89,6 @@ * DateTime header https://developer.oanda.com/rest-live-v20/primitives-df/
 })(AcceptDatetimeFormat = exports.AcceptDatetimeFormat || (exports.AcceptDatetimeFormat = {}));
+exports.AcceptDatetimeFormatDescription = {
+    'UNIX': 'If “UNIX” is specified DateTime fields will be specified or returned in the “12345678.000000123” format.',
+    'RFC3339': 'If “RFC3339” is specified DateTime will be specified or returned in “YYYY-MM-DDTHH:MM:SS.nnnnnnnnnZ” format.',
+};
 /**
@@ -90,2 +108,6 @@ * In the context of an Order or a Trade, defines whether the units are positive or negative. https://developer.oanda.com/rest-live-v20/primitives-df/
 })(Direction = exports.Direction || (exports.Direction = {}));
+exports.DirectionDescription = {
+    'LONG': 'A long Order is used to to buy units of an Instrument. A Trade is long when it has bought units of an Instrument.',
+    'SHORT': 'A short Order is used to to sell units of an Instrument. A Trade is short when it has sold units of an Instrument.',
+};
 var Tag = /** @class */ (function () {
@@ -92,0 +114,0 @@ function Tag() {

dist/definitions/trade.d.ts

@@ -27,2 +27,7 @@ export { Trade, TradeSummary, CalculatedTradeState } from '../trade';
 }
+export declare const TradeStateDescription: {
+    OPEN: string;
+    CLOSED: string;
+    CLOSE_WHEN_TRADEABLE: string;
+};
 /**
@@ -49,2 +54,8 @@ * The state to filter the Trades by https://developer.oanda.com/rest-live-v20/trade-df/
 }
+export declare const TradeStateFilterDescription: {
+    OPEN: string;
+    CLOSED: string;
+    CLOSE_WHEN_TRADEABLE: string;
+    ALL: string;
+};
 /**
@@ -67,1 +78,6 @@ * The classification of TradePLs. https://developer.oanda.com/rest-live-v20/trade-df/
 }
+export declare const TradePLDescription: {
+    POSITIVE: string;
+    NEGATIVE: string;
+    ZERO: string;
+};

dist/definitions/trade.js

@@ -25,2 +25,7 @@ "use strict";
 })(TradeState = exports.TradeState || (exports.TradeState = {}));
+exports.TradeStateDescription = {
+    'OPEN': 'The Trade is currently open',
+    'CLOSED': 'The Trade has been fully closed',
+    'CLOSE_WHEN_TRADEABLE': 'The Trade will be closed as soon as the trade’s instrument becomes tradeable',
+};
 /**
@@ -48,2 +53,8 @@ * The state to filter the Trades by https://developer.oanda.com/rest-live-v20/trade-df/
 })(TradeStateFilter = exports.TradeStateFilter || (exports.TradeStateFilter = {}));
+exports.TradeStateFilterDescription = {
+    'OPEN': 'The Trades that are currently open',
+    'CLOSED': 'The Trades that have been fully closed',
+    'CLOSE_WHEN_TRADEABLE': 'The Trades  that will be closed as soon as the trades’ instrument becomes tradeable',
+    'ALL': 'The Trades that are in any of the possible states listed above.',
+};
 /**
@@ -67,2 +78,7 @@ * The classification of TradePLs. https://developer.oanda.com/rest-live-v20/trade-df/
 })(TradePL = exports.TradePL || (exports.TradePL = {}));
+exports.TradePLDescription = {
+    'POSITIVE': 'An open Trade currently has a positive (profitable) unrealized P/L, or a closed Trade realized a positive amount of P/L.',
+    'NEGATIVE': 'An open Trade currently has a negative (losing) unrealized P/L, or a closed Trade realized a negative amount of P/L.',
+    'ZERO': 'An open Trade currently has unrealized P/L of zero (neither profitable nor losing), or a closed Trade realized a P/L amount of zero.',
+};
 //# sourceMappingURL=trade.js.map

package.json

 {
   "name": "@narative/oanda-v20",
   "description": "OANDA v20 bindings for Javascript",
-  "version": "3.0.47",
+  "version": "3.0.48",
   "author": "OANDA Corporation",
@@ -6,0 +6,0 @@ "repository": "https://github.com/narative/v20-javascript",

scripts/definitions.ts

@@ -105,3 +105,8 @@ import * as path from 'path'
   .join('\n')}}`
-        resultEnums.push(`${enumValue}`)
+
+        // enum description
+        const enumDescription = `export const ${name}Description = {
+${values.map((v) => `  ${convertEnumName(v.value)}: '${v.description}',`).join('\n')}\n}`
+
+        resultEnums.push(`${enumValue}\n\n${enumDescription}`)
         return
@@ -108,0 +113,0 @@ }

scripts/run.ts

@@ -41,5 +41,5 @@ import * as oanda from '../src'
   await parseAllDefinitions()
-  await parseAllEndpoints()
+  // await parseAllEndpoints()
 }
 
 main()

src/definitions/account.ts

@@ -38,2 +38,8 @@ import * as account from './account'
 
+export const GuaranteedStopLossOrderModeDescription = {
+  'DISABLED': 'The Account is not permitted to create guaranteed Stop Loss Orders.',
+  'ALLOWED': 'The Account is able, but not required to have guaranteed Stop Loss Orders for open Trades.',
+  'REQUIRED': 'The Account is required to have guaranteed Stop Loss Orders for all open Trades.',
+}
+
 /**
@@ -59,2 +65,8 @@ * The financing mode of an Account https://developer.oanda.com/rest-live-v20/account-df/
 
+export const AccountFinancingModeDescription = {
+  'NO_FINANCING': 'No financing is paid/charged for open Trades in the Account',
+  'SECOND_BY_SECOND': 'Second-by-second financing is paid/charged for open Trades in the Account, both daily and when the the Trade is closed',
+  'DAILY': 'A full day’s worth of financing is paid/charged for open Trades in the Account daily at 5pm New York time',
+}
+
 /**
@@ -80,2 +92,8 @@ * The way that position values for an Account are calculated and aggregated. https://developer.oanda.com/rest-live-v20/account-df/
 
+export const PositionAggregationModeDescription = {
+  'ABSOLUTE_SUM': 'The Position value or margin for each side (long and short) of the Position are computed independently and added together.',
+  'MAXIMAL_SIDE': 'The Position value or margin for each side (long and short) of the Position are computed independently. The Position value or margin chosen is the maximal absolute value of the two.',
+  'NET_SUM': 'The units for each side (long and short) of the Position are netted together and the resulting value (long or short) is used to compute the Position value or margin.',
+}
+
 export class AccumulatedAccountState {
@@ -82,0 +100,0 @@ /**

src/definitions/instrument.ts

@@ -125,2 +125,26 @@ import * as account from './account'
 
+export const CandlestickGranularityDescription = {
+  'S5': '5 second candlesticks, minute alignment',
+  'S10': '10 second candlesticks, minute alignment',
+  'S15': '15 second candlesticks, minute alignment',
+  'S30': '30 second candlesticks, minute alignment',
+  'M1': '1 minute candlesticks, minute alignment',
+  'M2': '2 minute candlesticks, hour alignment',
+  'M4': '4 minute candlesticks, hour alignment',
+  'M5': '5 minute candlesticks, hour alignment',
+  'M10': '10 minute candlesticks, hour alignment',
+  'M15': '15 minute candlesticks, hour alignment',
+  'M30': '30 minute candlesticks, hour alignment',
+  'H1': '1 hour candlesticks, hour alignment',
+  'H2': '2 hour candlesticks, day alignment',
+  'H3': '3 hour candlesticks, day alignment',
+  'H4': '4 hour candlesticks, day alignment',
+  'H6': '6 hour candlesticks, day alignment',
+  'H8': '8 hour candlesticks, day alignment',
+  'H12': '12 hour candlesticks, day alignment',
+  'D': '1 day candlesticks, day alignment',
+  'W': '1 week candlesticks, aligned to start of week',
+  'M': '1 month candlesticks, aligned to first day of the month',
+}
+
 /**
@@ -166,2 +190,12 @@ * The day of the week to use for candlestick granularities with weekly alignment. https://developer.oanda.com/rest-live-v20/instrument-df/
 
+export const WeeklyAlignmentDescription = {
+  'Monday': 'Monday',
+  'Tuesday': 'Tuesday',
+  'Wednesday': 'Wednesday',
+  'Thursday': 'Thursday',
+  'Friday': 'Friday',
+  'Saturday': 'Saturday',
+  'Sunday': 'Sunday',
+}
+
 /**
@@ -192,2 +226,9 @@ * The type of price adjustment. https://developer.oanda.com/rest-live-v20/instrument-df/
 
+export const PriceAdjustmentTypeDescription = {
+  'PRESENT_VALUE': 'The present value adjustment is intended to back-out the interest component of the future-date contract expiry.',
+  'DIVIDEND': 'The dividend adjustment is intended to include the impact of the dividend payment from the equities that make up the index.',
+  'BASIS': 'The basis adjustment is intended to offset the difference in the basis between the futures price and the index price.',
+  'FAIR_VALUE': 'The fair value adjustment is intended to be configured manually by the Trading team to adjust the price of the CFD for any reason which is not captured by the other adjustments, and will typically be the 0.',
+}
+
 /**
@@ -203,2 +244,6 @@ * Time interval at which data is sampled. https://developer.oanda.com/rest-live-v20/instrument-df/
 
+export const SamplingIntervalDescription = {
+  'M1': 'One minute sampling.',
+}
+
 export class CandlestickResponse {
@@ -205,0 +250,0 @@ /**

src/definitions/order.ts

@@ -73,2 +73,13 @@ import * as account from './account'
 
+export const OrderTypeDescription = {
+  'MARKET': 'A Market Order',
+  'LIMIT': 'A Limit Order',
+  'STOP': 'A Stop Order',
+  'MARKET_IF_TOUCHED': 'A Market-if-touched Order',
+  'TAKE_PROFIT': 'A Take Profit Order',
+  'STOP_LOSS': 'A Stop Loss Order',
+  'TRAILING_STOP_LOSS': 'A Trailing Stop Loss Order',
+  'FIXED_PRICE': 'A Fixed Price Order',
+}
+
 /**
@@ -109,2 +120,11 @@ * The type of the Order. https://developer.oanda.com/rest-live-v20/order-df/
 
+export const CancellableOrderTypeDescription = {
+  'LIMIT': 'A Limit Order',
+  'STOP': 'A Stop Order',
+  'MARKET_IF_TOUCHED': 'A Market-if-touched Order',
+  'TAKE_PROFIT': 'A Take Profit Order',
+  'STOP_LOSS': 'A Stop Loss Order',
+  'TRAILING_STOP_LOSS': 'A Trailing Stop Loss Order',
+}
+
 /**
@@ -135,2 +155,9 @@ * The current state of the Order. https://developer.oanda.com/rest-live-v20/order-df/
 
+export const OrderStateDescription = {
+  'PENDING': 'The Order is currently pending execution',
+  'FILLED': 'The Order has been filled',
+  'TRIGGERED': 'The Order has been triggered',
+  'CANCELLED': 'The Order has been cancelled',
+}
+
 /**
@@ -166,2 +193,10 @@ * The state to filter the requested Orders by. https://developer.oanda.com/rest-live-v20/order-df/
 
+export const OrderStateFilterDescription = {
+  'PENDING': 'The Orders that are currently pending execution',
+  'FILLED': 'The Orders that have been filled',
+  'TRIGGERED': 'The Orders that have been triggered',
+  'CANCELLED': 'The Orders that have been cancelled',
+  'ALL': 'The Orders that are in any of the possible states listed above',
+}
+
 /**
@@ -197,2 +232,10 @@ * The time-in-force of an Order. TimeInForce describes how long an Order should remain pending before being automatically cancelled by the execution system. https://developer.oanda.com/rest-live-v20/order-df/
 
+export const TimeInForceDescription = {
+  'GTC': 'The Order is “Good unTil Cancelled”',
+  'GTD': 'The Order is “Good unTil Date” and will be cancelled at the provided time',
+  'GFD': 'The Order is “Good For Day” and will be cancelled at 5pm New York time',
+  'FOK': 'The Order must be immediately “Filled Or Killed”',
+  'IOC': 'The Order must be “Immediately partially filled Or Cancelled”',
+}
+
 /**
@@ -223,2 +266,9 @@ * Specification of how Positions in the Account are modified when the Order is filled. https://developer.oanda.com/rest-live-v20/order-df/
 
+export const OrderPositionFillDescription = {
+  'OPEN_ONLY': 'When the Order is filled, only allow Positions to be opened or extended.',
+  'REDUCE_FIRST': 'When the Order is filled, always fully reduce an existing Position before opening a new Position.',
+  'REDUCE_ONLY': 'When the Order is filled, only reduce an existing Position.',
+  'DEFAULT': 'When the Order is filled, use REDUCE_FIRST behaviour for non-client hedging Accounts, and OPEN_ONLY behaviour for client hedging Accounts.',
+}
+
 /**
@@ -256,1 +306,9 @@ * Specification of which price component should be used when determining if an Order should be triggered and filled. This allows Orders to be triggered based on the bid, ask, mid, default (ask for buy, bid for sell) or inverse (ask for sell, bid for buy) price depending on the desired behaviour. Orders are always filled using their default price component.
 
+export const OrderTriggerConditionDescription = {
+  'DEFAULT': 'Trigger an Order the “natural” way: compare its price to the ask for long Orders and bid for short Orders.',
+  'INVERSE': 'Trigger an Order the opposite of the “natural” way: compare its price the bid for long Orders and ask for short Orders.',
+  'BID': 'Trigger an Order by comparing its price to the bid regardless of whether it is long or short.',
+  'ASK': 'Trigger an Order by comparing its price to the ask regardless of whether it is long or short.',
+  'MID': 'Trigger an Order by comparing its price to the midpoint regardless of whether it is long or short.',
+}
+

src/definitions/pricing.ts

@@ -38,1 +38,7 @@ import * as account from './account'
 
+export const PriceStatusDescription = {
+  'tradeable': 'The Instrument’s price is tradeable.',
+  'non-tradeable': 'The Instrument’s price is not tradeable.',
+  'invalid': 'The Instrument of the price is invalid or there is no valid Price for the Instrument.',
+}
+

src/definitions/primitives.ts

@@ -63,2 +63,8 @@ import * as account from './account'
 
+export const InstrumentTypeDescription = {
+  'CURRENCY': 'Currency',
+  'CFD': 'Contract For Difference',
+  'METAL': 'Metal',
+}
+
 /**
@@ -104,2 +110,12 @@ * The DayOfWeek provides a representation of the day of the week. https://developer.oanda.com/rest-live-v20/primitives-df/
 
+export const DayOfWeekDescription = {
+  'SUNDAY': 'Sunday',
+  'MONDAY': 'Monday',
+  'TUESDAY': 'Tuesday',
+  'WEDNESDAY': 'Wednesday',
+  'THURSDAY': 'Thursday',
+  'FRIDAY': 'Friday',
+  'SATURDAY': 'Saturday',
+}
+
 /**
@@ -120,2 +136,7 @@ * DateTime header https://developer.oanda.com/rest-live-v20/primitives-df/
 
+export const AcceptDatetimeFormatDescription = {
+  'UNIX': 'If “UNIX” is specified DateTime fields will be specified or returned in the “12345678.000000123” format.',
+  'RFC3339': 'If “RFC3339” is specified DateTime will be specified or returned in “YYYY-MM-DDTHH:MM:SS.nnnnnnnnnZ” format.',
+}
+
 /**
@@ -136,2 +157,7 @@ * In the context of an Order or a Trade, defines whether the units are positive or negative. https://developer.oanda.com/rest-live-v20/primitives-df/
 
+export const DirectionDescription = {
+  'LONG': 'A long Order is used to to buy units of an Instrument. A Trade is long when it has bought units of an Instrument.',
+  'SHORT': 'A short Order is used to to sell units of an Instrument. A Trade is short when it has sold units of an Instrument.',
+}
+
 export class Tag {
@@ -138,0 +164,0 @@ /**

src/definitions/trade.ts

@@ -43,2 +43,8 @@ import * as account from './account'
 
+export const TradeStateDescription = {
+  'OPEN': 'The Trade is currently open',
+  'CLOSED': 'The Trade has been fully closed',
+  'CLOSE_WHEN_TRADEABLE': 'The Trade will be closed as soon as the trade’s instrument becomes tradeable',
+}
+
 /**
@@ -69,2 +75,9 @@ * The state to filter the Trades by https://developer.oanda.com/rest-live-v20/trade-df/
 
+export const TradeStateFilterDescription = {
+  'OPEN': 'The Trades that are currently open',
+  'CLOSED': 'The Trades that have been fully closed',
+  'CLOSE_WHEN_TRADEABLE': 'The Trades  that will be closed as soon as the trades’ instrument becomes tradeable',
+  'ALL': 'The Trades that are in any of the possible states listed above.',
+}
+
 /**
@@ -90,1 +103,7 @@ * The classification of TradePLs. https://developer.oanda.com/rest-live-v20/trade-df/
 
+export const TradePLDescription = {
+  'POSITIVE': 'An open Trade currently has a positive (profitable) unrealized P/L, or a closed Trade realized a positive amount of P/L.',
+  'NEGATIVE': 'An open Trade currently has a negative (losing) unrealized P/L, or a closed Trade realized a negative amount of P/L.',
+  'ZERO': 'An open Trade currently has unrealized P/L of zero (neither profitable nor losing), or a closed Trade realized a P/L amount of zero.',
+}
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4079978

increased by3.01%

Lines of code

71881

increased by2.14%

No dependency changes