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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (192) hide show
  1. package/.openapi-generator/FILES +52 -0
  2. package/dist/apis/ScriptsApi.d.ts +148 -0
  3. package/dist/apis/ScriptsApi.js +396 -0
  4. package/dist/apis/index.d.ts +1 -0
  5. package/dist/apis/index.js +1 -0
  6. package/dist/esm/apis/ScriptsApi.d.ts +148 -0
  7. package/dist/esm/apis/ScriptsApi.js +392 -0
  8. package/dist/esm/apis/index.d.ts +1 -0
  9. package/dist/esm/apis/index.js +1 -0
  10. package/dist/esm/models/Alert.d.ts +6 -0
  11. package/dist/esm/models/Alert.js +4 -0
  12. package/dist/esm/models/AlertCondition.d.ts +61 -5
  13. package/dist/esm/models/AlertCondition.js +27 -1
  14. package/dist/esm/models/AlertConditionInput.d.ts +54 -5
  15. package/dist/esm/models/AlertConditionInput.js +24 -1
  16. package/dist/esm/models/AlertTemplate.d.ts +83 -0
  17. package/dist/esm/models/AlertTemplate.js +79 -0
  18. package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
  19. package/dist/esm/models/AlertTemplateInput.js +70 -0
  20. package/dist/esm/models/AlertTrigger.d.ts +1 -1
  21. package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
  22. package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
  23. package/dist/esm/models/CreateScriptRequest.js +49 -0
  24. package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
  25. package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
  26. package/dist/esm/models/IndicatorCondition.d.ts +56 -0
  27. package/dist/esm/models/IndicatorCondition.js +62 -0
  28. package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
  29. package/dist/esm/models/IndicatorConditionInput.js +62 -0
  30. package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
  31. package/dist/esm/models/IndicatorFilterChild.js +65 -0
  32. package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
  33. package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
  34. package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
  35. package/dist/esm/models/IndicatorFilterCondition.js +74 -0
  36. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
  37. package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
  38. package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
  39. package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
  40. package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
  41. package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
  42. package/dist/esm/models/IndicatorFilters.d.ts +47 -0
  43. package/dist/esm/models/IndicatorFilters.js +55 -0
  44. package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
  45. package/dist/esm/models/IndicatorFiltersInput.js +55 -0
  46. package/dist/esm/models/IndicatorOperand.d.ts +91 -0
  47. package/dist/esm/models/IndicatorOperand.js +74 -0
  48. package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
  49. package/dist/esm/models/IndicatorOperandInput.js +74 -0
  50. package/dist/esm/models/IndicatorResolved.d.ts +67 -0
  51. package/dist/esm/models/IndicatorResolved.js +65 -0
  52. package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
  53. package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
  54. package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
  55. package/dist/esm/models/IndicatorTemplateRef.js +47 -0
  56. package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
  57. package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
  58. package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
  59. package/dist/esm/models/ListScriptVersions200Response.js +57 -0
  60. package/dist/esm/models/ListScripts200Response.d.ts +52 -0
  61. package/dist/esm/models/ListScripts200Response.js +57 -0
  62. package/dist/esm/models/Script.d.ts +69 -0
  63. package/dist/esm/models/Script.js +68 -0
  64. package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
  65. package/dist/esm/models/ScriptDiagnostic.js +66 -0
  66. package/dist/esm/models/ScriptVersion.d.ts +103 -0
  67. package/dist/esm/models/ScriptVersion.js +91 -0
  68. package/dist/esm/models/index.d.ts +25 -0
  69. package/dist/esm/models/index.js +25 -0
  70. package/dist/models/Alert.d.ts +6 -0
  71. package/dist/models/Alert.js +4 -0
  72. package/dist/models/AlertCondition.d.ts +61 -5
  73. package/dist/models/AlertCondition.js +27 -1
  74. package/dist/models/AlertConditionInput.d.ts +54 -5
  75. package/dist/models/AlertConditionInput.js +24 -1
  76. package/dist/models/AlertTemplate.d.ts +83 -0
  77. package/dist/models/AlertTemplate.js +87 -0
  78. package/dist/models/AlertTemplateInput.d.ts +78 -0
  79. package/dist/models/AlertTemplateInput.js +78 -0
  80. package/dist/models/AlertTrigger.d.ts +1 -1
  81. package/dist/models/AlertTriggerInput.d.ts +1 -1
  82. package/dist/models/CreateScriptRequest.d.ts +44 -0
  83. package/dist/models/CreateScriptRequest.js +56 -0
  84. package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
  85. package/dist/models/CreateScriptVersionRequest.js +50 -0
  86. package/dist/models/IndicatorCondition.d.ts +56 -0
  87. package/dist/models/IndicatorCondition.js +70 -0
  88. package/dist/models/IndicatorConditionInput.d.ts +56 -0
  89. package/dist/models/IndicatorConditionInput.js +70 -0
  90. package/dist/models/IndicatorFilterChild.d.ts +68 -0
  91. package/dist/models/IndicatorFilterChild.js +73 -0
  92. package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
  93. package/dist/models/IndicatorFilterChildInput.js +73 -0
  94. package/dist/models/IndicatorFilterCondition.d.ts +73 -0
  95. package/dist/models/IndicatorFilterCondition.js +82 -0
  96. package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
  97. package/dist/models/IndicatorFilterConditionInput.js +82 -0
  98. package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
  99. package/dist/models/IndicatorFilterLeaf.js +62 -0
  100. package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
  101. package/dist/models/IndicatorFilterLeafInput.js +64 -0
  102. package/dist/models/IndicatorFilters.d.ts +47 -0
  103. package/dist/models/IndicatorFilters.js +63 -0
  104. package/dist/models/IndicatorFiltersInput.d.ts +47 -0
  105. package/dist/models/IndicatorFiltersInput.js +63 -0
  106. package/dist/models/IndicatorOperand.d.ts +91 -0
  107. package/dist/models/IndicatorOperand.js +82 -0
  108. package/dist/models/IndicatorOperandInput.d.ts +91 -0
  109. package/dist/models/IndicatorOperandInput.js +82 -0
  110. package/dist/models/IndicatorResolved.d.ts +67 -0
  111. package/dist/models/IndicatorResolved.js +73 -0
  112. package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
  113. package/dist/models/IndicatorResolvedThreshold.js +63 -0
  114. package/dist/models/IndicatorTemplateRef.d.ts +46 -0
  115. package/dist/models/IndicatorTemplateRef.js +54 -0
  116. package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
  117. package/dist/models/ListAlertTemplates200Response.js +64 -0
  118. package/dist/models/ListScriptVersions200Response.d.ts +52 -0
  119. package/dist/models/ListScriptVersions200Response.js +64 -0
  120. package/dist/models/ListScripts200Response.d.ts +52 -0
  121. package/dist/models/ListScripts200Response.js +64 -0
  122. package/dist/models/Script.d.ts +69 -0
  123. package/dist/models/Script.js +75 -0
  124. package/dist/models/ScriptDiagnostic.d.ts +64 -0
  125. package/dist/models/ScriptDiagnostic.js +74 -0
  126. package/dist/models/ScriptVersion.d.ts +103 -0
  127. package/dist/models/ScriptVersion.js +99 -0
  128. package/dist/models/index.d.ts +25 -0
  129. package/dist/models/index.js +25 -0
  130. package/docs/Alert.md +2 -0
  131. package/docs/AlertCondition.md +15 -1
  132. package/docs/AlertConditionInput.md +13 -1
  133. package/docs/AlertTemplate.md +49 -0
  134. package/docs/AlertTemplateInput.md +47 -0
  135. package/docs/CreateScriptRequest.md +38 -0
  136. package/docs/CreateScriptVersionRequest.md +34 -0
  137. package/docs/IndicatorCondition.md +39 -0
  138. package/docs/IndicatorConditionInput.md +39 -0
  139. package/docs/IndicatorFilterChild.md +41 -0
  140. package/docs/IndicatorFilterChildInput.md +41 -0
  141. package/docs/IndicatorFilterCondition.md +41 -0
  142. package/docs/IndicatorFilterConditionInput.md +41 -0
  143. package/docs/IndicatorFilterLeaf.md +37 -0
  144. package/docs/IndicatorFilterLeafInput.md +37 -0
  145. package/docs/IndicatorFilters.md +37 -0
  146. package/docs/IndicatorFiltersInput.md +37 -0
  147. package/docs/IndicatorOperand.md +47 -0
  148. package/docs/IndicatorOperandInput.md +47 -0
  149. package/docs/IndicatorResolved.md +43 -0
  150. package/docs/IndicatorResolvedThreshold.md +37 -0
  151. package/docs/IndicatorTemplateRef.md +39 -0
  152. package/docs/ListAlertTemplates200Response.md +41 -0
  153. package/docs/ListScriptVersions200Response.md +41 -0
  154. package/docs/ListScripts200Response.md +41 -0
  155. package/docs/Script.md +46 -0
  156. package/docs/ScriptDiagnostic.md +42 -0
  157. package/docs/ScriptVersion.md +54 -0
  158. package/docs/ScriptsApi.md +588 -0
  159. package/package.json +1 -1
  160. package/src/apis/ScriptsApi.ts +504 -0
  161. package/src/apis/index.ts +1 -0
  162. package/src/models/Alert.ts +9 -0
  163. package/src/models/AlertCondition.ts +98 -6
  164. package/src/models/AlertConditionInput.ts +83 -6
  165. package/src/models/AlertTemplate.ts +148 -0
  166. package/src/models/AlertTemplateInput.ts +130 -0
  167. package/src/models/AlertTrigger.ts +1 -1
  168. package/src/models/AlertTriggerInput.ts +1 -1
  169. package/src/models/CreateScriptRequest.ts +83 -0
  170. package/src/models/CreateScriptVersionRequest.ts +66 -0
  171. package/src/models/IndicatorCondition.ts +106 -0
  172. package/src/models/IndicatorConditionInput.ts +106 -0
  173. package/src/models/IndicatorFilterChild.ts +125 -0
  174. package/src/models/IndicatorFilterChildInput.ts +125 -0
  175. package/src/models/IndicatorFilterCondition.ts +126 -0
  176. package/src/models/IndicatorFilterConditionInput.ts +126 -0
  177. package/src/models/IndicatorFilterLeaf.ts +93 -0
  178. package/src/models/IndicatorFilterLeafInput.ts +95 -0
  179. package/src/models/IndicatorFilters.ts +94 -0
  180. package/src/models/IndicatorFiltersInput.ts +94 -0
  181. package/src/models/IndicatorOperand.ts +139 -0
  182. package/src/models/IndicatorOperandInput.ts +139 -0
  183. package/src/models/IndicatorResolved.ts +120 -0
  184. package/src/models/IndicatorResolvedThreshold.ts +87 -0
  185. package/src/models/IndicatorTemplateRef.ts +82 -0
  186. package/src/models/ListAlertTemplates200Response.ts +108 -0
  187. package/src/models/ListScriptVersions200Response.ts +108 -0
  188. package/src/models/ListScripts200Response.ts +108 -0
  189. package/src/models/Script.ts +128 -0
  190. package/src/models/ScriptDiagnostic.ts +113 -0
  191. package/src/models/ScriptVersion.ts +175 -0
  192. package/src/models/index.ts +25 -0
