@invinite-org/data-api-client 6.2.0 → 6.3.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.
Files changed (192) hide show
  1. package/.openapi-generator/FILES +52 -0
  2. package/dist/apis/ScriptsApi.d.ts +148 -0
  3. package/dist/apis/ScriptsApi.js +396 -0
  4. package/dist/apis/index.d.ts +1 -0
  5. package/dist/apis/index.js +1 -0
  6. package/dist/esm/apis/ScriptsApi.d.ts +148 -0
  7. package/dist/esm/apis/ScriptsApi.js +392 -0
  8. package/dist/esm/apis/index.d.ts +1 -0
  9. package/dist/esm/apis/index.js +1 -0
  10. package/dist/esm/models/Alert.d.ts +6 -0
  11. package/dist/esm/models/Alert.js +4 -0
  12. package/dist/esm/models/AlertCondition.d.ts +61 -5
  13. package/dist/esm/models/AlertCondition.js +27 -1
  14. package/dist/esm/models/AlertConditionInput.d.ts +54 -5
  15. package/dist/esm/models/AlertConditionInput.js +24 -1
  16. package/dist/esm/models/AlertTemplate.d.ts +83 -0
  17. package/dist/esm/models/AlertTemplate.js +79 -0
  18. package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
  19. package/dist/esm/models/AlertTemplateInput.js +70 -0
  20. package/dist/esm/models/AlertTrigger.d.ts +1 -1
  21. package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
  22. package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
  23. package/dist/esm/models/CreateScriptRequest.js +49 -0
  24. package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
  25. package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
  26. package/dist/esm/models/IndicatorCondition.d.ts +56 -0
  27. package/dist/esm/models/IndicatorCondition.js +62 -0
  28. package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
  29. package/dist/esm/models/IndicatorConditionInput.js +62 -0
  30. package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
  31. package/dist/esm/models/IndicatorFilterChild.js +65 -0
  32. package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
  33. package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
  34. package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
  35. package/dist/esm/models/IndicatorFilterCondition.js +74 -0
  36. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
  37. package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
  38. package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
  39. package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
  40. package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
  41. package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
  42. package/dist/esm/models/IndicatorFilters.d.ts +47 -0
  43. package/dist/esm/models/IndicatorFilters.js +55 -0
  44. package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
  45. package/dist/esm/models/IndicatorFiltersInput.js +55 -0
  46. package/dist/esm/models/IndicatorOperand.d.ts +91 -0
  47. package/dist/esm/models/IndicatorOperand.js +74 -0
  48. package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
  49. package/dist/esm/models/IndicatorOperandInput.js +74 -0
  50. package/dist/esm/models/IndicatorResolved.d.ts +67 -0
  51. package/dist/esm/models/IndicatorResolved.js +65 -0
  52. package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
  53. package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
  54. package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
  55. package/dist/esm/models/IndicatorTemplateRef.js +47 -0
  56. package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
  57. package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
  58. package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
  59. package/dist/esm/models/ListScriptVersions200Response.js +57 -0
  60. package/dist/esm/models/ListScripts200Response.d.ts +52 -0
  61. package/dist/esm/models/ListScripts200Response.js +57 -0
  62. package/dist/esm/models/Script.d.ts +69 -0
  63. package/dist/esm/models/Script.js +68 -0
  64. package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
  65. package/dist/esm/models/ScriptDiagnostic.js +66 -0
  66. package/dist/esm/models/ScriptVersion.d.ts +103 -0
  67. package/dist/esm/models/ScriptVersion.js +91 -0
  68. package/dist/esm/models/index.d.ts +25 -0
  69. package/dist/esm/models/index.js +25 -0
  70. package/dist/models/Alert.d.ts +6 -0
  71. package/dist/models/Alert.js +4 -0
  72. package/dist/models/AlertCondition.d.ts +61 -5
  73. package/dist/models/AlertCondition.js +27 -1
  74. package/dist/models/AlertConditionInput.d.ts +54 -5
  75. package/dist/models/AlertConditionInput.js +24 -1
  76. package/dist/models/AlertTemplate.d.ts +83 -0
  77. package/dist/models/AlertTemplate.js +87 -0
  78. package/dist/models/AlertTemplateInput.d.ts +78 -0
  79. package/dist/models/AlertTemplateInput.js +78 -0
  80. package/dist/models/AlertTrigger.d.ts +1 -1
  81. package/dist/models/AlertTriggerInput.d.ts +1 -1
  82. package/dist/models/CreateScriptRequest.d.ts +44 -0
  83. package/dist/models/CreateScriptRequest.js +56 -0
  84. package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
  85. package/dist/models/CreateScriptVersionRequest.js +50 -0
  86. package/dist/models/IndicatorCondition.d.ts +56 -0
  87. package/dist/models/IndicatorCondition.js +70 -0
  88. package/dist/models/IndicatorConditionInput.d.ts +56 -0
  89. package/dist/models/IndicatorConditionInput.js +70 -0
  90. package/dist/models/IndicatorFilterChild.d.ts +68 -0
  91. package/dist/models/IndicatorFilterChild.js +73 -0
  92. package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
  93. package/dist/models/IndicatorFilterChildInput.js +73 -0
  94. package/dist/models/IndicatorFilterCondition.d.ts +73 -0
  95. package/dist/models/IndicatorFilterCondition.js +82 -0
  96. package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
  97. package/dist/models/IndicatorFilterConditionInput.js +82 -0
  98. package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
  99. package/dist/models/IndicatorFilterLeaf.js +62 -0
  100. package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
  101. package/dist/models/IndicatorFilterLeafInput.js +64 -0
  102. package/dist/models/IndicatorFilters.d.ts +47 -0
  103. package/dist/models/IndicatorFilters.js +63 -0
  104. package/dist/models/IndicatorFiltersInput.d.ts +47 -0
  105. package/dist/models/IndicatorFiltersInput.js +63 -0
  106. package/dist/models/IndicatorOperand.d.ts +91 -0
  107. package/dist/models/IndicatorOperand.js +82 -0
  108. package/dist/models/IndicatorOperandInput.d.ts +91 -0
  109. package/dist/models/IndicatorOperandInput.js +82 -0
  110. package/dist/models/IndicatorResolved.d.ts +67 -0
  111. package/dist/models/IndicatorResolved.js +73 -0
  112. package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
  113. package/dist/models/IndicatorResolvedThreshold.js +63 -0
  114. package/dist/models/IndicatorTemplateRef.d.ts +46 -0
  115. package/dist/models/IndicatorTemplateRef.js +54 -0
  116. package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
  117. package/dist/models/ListAlertTemplates200Response.js +64 -0
  118. package/dist/models/ListScriptVersions200Response.d.ts +52 -0
  119. package/dist/models/ListScriptVersions200Response.js +64 -0
  120. package/dist/models/ListScripts200Response.d.ts +52 -0
  121. package/dist/models/ListScripts200Response.js +64 -0
  122. package/dist/models/Script.d.ts +69 -0
  123. package/dist/models/Script.js +75 -0
  124. package/dist/models/ScriptDiagnostic.d.ts +64 -0
  125. package/dist/models/ScriptDiagnostic.js +74 -0
  126. package/dist/models/ScriptVersion.d.ts +103 -0
  127. package/dist/models/ScriptVersion.js +99 -0
  128. package/dist/models/index.d.ts +25 -0
  129. package/dist/models/index.js +25 -0
  130. package/docs/Alert.md +2 -0
  131. package/docs/AlertCondition.md +15 -1
  132. package/docs/AlertConditionInput.md +13 -1
  133. package/docs/AlertTemplate.md +49 -0
  134. package/docs/AlertTemplateInput.md +47 -0
  135. package/docs/CreateScriptRequest.md +38 -0
  136. package/docs/CreateScriptVersionRequest.md +34 -0
  137. package/docs/IndicatorCondition.md +39 -0
  138. package/docs/IndicatorConditionInput.md +39 -0
  139. package/docs/IndicatorFilterChild.md +41 -0
  140. package/docs/IndicatorFilterChildInput.md +41 -0
  141. package/docs/IndicatorFilterCondition.md +41 -0
  142. package/docs/IndicatorFilterConditionInput.md +41 -0
  143. package/docs/IndicatorFilterLeaf.md +37 -0
  144. package/docs/IndicatorFilterLeafInput.md +37 -0
  145. package/docs/IndicatorFilters.md +37 -0
  146. package/docs/IndicatorFiltersInput.md +37 -0
  147. package/docs/IndicatorOperand.md +47 -0
  148. package/docs/IndicatorOperandInput.md +47 -0
  149. package/docs/IndicatorResolved.md +43 -0
  150. package/docs/IndicatorResolvedThreshold.md +37 -0
  151. package/docs/IndicatorTemplateRef.md +39 -0
  152. package/docs/ListAlertTemplates200Response.md +41 -0
  153. package/docs/ListScriptVersions200Response.md +41 -0
  154. package/docs/ListScripts200Response.md +41 -0
  155. package/docs/Script.md +46 -0
  156. package/docs/ScriptDiagnostic.md +42 -0
  157. package/docs/ScriptVersion.md +54 -0
  158. package/docs/ScriptsApi.md +588 -0
  159. package/package.json +1 -1
  160. package/src/apis/ScriptsApi.ts +504 -0
  161. package/src/apis/index.ts +1 -0
  162. package/src/models/Alert.ts +9 -0
  163. package/src/models/AlertCondition.ts +98 -6
  164. package/src/models/AlertConditionInput.ts +83 -6
  165. package/src/models/AlertTemplate.ts +148 -0
  166. package/src/models/AlertTemplateInput.ts +130 -0
  167. package/src/models/AlertTrigger.ts +1 -1
  168. package/src/models/AlertTriggerInput.ts +1 -1
  169. package/src/models/CreateScriptRequest.ts +83 -0
  170. package/src/models/CreateScriptVersionRequest.ts +66 -0
  171. package/src/models/IndicatorCondition.ts +106 -0
  172. package/src/models/IndicatorConditionInput.ts +106 -0
  173. package/src/models/IndicatorFilterChild.ts +125 -0
  174. package/src/models/IndicatorFilterChildInput.ts +125 -0
  175. package/src/models/IndicatorFilterCondition.ts +126 -0
  176. package/src/models/IndicatorFilterConditionInput.ts +126 -0
  177. package/src/models/IndicatorFilterLeaf.ts +93 -0
  178. package/src/models/IndicatorFilterLeafInput.ts +95 -0
  179. package/src/models/IndicatorFilters.ts +94 -0
  180. package/src/models/IndicatorFiltersInput.ts +94 -0
  181. package/src/models/IndicatorOperand.ts +139 -0
  182. package/src/models/IndicatorOperandInput.ts +139 -0
  183. package/src/models/IndicatorResolved.ts +120 -0
  184. package/src/models/IndicatorResolvedThreshold.ts +87 -0
  185. package/src/models/IndicatorTemplateRef.ts +82 -0
  186. package/src/models/ListAlertTemplates200Response.ts +108 -0
  187. package/src/models/ListScriptVersions200Response.ts +108 -0
  188. package/src/models/ListScripts200Response.ts +108 -0
  189. package/src/models/Script.ts +128 -0
  190. package/src/models/ScriptDiagnostic.ts +113 -0
  191. package/src/models/ScriptVersion.ts +175 -0
  192. package/src/models/index.ts +25 -0
