@invinite-org/data-api-client 6.2.0 → 6.3.1

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 (208) 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/Company.d.ts +6 -6
  23. package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
  24. package/dist/esm/models/CreateScriptRequest.js +49 -0
  25. package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
  26. package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
  27. package/dist/esm/models/IndicatorCondition.d.ts +56 -0
  28. package/dist/esm/models/IndicatorCondition.js +62 -0
  29. package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
  30. package/dist/esm/models/IndicatorConditionInput.js +62 -0
  31. package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
  32. package/dist/esm/models/IndicatorFilterChild.js +65 -0
  33. package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
  34. package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
  35. package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
  36. package/dist/esm/models/IndicatorFilterCondition.js +74 -0
  37. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
  38. package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
  39. package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
  40. package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
  41. package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
  42. package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
  43. package/dist/esm/models/IndicatorFilters.d.ts +47 -0
  44. package/dist/esm/models/IndicatorFilters.js +55 -0
  45. package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
  46. package/dist/esm/models/IndicatorFiltersInput.js +55 -0
  47. package/dist/esm/models/IndicatorOperand.d.ts +91 -0
  48. package/dist/esm/models/IndicatorOperand.js +74 -0
  49. package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
  50. package/dist/esm/models/IndicatorOperandInput.js +74 -0
  51. package/dist/esm/models/IndicatorResolved.d.ts +67 -0
  52. package/dist/esm/models/IndicatorResolved.js +65 -0
  53. package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
  54. package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
  55. package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
  56. package/dist/esm/models/IndicatorTemplateRef.js +47 -0
  57. package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
  58. package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
  59. package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
  60. package/dist/esm/models/ListScriptVersions200Response.js +57 -0
  61. package/dist/esm/models/ListScripts200Response.d.ts +52 -0
  62. package/dist/esm/models/ListScripts200Response.js +57 -0
  63. package/dist/esm/models/Script.d.ts +69 -0
  64. package/dist/esm/models/Script.js +68 -0
  65. package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
  66. package/dist/esm/models/ScriptDiagnostic.js +66 -0
  67. package/dist/esm/models/ScriptVersion.d.ts +103 -0
  68. package/dist/esm/models/ScriptVersion.js +91 -0
  69. package/dist/esm/models/index.d.ts +25 -0
  70. package/dist/esm/models/index.js +25 -0
  71. package/dist/models/Alert.d.ts +6 -0
  72. package/dist/models/Alert.js +4 -0
  73. package/dist/models/AlertCondition.d.ts +61 -5
  74. package/dist/models/AlertCondition.js +27 -1
  75. package/dist/models/AlertConditionInput.d.ts +54 -5
  76. package/dist/models/AlertConditionInput.js +24 -1
  77. package/dist/models/AlertTemplate.d.ts +83 -0
  78. package/dist/models/AlertTemplate.js +87 -0
  79. package/dist/models/AlertTemplateInput.d.ts +78 -0
  80. package/dist/models/AlertTemplateInput.js +78 -0
  81. package/dist/models/AlertTrigger.d.ts +1 -1
  82. package/dist/models/AlertTriggerInput.d.ts +1 -1
  83. package/dist/models/Company.d.ts +6 -6
  84. package/dist/models/CreateScriptRequest.d.ts +44 -0
  85. package/dist/models/CreateScriptRequest.js +56 -0
  86. package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
  87. package/dist/models/CreateScriptVersionRequest.js +50 -0
  88. package/dist/models/IndicatorCondition.d.ts +56 -0
  89. package/dist/models/IndicatorCondition.js +70 -0
  90. package/dist/models/IndicatorConditionInput.d.ts +56 -0
  91. package/dist/models/IndicatorConditionInput.js +70 -0
  92. package/dist/models/IndicatorFilterChild.d.ts +68 -0
  93. package/dist/models/IndicatorFilterChild.js +73 -0
  94. package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
  95. package/dist/models/IndicatorFilterChildInput.js +73 -0
  96. package/dist/models/IndicatorFilterCondition.d.ts +73 -0
  97. package/dist/models/IndicatorFilterCondition.js +82 -0
  98. package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
  99. package/dist/models/IndicatorFilterConditionInput.js +82 -0
  100. package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
  101. package/dist/models/IndicatorFilterLeaf.js +62 -0
  102. package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
  103. package/dist/models/IndicatorFilterLeafInput.js +64 -0
  104. package/dist/models/IndicatorFilters.d.ts +47 -0
  105. package/dist/models/IndicatorFilters.js +63 -0
  106. package/dist/models/IndicatorFiltersInput.d.ts +47 -0
  107. package/dist/models/IndicatorFiltersInput.js +63 -0
  108. package/dist/models/IndicatorOperand.d.ts +91 -0
  109. package/dist/models/IndicatorOperand.js +82 -0
  110. package/dist/models/IndicatorOperandInput.d.ts +91 -0
  111. package/dist/models/IndicatorOperandInput.js +82 -0
  112. package/dist/models/IndicatorResolved.d.ts +67 -0
  113. package/dist/models/IndicatorResolved.js +73 -0
  114. package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
  115. package/dist/models/IndicatorResolvedThreshold.js +63 -0
  116. package/dist/models/IndicatorTemplateRef.d.ts +46 -0
  117. package/dist/models/IndicatorTemplateRef.js +54 -0
  118. package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
  119. package/dist/models/ListAlertTemplates200Response.js +64 -0
  120. package/dist/models/ListScriptVersions200Response.d.ts +52 -0
  121. package/dist/models/ListScriptVersions200Response.js +64 -0
  122. package/dist/models/ListScripts200Response.d.ts +52 -0
  123. package/dist/models/ListScripts200Response.js +64 -0
  124. package/dist/models/Script.d.ts +69 -0
  125. package/dist/models/Script.js +75 -0
  126. package/dist/models/ScriptDiagnostic.d.ts +64 -0
  127. package/dist/models/ScriptDiagnostic.js +74 -0
  128. package/dist/models/ScriptVersion.d.ts +103 -0
  129. package/dist/models/ScriptVersion.js +99 -0
  130. package/dist/models/index.d.ts +25 -0
  131. package/dist/models/index.js +25 -0
  132. package/docs/Alert.md +2 -0
  133. package/docs/AlertCondition.md +15 -1
  134. package/docs/AlertConditionInput.md +13 -1
  135. package/docs/AlertTemplate.md +49 -0
  136. package/docs/AlertTemplateInput.md +47 -0
  137. package/docs/CompaniesApi.md +4 -4
  138. package/docs/CreateScriptRequest.md +38 -0
  139. package/docs/CreateScriptVersionRequest.md +34 -0
  140. package/docs/EventsApi.md +2 -2
  141. package/docs/FilingsApi.md +4 -4
  142. package/docs/FinancialsApi.md +12 -12
  143. package/docs/GuidanceApi.md +4 -4
  144. package/docs/HoldingsApi.md +8 -8
  145. package/docs/IPOsApi.md +4 -4
  146. package/docs/IndicatorCondition.md +39 -0
  147. package/docs/IndicatorConditionInput.md +39 -0
  148. package/docs/IndicatorFilterChild.md +41 -0
  149. package/docs/IndicatorFilterChildInput.md +41 -0
  150. package/docs/IndicatorFilterCondition.md +41 -0
  151. package/docs/IndicatorFilterConditionInput.md +41 -0
  152. package/docs/IndicatorFilterLeaf.md +37 -0
  153. package/docs/IndicatorFilterLeafInput.md +37 -0
  154. package/docs/IndicatorFilters.md +37 -0
  155. package/docs/IndicatorFiltersInput.md +37 -0
  156. package/docs/IndicatorOperand.md +47 -0
  157. package/docs/IndicatorOperandInput.md +47 -0
  158. package/docs/IndicatorResolved.md +43 -0
  159. package/docs/IndicatorResolvedThreshold.md +37 -0
  160. package/docs/IndicatorTemplateRef.md +39 -0
  161. package/docs/InsiderTradesApi.md +2 -2
  162. package/docs/InvestorDocumentsApi.md +4 -4
  163. package/docs/ListAlertTemplates200Response.md +41 -0
  164. package/docs/ListScriptVersions200Response.md +41 -0
  165. package/docs/ListScripts200Response.md +41 -0
  166. package/docs/MetricsApi.md +10 -10
  167. package/docs/NewsApi.md +6 -6
  168. package/docs/ReferenceApi.md +6 -6
  169. package/docs/Script.md +46 -0
  170. package/docs/ScriptDiagnostic.md +42 -0
  171. package/docs/ScriptVersion.md +54 -0
  172. package/docs/ScriptsApi.md +588 -0
  173. package/docs/TranscriptsApi.md +2 -2
  174. package/package.json +1 -1
  175. package/src/apis/ScriptsApi.ts +504 -0
  176. package/src/apis/index.ts +1 -0
  177. package/src/models/Alert.ts +9 -0
  178. package/src/models/AlertCondition.ts +98 -6
  179. package/src/models/AlertConditionInput.ts +83 -6
  180. package/src/models/AlertTemplate.ts +148 -0
  181. package/src/models/AlertTemplateInput.ts +130 -0
  182. package/src/models/AlertTrigger.ts +1 -1
  183. package/src/models/AlertTriggerInput.ts +1 -1
  184. package/src/models/Company.ts +6 -6
  185. package/src/models/CreateScriptRequest.ts +83 -0
  186. package/src/models/CreateScriptVersionRequest.ts +66 -0
  187. package/src/models/IndicatorCondition.ts +106 -0
  188. package/src/models/IndicatorConditionInput.ts +106 -0
  189. package/src/models/IndicatorFilterChild.ts +125 -0
  190. package/src/models/IndicatorFilterChildInput.ts +125 -0
  191. package/src/models/IndicatorFilterCondition.ts +126 -0
  192. package/src/models/IndicatorFilterConditionInput.ts +126 -0
  193. package/src/models/IndicatorFilterLeaf.ts +93 -0
  194. package/src/models/IndicatorFilterLeafInput.ts +95 -0
  195. package/src/models/IndicatorFilters.ts +94 -0
  196. package/src/models/IndicatorFiltersInput.ts +94 -0
  197. package/src/models/IndicatorOperand.ts +139 -0
  198. package/src/models/IndicatorOperandInput.ts +139 -0
  199. package/src/models/IndicatorResolved.ts +120 -0
  200. package/src/models/IndicatorResolvedThreshold.ts +87 -0
  201. package/src/models/IndicatorTemplateRef.ts +82 -0
  202. package/src/models/ListAlertTemplates200Response.ts +108 -0
  203. package/src/models/ListScriptVersions200Response.ts +108 -0
  204. package/src/models/ListScripts200Response.ts +108 -0
  205. package/src/models/Script.ts +128 -0
  206. package/src/models/ScriptDiagnostic.ts +113 -0
  207. package/src/models/ScriptVersion.ts +175 -0
  208. package/src/models/index.ts +25 -0
