@invinite-org/data-api-client 4.0.0 → 4.1.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.
@@ -17,7 +17,7 @@ import type { StandardizedDetailedFactFormula } from './StandardizedDetailedFact
17
17
  */
18
18
  export interface AsReportedDetailedLineItem {
19
19
  /**
20
- * Fact value (as filed unless `display_sign=cash_flow_direction`)
20
+ * Fact value on today's split basis (per-share values and weighted share counts are adjusted for later stock splits, see `value_as_reported` / `split_factor`); as filed otherwise, unless `display_sign=cash_flow_direction`
21
21
  * @type {number}
22
22
  * @memberof AsReportedDetailedLineItem
23
23
  */
@@ -64,6 +64,42 @@ export interface AsReportedDetailedLineItem {
64
64
  * @memberof AsReportedDetailedLineItem
65
65
  */
66
66
  html_tag_id: string | null;
67
+ /**
68
+ * The value as first filed when a later filing changed it (a restatement or reclassification), on the basis of that filing and signed like `value`; null when the first filing reported the same number (a coarser later repeat counts as the same) or the fact is derived. Only the first and the latest filing are kept: an intermediate value is not available
69
+ * @type {number}
70
+ * @memberof AsReportedDetailedLineItem
71
+ */
72
+ original_value: number | null;
73
+ /**
74
+ * The company's caption in the first filing when a later filing changed it; null when unchanged or not known
75
+ * @type {string}
76
+ * @memberof AsReportedDetailedLineItem
77
+ */
78
+ original_label: string | null;
79
+ /**
80
+ * Filing date of the first filing; set only when `original_value` or `original_label` is
81
+ * @type {Date}
82
+ * @memberof AsReportedDetailedLineItem
83
+ */
84
+ original_filing_date: Date | null;
85
+ /**
86
+ * Accession number of the first filing (a 10-K / 10-Q or an amendment); null when no original is served or that filing cannot be identified
87
+ * @type {string}
88
+ * @memberof AsReportedDetailedLineItem
89
+ */
90
+ original_accession: string | null;
91
+ /**
92
+ * The number as filed when `value` differs from it: `value` is on today's split basis for per-share and weighted share counts, this is the filer's figure on the basis of its own filing; null when they are equal
93
+ * @type {number}
94
+ * @memberof AsReportedDetailedLineItem
95
+ */
96
+ value_as_reported: number | null;
97
+ /**
98
+ * The stock-split factor applied to the filed number to reach `value` (0.25 = a 4-for-1 split since the filing for a per-share value); null when no split applies
99
+ * @type {number}
100
+ * @memberof AsReportedDetailedLineItem
101
+ */
102
+ split_factor: number | null;
67
103
  }
68
104
  /**
69
105
  * Check if a given object implements the AsReportedDetailedLineItem interface.
@@ -32,6 +32,18 @@ export function instanceOfAsReportedDetailedLineItem(value) {
32
32
  return false;
33
33
  if (!('html_tag_id' in value) || value['html_tag_id'] === undefined)
34
34
  return false;
35
+ if (!('original_value' in value) || value['original_value'] === undefined)
36
+ return false;
37
+ if (!('original_label' in value) || value['original_label'] === undefined)
38
+ return false;
39
+ if (!('original_filing_date' in value) || value['original_filing_date'] === undefined)
40
+ return false;
41
+ if (!('original_accession' in value) || value['original_accession'] === undefined)
42
+ return false;
43
+ if (!('value_as_reported' in value) || value['value_as_reported'] === undefined)
44
+ return false;
45
+ if (!('split_factor' in value) || value['split_factor'] === undefined)
46
+ return false;
35
47
  return true;
36
48
  }
37
49
  export function AsReportedDetailedLineItemFromJSON(json) {
@@ -50,6 +62,12 @@ export function AsReportedDetailedLineItemFromJSONTyped(json, ignoreDiscriminato
50
62
  'formula': StandardizedDetailedFactFormulaFromJSON(json['formula']),
51
63
  'accession': json['accession'],
52
64
  'html_tag_id': json['html_tag_id'],
65
+ 'original_value': json['original_value'],
66
+ 'original_label': json['original_label'],
67
+ 'original_filing_date': (json['original_filing_date'] == null ? null : new Date(json['original_filing_date'])),
68
+ 'original_accession': json['original_accession'],
69
+ 'value_as_reported': json['value_as_reported'],
70
+ 'split_factor': json['split_factor'],
53
71
  };
54
72
  }
55
73
  export function AsReportedDetailedLineItemToJSON(json) {
@@ -68,5 +86,11 @@ export function AsReportedDetailedLineItemToJSONTyped(value, ignoreDiscriminator
68
86
  'formula': StandardizedDetailedFactFormulaToJSON(value['formula']),
69
87
  'accession': value['accession'],
70
88
  'html_tag_id': value['html_tag_id'],
89
+ 'original_value': value['original_value'],
90
+ 'original_label': value['original_label'],
91
+ 'original_filing_date': value['original_filing_date'] == null ? value['original_filing_date'] : value['original_filing_date'].toISOString().substring(0, 10),
92
+ 'original_accession': value['original_accession'],
93
+ 'value_as_reported': value['value_as_reported'],
94
+ 'split_factor': value['split_factor'],
71
95
  };
72
96
  }
@@ -58,6 +58,18 @@ export interface StandardizedDetailedFact {
58
58
  * @memberof StandardizedDetailedFact
59
59
  */
60
60
  parent_id: string | null;
61
+ /**
62
+ * The number as filed when `value` differs from it: `value` is on today's split basis for per-share and weighted share counts, this is the filer's figure on the basis of its own filing; null when they are equal
63
+ * @type {number}
64
+ * @memberof StandardizedDetailedFact
65
+ */
66
+ value_as_reported: number | null;
67
+ /**
68
+ * The stock-split factor applied to the filed number to reach `value` (0.25 = a 4-for-1 split since the filing for a per-share value); null when no split applies
69
+ * @type {number}
70
+ * @memberof StandardizedDetailedFact
71
+ */
72
+ split_factor: number | null;
61
73
  }