@@ -0,0 +1,47 @@
1
+
2
+ # IndicatorOperand
3
+
4
+ One side of an indicator condition (invinite\'s chart-condition operand): an indicator series, a price field, volume, or a constant (`value`, right side only).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `kind` | string
11
+ `indicator_id` | string
12
+ `series_key` | string
13
+ `params` | { [key: string]: any; }
14
+ `label` | string
15
+ `source` | string
16
+ `value` | number
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import type { IndicatorOperand } from '@invinite-org/data-api-client'
22
+
23
+ // TODO: Update the object below with actual values
24
+ const example = {
25
+ "kind": null,
26
+ "indicator_id": null,
27
+ "series_key": null,
28
+ "params": null,
29
+ "label": null,
30
+ "source": null,
31
+ "value": null,
32
+ } satisfies IndicatorOperand
33
+
34
+ console.log(example)
35
+
36
+ // Convert the instance to a JSON string
37
+ const exampleJSON: string = JSON.stringify(example)
38
+ console.log(exampleJSON)
39
+
40
+ // Parse the JSON string back to an object
41
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorOperand
42
+ console.log(exampleParsed)
43
+ ```
44
+
45
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
46
+
47
+
@@ -0,0 +1,47 @@
1
+
2
+ # IndicatorOperandInput
3
+
4
+ One side of an indicator condition (invinite\'s chart-condition operand): an indicator series, a price field, volume, or a constant (`value`, right side only). (request form)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `kind` | string
11
+ `indicator_id` | string
12
+ `series_key` | string
13
+ `params` | { [key: string]: any; }
14
+ `label` | string
15
+ `source` | string
16
+ `value` | number
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import type { IndicatorOperandInput } from '@invinite-org/data-api-client'
22
+
23
+ // TODO: Update the object below with actual values
24
+ const example = {
25
+ "kind": null,
26
+ "indicator_id": null,
27
+ "series_key": null,
28
+ "params": null,
29
+ "label": null,
30
+ "source": null,
31
+ "value": null,
32
+ } satisfies IndicatorOperandInput
33
+
34
+ console.log(example)
35
+
36
+ // Convert the instance to a JSON string
37
+ const exampleJSON: string = JSON.stringify(example)
38
+ console.log(exampleJSON)
39
+
40
+ // Parse the JSON string back to an object
41
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorOperandInput
42
+ console.log(exampleParsed)
43
+ ```
44
+
45
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
46
+
47
+
@@ -0,0 +1,43 @@
1
+
2
+ # IndicatorResolved
3
+
4
+ What the platform runs for an indicator alert (set at create, read-only: a value sent in a request is ignored).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `script_version_id` | string
11
+ `inputs` | { [key: string]: any; }
12
+ `evaluation` | string
13
+ `summary` | string
14
+ `threshold` | [IndicatorResolvedThreshold](IndicatorResolvedThreshold.md)
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { IndicatorResolved } from '@invinite-org/data-api-client'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "script_version_id": null,
24
+ "inputs": null,
25
+ "evaluation": null,
26
+ "summary": null,
27
+ "threshold": null,
28
+ } satisfies IndicatorResolved
29
+
30
+ console.log(example)
31
+
32
+ // Convert the instance to a JSON string
33
+ const exampleJSON: string = JSON.stringify(example)
34
+ console.log(exampleJSON)
35
+
36
+ // Parse the JSON string back to an object
37
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorResolved
38
+ console.log(exampleParsed)
39
+ ```
40
+
41
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
42
+
43
+
@@ -0,0 +1,37 @@
1
+
2
+ # IndicatorResolvedThreshold
3
+
4
+ shared: the crossed constant
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `comparator` | string
11
+ `value` | number
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { IndicatorResolvedThreshold } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "comparator": null,
21
+ "value": null,
22
+ } satisfies IndicatorResolvedThreshold
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorResolvedThreshold
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -0,0 +1,39 @@
1
+
2
+ # IndicatorTemplateRef
3
+
4
+ A built-in template (`GET /v1/alert-templates`) and its inputs.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `key` | string
11
+ `version` | number
12
+ `inputs` | { [key: string]: any; }
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { IndicatorTemplateRef } from '@invinite-org/data-api-client'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "key": null,
22
+ "version": null,
23
+ "inputs": null,
24
+ } satisfies IndicatorTemplateRef
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorTemplateRef
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -0,0 +1,41 @@
1
+
2
+ # ListAlertTemplates200Response
3
+
4
+ A page of AlertTemplate rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array<AlertTemplate>](AlertTemplate.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListCompanies200ResponseMeta](ListCompanies200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListAlertTemplates200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListAlertTemplates200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListAlertTemplates200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # ListScriptVersions200Response
3
+
4
+ A page of ScriptVersion rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array<ScriptVersion>](ScriptVersion.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListCompanies200ResponseMeta](ListCompanies200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListScriptVersions200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListScriptVersions200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListScriptVersions200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # ListScripts200Response
3
+
4
+ A page of Script rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array<Script>](Script.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListCompanies200ResponseMeta](ListCompanies200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListScripts200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListScripts200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListScripts200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
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
+