@@ -0,0 +1,588 @@
1
+ # ScriptsApi
2
+
3
+ All URIs are relative to *https://api.data.invinite.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**createScript**](ScriptsApi.md#createscriptoperation) | **POST** /v1/scripts | Upload a script |
8
+ | [**createScriptVersion**](ScriptsApi.md#createscriptversionoperation) | **POST** /v1/scripts/{id}/versions | Upload a new script version |
9
+ | [**deleteScript**](ScriptsApi.md#deletescript) | **DELETE** /v1/scripts/{id} | Delete a script |
10
+ | [**getScript**](ScriptsApi.md#getscript) | **GET** /v1/scripts/{id} | Get a script |
11
+ | [**listAlertTemplates**](ScriptsApi.md#listalerttemplates) | **GET** /v1/alert-templates | List indicator alert templates |
12
+ | [**listScriptVersions**](ScriptsApi.md#listscriptversions) | **GET** /v1/scripts/{id}/versions | List script versions |
13
+ | [**listScripts**](ScriptsApi.md#listscripts) | **GET** /v1/scripts | List scripts |
14
+
15
+
16
+
17
+ ## createScript
18
+
19
+ > Script createScript(createScriptRequest)
20
+
21
+ Upload a script
22
+
23
+ Creates the script and its version 1, compiled server-side (≤ 10 s, one compile per account at a time — a second concurrent upload answers 429 with Retry-After; a busy compiler 503 with Retry-After). A compile error is still a 201: the version has `status: error` and `diagnostics` (line, column, message). Answers 503 `unavailable` while hosted scripts are switched off.
24
+
25
+ ### Example
26
+
27
+ ```ts
28
+ import {
29
+ Configuration,
30
+ ScriptsApi,
31
+ } from '@invinite-org/data-api-client';
32
+ import type { CreateScriptOperationRequest } from '@invinite-org/data-api-client';
33
+
34
+ async function example() {
35
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
36
+ const config = new Configuration({
37
+ // Configure HTTP bearer authorization: bearerAuth
38
+ accessToken: "YOUR BEARER TOKEN",
39
+ });
40
+ const api = new ScriptsApi(config);
41
+
42
+ const body = {
43
+ // CreateScriptRequest
44
+ createScriptRequest: {"name":"EMA cross","description":"Fast EMA crossing above the slow one","source":"import { defineIndicator, input } from \"@invinite-org/chartlang-core\";\n\nexport default defineIndicator({\n name: \"EMA cross\",\n apiVersion: 1,\n overlay: true,\n inputs: { fast: input.int(9, { min: 1, max: 200 }), slow: input.int(21, { min: 2, max: 500 }) },\n compute({ bar, ta, alert, inputs }) {\n const fast = ta.ema(bar.close, inputs.fast);\n const slow = ta.ema(bar.close, inputs.slow);\n if (ta.crossover(fast, slow).current) alert(\"EMA cross up at \" + bar.close);\n }\n});\n"},
45
+ } satisfies CreateScriptOperationRequest;
46
+
47
+ try {
48
+ const data = await api.createScript(body);
49
+ console.log(data);
50
+ } catch (error) {
51
+ console.error(error);
52
+ }
53
+ }
54
+
55
+ // Run the test
56
+ example().catch(console.error);
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+
62
+ | Name | Type | Description | Notes |
63
+ |------------- | ------------- | ------------- | -------------|
64
+ | **createScriptRequest** | [CreateScriptRequest](CreateScriptRequest.md) | | |
65
+
66
+ ### Return type
67
+
68
+ [**Script**](Script.md)
69
+
70
+ ### Authorization
71
+
72
+ [bearerAuth](../README.md#bearerAuth)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: `application/json`
77
+ - **Accept**: `application/json`, `application/problem+json`
78
+
79
+
80
+ ### HTTP response details
81
+ | Status code | Description | Response headers |
82
+ |-------------|-------------|------------------|
83
+ | **201** | The resource | * X-Request-Id - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
84
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
85
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
86
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
87
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
88
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
89
+ | **409** | 409: idempotency_in_flight / conflict | * X-Request-Id - <br> |
90
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
91
+ | **500** | 500: internal | * X-Request-Id - <br> |
92
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
93
+
94
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
95
+
96
+
97
+ ## createScriptVersion
98
+
99
+ > ScriptVersion createScriptVersion(id, createScriptVersionRequest)
100
+
101
+ Upload a new script version
102
+
103
+ Adds the next version of the script (at most 20 per script), compiled like the first. Existing alerts keep their version. Answers 503 &#x60;unavailable&#x60; while hosted scripts are switched off.
104
+
105
+ ### Example
106
+
107
+ ```ts
108
+ import {
109
+ Configuration,
110
+ ScriptsApi,
111
+ } from '@invinite-org/data-api-client';
112
+ import type { CreateScriptVersionOperationRequest } from '@invinite-org/data-api-client';
113
+
114
+ async function example() {
115
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
116
+ const config = new Configuration({
117
+ // Configure HTTP bearer authorization: bearerAuth
118
+ accessToken: "YOUR BEARER TOKEN",
119
+ });
120
+ const api = new ScriptsApi(config);
121
+
122
+ const body = {
123
+ // string | Script id
124
+ id: scr_01JD2Q4X7Y8Z9A0B1C2D3E4F5G,
125
+ // CreateScriptVersionRequest
126
+ createScriptVersionRequest: {"source":"import { defineIndicator, input } from \"@invinite-org/chartlang-core\";\n\nexport default defineIndicator({\n name: \"EMA cross\",\n apiVersion: 1,\n overlay: true,\n inputs: { fast: input.int(9, { min: 1, max: 200 }), slow: input.int(21, { min: 2, max: 500 }) },\n compute({ bar, ta, alert, inputs }) {\n const fast = ta.ema(bar.close, inputs.fast);\n const slow = ta.ema(bar.close, inputs.slow);\n if (ta.crossover(fast, slow).current) alert(\"EMA cross up at \" + bar.close);\n }\n});\n"},
127
+ } satisfies CreateScriptVersionOperationRequest;
128
+
129
+ try {
130
+ const data = await api.createScriptVersion(body);
131
+ console.log(data);
132
+ } catch (error) {
133
+ console.error(error);
134
+ }
135
+ }
136
+
137
+ // Run the test
138
+ example().catch(console.error);
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+
144
+ | Name | Type | Description | Notes |
145
+ |------------- | ------------- | ------------- | -------------|
146
+ | **id** | `string` | Script id | [Defaults to `undefined`] |
147
+ | **createScriptVersionRequest** | [CreateScriptVersionRequest](CreateScriptVersionRequest.md) | | |
148
+
149
+ ### Return type
150
+
151
+ [**ScriptVersion**](ScriptVersion.md)
152
+
153
+ ### Authorization
154
+
155
+ [bearerAuth](../README.md#bearerAuth)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: `application/json`
160
+ - **Accept**: `application/json`, `application/problem+json`
161
+
162
+
163
+ ### HTTP response details
164
+ | Status code | Description | Response headers |
165
+ |-------------|-------------|------------------|
166
+ | **201** | The resource | * X-Request-Id - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
167
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
168
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
169
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
170
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
171
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
172
+ | **409** | 409: idempotency_in_flight / conflict | * X-Request-Id - <br> |
173
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
174
+ | **500** | 500: internal | * X-Request-Id - <br> |
175
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
176
+
177
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
178
+
179
+
180
+ ## deleteScript
181
+
182
+ > any deleteScript(id)
183
+
184
+ Delete a script
185
+
186
+ Deletes the script and its versions (204). 409 &#x60;conflict&#x60; while an alert uses one of its versions (delete those alerts first). Answers 503 &#x60;unavailable&#x60; while hosted scripts are switched off.
187
+
188
+ ### Example
189
+
190
+ ```ts
191
+ import {
192
+ Configuration,
193
+ ScriptsApi,
194
+ } from '@invinite-org/data-api-client';
195
+ import type { DeleteScriptRequest } from '@invinite-org/data-api-client';
196
+
197
+ async function example() {
198
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
199
+ const config = new Configuration({
200
+ // Configure HTTP bearer authorization: bearerAuth
201
+ accessToken: "YOUR BEARER TOKEN",
202
+ });
203
+ const api = new ScriptsApi(config);
204
+
205
+ const body = {
206
+ // string | Script id
207
+ id: scr_01JD2Q4X7Y8Z9A0B1C2D3E4F5G,
208
+ } satisfies DeleteScriptRequest;
209
+
210
+ try {
211
+ const data = await api.deleteScript(body);
212
+ console.log(data);
213
+ } catch (error) {
214
+ console.error(error);
215
+ }
216
+ }
217
+
218
+ // Run the test
219
+ example().catch(console.error);
220
+ ```
221
+
222
+ ### Parameters
223
+
224
+
225
+ | Name | Type | Description | Notes |
226
+ |------------- | ------------- | ------------- | -------------|
227
+ | **id** | `string` | Script id | [Defaults to `undefined`] |
228
+
229
+ ### Return type
230
+
231
+ **any**
232
+
233
+ ### Authorization
234
+
235
+ [bearerAuth](../README.md#bearerAuth)
236
+
237
+ ### HTTP request headers
238
+
239
+ - **Content-Type**: Not defined
240
+ - **Accept**: `application/json`, `application/problem+json`
241
+
242
+
243
+ ### HTTP response details
244
+ | Status code | Description | Response headers |
245
+ |-------------|-------------|------------------|
246
+ | **204** | Done | * X-Request-Id - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
247
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
248
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
249
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
250
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
251
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
252
+ | **409** | 409: idempotency_in_flight / conflict | * X-Request-Id - <br> |
253
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
254
+ | **500** | 500: internal | * X-Request-Id - <br> |
255
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
256
+
257
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
258
+
259
+
260
+ ## getScript
261
+
262
+ > Script getScript(id)
263
+
264
+ Get a script
265
+
266
+ One script with its latest version. Answers 503 &#x60;unavailable&#x60; while hosted scripts are switched off.
267
+
268
+ ### Example
269
+
270
+ ```ts
271
+ import {
272
+ Configuration,
273
+ ScriptsApi,
274
+ } from '@invinite-org/data-api-client';
275
+ import type { GetScriptRequest } from '@invinite-org/data-api-client';
276
+
277
+ async function example() {
278
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
279
+ const config = new Configuration({
280
+ // Configure HTTP bearer authorization: bearerAuth
281
+ accessToken: "YOUR BEARER TOKEN",
282
+ });
283
+ const api = new ScriptsApi(config);
284
+
285
+ const body = {
286
+ // string | Script id
287
+ id: scr_01JD2Q4X7Y8Z9A0B1C2D3E4F5G,
288
+ } satisfies GetScriptRequest;
289
+
290
+ try {
291
+ const data = await api.getScript(body);
292
+ console.log(data);
293
+ } catch (error) {
294
+ console.error(error);
295
+ }
296
+ }
297
+
298
+ // Run the test
299
+ example().catch(console.error);
300
+ ```
301
+
302
+ ### Parameters
303
+
304
+
305
+ | Name | Type | Description | Notes |
306
+ |------------- | ------------- | ------------- | -------------|
307
+ | **id** | `string` | Script id | [Defaults to `undefined`] |
308
+
309
+ ### Return type
310
+
311
+ [**Script**](Script.md)
312
+
313
+ ### Authorization
314
+
315
+ [bearerAuth](../README.md#bearerAuth)
316
+
317
+ ### HTTP request headers
318
+
319
+ - **Content-Type**: Not defined
320
+ - **Accept**: `application/json`, `application/problem+json`
321
+
322
+
323
+ ### HTTP response details
324
+ | Status code | Description | Response headers |
325
+ |-------------|-------------|------------------|
326
+ | **200** | The resource | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
327
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
328
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
329
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
330
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
331
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
332
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
333
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
334
+ | **500** | 500: internal | * X-Request-Id - <br> |
335
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
336
+
337
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
338
+
339
+
340
+ ## listAlertTemplates
341
+
342
+ > ListAlertTemplates200Response listAlertTemplates(limit, cursor)
343
+
344
+ List indicator alert templates
345
+
346
+ The built-in templates of the &#x60;indicator&#x60; alert type: key, version, inputs with their defaults, snapshot fidelity and chartlang source. Answers 503 &#x60;unavailable&#x60; while hosted scripts are switched off.
347
+
348
+ ### Example
349
+
350
+ ```ts
351
+ import {
352
+ Configuration,
353
+ ScriptsApi,
354
+ } from '@invinite-org/data-api-client';
355
+ import type { ListAlertTemplatesRequest } from '@invinite-org/data-api-client';
356
+
357
+ async function example() {
358
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
359
+ const config = new Configuration({
360
+ // Configure HTTP bearer authorization: bearerAuth
361
+ accessToken: "YOUR BEARER TOKEN",
362
+ });
363
+ const api = new ScriptsApi(config);
364
+
365
+ const body = {
366
+ // number | Rows per page (default 25, max 200) (optional)
367
+ limit: 25,
368
+ // string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
369
+ cursor: eyJ2IjoyfQ,
370
+ } satisfies ListAlertTemplatesRequest;
371
+
372
+ try {
373
+ const data = await api.listAlertTemplates(body);
374
+ console.log(data);
375
+ } catch (error) {
376
+ console.error(error);
377
+ }
378
+ }
379
+
380
+ // Run the test
381
+ example().catch(console.error);
382
+ ```
383
+
384
+ ### Parameters
385
+
386
+
387
+ | Name | Type | Description | Notes |
388
+ |------------- | ------------- | ------------- | -------------|
389
+ | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
390
+ | **cursor** | `string` | Opaque &#x60;next_cursor&#x60; of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
391
+
392
+ ### Return type
393
+
394
+ [**ListAlertTemplates200Response**](ListAlertTemplates200Response.md)
395
+
396
+ ### Authorization
397
+
398
+ [bearerAuth](../README.md#bearerAuth)
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: Not defined
403
+ - **Accept**: `application/json`, `application/problem+json`
404
+
405
+
406
+ ### HTTP response details
407
+ | Status code | Description | Response headers |
408
+ |-------------|-------------|------------------|
409
+ | **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
410
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
411
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
412
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
413
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
414
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
415
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
416
+ | **500** | 500: internal | * X-Request-Id - <br> |
417
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
418
+
419
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
420
+
421
+
422
+ ## listScriptVersions
423
+
424
+ > ListScriptVersions200Response listScriptVersions(id, limit, cursor)
425
+
426
+ List script versions
427
+
428
+ The script\&#39;s versions, oldest first. Answers 503 &#x60;unavailable&#x60; while hosted scripts are switched off.
429
+
430
+ ### Example
431
+
432
+ ```ts
433
+ import {
434
+ Configuration,
435
+ ScriptsApi,
436
+ } from '@invinite-org/data-api-client';
437
+ import type { ListScriptVersionsRequest } from '@invinite-org/data-api-client';
438
+
439
+ async function example() {
440
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
441
+ const config = new Configuration({
442
+ // Configure HTTP bearer authorization: bearerAuth
443
+ accessToken: "YOUR BEARER TOKEN",
444
+ });
445
+ const api = new ScriptsApi(config);
446
+
447
+ const body = {
448
+ // string | Script id
449
+ id: scr_01JD2Q4X7Y8Z9A0B1C2D3E4F5G,
450
+ // number | Rows per page (default 25, max 200) (optional)
451
+ limit: 25,
452
+ // string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
453
+ cursor: eyJ2IjoyfQ,
454
+ } satisfies ListScriptVersionsRequest;
455
+
456
+ try {
457
+ const data = await api.listScriptVersions(body);
458
+ console.log(data);
459
+ } catch (error) {
460
+ console.error(error);
461
+ }
462
+ }
463
+
464
+ // Run the test
465
+ example().catch(console.error);
466
+ ```
467
+
468
+ ### Parameters
469
+
470
+
471
+ | Name | Type | Description | Notes |
472
+ |------------- | ------------- | ------------- | -------------|
473
+ | **id** | `string` | Script id | [Defaults to `undefined`] |
474
+ | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
475
+ | **cursor** | `string` | Opaque &#x60;next_cursor&#x60; of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
476
+
477
+ ### Return type
478
+
479
+ [**ListScriptVersions200Response**](ListScriptVersions200Response.md)
480
+
481
+ ### Authorization
482
+
483
+ [bearerAuth](../README.md#bearerAuth)
484
+
485
+ ### HTTP request headers
486
+
487
+ - **Content-Type**: Not defined
488
+ - **Accept**: `application/json`, `application/problem+json`
489
+
490
+
491
+ ### HTTP response details
492
+ | Status code | Description | Response headers |
493
+ |-------------|-------------|------------------|
494
+ | **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
495
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
496
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
497
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
498
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
499
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
500
+ | **404** | 404: not_found / not_covered | * X-Request-Id - <br> |
501
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
502
+ | **500** | 500: internal | * X-Request-Id - <br> |
503
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
504
+
505
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
506
+
507
+
508
+ ## listScripts
509
+
510
+ > ListScripts200Response listScripts(limit, cursor)
511
+
512
+ List scripts
513
+
514
+ The account\&#39;s scripts, oldest first, each with its latest version. Answers 503 &#x60;unavailable&#x60; while hosted scripts are switched off.
515
+
516
+ ### Example
517
+
518
+ ```ts
519
+ import {
520
+ Configuration,
521
+ ScriptsApi,
522
+ } from '@invinite-org/data-api-client';
523
+ import type { ListScriptsRequest } from '@invinite-org/data-api-client';
524
+
525
+ async function example() {
526
+ console.log("🚀 Testing @invinite-org/data-api-client SDK...");
527
+ const config = new Configuration({
528
+ // Configure HTTP bearer authorization: bearerAuth
529
+ accessToken: "YOUR BEARER TOKEN",
530
+ });
531
+ const api = new ScriptsApi(config);
532
+
533
+ const body = {
534
+ // number | Rows per page (default 25, max 200) (optional)
535
+ limit: 25,
536
+ // string | Opaque `next_cursor` of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) (optional)
537
+ cursor: eyJ2IjoyfQ,
538
+ } satisfies ListScriptsRequest;
539
+
540
+ try {
541
+ const data = await api.listScripts(body);
542
+ console.log(data);
543
+ } catch (error) {
544
+ console.error(error);
545
+ }
546
+ }
547
+
548
+ // Run the test
549
+ example().catch(console.error);
550
+ ```
551
+
552
+ ### Parameters
553
+
554
+
555
+ | Name | Type | Description | Notes |
556
+ |------------- | ------------- | ------------- | -------------|
557
+ | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
558
+ | **cursor** | `string` | Opaque &#x60;next_cursor&#x60; of the previous page; reuse it with the SAME filters (changed filters → 400 cursor_mismatch) | [Optional] [Defaults to `undefined`] |
559
+
560
+ ### Return type
561
+
562
+ [**ListScripts200Response**](ListScripts200Response.md)
563
+
564
+ ### Authorization
565
+
566
+ [bearerAuth](../README.md#bearerAuth)
567
+
568
+ ### HTTP request headers
569
+
570
+ - **Content-Type**: Not defined
571
+ - **Accept**: `application/json`, `application/problem+json`
572
+
573
+
574
+ ### HTTP response details
575
+ | Status code | Description | Response headers |
576
+ |-------------|-------------|------------------|
577
+ | **200** | A page of rows | * X-Request-Id - <br> * ETag - <br> * Cache-Control - <br> * X-Credits-Charged - <br> * X-Credits-Remaining - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> * Link - <br> |
578
+ | **304** | 304: the &#x60;If-None-Match&#x60; ETag still matches (0 credits) | * X-Request-Id - <br> * ETag - <br> * X-Credits-Charged - <br> |
579
+ | **400** | 400: invalid_parameter / unknown_parameter / cursor_mismatch | * X-Request-Id - <br> |
580
+ | **401** | 401: Missing or invalid API key | * X-Request-Id - <br> |
581
+ | **402** | 402: insufficient_credits | * X-Request-Id - <br> |
582
+ | **403** | 403: plan_required / excluded | * X-Request-Id - <br> |
583
+ | **429** | 429: rate_limited | * X-Request-Id - <br> * Retry-After - <br> * X-RateLimit-Limit-Second - <br> * X-RateLimit-Remaining-Second - <br> * X-RateLimit-Limit-Minute - <br> * X-RateLimit-Remaining-Minute - <br> * X-RateLimit-Reset - <br> * RateLimit - <br> * RateLimit-Policy - <br> |
584
+ | **500** | 500: internal | * X-Request-Id - <br> |
585
+ | **503** | 503: A dependency is down (an outage, never a data state) | * X-Request-Id - <br> * Retry-After - <br> |
586
+
587
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
588
+
@@ -387,7 +387,7 @@ async function example() {
387
387
  const body = {
388
388
  // string | Query
389
389
  q: gross margin,
390
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
390
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
391
391
  company: AAPL,
392
392
  // string | Event id (optional)
393
393
  event: evt_01JC8M2X,
@@ -427,7 +427,7 @@ example().catch(console.error);
427
427
  | Name | Type | Description | Notes |
428
428
  |------------- | ------------- | ------------- | -------------|
429
429
  | **q** | `string` | Query | [Defaults to `undefined`] |
430
- | **company** | `string` | Ticker (&#x60;AAPL&#x60;) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
430
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
431
431
  | **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
432
432
  | **type** | `string` | Text types — any of &#x60;transcript&#x60;, &#x60;qa&#x60;, &#x60;prepared&#x60;, &#x60;presentation&#x60;, comma-separated | [Optional] [Defaults to `undefined`] |
433
433
  | **mode** | `lexical`, `literal` | Mode | [Optional] [Defaults to `&#39;lexical&#39;`] [Enum: lexical, literal] |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/data-api-client",
3
- "version": "6.2.0",
3
+ "version": "6.3.1",
4
4
  "description": "Typed TypeScript/JavaScript client for the Invinite Data API",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {