@clear-street/clearstreet 0.98.0 → 0.100.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/CHANGELOG.md +25 -0
- package/package.json +1 -1
- package/resources/v1/index.d.mts +3 -3
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +3 -3
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/instrument-data/market-data.d.mts +101 -28
- package/resources/v1/instrument-data/market-data.d.mts.map +1 -1
- package/resources/v1/instrument-data/market-data.d.ts +101 -28
- package/resources/v1/instrument-data/market-data.d.ts.map +1 -1
- package/resources/v1/instrument-data/market-data.js +10 -11
- package/resources/v1/instrument-data/market-data.js.map +1 -1
- package/resources/v1/instrument-data/market-data.mjs +10 -11
- package/resources/v1/instrument-data/market-data.mjs.map +1 -1
- package/resources/v1/instruments.d.mts +45 -3
- package/resources/v1/instruments.d.mts.map +1 -1
- package/resources/v1/instruments.d.ts +45 -3
- package/resources/v1/instruments.d.ts.map +1 -1
- package/resources/v1/omni-ai/omni-ai.d.mts +1 -1
- package/resources/v1/omni-ai/omni-ai.d.ts +1 -1
- package/resources/v1/orders.d.mts +20 -7
- package/resources/v1/orders.d.mts.map +1 -1
- package/resources/v1/orders.d.ts +20 -7
- package/resources/v1/orders.d.ts.map +1 -1
- package/resources/v1/positions.d.mts +52 -1
- package/resources/v1/positions.d.mts.map +1 -1
- package/resources/v1/positions.d.ts +52 -1
- package/resources/v1/positions.d.ts.map +1 -1
- package/resources/v1/screener.d.mts +58 -8
- package/resources/v1/screener.d.mts.map +1 -1
- package/resources/v1/screener.d.ts +58 -8
- package/resources/v1/screener.d.ts.map +1 -1
- package/resources/v1/screener.js +25 -6
- package/resources/v1/screener.js.map +1 -1
- package/resources/v1/screener.mjs +25 -6
- package/resources/v1/screener.mjs.map +1 -1
- package/resources/v1/v1.d.mts +7 -7
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +7 -7
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/resources/v1/watchlist.d.mts +3 -3
- package/resources/v1/watchlist.d.ts +3 -3
- package/src/resources/v1/index.ts +4 -0
- package/src/resources/v1/instrument-data/market-data.ts +109 -28
- package/src/resources/v1/instruments.ts +51 -2
- package/src/resources/v1/omni-ai/omni-ai.ts +1 -1
- package/src/resources/v1/orders.ts +22 -7
- package/src/resources/v1/positions.ts +55 -0
- package/src/resources/v1/screener.ts +72 -7
- package/src/resources/v1/v1.ts +9 -1
- package/src/resources/v1/watchlist.ts +3 -3
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -195,6 +195,11 @@ export interface Position {
|
|
|
195
195
|
* value is observed, it indicates it does not apply.
|
|
196
196
|
*/
|
|
197
197
|
underlying_instrument_id?: string | null;
|
|
198
|
+
/**
|
|
199
|
+
* Type of the underlying instrument, alongside `underlying_instrument_id` When a
|
|
200
|
+
* null/undefined value is observed, it indicates it does not apply.
|
|
201
|
+
*/
|
|
202
|
+
underlying_instrument_type?: V1API.SecurityType | null;
|
|
198
203
|
/**
|
|
199
204
|
* The total unrealized profit or loss for this position based on current market
|
|
200
205
|
* value When a null/undefined value is observed, it indicates that there is no
|
|
@@ -256,6 +261,15 @@ export interface PositionInstruction {
|
|
|
256
261
|
* value is observed, it indicates that there is no available data.
|
|
257
262
|
*/
|
|
258
263
|
created_at?: string | null;
|
|
264
|
+
/**
|
|
265
|
+
* Machine-readable counterpart to `rejection_reason`: a stable reason code plus
|
|
266
|
+
* params, present on every rejected row that has a `rejection_reason` — on submit,
|
|
267
|
+
* cancel, get, and list alike. Branch on `rejection.reason` instead of parsing
|
|
268
|
+
* `rejection_reason`. Forward-only: instructions rejected before this field
|
|
269
|
+
* shipped may carry only `rejection_reason`. When a null/undefined value is
|
|
270
|
+
* observed, it indicates it does not apply.
|
|
271
|
+
*/
|
|
272
|
+
rejection?: PositionInstructionRejection | null;
|
|
259
273
|
/**
|
|
260
274
|
* Human-readable explanation populated on any non-success terminal status —
|
|
261
275
|
* `REJECTED` or `CANCEL_FAILED`. On a `207 Multi-Status` batch submit the
|
|
@@ -275,6 +289,43 @@ export interface PositionInstruction {
|
|
|
275
289
|
updated_at?: string | null;
|
|
276
290
|
}
|
|
277
291
|
export type PositionInstructionList = Array<PositionInstruction>;
|
|
292
|
+
/**
|
|
293
|
+
* Machine-readable detail for a rejected position instruction.
|
|
294
|
+
*
|
|
295
|
+
* Present on every rejected row that carries a `rejection_reason`, across the full
|
|
296
|
+
* lifecycle — submit, cancel, get, and list. Branch on `reason` for programmatic
|
|
297
|
+
* handling and template your own copy from `metadata`; `rejection_reason` remains
|
|
298
|
+
* the human-readable fallback. Forward-only: instructions rejected before this
|
|
299
|
+
* field shipped may carry only `rejection_reason`.
|
|
300
|
+
*/
|
|
301
|
+
export interface PositionInstructionRejection {
|
|
302
|
+
/**
|
|
303
|
+
* Namespacing domain of the `reason` code — `com.clearstreet.oems.exercise` for
|
|
304
|
+
* reasons OEMS validates, `com.clearstreet.oems.clearing` for clearing-owned
|
|
305
|
+
* reasons.
|
|
306
|
+
*/
|
|
307
|
+
domain: string;
|
|
308
|
+
/**
|
|
309
|
+
* Reason-specific parameters as a string→string map. Which keys are present
|
|
310
|
+
* depends on `reason`:
|
|
311
|
+
*
|
|
312
|
+
* - `INSUFFICIENT_POSITION` → `available`, `requested`
|
|
313
|
+
* - `DNE_NOT_ON_EXPIRY` / `CEA_NOT_ON_EXPIRY` → `expiry`, `business_date`
|
|
314
|
+
* - `EXERCISE_PAST_CUTOFF` → `cutoff_time`
|
|
315
|
+
* - `DUPLICATE_INSTRUCTION` → `existing_id`
|
|
316
|
+
*
|
|
317
|
+
* Empty for reasons that carry no parameters. New keys may be added over time, so
|
|
318
|
+
* treat unknown keys leniently.
|
|
319
|
+
*/
|
|
320
|
+
metadata: {
|
|
321
|
+
[key: string]: string;
|
|
322
|
+
};
|
|
323
|
+
/**
|
|
324
|
+
* Stable, machine-readable reason code, e.g. `DNE_NOT_ON_EXPIRY`,
|
|
325
|
+
* `INSUFFICIENT_POSITION`, `OPTIONS_LEVEL_EXCEEDED`, `EXERCISE_PAST_CUTOFF`.
|
|
326
|
+
*/
|
|
327
|
+
reason: string;
|
|
328
|
+
}
|
|
278
329
|
/**
|
|
279
330
|
* Lifecycle status of a position instruction.
|
|
280
331
|
*
|
|
@@ -414,6 +465,6 @@ export declare namespace PositionSubmitPositionInstructionsParams {
|
|
|
414
465
|
}
|
|
415
466
|
}
|
|
416
467
|
export declare namespace Positions {
|
|
417
|
-
export { type Position as Position, type PositionInstruction as PositionInstruction, type PositionInstructionList as PositionInstructionList, type PositionInstructionStatus as PositionInstructionStatus, type PositionInstructionType as PositionInstructionType, type PositionList as PositionList, type PositionType as PositionType, type PositionCancelPositionInstructionResponse as PositionCancelPositionInstructionResponse, type PositionClosePositionResponse as PositionClosePositionResponse, type PositionClosePositionsResponse as PositionClosePositionsResponse, type PositionGetPositionInstructionsResponse as PositionGetPositionInstructionsResponse, type PositionGetPositionsResponse as PositionGetPositionsResponse, type PositionSubmitPositionInstructionsResponse as PositionSubmitPositionInstructionsResponse, type PositionCancelPositionInstructionParams as PositionCancelPositionInstructionParams, type PositionClosePositionParams as PositionClosePositionParams, type PositionClosePositionsParams as PositionClosePositionsParams, type PositionGetPositionInstructionsParams as PositionGetPositionInstructionsParams, type PositionGetPositionsParams as PositionGetPositionsParams, type PositionSubmitPositionInstructionsParams as PositionSubmitPositionInstructionsParams, };
|
|
468
|
+
export { type Position as Position, type PositionInstruction as PositionInstruction, type PositionInstructionList as PositionInstructionList, type PositionInstructionRejection as PositionInstructionRejection, type PositionInstructionStatus as PositionInstructionStatus, type PositionInstructionType as PositionInstructionType, type PositionList as PositionList, type PositionType as PositionType, type PositionCancelPositionInstructionResponse as PositionCancelPositionInstructionResponse, type PositionClosePositionResponse as PositionClosePositionResponse, type PositionClosePositionsResponse as PositionClosePositionsResponse, type PositionGetPositionInstructionsResponse as PositionGetPositionInstructionsResponse, type PositionGetPositionsResponse as PositionGetPositionsResponse, type PositionSubmitPositionInstructionsResponse as PositionSubmitPositionInstructionsResponse, type PositionCancelPositionInstructionParams as PositionCancelPositionInstructionParams, type PositionClosePositionParams as PositionClosePositionParams, type PositionClosePositionsParams as PositionClosePositionsParams, type PositionGetPositionInstructionsParams as PositionGetPositionInstructionsParams, type PositionGetPositionsParams as PositionGetPositionsParams, type PositionSubmitPositionInstructionsParams as PositionSubmitPositionInstructionsParams, };
|
|
418
469
|
}
|
|
419
470
|
//# sourceMappingURL=positions.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"positions.d.mts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE/C;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"positions.d.mts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,YAAY,wBAAoB;AAC5C,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAEvD;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;GAQG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE/C;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
|
|
@@ -195,6 +195,11 @@ export interface Position {
|
|
|
195
195
|
* value is observed, it indicates it does not apply.
|
|
196
196
|
*/
|
|
197
197
|
underlying_instrument_id?: string | null;
|
|
198
|
+
/**
|
|
199
|
+
* Type of the underlying instrument, alongside `underlying_instrument_id` When a
|
|
200
|
+
* null/undefined value is observed, it indicates it does not apply.
|
|
201
|
+
*/
|
|
202
|
+
underlying_instrument_type?: V1API.SecurityType | null;
|
|
198
203
|
/**
|
|
199
204
|
* The total unrealized profit or loss for this position based on current market
|
|
200
205
|
* value When a null/undefined value is observed, it indicates that there is no
|
|
@@ -256,6 +261,15 @@ export interface PositionInstruction {
|
|
|
256
261
|
* value is observed, it indicates that there is no available data.
|
|
257
262
|
*/
|
|
258
263
|
created_at?: string | null;
|
|
264
|
+
/**
|
|
265
|
+
* Machine-readable counterpart to `rejection_reason`: a stable reason code plus
|
|
266
|
+
* params, present on every rejected row that has a `rejection_reason` — on submit,
|
|
267
|
+
* cancel, get, and list alike. Branch on `rejection.reason` instead of parsing
|
|
268
|
+
* `rejection_reason`. Forward-only: instructions rejected before this field
|
|
269
|
+
* shipped may carry only `rejection_reason`. When a null/undefined value is
|
|
270
|
+
* observed, it indicates it does not apply.
|
|
271
|
+
*/
|
|
272
|
+
rejection?: PositionInstructionRejection | null;
|
|
259
273
|
/**
|
|
260
274
|
* Human-readable explanation populated on any non-success terminal status —
|
|
261
275
|
* `REJECTED` or `CANCEL_FAILED`. On a `207 Multi-Status` batch submit the
|
|
@@ -275,6 +289,43 @@ export interface PositionInstruction {
|
|
|
275
289
|
updated_at?: string | null;
|
|
276
290
|
}
|
|
277
291
|
export type PositionInstructionList = Array<PositionInstruction>;
|
|
292
|
+
/**
|
|
293
|
+
* Machine-readable detail for a rejected position instruction.
|
|
294
|
+
*
|
|
295
|
+
* Present on every rejected row that carries a `rejection_reason`, across the full
|
|
296
|
+
* lifecycle — submit, cancel, get, and list. Branch on `reason` for programmatic
|
|
297
|
+
* handling and template your own copy from `metadata`; `rejection_reason` remains
|
|
298
|
+
* the human-readable fallback. Forward-only: instructions rejected before this
|
|
299
|
+
* field shipped may carry only `rejection_reason`.
|
|
300
|
+
*/
|
|
301
|
+
export interface PositionInstructionRejection {
|
|
302
|
+
/**
|
|
303
|
+
* Namespacing domain of the `reason` code — `com.clearstreet.oems.exercise` for
|
|
304
|
+
* reasons OEMS validates, `com.clearstreet.oems.clearing` for clearing-owned
|
|
305
|
+
* reasons.
|
|
306
|
+
*/
|
|
307
|
+
domain: string;
|
|
308
|
+
/**
|
|
309
|
+
* Reason-specific parameters as a string→string map. Which keys are present
|
|
310
|
+
* depends on `reason`:
|
|
311
|
+
*
|
|
312
|
+
* - `INSUFFICIENT_POSITION` → `available`, `requested`
|
|
313
|
+
* - `DNE_NOT_ON_EXPIRY` / `CEA_NOT_ON_EXPIRY` → `expiry`, `business_date`
|
|
314
|
+
* - `EXERCISE_PAST_CUTOFF` → `cutoff_time`
|
|
315
|
+
* - `DUPLICATE_INSTRUCTION` → `existing_id`
|
|
316
|
+
*
|
|
317
|
+
* Empty for reasons that carry no parameters. New keys may be added over time, so
|
|
318
|
+
* treat unknown keys leniently.
|
|
319
|
+
*/
|
|
320
|
+
metadata: {
|
|
321
|
+
[key: string]: string;
|
|
322
|
+
};
|
|
323
|
+
/**
|
|
324
|
+
* Stable, machine-readable reason code, e.g. `DNE_NOT_ON_EXPIRY`,
|
|
325
|
+
* `INSUFFICIENT_POSITION`, `OPTIONS_LEVEL_EXCEEDED`, `EXERCISE_PAST_CUTOFF`.
|
|
326
|
+
*/
|
|
327
|
+
reason: string;
|
|
328
|
+
}
|
|
278
329
|
/**
|
|
279
330
|
* Lifecycle status of a position instruction.
|
|
280
331
|
*
|
|
@@ -414,6 +465,6 @@ export declare namespace PositionSubmitPositionInstructionsParams {
|
|
|
414
465
|
}
|
|
415
466
|
}
|
|
416
467
|
export declare namespace Positions {
|
|
417
|
-
export { type Position as Position, type PositionInstruction as PositionInstruction, type PositionInstructionList as PositionInstructionList, type PositionInstructionStatus as PositionInstructionStatus, type PositionInstructionType as PositionInstructionType, type PositionList as PositionList, type PositionType as PositionType, type PositionCancelPositionInstructionResponse as PositionCancelPositionInstructionResponse, type PositionClosePositionResponse as PositionClosePositionResponse, type PositionClosePositionsResponse as PositionClosePositionsResponse, type PositionGetPositionInstructionsResponse as PositionGetPositionInstructionsResponse, type PositionGetPositionsResponse as PositionGetPositionsResponse, type PositionSubmitPositionInstructionsResponse as PositionSubmitPositionInstructionsResponse, type PositionCancelPositionInstructionParams as PositionCancelPositionInstructionParams, type PositionClosePositionParams as PositionClosePositionParams, type PositionClosePositionsParams as PositionClosePositionsParams, type PositionGetPositionInstructionsParams as PositionGetPositionInstructionsParams, type PositionGetPositionsParams as PositionGetPositionsParams, type PositionSubmitPositionInstructionsParams as PositionSubmitPositionInstructionsParams, };
|
|
468
|
+
export { type Position as Position, type PositionInstruction as PositionInstruction, type PositionInstructionList as PositionInstructionList, type PositionInstructionRejection as PositionInstructionRejection, type PositionInstructionStatus as PositionInstructionStatus, type PositionInstructionType as PositionInstructionType, type PositionList as PositionList, type PositionType as PositionType, type PositionCancelPositionInstructionResponse as PositionCancelPositionInstructionResponse, type PositionClosePositionResponse as PositionClosePositionResponse, type PositionClosePositionsResponse as PositionClosePositionsResponse, type PositionGetPositionInstructionsResponse as PositionGetPositionInstructionsResponse, type PositionGetPositionsResponse as PositionGetPositionsResponse, type PositionSubmitPositionInstructionsResponse as PositionSubmitPositionInstructionsResponse, type PositionCancelPositionInstructionParams as PositionCancelPositionInstructionParams, type PositionClosePositionParams as PositionClosePositionParams, type PositionClosePositionsParams as PositionClosePositionsParams, type PositionGetPositionInstructionsParams as PositionGetPositionInstructionsParams, type PositionGetPositionsParams as PositionGetPositionsParams, type PositionSubmitPositionInstructionsParams as PositionSubmitPositionInstructionsParams, };
|
|
418
469
|
}
|
|
419
470
|
//# sourceMappingURL=positions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"positions.d.ts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE/C;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"positions.d.ts","sourceRoot":"","sources":["../../src/resources/v1/positions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,YAAY,uBAAoB;AAC5C,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;OAcG;IACH,yBAAyB,CACvB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uCAAuC,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAQxD;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,YAAY,EAAE,SAAS,CAAC,oBAAoB,EAC5C,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAQ5C;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;OAeG;IACH,uBAAuB,CACrB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qCAAqC,GAAG,IAAI,GAAG,SAAc,EACpE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uCAAuC,CAAC;IAItD;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,0BAA0B,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,wCAAwC,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0CAA0C,CAAC;CAO1D;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,YAAY,CAAC;IAEpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,YAAY,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAEvD;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEhD;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEjE;;;;;;;;GAQG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,yBAAyB,GACjC,MAAM,GACN,UAAU,GACV,UAAU,GACV,kBAAkB,GAClB,WAAW,GACX,eAAe,GACf,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAE3F,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,yCAA0C,SAAQ,MAAM,CAAC,YAAY;IACpF;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,uCAAwC,SAAQ,MAAM,CAAC,YAAY;IAClF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,WAAW,0CAA2C,SAAQ,MAAM,CAAC,YAAY;IACrF,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;IAE/C;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,oBAAoB,CAAC;CAC3D;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EACJ,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,cAAc,GACd,eAAe,GACf,gBAAgB,GAChB,sBAAsB,GACtB,oBAAoB,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,wCAAwC;IACvD,YAAY,EAAE,KAAK,CAAC,wCAAwC,CAAC,WAAW,CAAC,CAAC;CAC3E;AAED,yBAAiB,wCAAwC,CAAC;IACxD;;;;;OAKG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,uBAAuB,CAAC;QAEvD;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0CAA0C,IAAI,0CAA0C,EAC7F,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wCAAwC,IAAI,wCAAwC,GAC1F,CAAC;CACH"}
|
|
@@ -71,18 +71,35 @@ export declare class Screener extends APIResource {
|
|
|
71
71
|
*/
|
|
72
72
|
getScreeners(options?: RequestOptions): APIPromise<ScreenerGetScreenersResponse>;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* Partially update a saved screener configuration.
|
|
75
75
|
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
76
|
+
* Every field is optional. Omitting a field, or sending it as `null`, leaves the
|
|
77
|
+
* stored value unchanged. Sending a field's empty value clears it: `columns: []`
|
|
78
|
+
* clears the stored columns, `sorts: []` clears the stored sort, and `filters: []`
|
|
79
|
+
* clears the stored filters. `name: ""` is rejected -- a screener's name cannot be
|
|
80
|
+
* cleared. `shared: false` sets it to `false`; it is a value, not a clear.
|
|
81
|
+
*
|
|
82
|
+
* Unknown fields are rejected with a 422.
|
|
78
83
|
*
|
|
79
84
|
* @example
|
|
80
85
|
* ```ts
|
|
81
|
-
* const response = await client.v1.screener.
|
|
86
|
+
* const response = await client.v1.screener.patchScreener(
|
|
82
87
|
* '550e8400-e29b-41d4-a716-446655440000',
|
|
83
88
|
* );
|
|
84
89
|
* ```
|
|
85
90
|
*/
|
|
91
|
+
patchScreener(screenerID: string, body: ScreenerPatchScreenerParams, options?: RequestOptions): APIPromise<ScreenerPatchScreenerResponse>;
|
|
92
|
+
/**
|
|
93
|
+
* Update a saved screener configuration.
|
|
94
|
+
*
|
|
95
|
+
* Replaces the screener configuration for the authenticated user. If `name` is
|
|
96
|
+
* null, the existing name is preserved.
|
|
97
|
+
*
|
|
98
|
+
* Deprecated -- use `PATCH /saved-screeners/{screener_id}`; PUT replaces omitted
|
|
99
|
+
* `columns`, `filters` and `sorts` with empty values.
|
|
100
|
+
*
|
|
101
|
+
* @deprecated
|
|
102
|
+
*/
|
|
86
103
|
replaceScreener(screenerID: string, body: ScreenerReplaceScreenerParams, options?: RequestOptions): APIPromise<ScreenerReplaceScreenerResponse>;
|
|
87
104
|
/**
|
|
88
105
|
* Search instruments using structured filters.
|
|
@@ -101,8 +118,8 @@ export declare class Screener extends APIResource {
|
|
|
101
118
|
* `instrument_id` column is always prepended. Metadata carries `total_items`,
|
|
102
119
|
* `total_pages`, and `next_page_token` for paging.
|
|
103
120
|
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
121
|
+
* Screener results can shuffle between calls; reconcile by re-checking rows across
|
|
122
|
+
* pages rather than assuming stable ordering.
|
|
106
123
|
*
|
|
107
124
|
* @example
|
|
108
125
|
* ```ts
|
|
@@ -385,7 +402,7 @@ export interface ModifierDef {
|
|
|
385
402
|
*/
|
|
386
403
|
args: Array<ModifierArg>;
|
|
387
404
|
/**
|
|
388
|
-
* `"ADD"` or `"SUBTRACT"`.
|
|
405
|
+
* The modifier operation name: one of `"ADD"` or `"SUBTRACT"`.
|
|
389
406
|
*/
|
|
390
407
|
name: string;
|
|
391
408
|
}
|
|
@@ -590,6 +607,12 @@ export interface ScreenerGetScreenerCatalogResponse extends Shared.BaseResponse
|
|
|
590
607
|
export interface ScreenerGetScreenersResponse extends Shared.BaseResponse {
|
|
591
608
|
data: ScreenerEntryList;
|
|
592
609
|
}
|
|
610
|
+
export interface ScreenerPatchScreenerResponse extends Shared.BaseResponse {
|
|
611
|
+
/**
|
|
612
|
+
* A saved screener configuration entry
|
|
613
|
+
*/
|
|
614
|
+
data: ScreenerEntry;
|
|
615
|
+
}
|
|
593
616
|
export interface ScreenerReplaceScreenerResponse extends Shared.BaseResponse {
|
|
594
617
|
/**
|
|
595
618
|
* A saved screener configuration entry
|
|
@@ -622,6 +645,33 @@ export interface ScreenerCreateScreenerParams {
|
|
|
622
645
|
*/
|
|
623
646
|
sorts?: Array<SortSpec> | null;
|
|
624
647
|
}
|
|
648
|
+
export interface ScreenerPatchScreenerParams {
|
|
649
|
+
/**
|
|
650
|
+
* Structured field references to include when running this screener. Omit or send
|
|
651
|
+
* `null` to leave unchanged; `[]` clears the stored columns.
|
|
652
|
+
*/
|
|
653
|
+
columns?: Array<FieldRef> | null;
|
|
654
|
+
/**
|
|
655
|
+
* Structured search filter criteria. Omit or send `null` to leave unchanged; `[]`
|
|
656
|
+
* clears the stored filters.
|
|
657
|
+
*/
|
|
658
|
+
filters?: Array<SearchFilter> | null;
|
|
659
|
+
/**
|
|
660
|
+
* The name for this screener configuration. Omit or send `null` to leave
|
|
661
|
+
* unchanged. Cannot be set to an empty string.
|
|
662
|
+
*/
|
|
663
|
+
name?: string | null;
|
|
664
|
+
/**
|
|
665
|
+
* Whether any user may fetch this screener by id. Omit or send `null` to leave
|
|
666
|
+
* unchanged. `false` is a value, not a clear.
|
|
667
|
+
*/
|
|
668
|
+
shared?: boolean | null;
|
|
669
|
+
/**
|
|
670
|
+
* Multi-field sort specifications. Omit or send `null` to leave unchanged; `[]`
|
|
671
|
+
* clears the stored sort.
|
|
672
|
+
*/
|
|
673
|
+
sorts?: Array<SortSpec> | null;
|
|
674
|
+
}
|
|
625
675
|
export interface ScreenerReplaceScreenerParams {
|
|
626
676
|
/**
|
|
627
677
|
* Structured field references to include when running this screener
|
|
@@ -674,6 +724,6 @@ export interface ScreenerSearchScreenerParams {
|
|
|
674
724
|
sorts?: Array<SortSpec> | null;
|
|
675
725
|
}
|
|
676
726
|
export declare namespace Screener {
|
|
677
|
-
export { type Catalog as Catalog, type Combination as Combination, type Enums as Enums, type FieldColumns as FieldColumns, type FieldKind as FieldKind, type FieldLookback as FieldLookback, type FieldPeriod as FieldPeriod, type FieldRef as FieldRef, type FieldType as FieldType, type FilterOpSpec as FilterOpSpec, type FilterOperator as FilterOperator, type FilterValue as FilterValue, type Modifier as Modifier, type ModifierArg as ModifierArg, type ModifierDef as ModifierDef, type ModifierOp as ModifierOp, type OperatorArg as OperatorArg, type Rules as Rules, type ScreenerColumn as ScreenerColumn, type ScreenerEntry as ScreenerEntry, type ScreenerEntryList as ScreenerEntryList, type ScreenerFilter as ScreenerFilter, type ScreenerRow as ScreenerRow, type ScreenerRowList as ScreenerRowList, type SearchFilter as SearchFilter, type SortSpec as SortSpec, type Variable as Variable, type VariableDef as VariableDef, type ScreenerCreateScreenerResponse as ScreenerCreateScreenerResponse, type ScreenerGetScreenerByIDResponse as ScreenerGetScreenerByIDResponse, type ScreenerGetScreenerCatalogResponse as ScreenerGetScreenerCatalogResponse, type ScreenerGetScreenersResponse as ScreenerGetScreenersResponse, type ScreenerReplaceScreenerResponse as ScreenerReplaceScreenerResponse, type ScreenerSearchScreenerResponse as ScreenerSearchScreenerResponse, type ScreenerCreateScreenerParams as ScreenerCreateScreenerParams, type ScreenerReplaceScreenerParams as ScreenerReplaceScreenerParams, type ScreenerSearchScreenerParams as ScreenerSearchScreenerParams, };
|
|
727
|
+
export { type Catalog as Catalog, type Combination as Combination, type Enums as Enums, type FieldColumns as FieldColumns, type FieldKind as FieldKind, type FieldLookback as FieldLookback, type FieldPeriod as FieldPeriod, type FieldRef as FieldRef, type FieldType as FieldType, type FilterOpSpec as FilterOpSpec, type FilterOperator as FilterOperator, type FilterValue as FilterValue, type Modifier as Modifier, type ModifierArg as ModifierArg, type ModifierDef as ModifierDef, type ModifierOp as ModifierOp, type OperatorArg as OperatorArg, type Rules as Rules, type ScreenerColumn as ScreenerColumn, type ScreenerEntry as ScreenerEntry, type ScreenerEntryList as ScreenerEntryList, type ScreenerFilter as ScreenerFilter, type ScreenerRow as ScreenerRow, type ScreenerRowList as ScreenerRowList, type SearchFilter as SearchFilter, type SortSpec as SortSpec, type Variable as Variable, type VariableDef as VariableDef, type ScreenerCreateScreenerResponse as ScreenerCreateScreenerResponse, type ScreenerGetScreenerByIDResponse as ScreenerGetScreenerByIDResponse, type ScreenerGetScreenerCatalogResponse as ScreenerGetScreenerCatalogResponse, type ScreenerGetScreenersResponse as ScreenerGetScreenersResponse, type ScreenerPatchScreenerResponse as ScreenerPatchScreenerResponse, type ScreenerReplaceScreenerResponse as ScreenerReplaceScreenerResponse, type ScreenerSearchScreenerResponse as ScreenerSearchScreenerResponse, type ScreenerCreateScreenerParams as ScreenerCreateScreenerParams, type ScreenerPatchScreenerParams as ScreenerPatchScreenerParams, type ScreenerReplaceScreenerParams as ScreenerReplaceScreenerParams, type ScreenerSearchScreenerParams as ScreenerSearchScreenerParams, };
|
|
678
728
|
}
|
|
679
729
|
//# sourceMappingURL=screener.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"screener.d.mts","sourceRoot":"","sources":["../../src/resources/v1/screener.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9E;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI1G;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;IAI5F;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIhF
|
|
1
|
+
{"version":3,"file":"screener.d.mts","sourceRoot":"","sources":["../../src/resources/v1/screener.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,KAAK,iBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9E;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI1G;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;IAI5F;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIhF;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;OAUG;IACH,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,uBAAuB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAE9B;;OAEG;IACH,uBAAuB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAE1D;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEjC;;;;OAIG;IACH,mBAAmB,EAAE,WAAW,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,UAAU,GACV,WAAW,GACX,cAAc,GACd,YAAY,GACZ,cAAc,GACd,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,wBAAwB,GAAG,QAAQ,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,gBAAgB,GAAG,MAAM,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GACtB,WAAW,GACX,eAAe,GACf,cAAc,GACd,kBAAkB,GAClB,OAAO,GACP,SAAS,GACT,aAAa,GACb,QAAQ,GACR,OAAO,GACP,aAAa,GACb,WAAW,GACX,UAAU,GACV,SAAS,GACT,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,UAAU,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,GACjB,kBAAkB,CAAC;AAEvB;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;;;;OAKG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7B,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEhD,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAEjD;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,EAAE,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,kCAAmC,SAAQ,MAAM,CAAC,YAAY;IAC7E;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,iBAAiB,CAAC;CACzB;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -71,18 +71,35 @@ export declare class Screener extends APIResource {
|
|
|
71
71
|
*/
|
|
72
72
|
getScreeners(options?: RequestOptions): APIPromise<ScreenerGetScreenersResponse>;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* Partially update a saved screener configuration.
|
|
75
75
|
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
76
|
+
* Every field is optional. Omitting a field, or sending it as `null`, leaves the
|
|
77
|
+
* stored value unchanged. Sending a field's empty value clears it: `columns: []`
|
|
78
|
+
* clears the stored columns, `sorts: []` clears the stored sort, and `filters: []`
|
|
79
|
+
* clears the stored filters. `name: ""` is rejected -- a screener's name cannot be
|
|
80
|
+
* cleared. `shared: false` sets it to `false`; it is a value, not a clear.
|
|
81
|
+
*
|
|
82
|
+
* Unknown fields are rejected with a 422.
|
|
78
83
|
*
|
|
79
84
|
* @example
|
|
80
85
|
* ```ts
|
|
81
|
-
* const response = await client.v1.screener.
|
|
86
|
+
* const response = await client.v1.screener.patchScreener(
|
|
82
87
|
* '550e8400-e29b-41d4-a716-446655440000',
|
|
83
88
|
* );
|
|
84
89
|
* ```
|
|
85
90
|
*/
|
|
91
|
+
patchScreener(screenerID: string, body: ScreenerPatchScreenerParams, options?: RequestOptions): APIPromise<ScreenerPatchScreenerResponse>;
|
|
92
|
+
/**
|
|
93
|
+
* Update a saved screener configuration.
|
|
94
|
+
*
|
|
95
|
+
* Replaces the screener configuration for the authenticated user. If `name` is
|
|
96
|
+
* null, the existing name is preserved.
|
|
97
|
+
*
|
|
98
|
+
* Deprecated -- use `PATCH /saved-screeners/{screener_id}`; PUT replaces omitted
|
|
99
|
+
* `columns`, `filters` and `sorts` with empty values.
|
|
100
|
+
*
|
|
101
|
+
* @deprecated
|
|
102
|
+
*/
|
|
86
103
|
replaceScreener(screenerID: string, body: ScreenerReplaceScreenerParams, options?: RequestOptions): APIPromise<ScreenerReplaceScreenerResponse>;
|
|
87
104
|
/**
|
|
88
105
|
* Search instruments using structured filters.
|
|
@@ -101,8 +118,8 @@ export declare class Screener extends APIResource {
|
|
|
101
118
|
* `instrument_id` column is always prepended. Metadata carries `total_items`,
|
|
102
119
|
* `total_pages`, and `next_page_token` for paging.
|
|
103
120
|
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
121
|
+
* Screener results can shuffle between calls; reconcile by re-checking rows across
|
|
122
|
+
* pages rather than assuming stable ordering.
|
|
106
123
|
*
|
|
107
124
|
* @example
|
|
108
125
|
* ```ts
|
|
@@ -385,7 +402,7 @@ export interface ModifierDef {
|
|
|
385
402
|
*/
|
|
386
403
|
args: Array<ModifierArg>;
|
|
387
404
|
/**
|
|
388
|
-
* `"ADD"` or `"SUBTRACT"`.
|
|
405
|
+
* The modifier operation name: one of `"ADD"` or `"SUBTRACT"`.
|
|
389
406
|
*/
|
|
390
407
|
name: string;
|
|
391
408
|
}
|
|
@@ -590,6 +607,12 @@ export interface ScreenerGetScreenerCatalogResponse extends Shared.BaseResponse
|
|
|
590
607
|
export interface ScreenerGetScreenersResponse extends Shared.BaseResponse {
|
|
591
608
|
data: ScreenerEntryList;
|
|
592
609
|
}
|
|
610
|
+
export interface ScreenerPatchScreenerResponse extends Shared.BaseResponse {
|
|
611
|
+
/**
|
|
612
|
+
* A saved screener configuration entry
|
|
613
|
+
*/
|
|
614
|
+
data: ScreenerEntry;
|
|
615
|
+
}
|
|
593
616
|
export interface ScreenerReplaceScreenerResponse extends Shared.BaseResponse {
|
|
594
617
|
/**
|
|
595
618
|
* A saved screener configuration entry
|
|
@@ -622,6 +645,33 @@ export interface ScreenerCreateScreenerParams {
|
|
|
622
645
|
*/
|
|
623
646
|
sorts?: Array<SortSpec> | null;
|
|
624
647
|
}
|
|
648
|
+
export interface ScreenerPatchScreenerParams {
|
|
649
|
+
/**
|
|
650
|
+
* Structured field references to include when running this screener. Omit or send
|
|
651
|
+
* `null` to leave unchanged; `[]` clears the stored columns.
|
|
652
|
+
*/
|
|
653
|
+
columns?: Array<FieldRef> | null;
|
|
654
|
+
/**
|
|
655
|
+
* Structured search filter criteria. Omit or send `null` to leave unchanged; `[]`
|
|
656
|
+
* clears the stored filters.
|
|
657
|
+
*/
|
|
658
|
+
filters?: Array<SearchFilter> | null;
|
|
659
|
+
/**
|
|
660
|
+
* The name for this screener configuration. Omit or send `null` to leave
|
|
661
|
+
* unchanged. Cannot be set to an empty string.
|
|
662
|
+
*/
|
|
663
|
+
name?: string | null;
|
|
664
|
+
/**
|
|
665
|
+
* Whether any user may fetch this screener by id. Omit or send `null` to leave
|
|
666
|
+
* unchanged. `false` is a value, not a clear.
|
|
667
|
+
*/
|
|
668
|
+
shared?: boolean | null;
|
|
669
|
+
/**
|
|
670
|
+
* Multi-field sort specifications. Omit or send `null` to leave unchanged; `[]`
|
|
671
|
+
* clears the stored sort.
|
|
672
|
+
*/
|
|
673
|
+
sorts?: Array<SortSpec> | null;
|
|
674
|
+
}
|
|
625
675
|
export interface ScreenerReplaceScreenerParams {
|
|
626
676
|
/**
|
|
627
677
|
* Structured field references to include when running this screener
|
|
@@ -674,6 +724,6 @@ export interface ScreenerSearchScreenerParams {
|
|
|
674
724
|
sorts?: Array<SortSpec> | null;
|
|
675
725
|
}
|
|
676
726
|
export declare namespace Screener {
|
|
677
|
-
export { type Catalog as Catalog, type Combination as Combination, type Enums as Enums, type FieldColumns as FieldColumns, type FieldKind as FieldKind, type FieldLookback as FieldLookback, type FieldPeriod as FieldPeriod, type FieldRef as FieldRef, type FieldType as FieldType, type FilterOpSpec as FilterOpSpec, type FilterOperator as FilterOperator, type FilterValue as FilterValue, type Modifier as Modifier, type ModifierArg as ModifierArg, type ModifierDef as ModifierDef, type ModifierOp as ModifierOp, type OperatorArg as OperatorArg, type Rules as Rules, type ScreenerColumn as ScreenerColumn, type ScreenerEntry as ScreenerEntry, type ScreenerEntryList as ScreenerEntryList, type ScreenerFilter as ScreenerFilter, type ScreenerRow as ScreenerRow, type ScreenerRowList as ScreenerRowList, type SearchFilter as SearchFilter, type SortSpec as SortSpec, type Variable as Variable, type VariableDef as VariableDef, type ScreenerCreateScreenerResponse as ScreenerCreateScreenerResponse, type ScreenerGetScreenerByIDResponse as ScreenerGetScreenerByIDResponse, type ScreenerGetScreenerCatalogResponse as ScreenerGetScreenerCatalogResponse, type ScreenerGetScreenersResponse as ScreenerGetScreenersResponse, type ScreenerReplaceScreenerResponse as ScreenerReplaceScreenerResponse, type ScreenerSearchScreenerResponse as ScreenerSearchScreenerResponse, type ScreenerCreateScreenerParams as ScreenerCreateScreenerParams, type ScreenerReplaceScreenerParams as ScreenerReplaceScreenerParams, type ScreenerSearchScreenerParams as ScreenerSearchScreenerParams, };
|
|
727
|
+
export { type Catalog as Catalog, type Combination as Combination, type Enums as Enums, type FieldColumns as FieldColumns, type FieldKind as FieldKind, type FieldLookback as FieldLookback, type FieldPeriod as FieldPeriod, type FieldRef as FieldRef, type FieldType as FieldType, type FilterOpSpec as FilterOpSpec, type FilterOperator as FilterOperator, type FilterValue as FilterValue, type Modifier as Modifier, type ModifierArg as ModifierArg, type ModifierDef as ModifierDef, type ModifierOp as ModifierOp, type OperatorArg as OperatorArg, type Rules as Rules, type ScreenerColumn as ScreenerColumn, type ScreenerEntry as ScreenerEntry, type ScreenerEntryList as ScreenerEntryList, type ScreenerFilter as ScreenerFilter, type ScreenerRow as ScreenerRow, type ScreenerRowList as ScreenerRowList, type SearchFilter as SearchFilter, type SortSpec as SortSpec, type Variable as Variable, type VariableDef as VariableDef, type ScreenerCreateScreenerResponse as ScreenerCreateScreenerResponse, type ScreenerGetScreenerByIDResponse as ScreenerGetScreenerByIDResponse, type ScreenerGetScreenerCatalogResponse as ScreenerGetScreenerCatalogResponse, type ScreenerGetScreenersResponse as ScreenerGetScreenersResponse, type ScreenerPatchScreenerResponse as ScreenerPatchScreenerResponse, type ScreenerReplaceScreenerResponse as ScreenerReplaceScreenerResponse, type ScreenerSearchScreenerResponse as ScreenerSearchScreenerResponse, type ScreenerCreateScreenerParams as ScreenerCreateScreenerParams, type ScreenerPatchScreenerParams as ScreenerPatchScreenerParams, type ScreenerReplaceScreenerParams as ScreenerReplaceScreenerParams, type ScreenerSearchScreenerParams as ScreenerSearchScreenerParams, };
|
|
678
728
|
}
|
|
679
729
|
//# sourceMappingURL=screener.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"screener.d.ts","sourceRoot":"","sources":["../../src/resources/v1/screener.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9E;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI1G;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;IAI5F;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIhF
|
|
1
|
+
{"version":3,"file":"screener.d.ts","sourceRoot":"","sources":["../../src/resources/v1/screener.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,KAAK,gBAAa;AAC9B,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9E;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI1G;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;IAI5F;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIhF;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;OAUG;IACH,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,uBAAuB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAE9B;;OAEG;IACH,uBAAuB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC;IAE1D;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEjC;;;;OAIG;IACH,mBAAmB,EAAE,WAAW,CAAC;IAEjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,UAAU,GACV,WAAW,GACX,cAAc,GACd,YAAY,GACZ,cAAc,GACd,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,wBAAwB,GAAG,QAAQ,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,gBAAgB,GAAG,MAAM,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GACtB,WAAW,GACX,eAAe,GACf,cAAc,GACd,kBAAkB,GAClB,OAAO,GACP,SAAS,GACT,aAAa,GACb,QAAQ,GACR,OAAO,GACP,aAAa,GACb,WAAW,GACX,UAAU,GACV,SAAS,GACT,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,UAAU,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,GACjB,kBAAkB,CAAC;AAEvB;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;;;;OAKG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE7B,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;AAEhD,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;AAEjD;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IAEf;;;OAGG;IACH,EAAE,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,kCAAmC,SAAQ,MAAM,CAAC,YAAY;IAC7E;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,4BAA6B,SAAQ,MAAM,CAAC,YAAY;IACvE,IAAI,EAAE,iBAAiB,CAAC;CACzB;AAED,MAAM,WAAW,6BAA8B,SAAQ,MAAM,CAAC,YAAY;IACxE;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,+BAAgC,SAAQ,MAAM,CAAC,YAAY;IAC1E;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;CACrB;AAED,MAAM,WAAW,8BAA+B,SAAQ,MAAM,CAAC,YAAY;IACzE,IAAI,EAAE,eAAe,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
package/resources/v1/screener.js
CHANGED
|
@@ -86,18 +86,37 @@ class Screener extends resource_1.APIResource {
|
|
|
86
86
|
return this._client.get('/v1/saved-screeners', options);
|
|
87
87
|
}
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* Partially update a saved screener configuration.
|
|
90
90
|
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
91
|
+
* Every field is optional. Omitting a field, or sending it as `null`, leaves the
|
|
92
|
+
* stored value unchanged. Sending a field's empty value clears it: `columns: []`
|
|
93
|
+
* clears the stored columns, `sorts: []` clears the stored sort, and `filters: []`
|
|
94
|
+
* clears the stored filters. `name: ""` is rejected -- a screener's name cannot be
|
|
95
|
+
* cleared. `shared: false` sets it to `false`; it is a value, not a clear.
|
|
96
|
+
*
|
|
97
|
+
* Unknown fields are rejected with a 422.
|
|
93
98
|
*
|
|
94
99
|
* @example
|
|
95
100
|
* ```ts
|
|
96
|
-
* const response = await client.v1.screener.
|
|
101
|
+
* const response = await client.v1.screener.patchScreener(
|
|
97
102
|
* '550e8400-e29b-41d4-a716-446655440000',
|
|
98
103
|
* );
|
|
99
104
|
* ```
|
|
100
105
|
*/
|
|
106
|
+
patchScreener(screenerID, body, options) {
|
|
107
|
+
return this._client.patch((0, path_1.path) `/v1/saved-screeners/${screenerID}`, { body, ...options });
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Update a saved screener configuration.
|
|
111
|
+
*
|
|
112
|
+
* Replaces the screener configuration for the authenticated user. If `name` is
|
|
113
|
+
* null, the existing name is preserved.
|
|
114
|
+
*
|
|
115
|
+
* Deprecated -- use `PATCH /saved-screeners/{screener_id}`; PUT replaces omitted
|
|
116
|
+
* `columns`, `filters` and `sorts` with empty values.
|
|
117
|
+
*
|
|
118
|
+
* @deprecated
|
|
119
|
+
*/
|
|
101
120
|
replaceScreener(screenerID, body, options) {
|
|
102
121
|
return this._client.put((0, path_1.path) `/v1/saved-screeners/${screenerID}`, { body, ...options });
|
|
103
122
|
}
|
|
@@ -118,8 +137,8 @@ class Screener extends resource_1.APIResource {
|
|
|
118
137
|
* `instrument_id` column is always prepended. Metadata carries `total_items`,
|
|
119
138
|
* `total_pages`, and `next_page_token` for paging.
|
|
120
139
|
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
140
|
+
* Screener results can shuffle between calls; reconcile by re-checking rows across
|
|
141
|
+
* pages rather than assuming stable ordering.
|
|
123
142
|
*
|
|
124
143
|
* @example
|
|
125
144
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"screener.js","sourceRoot":"","sources":["../../src/resources/v1/screener.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,UAAkB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,uBAAuB,UAAU,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,UAAkB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"screener.js","sourceRoot":"","sources":["../../src/resources/v1/screener.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,UAAkB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,uBAAuB,UAAU,EAAE,EAAE;YAClE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,UAAkB,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,UAAkB,EAClB,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CACb,UAAkB,EAClB,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,UAAU,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAjKD,4BAiKC"}
|