@@ -1,7 +1,7 @@
1
1
 
2
2
  # AlertCondition
3
3
 
4
- What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
4
+ What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
5
5
 
6
6
  ## Properties
7
7
 
@@ -58,6 +58,13 @@ Name | Type
58
58
  `at` | Date
59
59
  `weekday` | number
60
60
  `days` | Array<number>
61
+ `script_version_id` | string
62
+ `inputs` | { [key: string]: any; }
63
+ `alert_ids` | Array<string>
64
+ `template` | [IndicatorTemplateRef](IndicatorTemplateRef.md)
65
+ `condition` | [IndicatorCondition](IndicatorCondition.md)
66
+ `filters` | [IndicatorFilters](IndicatorFilters.md)
67
+ `resolved` | [IndicatorResolved](IndicatorResolved.md)
61
68
 
62
69
  ## Example
63
70
 
@@ -117,6 +124,13 @@ const example = {
117
124
  "at": null,
118
125
  "weekday": null,
119
126
  "days": null,
127
+ "script_version_id": null,
128
+ "inputs": null,
129
+ "alert_ids": null,
130
+ "template": null,
131
+ "condition": null,
132
+ "filters": null,
133
+ "resolved": null,
120
134
  } satisfies AlertCondition
121
135
 
122
136
  console.log(example)