62
74
  /**
63
75
  * Check if a given object implements the StandardizedDetailedFact interface.
@@ -30,6 +30,10 @@ export function instanceOfStandardizedDetailedFact(value) {
30
30
  return false;
31
31
  if (!('parent_id' in value) || value['parent_id'] === undefined)
32
32
  return false;
33
+ if (!('value_as_reported' in value) || value['value_as_reported'] === undefined)
34
+ return false;
35
+ if (!('split_factor' in value) || value['split_factor'] === undefined)
36
+ return false;
33
37
  return true;
34
38
  }
35
39
  export function StandardizedDetailedFactFromJSON(json) {
@@ -47,6 +51,8 @@ export function StandardizedDetailedFactFromJSONTyped(json, ignoreDiscriminator)
47
51
  'accession': json['accession'],
48
52
  'html_tag_id': json['html_tag_id'],
49
53
  'parent_id': json['parent_id'],
54
+ 'value_as_reported': json['value_as_reported'],
55
+ 'split_factor': json['split_factor'],
50
56
  };
51
57
  }
52
58
  export function StandardizedDetailedFactToJSON(json) {
@@ -64,5 +70,7 @@ export function StandardizedDetailedFactToJSONTyped(value, ignoreDiscriminator =
64
70
  'accession': value['accession'],
65
71
  'html_tag_id': value['html_tag_id'],
66
72
  'parent_id': value['parent_id'],
73
+ 'value_as_reported': value['value_as_reported'],
74
+ 'split_factor': value['split_factor'],
67
75
  };
68
76
  }
@@ -17,7 +17,7 @@ import type { StandardizedDetailedFactFormula } from './StandardizedDetailedFact
17
17
  */
