@invinite-org/data-api-client 6.1.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 (224) hide show
  1. package/.openapi-generator/FILES +52 -0
  2. package/dist/apis/FilingsApi.d.ts +2 -2
  3. package/dist/apis/FilingsApi.js +2 -2
  4. package/dist/apis/ReferenceApi.d.ts +4 -4
  5. package/dist/apis/ReferenceApi.js +4 -4
  6. package/dist/apis/ScriptsApi.d.ts +148 -0
  7. package/dist/apis/ScriptsApi.js +396 -0
  8. package/dist/apis/index.d.ts +1 -0
  9. package/dist/apis/index.js +1 -0
  10. package/dist/esm/apis/FilingsApi.d.ts +2 -2
  11. package/dist/esm/apis/FilingsApi.js +2 -2
  12. package/dist/esm/apis/ReferenceApi.d.ts +4 -4
  13. package/dist/esm/apis/ReferenceApi.js +4 -4
  14. package/dist/esm/apis/ScriptsApi.d.ts +148 -0
  15. package/dist/esm/apis/ScriptsApi.js +392 -0
  16. package/dist/esm/apis/index.d.ts +1 -0
  17. package/dist/esm/apis/index.js +1 -0
  18. package/dist/esm/models/Alert.d.ts +6 -0
  19. package/dist/esm/models/Alert.js +4 -0
  20. package/dist/esm/models/AlertCondition.d.ts +62 -6
  21. package/dist/esm/models/AlertCondition.js +27 -1
  22. package/dist/esm/models/AlertConditionInput.d.ts +55 -6
  23. package/dist/esm/models/AlertConditionInput.js +24 -1
  24. package/dist/esm/models/AlertTemplate.d.ts +83 -0
  25. package/dist/esm/models/AlertTemplate.js +79 -0
  26. package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
  27. package/dist/esm/models/AlertTemplateInput.js +70 -0
  28. package/dist/esm/models/AlertTrigger.d.ts +1 -1
  29. package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
  30. package/dist/esm/models/Company.d.ts +8 -8
  31. package/dist/esm/models/CompanyListItem.d.ts +1 -1
  32. package/dist/esm/models/CompanyRef.d.ts +1 -1
  33. package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
  34. package/dist/esm/models/CreateScriptRequest.js +49 -0
  35. package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
  36. package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
  37. package/dist/esm/models/IndicatorCondition.d.ts +56 -0
  38. package/dist/esm/models/IndicatorCondition.js +62 -0
  39. package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
  40. package/dist/esm/models/IndicatorConditionInput.js +62 -0
  41. package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
  42. package/dist/esm/models/IndicatorFilterChild.js +65 -0
  43. package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
  44. package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
  45. package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
  46. package/dist/esm/models/IndicatorFilterCondition.js +74 -0
  47. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
  48. package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
  49. package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
  50. package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
  51. package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
  52. package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
  53. package/dist/esm/models/IndicatorFilters.d.ts +47 -0
  54. package/dist/esm/models/IndicatorFilters.js +55 -0
  55. package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
  56. package/dist/esm/models/IndicatorFiltersInput.js +55 -0
  57. package/dist/esm/models/IndicatorOperand.d.ts +91 -0
  58. package/dist/esm/models/IndicatorOperand.js +74 -0
  59. package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
  60. package/dist/esm/models/IndicatorOperandInput.js +74 -0
  61. package/dist/esm/models/IndicatorResolved.d.ts +67 -0
  62. package/dist/esm/models/IndicatorResolved.js +65 -0
  63. package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
  64. package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
  65. package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
  66. package/dist/esm/models/IndicatorTemplateRef.js +47 -0
  67. package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
  68. package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
  69. package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
  70. package/dist/esm/models/ListScriptVersions200Response.js +57 -0
  71. package/dist/esm/models/ListScripts200Response.d.ts +52 -0
  72. package/dist/esm/models/ListScripts200Response.js +57 -0
  73. package/dist/esm/models/Script.d.ts +69 -0
  74. package/dist/esm/models/Script.js +68 -0
  75. package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
  76. package/dist/esm/models/ScriptDiagnostic.js +66 -0
  77. package/dist/esm/models/ScriptVersion.d.ts +103 -0
  78. package/dist/esm/models/ScriptVersion.js +91 -0
  79. package/dist/esm/models/index.d.ts +25 -0
  80. package/dist/esm/models/index.js +25 -0
  81. package/dist/models/Alert.d.ts +6 -0
  82. package/dist/models/Alert.js +4 -0
  83. package/dist/models/AlertCondition.d.ts +62 -6
  84. package/dist/models/AlertCondition.js +27 -1
  85. package/dist/models/AlertConditionInput.d.ts +55 -6
  86. package/dist/models/AlertConditionInput.js +24 -1
  87. package/dist/models/AlertTemplate.d.ts +83 -0
  88. package/dist/models/AlertTemplate.js +87 -0
  89. package/dist/models/AlertTemplateInput.d.ts +78 -0
  90. package/dist/models/AlertTemplateInput.js +78 -0
  91. package/dist/models/AlertTrigger.d.ts +1 -1
  92. package/dist/models/AlertTriggerInput.d.ts +1 -1
  93. package/dist/models/Company.d.ts +8 -8
  94. package/dist/models/CompanyListItem.d.ts +1 -1
  95. package/dist/models/CompanyRef.d.ts +1 -1
  96. package/dist/models/CreateScriptRequest.d.ts +44 -0
  97. package/dist/models/CreateScriptRequest.js +56 -0
  98. package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
  99. package/dist/models/CreateScriptVersionRequest.js +50 -0
  100. package/dist/models/IndicatorCondition.d.ts +56 -0
  101. package/dist/models/IndicatorCondition.js +70 -0
  102. package/dist/models/IndicatorConditionInput.d.ts +56 -0
  103. package/dist/models/IndicatorConditionInput.js +70 -0
  104. package/dist/models/IndicatorFilterChild.d.ts +68 -0
  105. package/dist/models/IndicatorFilterChild.js +73 -0
  106. package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
  107. package/dist/models/IndicatorFilterChildInput.js +73 -0
  108. package/dist/models/IndicatorFilterCondition.d.ts +73 -0
  109. package/dist/models/IndicatorFilterCondition.js +82 -0
  110. package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
  111. package/dist/models/IndicatorFilterConditionInput.js +82 -0
  112. package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
  113. package/dist/models/IndicatorFilterLeaf.js +62 -0
  114. package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
  115. package/dist/models/IndicatorFilterLeafInput.js +64 -0
  116. package/dist/models/IndicatorFilters.d.ts +47 -0
  117. package/dist/models/IndicatorFilters.js +63 -0
  118. package/dist/models/IndicatorFiltersInput.d.ts +47 -0
  119. package/dist/models/IndicatorFiltersInput.js +63 -0
  120. package/dist/models/IndicatorOperand.d.ts +91 -0
  121. package/dist/models/IndicatorOperand.js +82 -0
  122. package/dist/models/IndicatorOperandInput.d.ts +91 -0
  123. package/dist/models/IndicatorOperandInput.js +82 -0
  124. package/dist/models/IndicatorResolved.d.ts +67 -0
  125. package/dist/models/IndicatorResolved.js +73 -0
  126. package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
  127. package/dist/models/IndicatorResolvedThreshold.js +63 -0
  128. package/dist/models/IndicatorTemplateRef.d.ts +46 -0
  129. package/dist/models/IndicatorTemplateRef.js +54 -0
  130. package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
  131. package/dist/models/ListAlertTemplates200Response.js +64 -0
  132. package/dist/models/ListScriptVersions200Response.d.ts +52 -0
  133. package/dist/models/ListScriptVersions200Response.js +64 -0
  134. package/dist/models/ListScripts200Response.d.ts +52 -0
  135. package/dist/models/ListScripts200Response.js +64 -0
  136. package/dist/models/Script.d.ts +69 -0
  137. package/dist/models/Script.js +75 -0
  138. package/dist/models/ScriptDiagnostic.d.ts +64 -0
  139. package/dist/models/ScriptDiagnostic.js +74 -0
  140. package/dist/models/ScriptVersion.d.ts +103 -0
  141. package/dist/models/ScriptVersion.js +99 -0
  142. package/dist/models/index.d.ts +25 -0
  143. package/dist/models/index.js +25 -0
  144. package/docs/Alert.md +2 -0
  145. package/docs/AlertCondition.md +15 -1
  146. package/docs/AlertConditionInput.md +13 -1
  147. package/docs/AlertTemplate.md +49 -0
  148. package/docs/AlertTemplateInput.md +47 -0
  149. package/docs/CompaniesApi.md +2 -2
  150. package/docs/CreateScriptRequest.md +38 -0
  151. package/docs/CreateScriptVersionRequest.md +34 -0
  152. package/docs/EventsApi.md +2 -2
  153. package/docs/FilingsApi.md +5 -5
  154. package/docs/FinancialsApi.md +12 -12
  155. package/docs/GuidanceApi.md +4 -4
  156. package/docs/HoldingsApi.md +6 -6
  157. package/docs/IPOsApi.md +2 -2
  158. package/docs/IndicatorCondition.md +39 -0
  159. package/docs/IndicatorConditionInput.md +39 -0
  160. package/docs/IndicatorFilterChild.md +41 -0
  161. package/docs/IndicatorFilterChildInput.md +41 -0
  162. package/docs/IndicatorFilterCondition.md +41 -0
  163. package/docs/IndicatorFilterConditionInput.md +41 -0
  164. package/docs/IndicatorFilterLeaf.md +37 -0
  165. package/docs/IndicatorFilterLeafInput.md +37 -0
  166. package/docs/IndicatorFilters.md +37 -0
  167. package/docs/IndicatorFiltersInput.md +37 -0
  168. package/docs/IndicatorOperand.md +47 -0
  169. package/docs/IndicatorOperandInput.md +47 -0
  170. package/docs/IndicatorResolved.md +43 -0
  171. package/docs/IndicatorResolvedThreshold.md +37 -0
  172. package/docs/IndicatorTemplateRef.md +39 -0
  173. package/docs/InsiderTradesApi.md +2 -2
  174. package/docs/InvestorDocumentsApi.md +4 -4
  175. package/docs/ListAlertTemplates200Response.md +41 -0
  176. package/docs/ListScriptVersions200Response.md +41 -0
  177. package/docs/ListScripts200Response.md +41 -0
  178. package/docs/MetricsApi.md +10 -10
  179. package/docs/NewsApi.md +6 -6
  180. package/docs/ReferenceApi.md +8 -8
  181. package/docs/Script.md +46 -0
  182. package/docs/ScriptDiagnostic.md +42 -0
  183. package/docs/ScriptVersion.md +54 -0
  184. package/docs/ScriptsApi.md +588 -0
  185. package/docs/TranscriptsApi.md +2 -2
  186. package/package.json +1 -1
  187. package/src/apis/FilingsApi.ts +2 -2
  188. package/src/apis/ReferenceApi.ts +4 -4
  189. package/src/apis/ScriptsApi.ts +504 -0
  190. package/src/apis/index.ts +1 -0
  191. package/src/models/Alert.ts +9 -0
  192. package/src/models/AlertCondition.ts +99 -7
  193. package/src/models/AlertConditionInput.ts +84 -7
  194. package/src/models/AlertTemplate.ts +148 -0
  195. package/src/models/AlertTemplateInput.ts +130 -0
  196. package/src/models/AlertTrigger.ts +1 -1
  197. package/src/models/AlertTriggerInput.ts +1 -1
  198. package/src/models/Company.ts +8 -8
  199. package/src/models/CompanyListItem.ts +1 -1
  200. package/src/models/CompanyRef.ts +1 -1
  201. package/src/models/CreateScriptRequest.ts +83 -0
  202. package/src/models/CreateScriptVersionRequest.ts +66 -0
  203. package/src/models/IndicatorCondition.ts +106 -0
  204. package/src/models/IndicatorConditionInput.ts +106 -0
  205. package/src/models/IndicatorFilterChild.ts +125 -0
  206. package/src/models/IndicatorFilterChildInput.ts +125 -0
  207. package/src/models/IndicatorFilterCondition.ts +126 -0
  208. package/src/models/IndicatorFilterConditionInput.ts +126 -0
  209. package/src/models/IndicatorFilterLeaf.ts +93 -0
  210. package/src/models/IndicatorFilterLeafInput.ts +95 -0
  211. package/src/models/IndicatorFilters.ts +94 -0
  212. package/src/models/IndicatorFiltersInput.ts +94 -0
  213. package/src/models/IndicatorOperand.ts +139 -0
  214. package/src/models/IndicatorOperandInput.ts +139 -0
  215. package/src/models/IndicatorResolved.ts +120 -0
  216. package/src/models/IndicatorResolvedThreshold.ts +87 -0
  217. package/src/models/IndicatorTemplateRef.ts +82 -0
  218. package/src/models/ListAlertTemplates200Response.ts +108 -0
  219. package/src/models/ListScriptVersions200Response.ts +108 -0
  220. package/src/models/ListScripts200Response.ts +108 -0
  221. package/src/models/Script.ts +128 -0
  222. package/src/models/ScriptDiagnostic.ts +113 -0
  223. package/src/models/ScriptVersion.ts +175 -0
  224. package/src/models/index.ts +25 -0