@@ -1,7 +1,7 @@
1
1
 
2
2
  # AlertConditionInput
3
3
 
4
- What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
4
+ What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
5
5
 
6
6
  ## Properties
7
7
 
@@ -58,6 +58,12 @@ Name | Type
58
58
  `at` | string
59
59
  `weekday` | number
60
60
  `days` | Array<number>
61
+ `script_version_id` | string
62
+ `inputs` | { [key: string]: any; }
63
+ `alert_ids` | Array<string>
64
+ `template` | [IndicatorTemplateRef](IndicatorTemplateRef.md)
65
+ `condition` | [IndicatorConditionInput](IndicatorConditionInput.md)
66
+ `filters` | [IndicatorFiltersInput](IndicatorFiltersInput.md)
61
67
 
62
68
  ## Example
63
69
 
@@ -117,6 +123,12 @@ const example = {
117
123
  "at": null,
118
124
  "weekday": null,
119
125
  "days": null,
126
+ "script_version_id": null,
127
+ "inputs": null,
128
+ "alert_ids": null,
129
+ "template": null,
130
+ "condition": null,
131
+ "filters": null,
120
132
  } satisfies AlertConditionInput
121
133
 
122
134
  console.log(example)
@@ -0,0 +1,49 @@
1
+
2
+ # AlertTemplate
3
+
4
+ A built-in template of the `indicator` alert type.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `key` | string
11
+ `version` | number
12
+ `source_key` | string
13
+ `title` | string
14
+ `description` | string
15
+ `fidelity` | string
16
+ `inputs` | [Array<AlertTemplateInput>](AlertTemplateInput.md)
17
+ `source` | string
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import type { AlertTemplate } from '@invinite-org/data-api-client'
23
+
24
+ // TODO: Update the object below with actual values
25
+ const example = {
26
+ "key": null,
27
+ "version": null,
28
+ "source_key": null,
29
+ "title": null,
30
+ "description": null,
31
+ "fidelity": null,
32
+ "inputs": null,
33
+ "source": null,
34
+ } satisfies AlertTemplate
35
+
36
+ console.log(example)
37
+
38
+ // Convert the instance to a JSON string
39
+ const exampleJSON: string = JSON.stringify(example)
40
+ console.log(exampleJSON)
41
+
42
+ // Parse the JSON string back to an object
43
+ const exampleParsed = JSON.parse(exampleJSON) as AlertTemplate
44
+ console.log(exampleParsed)
45
+ ```
46
+
47
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
48
+
49
+
@@ -0,0 +1,47 @@
1
+
2
+ # AlertTemplateInput
3
+
4
+ One input of a template.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `name` | string
11
+ `kind` | string
12
+ `title` | string
13
+ `_default` | any
14
+ `min` | number
15
+ `max` | number
16
+ `options` | Array<string>
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import type { AlertTemplateInput } from '@invinite-org/data-api-client'
22
+
23
+ // TODO: Update the object below with actual values
24
+ const example = {
25
+ "name": null,
26
+ "kind": null,
27
+ "title": null,
28
+ "_default": null,
29
+ "min": null,
30
+ "max": null,
31
+ "options": null,
32
+ } satisfies AlertTemplateInput
33
+
34
+ console.log(example)
35
+
36
+ // Convert the instance to a JSON string
37
+ const exampleJSON: string = JSON.stringify(example)
38
+ console.log(exampleJSON)
39
+
40
+ // Parse the JSON string back to an object
41
+ const exampleParsed = JSON.parse(exampleJSON) as AlertTemplateInput
42
+ console.log(exampleParsed)
43
+ ```
44
+
45
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
46
+
47
+
@@ -0,0 +1,38 @@
1
+
2
+ # CreateScriptRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `description` | string
11
+ `source` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { CreateScriptRequest } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "name": null,
21
+ "description": null,
22
+ "source": null,
23
+ } satisfies CreateScriptRequest
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as CreateScriptRequest
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
@@ -0,0 +1,34 @@
1
+
2
+ # CreateScriptVersionRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `source` | string
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { CreateScriptVersionRequest } from '@invinite-org/data-api-client'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "source": null,
19
+ } satisfies CreateScriptVersionRequest
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as CreateScriptVersionRequest
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,39 @@
1
+
2
+ # IndicatorCondition
3
+
4
+ A structured trigger `lhs <comparator> rhs`, evaluated at each bar close. The crossings take any right side but a zone; `entering` / `exiting` only a rectangle zone (`indicator_id: rectangle`, `series_key: band`).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `lhs` | [IndicatorOperand](IndicatorOperand.md)
11
+ `comparator` | string
12
+ `rhs` | [IndicatorOperand](IndicatorOperand.md)
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { IndicatorCondition } from '@invinite-org/data-api-client'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "lhs": null,
22
+ "comparator": null,
23
+ "rhs": null,
24
+ } satisfies IndicatorCondition
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorCondition
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -0,0 +1,39 @@
1
+
2
+ # IndicatorConditionInput
3
+
4
+ A structured trigger `lhs <comparator> rhs`, evaluated at each bar close. The crossings take any right side but a zone; `entering` / `exiting` only a rectangle zone (`indicator_id: rectangle`, `series_key: band`). (request form)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `lhs` | [IndicatorOperandInput](IndicatorOperandInput.md)
11
+ `comparator` | string
12
+ `rhs` | [IndicatorOperandInput](IndicatorOperandInput.md)
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { IndicatorConditionInput } from '@invinite-org/data-api-client'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "lhs": null,
22
+ "comparator": null,
23
+ "rhs": null,
24
+ } satisfies IndicatorConditionInput
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorConditionInput
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -0,0 +1,41 @@
1
+
2
+ # IndicatorFilterChild
3
+
4
+ A filter leaf (`kind: condition` + `condition`) or one nested group (`kind: group` + `op` + `children` of leaves).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `kind` | string
11
+ `condition` | [IndicatorFilterCondition](IndicatorFilterCondition.md)
12
+ `op` | string
13
+ `children` | [Array&lt;IndicatorFilterLeaf&gt;](IndicatorFilterLeaf.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { IndicatorFilterChild } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "kind": null,
23
+ "condition": null,
24
+ "op": null,
25
+ "children": null,
26
+ } satisfies IndicatorFilterChild
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorFilterChild
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # IndicatorFilterChildInput
3
+
4
+ A filter leaf (`kind: condition` + `condition`) or one nested group (`kind: group` + `op` + `children` of leaves). (request form)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `kind` | string
11
+ `condition` | [IndicatorFilterConditionInput](IndicatorFilterConditionInput.md)
12
+ `op` | string
13
+ `children` | [Array&lt;IndicatorFilterLeafInput&gt;](IndicatorFilterLeafInput.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { IndicatorFilterChildInput } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "kind": null,
23
+ "condition": null,
24
+ "op": null,
25
+ "children": null,
26
+ } satisfies IndicatorFilterChildInput
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorFilterChildInput
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # IndicatorFilterCondition
3
+
4
+ A state comparison that must hold on the trigger bar.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `lhs` | [IndicatorOperand](IndicatorOperand.md)
11
+ `comparator` | string
12
+ `rhs` | [IndicatorOperand](IndicatorOperand.md)
13
+ `interval` | string
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { IndicatorFilterCondition } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "lhs": null,
23
+ "comparator": null,
24
+ "rhs": null,
25
+ "interval": null,
26
+ } satisfies IndicatorFilterCondition
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorFilterCondition
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # IndicatorFilterConditionInput
3
+
4
+ A state comparison that must hold on the trigger bar. (request form)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `lhs` | [IndicatorOperandInput](IndicatorOperandInput.md)
11
+ `comparator` | string
12
+ `rhs` | [IndicatorOperandInput](IndicatorOperandInput.md)
13
+ `interval` | string
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { IndicatorFilterConditionInput } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "lhs": null,
23
+ "comparator": null,
24
+ "rhs": null,
25
+ "interval": null,
26
+ } satisfies IndicatorFilterConditionInput
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorFilterConditionInput
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,37 @@
1
+
2
+ # IndicatorFilterLeaf
3
+
4
+ One filter comparison.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `kind` | string
11
+ `condition` | [IndicatorFilterCondition](IndicatorFilterCondition.md)
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { IndicatorFilterLeaf } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "kind": null,
21
+ "condition": null,
22
+ } satisfies IndicatorFilterLeaf
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorFilterLeaf
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -0,0 +1,37 @@
1
+
2
+ # IndicatorFilterLeafInput
3
+
4
+ One filter comparison. (request form)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `kind` | string
11
+ `condition` | [IndicatorFilterConditionInput](IndicatorFilterConditionInput.md)
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { IndicatorFilterLeafInput } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "kind": null,
21
+ "condition": null,
22
+ } satisfies IndicatorFilterLeafInput
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorFilterLeafInput
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -0,0 +1,37 @@
1
+
2
+ # IndicatorFilters
3
+
4
+ State filters that gate the trigger (at most 4 comparisons in all, two levels).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `op` | string
11
+ `children` | [Array&lt;IndicatorFilterChild&gt;](IndicatorFilterChild.md)
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { IndicatorFilters } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "op": null,
21
+ "children": null,
22
+ } satisfies IndicatorFilters
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorFilters
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -0,0 +1,37 @@
1
+
2
+ # IndicatorFiltersInput
3
+
4
+ State filters that gate the trigger (at most 4 comparisons in all, two levels). (request form)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `op` | string
11
+ `children` | [Array&lt;IndicatorFilterChildInput&gt;](IndicatorFilterChildInput.md)
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { IndicatorFiltersInput } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "op": null,
21
+ "children": null,
22
+ } satisfies IndicatorFiltersInput
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorFiltersInput
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+