18
18
  export interface AsReportedDetailedLineItem {
19
19
  /**
20
- * Fact value (as filed unless `display_sign=cash_flow_direction`)
20
+ * Fact value on today's split basis (per-share values and weighted share counts are adjusted for later stock splits, see `value_as_reported` / `split_factor`); as filed otherwise, unless `display_sign=cash_flow_direction`
21
21
  * @type {number}
22
22
  * @memberof AsReportedDetailedLineItem
23
23
  */
@@ -64,6 +64,42 @@ export interface AsReportedDetailedLineItem {
64
64
  * @memberof AsReportedDetailedLineItem
65
65
  */
66
66
  html_tag_id: string | null;
67
+ /**
68
+ * The value as first filed when a later filing changed it (a restatement or reclassification), on the basis of that filing and signed like `value`; null when the first filing reported the same number (a coarser later repeat counts as the same) or the fact is derived. Only the first and the latest filing are kept: an intermediate value is not available
69
+ * @type {number}
70
+ * @memberof AsReportedDetailedLineItem
71
+ */
72
+ original_value: number | null;
73
+ /**
74
+ * The company's caption in the first filing when a later filing changed it; null when unchanged or not known
75
+ * @type {string}
76
+ * @memberof AsReportedDetailedLineItem
77
+ */
78
+ original_label: string | null;
79
+ /**
80
+ * Filing date of the first filing; set only when `original_value` or `original_label` is
81
+ * @type {Date}
82
+ * @memberof AsReportedDetailedLineItem
83
+ */
84
+ original_filing_date: Date | null;
85
+ /**
86
+ * Accession number of the first filing (a 10-K / 10-Q or an amendment); null when no original is served or that filing cannot be identified
87
+ * @type {string}
88
+ * @memberof AsReportedDetailedLineItem
89
+ */
90
+ original_accession: string | null;
91
+ /**
92
+ * The number as filed when `value` differs from it: `value` is on today's split basis for per-share and weighted share counts, this is the filer's figure on the basis of its own filing; null when they are equal
93
+ * @type {number}
94
+ * @memberof AsReportedDetailedLineItem
95
+ */
96
+ value_as_reported: number | null;
97
+ /**
98
+ * The stock-split factor applied to the filed number to reach `value` (0.25 = a 4-for-1 split since the filing for a per-share value); null when no split applies
99
+ * @type {number}
100
+ * @memberof AsReportedDetailedLineItem
101
+ */
102
+ split_factor: number | null;
67
103
  }
68
104
  /**
69
105
  * Check if a given object implements the AsReportedDetailedLineItem interface.
@@ -39,6 +39,18 @@ function instanceOfAsReportedDetailedLineItem(value) {
39
39
  return false;
40
40
  if (!('html_tag_id' in value) || value['html_tag_id'] === undefined)
41
41
  return false;
42
+ if (!('original_value' in value) || value['original_value'] === undefined)
43
+ return false;
44
+ if (!('original_label' in value) || value['original_label'] === undefined)
45
+ return false;
46
+ if (!('original_filing_date' in value) || value['original_filing_date'] === undefined)
47
+ return false;
48
+ if (!('original_accession' in value) || value['original_accession'] === undefined)
49
+ return false;
50
+ if (!('value_as_reported' in value) || value['value_as_reported'] === undefined)
51
+ return false;
52
+ if (!('split_factor' in value) || value['split_factor'] === undefined)
53
+ return false;
42
54
  return true;
43
55
  }
44
56
  function AsReportedDetailedLineItemFromJSON(json) {
@@ -57,6 +69,12 @@ function AsReportedDetailedLineItemFromJSONTyped(json, ignoreDiscriminator) {
57
69
  'formula': (0, StandardizedDetailedFactFormula_1.StandardizedDetailedFactFormulaFromJSON)(json['formula']),
58
70
  'accession': json['accession'],
59
71
  'html_tag_id': json['html_tag_id'],
72
+ 'original_value': json['original_value'],
73
+ 'original_label': json['original_label'],
74
+ 'original_filing_date': (json['original_filing_date'] == null ? null : new Date(json['original_filing_date'])),
75
+ 'original_accession': json['original_accession'],
76
+ 'value_as_reported': json['value_as_reported'],
77
+ 'split_factor': json['split_factor'],
60
78
  };
61
79
  }
62
80
  function AsReportedDetailedLineItemToJSON(json) {
@@ -75,5 +93,11 @@ function AsReportedDetailedLineItemToJSONTyped(value, ignoreDiscriminator = fals
75
93
  'formula': (0, StandardizedDetailedFactFormula_1.StandardizedDetailedFactFormulaToJSON)(value['formula']),
76
94
  'accession': value['accession'],
77
95
  'html_tag_id': value['html_tag_id'],
96
+ 'original_value': value['original_value'],
97
+ 'original_label': value['original_label'],
98
+ 'original_filing_date': value['original_filing_date'] == null ? value['original_filing_date'] : value['original_filing_date'].toISOString().substring(0, 10),
99
+ 'original_accession': value['original_accession'],
100
+ 'value_as_reported': value['value_as_reported'],
101
+ 'split_factor': value['split_factor'],
78
102
  };
79
103
  }
@@ -58,6 +58,18 @@ export interface StandardizedDetailedFact {
58
58
  * @memberof StandardizedDetailedFact
59
59
  */
60
60
  parent_id: string | null;
61
+ /**
62
+ * The number as filed when `value` differs from it: `value` is on today's split basis for per-share and weighted share counts, this is the filer's figure on the basis of its own filing; null when they are equal
63
+ * @type {number}
64
+ * @memberof StandardizedDetailedFact
65
+ */
66
+ value_as_reported: number | null;
67
+ /**
68
+ * The stock-split factor applied to the filed number to reach `value` (0.25 = a 4-for-1 split since the filing for a per-share value); null when no split applies
69
+ * @type {number}
70
+ * @memberof StandardizedDetailedFact
71
+ */
72
+ split_factor: number | null;
61
73
  }