@@ -125,7 +125,7 @@ async function example() {
125
125
  const api = new MetricsApi(config);
126
126
 
127
127
  const body = {
128
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
128
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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.
129
129
  company: AAPL,
130
130
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
131
131
  period: annual,
@@ -166,7 +166,7 @@ example().catch(console.error);
166
166
 
167
167
  | Name | Type | Description | Notes |
168
168
  |------------- | ------------- | ------------- | -------------|
169
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
169
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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. | [Defaults to `undefined`] |
170
170
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
171
171
  | **horizon** | `3`, `5`, `10` | Years spanned | [Optional] [Defaults to `undefined`] [Enum: 3, 5, 10] |
172
172
  | **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -235,7 +235,7 @@ async function example() {
235
235
  const api = new MetricsApi(config);
236
236
 
237
237
  const body = {
238
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
238
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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.
239
239
  company: AAPL,
240
240
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
241
241
  period: annual,
@@ -276,7 +276,7 @@ example().catch(console.error);
276
276
 
277
277
  | Name | Type | Description | Notes |
278
278
  |------------- | ------------- | ------------- | -------------|
279
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
279
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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. | [Defaults to `undefined`] |
280
280
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
281
281
  | **basis** | `yoy`, `qoq` | Comparison basis | [Optional] [Defaults to `'yoy'`] [Enum: yoy, qoq] |
282
282
  | **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -345,7 +345,7 @@ async function example() {
345
345
  const api = new MetricsApi(config);
346
346
 
347
347
  const body = {
348
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
348
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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.
349
349
  company: AAPL,
350
350
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
351
351
  period: annual,
@@ -386,7 +386,7 @@ example().catch(console.error);
386
386
 
387
387
  | Name | Type | Description | Notes |
388
388
  |------------- | ------------- | ------------- | -------------|
389
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
389
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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. | [Defaults to `undefined`] |
390
390
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
391
391
  | **category** | `string` | Ratio categories — any of `profitability`, `liquidity`, `leverage`, `efficiency`, `valuation`, comma-separated | [Optional] [Defaults to `undefined`] |
392
392
  | **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -455,7 +455,7 @@ async function example() {
455
455
  const api = new MetricsApi(config);
456
456
 
457
457
  const body = {
458
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
458
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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.
459
459
  company: AAPL,
460
460
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
461
461
  period: annual,
@@ -498,7 +498,7 @@ example().catch(console.error);
498
498
 
499
499
  | Name | Type | Description | Notes |
500
500
  |------------- | ------------- | ------------- | -------------|
501
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
501
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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. | [Defaults to `undefined`] |
502
502
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
503
503
  | **metric** | `string` | Metric id, comma list | [Optional] [Defaults to `undefined`] |
504
504
  | **axis** | `string` | XBRL axis, comma list | [Optional] [Defaults to `undefined`] |
@@ -568,7 +568,7 @@ async function example() {
568
568
  const api = new MetricsApi(config);
569
569
 
570
570
  const body = {
571
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
571
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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.
572
572
  company: AAPL,
573
573
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
574
574
  period: annual,
@@ -611,7 +611,7 @@ example().catch(console.error);
611
611
 
612
612
  | Name | Type | Description | Notes |
613
613
  |------------- | ------------- | ------------- | -------------|
614
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
614
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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. | [Defaults to `undefined`] |
615
615
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
616
616
  | **metric** | `string` | Metric id, comma list | [Optional] [Defaults to `undefined`] |
617
617
  | **axis** | `string` | XBRL axis, comma list | [Optional] [Defaults to `undefined`] |
package/docs/NewsApi.md CHANGED
@@ -207,7 +207,7 @@ async function example() {
207
207
  const api = new NewsApi(config);
208
208
 
209
209
  const body = {
210
- // 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. (optional)
210
+ // 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)
211
211
  company: AAPL,
212
212
  // string | Topics, comma list (optional)
213
213
  topic: product_launch,
@@ -252,7 +252,7 @@ example().catch(console.error);
252
252
 
253
253
  | Name | Type | Description | Notes |
254
254
  |------------- | ------------- | ------------- | -------------|
255
- | **company** | `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. | [Optional] [Defaults to `undefined`] |
255
+ | **company** | `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] [Defaults to `undefined`] |
256
256
  | **topic** | `string` | Topics, comma list | [Optional] [Defaults to `undefined`] |
257
257
  | **item** | `string` | News item id | [Optional] [Defaults to `undefined`] |
258
258
  | **announcedAtGte** | `Date` | `announced_at` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -323,7 +323,7 @@ async function example() {
323
323
  const api = new NewsApi(config);
324
324
 
325
325
  const body = {
326
- // 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. (optional)
326
+ // 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)
327
327
  company: AAPL,
328
328
  // string | Event id (optional)
329
329
  event: evt_01JC8M2X,
@@ -366,7 +366,7 @@ example().catch(console.error);
366
366
 
367
367
  | Name | Type | Description | Notes |
368
368
  |------------- | ------------- | ------------- | -------------|
369
- | **company** | `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. | [Optional] [Defaults to `undefined`] |
369
+ | **company** | `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] [Defaults to `undefined`] |
370
370
  | **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
371
371
  | **kind** | `string` | Kinds, comma list | [Optional] [Defaults to `undefined`] |
372
372
  | **topic** | `string` | Topics, comma list | [Optional] [Defaults to `undefined`] |
@@ -438,7 +438,7 @@ async function example() {
438
438
  const body = {
439
439
  // string | Query
440
440
  q: buyback,
441
- // 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. (optional)
441
+ // 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)
442
442
  company: AAPL,
443
443
  // 'title' | 'lede' | 'summary' | 'any' | Field searched (optional)
444
444
  field: any,
@@ -476,7 +476,7 @@ example().catch(console.error);
476
476
  | Name | Type | Description | Notes |
477
477
  |------------- | ------------- | ------------- | -------------|
478
478
  | **q** | `string` | Query | [Defaults to `undefined`] |
479
- | **company** | `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. | [Optional] [Defaults to `undefined`] |
479
+ | **company** | `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] [Defaults to `undefined`] |
480
480
  | **field** | `title`, `lede`, `summary`, `any` | Field searched | [Optional] [Defaults to `'any'`] [Enum: title, lede, summary, any] |
481
481
  | **mode** | `lexical`, `literal` | Mode | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
482
482
  | **publishedAtGte** | `Date` | `published_at` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.data.invinite.com*
17
17
 
18
18
  List dividends
19
19
 
20
-
20
+ Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
21
21
 
22
22
  ### Example
23
23
 
@@ -37,7 +37,7 @@ async function example() {
37
37
  const api = new ReferenceApi(config);
38
38
 
39
39
  const body = {
40
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
40
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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.
41
41
  company: AAPL,
42
42
  // Date | `ex_date` on or after this value (optional)
43
43
  exDateGte: 2025-01-01,
@@ -74,7 +74,7 @@ example().catch(console.error);
74
74
 
75
75
  | Name | Type | Description | Notes |
76
76
  |------------- | ------------- | ------------- | -------------|
77
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
77
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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. | [Defaults to `undefined`] |
78
78
  | **exDateGte** | `Date` | `ex_date` on or after this value | [Optional] [Defaults to `undefined`] |
79
79
  | **exDateGt** | `Date` | `ex_date` after this value | [Optional] [Defaults to `undefined`] |
80
80
  | **exDateLte** | `Date` | `ex_date` on or before this value | [Optional] [Defaults to `undefined`] |
@@ -141,7 +141,7 @@ async function example() {
141
141
  const api = new ReferenceApi(config);
142
142
 
143
143
  const body = {
144
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
144
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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.
145
145
  company: AAPL,
146
146
  // 'period_end' | '-period_end' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-period_end` (optional)
147
147
  sort: -period_end,
@@ -170,7 +170,7 @@ example().catch(console.error);
170
170
 
171
171
  | Name | Type | Description | Notes |
172
172
  |------------- | ------------- | ------------- | -------------|
173
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
173
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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. | [Defaults to `undefined`] |
174
174
  | **sort** | `period_end`, `-period_end` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-period_end` | [Optional] [Defaults to `'-period_end'`] [Enum: period_end, -period_end] |
175
175
  | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
176
176
  | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
@@ -313,7 +313,7 @@ example().catch(console.error);
313
313
 
314
314
  List stock splits
315
315
 
316
-
316
+ Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
317
317
 
318
318
  ### Example
319
319
 
@@ -333,7 +333,7 @@ async function example() {
333
333
  const api = new ReferenceApi(config);
334
334
 
335
335
  const body = {
336
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
336
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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.
337
337
  company: AAPL,
338
338
  // 'execution_date' | '-execution_date' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-execution_date` (optional)
339
339
  sort: -execution_date,
@@ -362,7 +362,7 @@ example().catch(console.error);
362
362
 
363
363
  | Name | Type | Description | Notes |
364
364
  |------------- | ------------- | ------------- | -------------|
365
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
365
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). 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. | [Defaults to `undefined`] |
366
366
  | **sort** | `execution_date`, `-execution_date` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-execution_date` | [Optional] [Defaults to `'-execution_date'`] [Enum: execution_date, -execution_date] |
367
367
  | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
368
368
  | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
package/docs/Script.md ADDED
@@ -0,0 +1,46 @@
1
+
2
+ # Script
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `name` | string
11
+ `description` | string
12
+ `version_count` | number
13
+ `latest_version` | [ScriptVersion](ScriptVersion.md)
14
+ `created_at` | Date
15
+ `updated_at` | Date
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { Script } from '@invinite-org/data-api-client'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "id": null,
25
+ "name": null,
26
+ "description": null,
27
+ "version_count": null,
28
+ "latest_version": null,
29
+ "created_at": null,
30
+ "updated_at": null,
31
+ } satisfies Script
32
+
33
+ console.log(example)
34
+
35
+ // Convert the instance to a JSON string
36
+ const exampleJSON: string = JSON.stringify(example)
37
+ console.log(exampleJSON)
38
+
39
+ // Parse the JSON string back to an object
40
+ const exampleParsed = JSON.parse(exampleJSON) as Script
41
+ console.log(exampleParsed)
42
+ ```
43
+
44
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
45
+
46
+
@@ -0,0 +1,42 @@
1
+
2
+ # ScriptDiagnostic
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `line` | number
10
+ `column` | number
11
+ `message` | string
12
+ `code` | string
13
+ `severity` | string
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ScriptDiagnostic } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "line": null,
23
+ "column": null,
24
+ "message": null,
25
+ "code": null,
26
+ "severity": null,
27
+ } satisfies ScriptDiagnostic
28
+
29
+ console.log(example)
30
+
31
+ // Convert the instance to a JSON string
32
+ const exampleJSON: string = JSON.stringify(example)
33
+ console.log(exampleJSON)
34
+
35
+ // Parse the JSON string back to an object
36
+ const exampleParsed = JSON.parse(exampleJSON) as ScriptDiagnostic
37
+ console.log(exampleParsed)
38
+ ```
39
+
40
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
+
42
+
@@ -0,0 +1,54 @@
1
+
2
+ # ScriptVersion
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `script_id` | string
11
+ `version` | number
12
+ `status` | string
13
+ `compiler_version` | string
14
+ `source_sha256` | string
15
+ `source` | string
16
+ `diagnostics` | [Array<ScriptDiagnostic>](ScriptDiagnostic.md)
17
+ `manifest` | { [key: string]: any; }
18
+ `alert_ids` | Array<string>
19
+ `created_at` | Date
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import type { ScriptVersion } from '@invinite-org/data-api-client'
25
+
26
+ // TODO: Update the object below with actual values
27
+ const example = {
28
+ "id": null,
29
+ "script_id": null,
30
+ "version": null,
31
+ "status": null,
32
+ "compiler_version": null,
33
+ "source_sha256": null,
34
+ "source": null,
35
+ "diagnostics": null,
36
+ "manifest": null,
37
+ "alert_ids": null,
38
+ "created_at": null,
39
+ } satisfies ScriptVersion
40
+
41
+ console.log(example)
42
+
43
+ // Convert the instance to a JSON string
44
+ const exampleJSON: string = JSON.stringify(example)
45
+ console.log(exampleJSON)
46
+
47
+ // Parse the JSON string back to an object
48
+ const exampleParsed = JSON.parse(exampleJSON) as ScriptVersion
49
+ console.log(exampleParsed)
50
+ ```
51
+
52
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
53
+
54
+