62
74
  /**
63
75
  * Check if a given object implements the StandardizedDetailedFact interface.
@@ -37,6 +37,10 @@ function instanceOfStandardizedDetailedFact(value) {
37
37
  return false;
38
38
  if (!('parent_id' in value) || value['parent_id'] === undefined)
39
39
  return false;
40
+ if (!('value_as_reported' in value) || value['value_as_reported'] === undefined)
41
+ return false;
42
+ if (!('split_factor' in value) || value['split_factor'] === undefined)
43
+ return false;
40
44
  return true;
41
45
  }
42
46
  function StandardizedDetailedFactFromJSON(json) {
@@ -54,6 +58,8 @@ function StandardizedDetailedFactFromJSONTyped(json, ignoreDiscriminator) {
54
58
  'accession': json['accession'],
55
59
  'html_tag_id': json['html_tag_id'],
56
60
  'parent_id': json['parent_id'],
61
+ 'value_as_reported': json['value_as_reported'],
62
+ 'split_factor': json['split_factor'],
57
63
  };
58
64
  }
59
65
  function StandardizedDetailedFactToJSON(json) {
@@ -71,5 +77,7 @@ function StandardizedDetailedFactToJSONTyped(value, ignoreDiscriminator = false)
71
77
  'accession': value['accession'],
72
78
  'html_tag_id': value['html_tag_id'],
73
79
  'parent_id': value['parent_id'],
80
+ 'value_as_reported': value['value_as_reported'],
81
+ 'split_factor': value['split_factor'],
74
82
  };
75
83
  }
@@ -14,6 +14,12 @@ Name | Type
14
14
  `formula` | [StandardizedDetailedFactFormula](StandardizedDetailedFactFormula.md)
15
15
  `accession` | string
16
16
  `html_tag_id` | string
17
+ `original_value` | number
18
+ `original_label` | string
19
+ `original_filing_date` | Date
20
+ `original_accession` | string
21
+ `value_as_reported` | number
22
+ `split_factor` | number
17
23
 
18
24
  ## Example
19
25
 
@@ -30,6 +36,12 @@ const example = {
30
36
  "formula": null,
31
37
  "accession": null,
32
38
  "html_tag_id": null,
39
+ "original_value": null,
40
+ "original_label": null,
41
+ "original_filing_date": null,
42
+ "original_accession": null,
43
+ "value_as_reported": null,
44
+ "split_factor": null,
33
45
  } satisfies AsReportedDetailedLineItem
34
46
 
35
47
  console.log(example)
@@ -14,6 +14,8 @@ Name | Type
14
14
  `accession` | string
15
15
  `html_tag_id` | string
16
16
  `parent_id` | string
17
+ `value_as_reported` | number
18
+ `split_factor` | number
17
19
 
18
20
  ## Example
19
21
 
@@ -29,6 +31,8 @@ const example = {
29
31
  "accession": null,
30
32
  "html_tag_id": null,
31
33
  "parent_id": null,
34
+ "value_as_reported": null,
35
+ "split_factor": null,
32
36
  } satisfies StandardizedDetailedFact
33
37
 
34
38
  console.log(example)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/data-api-client",
3
- "version": "4.0.0",
3
+ "version": "4.1.0",
4
4
  "description": "Typed TypeScript/JavaScript client for the Invinite Data API",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -28,7 +28,7 @@ import {
28
28
  */
29
29
  export interface AsReportedDetailedLineItem {
30
30
  /**
31
- * Fact value (as filed unless `display_sign=cash_flow_direction`)
31
+ * Fact value on today's split basis (per-share values and weighted share counts are adjusted for later stock splits, see `value_as_reported` / `split_factor`); as filed otherwise, unless `display_sign=cash_flow_direction`
32
32
  * @type {number}
33
33
  * @memberof AsReportedDetailedLineItem
34
34
  */
@@ -75,6 +75,42 @@ export interface AsReportedDetailedLineItem {
75
75
  * @memberof AsReportedDetailedLineItem
76
76
  */
77
77
  html_tag_id: string | null;
78
+ /**
79
+ * The value as first filed when a later filing changed it (a restatement or reclassification), on the basis of that filing and signed like `value`; null when the first filing reported the same number (a coarser later repeat counts as the same) or the fact is derived. Only the first and the latest filing are kept: an intermediate value is not available
80
+ * @type {number}
81
+ * @memberof AsReportedDetailedLineItem
82
+ */
83
+ original_value: number | null;
84
+ /**
85
+ * The company's caption in the first filing when a later filing changed it; null when unchanged or not known
86
+ * @type {string}
87
+ * @memberof AsReportedDetailedLineItem
88
+ */
89
+ original_label: string | null;
90
+ /**
91
+ * Filing date of the first filing; set only when `original_value` or `original_label` is
92
+ * @type {Date}
93
+ * @memberof AsReportedDetailedLineItem
94
+ */
95
+ original_filing_date: Date | null;
96
+ /**
97
+ * Accession number of the first filing (a 10-K / 10-Q or an amendment); null when no original is served or that filing cannot be identified
98
+ * @type {string}
99
+ * @memberof AsReportedDetailedLineItem
100
+ */
101
+ original_accession: string | null;
102
+ /**
103
+ * The number as filed when `value` differs from it: `value` is on today's split basis for per-share and weighted share counts, this is the filer's figure on the basis of its own filing; null when they are equal
104
+ * @type {number}
105
+ * @memberof AsReportedDetailedLineItem
106
+ */
107
+ value_as_reported: number | null;
108
+ /**
109
+ * The stock-split factor applied to the filed number to reach `value` (0.25 = a 4-for-1 split since the filing for a per-share value); null when no split applies
110
+ * @type {number}
111
+ * @memberof AsReportedDetailedLineItem
112
+ */
113
+ split_factor: number | null;
78
114
  }
79
115
 
80
116
  /**
@@ -89,6 +125,12 @@ export function instanceOfAsReportedDetailedLineItem(value: object): value is As
89
125
  if (!('formula' in value) || value['formula'] === undefined) return false;
90
126
  if (!('accession' in value) || value['accession'] === undefined) return false;
91
127
  if (!('html_tag_id' in value) || value['html_tag_id'] === undefined) return false;
128
+ if (!('original_value' in value) || value['original_value'] === undefined) return false;
129
+ if (!('original_label' in value) || value['original_label'] === undefined) return false;
130
+ if (!('original_filing_date' in value) || value['original_filing_date'] === undefined) return false;
131
+ if (!('original_accession' in value) || value['original_accession'] === undefined) return false;
132
+ if (!('value_as_reported' in value) || value['value_as_reported'] === undefined) return false;
133
+ if (!('split_factor' in value) || value['split_factor'] === undefined) return false;
92
134
  return true;
93
135
  }
94
136
 
@@ -110,6 +152,12 @@ export function AsReportedDetailedLineItemFromJSONTyped(json: any, ignoreDiscrim
110
152
  'formula': StandardizedDetailedFactFormulaFromJSON(json['formula']),
111
153
  'accession': json['accession'],
112
154
  'html_tag_id': json['html_tag_id'],
155
+ 'original_value': json['original_value'],
156
+ 'original_label': json['original_label'],
157
+ 'original_filing_date': (json['original_filing_date'] == null ? null : new Date(json['original_filing_date'])),
158
+ 'original_accession': json['original_accession'],
159
+ 'value_as_reported': json['value_as_reported'],
160
+ 'split_factor': json['split_factor'],
113
161
  };
114
162
  }
115
163
 
@@ -132,6 +180,12 @@ export function AsReportedDetailedLineItemToJSONTyped(value?: AsReportedDetailed
132
180
  'formula': StandardizedDetailedFactFormulaToJSON(value['formula']),
133
181
  'accession': value['accession'],
134
182
  'html_tag_id': value['html_tag_id'],
183
+ 'original_value': value['original_value'],
184
+ 'original_label': value['original_label'],
185
+ 'original_filing_date': value['original_filing_date'] == null ? value['original_filing_date'] : value['original_filing_date'].toISOString().substring(0,10),
186
+ 'original_accession': value['original_accession'],
187
+ 'value_as_reported': value['value_as_reported'],
188
+ 'split_factor': value['split_factor'],
135
189
  };
136
190
  }
137
191
 
@@ -69,6 +69,18 @@ export interface StandardizedDetailedFact {
69
69
  * @memberof StandardizedDetailedFact
70
70
  */
71
71
  parent_id: string | null;
72
+ /**
73
+ * The number as filed when `value` differs from it: `value` is on today's split basis for per-share and weighted share counts, this is the filer's figure on the basis of its own filing; null when they are equal
74
+ * @type {number}
75
+ * @memberof StandardizedDetailedFact
76
+ */
77
+ value_as_reported: number | null;
78
+ /**
79
+ * The stock-split factor applied to the filed number to reach `value` (0.25 = a 4-for-1 split since the filing for a per-share value); null when no split applies
80
+ * @type {number}
81
+ * @memberof StandardizedDetailedFact
82
+ */
83
+ split_factor: number | null;
72
84
  }
73
85
 
74
86
  /**
@@ -82,6 +94,8 @@ export function instanceOfStandardizedDetailedFact(value: object): value is Stan
82
94
  if (!('accession' in value) || value['accession'] === undefined) return false;
83
95
  if (!('html_tag_id' in value) || value['html_tag_id'] === undefined) return false;
84
96
  if (!('parent_id' in value) || value['parent_id'] === undefined) return false;
97
+ if (!('value_as_reported' in value) || value['value_as_reported'] === undefined) return false;
98
+ if (!('split_factor' in value) || value['split_factor'] === undefined) return false;
85
99
  return true;
86
100
  }
87
101
 
@@ -102,6 +116,8 @@ export function StandardizedDetailedFactFromJSONTyped(json: any, ignoreDiscrimin
102
116
  'accession': json['accession'],
103
117
  'html_tag_id': json['html_tag_id'],
104
118
  'parent_id': json['parent_id'],
119
+ 'value_as_reported': json['value_as_reported'],
120
+ 'split_factor': json['split_factor'],
105
121
  };
106
122
  }
107
123
 
@@ -123,6 +139,8 @@ export function StandardizedDetailedFactToJSONTyped(value?: StandardizedDetailed
123
139
  'accession': value['accession'],
124
140
  'html_tag_id': value['html_tag_id'],
125
141
  'parent_id': value['parent_id'],
142
+ 'value_as_reported': value['value_as_reported'],
143
+ 'split_factor': value['split_factor'],
126
144
  };
127
145
  }
128
146