@invinite-org/data-api-client 0.1.1 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/.openapi-generator/FILES +0 -1
  2. package/dist/apis/EarningsCallsApi.d.ts +20 -6
  3. package/dist/apis/EarningsCallsApi.js +34 -7
  4. package/dist/esm/apis/EarningsCallsApi.d.ts +20 -6
  5. package/dist/esm/apis/EarningsCallsApi.js +33 -6
  6. package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +59 -5
  7. package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +46 -2
  8. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +32 -0
  9. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +25 -0
  10. package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +32 -0
  11. package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +25 -0
  12. package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +59 -5
  13. package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +47 -3
  14. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +32 -0
  15. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +26 -1
  16. package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +32 -0
  17. package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +26 -1
  18. package/docs/EarningsCallsApi.md +36 -15
  19. package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +8 -0
  20. package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
  21. package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +6 -0
  22. package/package.json +4 -4
  23. package/src/apis/EarningsCallsApi.ts +48 -6
  24. package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +75 -7
  25. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +42 -0
  26. package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +42 -0
@@ -22,11 +22,17 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
22
22
  */
23
23
  document_id: string;
24
24
  /**
25
- * IR site section the document is filed in
25
+ * company = the IR library; call = a document of one earnings call (only with include=calls)
26
+ * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum}
27
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
28
+ */
29
+ source: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum;
30
+ /**
31
+ * IR site section the document is filed in; null on a call document
26
32
  * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum}
27
33
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
28
34
  */
29
- section: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum;
35
+ section: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum | null;
30
36
  /**
31
37
  * Document kind
32
38
  * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum}
@@ -45,6 +51,24 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
45
51
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
46
52
  */
47
53
  period: EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum | null;
54
+ /**
55
+ * Folder of the document tree, e.g. earnings/fy2027/q2, events/2026/09-10-<event>, reports/2025, governance, shareholder/tax; null = not placed yet
56
+ * @type {string}
57
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
58
+ */
59
+ group: string | null;
60
+ /**
61
+ * Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
62
+ * @type {string}
63
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
64
+ */
65
+ group_label: string | null;
66
+ /**
67
+ * Spine folder of the tree: earnings, events, reports, presentations, governance, esg, shareholder, other; null = not placed yet
68
+ * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum}
69
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
70
+ */
71
+ category: EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum | null;
48
72
  /**
49
73
  * The event the document belongs to
50
74
  * @type {string}
@@ -58,7 +82,7 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
58
82
  */
59
83
  event_type: EarningsCallsCompanyDocuments200ResponseDocumentsInnerEventTypeEnum | null;
60
84
  /**
61
- * The item's own date on the site
85
+ * The item's own date on the site (a call document: the call's New York day)
62
86
  * @type {Date}
63
87
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
64
88
  */
@@ -82,13 +106,13 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
82
106
  */
83
107
  source_url: string;
84
108
  /**
85
- * The IR page that listed the document
109
+ * The IR page that listed the document; null on a call document
86
110
  * @type {string}
87
111
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
88
112
  */
89
113
  page_url: string | null;
90
114
  /**
91
- * How the IR section was read
115
+ * How the IR section was read (a call document: where it was found)
92
116
  * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum}
93
117
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
94
118
  */
@@ -174,6 +198,14 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
174
198
  [key: string]: any;
175
199
  };
176
200
  }
201
+ /**
202
+ * @export
203
+ */
204
+ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum: {
205
+ readonly Company: "company";
206
+ readonly Call: "call";
207
+ };
208
+ export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum];
177
209
  /**
178
210
  * @export
179
211
  */
@@ -214,6 +246,7 @@ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindE
214
246
  readonly Webcast: "webcast";
215
247
  readonly Other: "other";
216
248
  readonly PreparedRemarks: "prepared_remarks";
249
+ readonly SecFiling: "sec_filing";
217
250
  };
218
251
  export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum];
219
252
  /**
@@ -229,6 +262,20 @@ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerPerio
229
262
  readonly Fy: "FY";
230
263
  };
231
264
  export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum];
265
+ /**
266
+ * @export
267
+ */
268
+ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum: {
269
+ readonly Earnings: "earnings";
270
+ readonly Events: "events";
271
+ readonly Reports: "reports";
272
+ readonly Presentations: "presentations";
273
+ readonly Governance: "governance";
274
+ readonly Esg: "esg";
275
+ readonly Shareholder: "shareholder";
276
+ readonly Other: "other";
277
+ };
278
+ export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum];
232
279
  /**
233
280
  * @export
234
281
  */
@@ -250,6 +297,13 @@ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerOrigi
250
297
  readonly JsonFeed: "json_feed";
251
298
  readonly HtmlPage: "html_page";
252
299
  readonly Agent: "agent";
300
+ readonly Q4Reports: "q4_reports";
301
+ readonly Q4Event: "q4_event";
302
+ readonly EdgarExhibit: "edgar_exhibit";
303
+ readonly EdgarFiling: "edgar_filing";
304
+ readonly IrListing: "ir_listing";
305
+ readonly PlaybookPattern: "playbook_pattern";
306
+ readonly AgentArchive: "agent_archive";
253
307
  };
254
308
  export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum];
255
309
  /**
@@ -11,6 +11,13 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ /**
15
+ * @export
16
+ */
17
+ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum = {
18
+ Company: 'company',
19
+ Call: 'call'
20
+ };
14
21
  /**
15
22
  * @export
16
23
  */
@@ -49,7 +56,8 @@ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum = {
49
56
  Infographic: 'infographic',
50
57
  Webcast: 'webcast',
51
58
  Other: 'other',
52
- PreparedRemarks: 'prepared_remarks'
59
+ PreparedRemarks: 'prepared_remarks',
60
+ SecFiling: 'sec_filing'
53
61
  };
54
62
  /**
55
63
  * @export
@@ -63,6 +71,19 @@ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum =
63
71
  H2: 'H2',
64
72
  Fy: 'FY'
65
73
  };
74
+ /**
75
+ * @export
76
+ */
77
+ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum = {
78
+ Earnings: 'earnings',
79
+ Events: 'events',
80
+ Reports: 'reports',
81
+ Presentations: 'presentations',
82
+ Governance: 'governance',
83
+ Esg: 'esg',
84
+ Shareholder: 'shareholder',
85
+ Other: 'other'
86
+ };
66
87
  /**
67
88
  * @export
68
89
  */
@@ -82,7 +103,14 @@ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum =
82
103
  NotifiedListing: 'notified_listing',
83
104
  JsonFeed: 'json_feed',
84
105
  HtmlPage: 'html_page',
85
- Agent: 'agent'
106
+ Agent: 'agent',
107
+ Q4Reports: 'q4_reports',
108
+ Q4Event: 'q4_event',
109
+ EdgarExhibit: 'edgar_exhibit',
110
+ EdgarFiling: 'edgar_filing',
111
+ IrListing: 'ir_listing',
112
+ PlaybookPattern: 'playbook_pattern',
113
+ AgentArchive: 'agent_archive'
86
114
  };
87
115
  /**
88
116
  * @export
@@ -115,6 +143,8 @@ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerLinkStatusEnu
115
143
  export function instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner(value) {
116
144
  if (!('document_id' in value) || value['document_id'] === undefined)
117
145
  return false;
146
+ if (!('source' in value) || value['source'] === undefined)
147
+ return false;
118
148
  if (!('section' in value) || value['section'] === undefined)
119
149
  return false;
120
150
  if (!('kind' in value) || value['kind'] === undefined)
@@ -123,6 +153,12 @@ export function instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner
123
153
  return false;
124
154
  if (!('period' in value) || value['period'] === undefined)
125
155
  return false;
156
+ if (!('group' in value) || value['group'] === undefined)
157
+ return false;
158
+ if (!('group_label' in value) || value['group_label'] === undefined)
159
+ return false;
160
+ if (!('category' in value) || value['category'] === undefined)
161
+ return false;
126
162
  if (!('event_id' in value) || value['event_id'] === undefined)
127
163
  return false;
128
164
  if (!('event_type' in value) || value['event_type'] === undefined)
@@ -174,10 +210,14 @@ export function EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTy
174
210
  }
175
211
  return {
176
212
  'document_id': json['document_id'],
213
+ 'source': json['source'],
177
214
  'section': json['section'],
178
215
  'kind': json['kind'],
179
216
  'year': json['year'],
180
217
  'period': json['period'],
218
+ 'group': json['group'],
219
+ 'group_label': json['group_label'],
220
+ 'category': json['category'],
181
221
  'event_id': json['event_id'],
182
222
  'event_type': json['event_type'],
183
223
  'event_date': (json['event_date'] == null ? null : new Date(json['event_date'])),
@@ -210,10 +250,14 @@ export function EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONType
210
250
  }
211
251
  return {
212
252
  'document_id': value['document_id'],
253
+ 'source': value['source'],
213
254
  'section': value['section'],
214
255
  'kind': value['kind'],
215
256
  'year': value['year'],
216
257
  'period': value['period'],
258
+ 'group': value['group'],
259
+ 'group_label': value['group_label'],
260
+ 'category': value['category'],
217
261
  'event_id': value['event_id'],
218
262
  'event_type': value['event_type'],
219
263
  'event_date': value['event_date'] == null ? value['event_date'] : value['event_date'].toISOString().substring(0, 10),
@@ -99,6 +99,24 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
99
99
  * @memberof EarningsCallsDocumentSearch200ResponseHitsInner
100
100
  */
101
101
  title: string | null;
102
+ /**
103
+ * Folder of the document tree, e.g. earnings/fy2027/q2, events/2026/09-10-<event>, reports/2025, governance, shareholder/tax; null = not placed yet
104
+ * @type {string}
105
+ * @memberof EarningsCallsDocumentSearch200ResponseHitsInner
106
+ */
107
+ group: string | null;
108
+ /**
109
+ * Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
110
+ * @type {string}
111
+ * @memberof EarningsCallsDocumentSearch200ResponseHitsInner
112
+ */
113
+ group_label: string | null;
114
+ /**
115
+ * Spine folder of the tree: earnings, events, reports, presentations, governance, esg, shareholder, other; null = not placed yet
116
+ * @type {EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum}
117
+ * @memberof EarningsCallsDocumentSearch200ResponseHitsInner
118
+ */
119
+ category: EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum | null;
102
120
  /**
103
121
  * Signed URL of the stored file; null for a link-only row
104
122
  * @type {string}
@@ -120,6 +138,20 @@ export declare const EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum: {
120
138
  readonly CompanyDocuments: "company_documents";
121
139
  };
122
140
  export type EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum = typeof EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum[keyof typeof EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum];
141
+ /**
142
+ * @export
143
+ */
144
+ export declare const EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum: {
145
+ readonly Earnings: "earnings";
146
+ readonly Events: "events";
147
+ readonly Reports: "reports";
148
+ readonly Presentations: "presentations";
149
+ readonly Governance: "governance";
150
+ readonly Esg: "esg";
151
+ readonly Shareholder: "shareholder";
152
+ readonly Other: "other";
153
+ };
154
+ export type EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = typeof EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum[keyof typeof EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum];
123
155
  /**
124
156
  * Check if a given object implements the EarningsCallsDocumentSearch200ResponseHitsInner interface.
125
157
  */
@@ -18,6 +18,19 @@ export const EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum = {
18
18
  EventDocuments: 'event_documents',
19
19
  CompanyDocuments: 'company_documents'
20
20
  };
21
+ /**
22
+ * @export
23
+ */
24
+ export const EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = {
25
+ Earnings: 'earnings',
26
+ Events: 'events',
27
+ Reports: 'reports',
28
+ Presentations: 'presentations',
29
+ Governance: 'governance',
30
+ Esg: 'esg',
31
+ Shareholder: 'shareholder',
32
+ Other: 'other'
33
+ };
21
34
  /**
22
35
  * Check if a given object implements the EarningsCallsDocumentSearch200ResponseHitsInner interface.
23
36
  */
@@ -50,6 +63,12 @@ export function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value)
50
63
  return false;
51
64
  if (!('title' in value) || value['title'] === undefined)
52
65
  return false;
66
+ if (!('group' in value) || value['group'] === undefined)
67
+ return false;
68
+ if (!('group_label' in value) || value['group_label'] === undefined)
69
+ return false;
70
+ if (!('category' in value) || value['category'] === undefined)
71
+ return false;
53
72
  if (!('url' in value) || value['url'] === undefined)
54
73
  return false;
55
74
  if (!('expires_at' in value) || value['expires_at'] === undefined)
@@ -78,6 +97,9 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(jso
78
97
  'heading': json['heading'],
79
98
  'text': json['text'],
80
99
  'title': json['title'],
100
+ 'group': json['group'],
101
+ 'group_label': json['group_label'],
102
+ 'category': json['category'],
81
103
  'url': json['url'],
82
104
  'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
83
105
  };
@@ -104,6 +126,9 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value
104
126
  'heading': value['heading'],
105
127
  'text': value['text'],
106
128
  'title': value['title'],
129
+ 'group': value['group'],
130
+ 'group_label': value['group_label'],
131
+ 'category': value['category'],
107
132
  'url': value['url'],
108
133
  'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
109
134
  };
@@ -105,6 +105,24 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
105
105
  * @memberof EarningsCallsDocuments200ResponseDocumentsInner
106
106
  */
107
107
  trust_tier: EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum | null;
108
+ /**
109
+ * Folder of the document tree, e.g. earnings/fy2027/q2, events/2026/09-10-<event>, reports/2025, governance, shareholder/tax; null = not placed yet
110
+ * @type {string}
111
+ * @memberof EarningsCallsDocuments200ResponseDocumentsInner
112
+ */
113
+ group: string | null;
114
+ /**
115
+ * Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
116
+ * @type {string}
117
+ * @memberof EarningsCallsDocuments200ResponseDocumentsInner
118
+ */
119
+ group_label: string | null;
120
+ /**
121
+ * Spine folder of the tree: earnings, events, reports, presentations, governance, esg, shareholder, other; null = not placed yet
122
+ * @type {EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum}
123
+ * @memberof EarningsCallsDocuments200ResponseDocumentsInner
124
+ */
125
+ category: EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum | null;
108
126
  /**
109
127
  * Extracted text, capped (only with include=body; null for spreadsheets / link-only rows)
110
128
  * @type {string}
@@ -161,6 +179,20 @@ export declare const EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnu
161
179
  readonly Internal: "internal";
162
180
  };
163
181
  export type EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum = typeof EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum[keyof typeof EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum];
182
+ /**
183
+ * @export
184
+ */
185
+ export declare const EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum: {
186
+ readonly Earnings: "earnings";
187
+ readonly Events: "events";
188
+ readonly Reports: "reports";
189
+ readonly Presentations: "presentations";
190
+ readonly Governance: "governance";
191
+ readonly Esg: "esg";
192
+ readonly Shareholder: "shareholder";
193
+ readonly Other: "other";
194
+ };
195
+ export type EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum = typeof EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum[keyof typeof EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum];
164
196
  /**
165
197
  * Check if a given object implements the EarningsCallsDocuments200ResponseDocumentsInner interface.
166
198
  */
@@ -56,6 +56,19 @@ export const EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum = {
56
56
  Unconfirmed: 'unconfirmed',
57
57
  Internal: 'internal'
58
58
  };
59
+ /**
60
+ * @export
61
+ */
62
+ export const EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum = {
63
+ Earnings: 'earnings',
64
+ Events: 'events',
65
+ Reports: 'reports',
66
+ Presentations: 'presentations',
67
+ Governance: 'governance',
68
+ Esg: 'esg',
69
+ Shareholder: 'shareholder',
70
+ Other: 'other'
71
+ };
59
72
  /**
60
73
  * Check if a given object implements the EarningsCallsDocuments200ResponseDocumentsInner interface.
61
74
  */
@@ -90,6 +103,12 @@ export function instanceOfEarningsCallsDocuments200ResponseDocumentsInner(value)
90
103
  return false;
91
104
  if (!('trust_tier' in value) || value['trust_tier'] === undefined)
92
105
  return false;
106
+ if (!('group' in value) || value['group'] === undefined)
107
+ return false;
108
+ if (!('group_label' in value) || value['group_label'] === undefined)
109
+ return false;
110
+ if (!('category' in value) || value['category'] === undefined)
111
+ return false;
93
112
  return true;
94
113
  }
95
114
  export function EarningsCallsDocuments200ResponseDocumentsInnerFromJSON(json) {
@@ -115,6 +134,9 @@ export function EarningsCallsDocuments200ResponseDocumentsInnerFromJSONTyped(jso
115
134
  'bytes': json['bytes'],
116
135
  'pages': json['pages'],
117
136
  'trust_tier': json['trust_tier'],
137
+ 'group': json['group'],
138
+ 'group_label': json['group_label'],
139
+ 'category': json['category'],
118
140
  'body_text': json['body_text'] == null ? undefined : json['body_text'],
119
141
  };
120
142
  }
@@ -141,6 +163,9 @@ export function EarningsCallsDocuments200ResponseDocumentsInnerToJSONTyped(value
141
163
  'bytes': value['bytes'],
142
164
  'pages': value['pages'],
143
165
  'trust_tier': value['trust_tier'],
166
+ 'group': value['group'],
167
+ 'group_label': value['group_label'],
168
+ 'category': value['category'],
144
169
  'body_text': value['body_text'],
145
170
  };
146
171
  }
@@ -22,11 +22,17 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
22
22
  */
23
23
  document_id: string;
24
24
  /**
25
- * IR site section the document is filed in
25
+ * company = the IR library; call = a document of one earnings call (only with include=calls)
26
+ * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum}
27
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
28
+ */
29
+ source: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum;
30
+ /**
31
+ * IR site section the document is filed in; null on a call document
26
32
  * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum}
27
33
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
28
34
  */
29
- section: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum;
35
+ section: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum | null;
30
36
  /**
31
37
  * Document kind
32
38
  * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum}
@@ -45,6 +51,24 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
45
51
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
46
52
  */
47
53
  period: EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum | null;
54
+ /**
55
+ * Folder of the document tree, e.g. earnings/fy2027/q2, events/2026/09-10-<event>, reports/2025, governance, shareholder/tax; null = not placed yet
56
+ * @type {string}
57
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
58
+ */
59
+ group: string | null;
60
+ /**
61
+ * Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "May 18, 2025 · GTC Taipei 2025" (an event's name)
62
+ * @type {string}
63
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
64
+ */
65
+ group_label: string | null;
66
+ /**
67
+ * Spine folder of the tree: earnings, events, reports, presentations, governance, esg, shareholder, other; null = not placed yet
68
+ * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum}
69
+ * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
70
+ */
71
+ category: EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum | null;
48
72
  /**
49
73
  * The event the document belongs to
50
74
  * @type {string}
@@ -58,7 +82,7 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
58
82
  */
59
83
  event_type: EarningsCallsCompanyDocuments200ResponseDocumentsInnerEventTypeEnum | null;
60
84
  /**
61
- * The item's own date on the site
85
+ * The item's own date on the site (a call document: the call's New York day)
62
86
  * @type {Date}
63
87
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
64
88
  */
@@ -82,13 +106,13 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
82
106
  */
83
107
  source_url: string;
84
108
  /**
85
- * The IR page that listed the document
109
+ * The IR page that listed the document; null on a call document
86
110
  * @type {string}
87
111
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
88
112
  */
89
113
  page_url: string | null;
90
114
  /**
91
- * How the IR section was read
115
+ * How the IR section was read (a call document: where it was found)
92
116
  * @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum}
93
117
  * @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
94
118
  */
@@ -174,6 +198,14 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
174
198
  [key: string]: any;
175
199
  };
176
200
  }
201
+ /**
202
+ * @export
203
+ */
204
+ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum: {
205
+ readonly Company: "company";
206
+ readonly Call: "call";
207
+ };
208
+ export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum];
177
209
  /**
178
210
  * @export
179
211
  */
@@ -214,6 +246,7 @@ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindE
214
246
  readonly Webcast: "webcast";
215
247
  readonly Other: "other";
216
248
  readonly PreparedRemarks: "prepared_remarks";
249
+ readonly SecFiling: "sec_filing";
217
250
  };
218
251
  export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum];
219
252
  /**
@@ -229,6 +262,20 @@ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerPerio
229
262
  readonly Fy: "FY";
230
263
  };
231
264
  export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum];
265
+ /**
266
+ * @export
267
+ */
268
+ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum: {
269
+ readonly Earnings: "earnings";
270
+ readonly Events: "events";
271
+ readonly Reports: "reports";
272
+ readonly Presentations: "presentations";
273
+ readonly Governance: "governance";
274
+ readonly Esg: "esg";
275
+ readonly Shareholder: "shareholder";
276
+ readonly Other: "other";
277
+ };
278
+ export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum];
232
279
  /**
233
280
  * @export
234
281
  */
@@ -250,6 +297,13 @@ export declare const EarningsCallsCompanyDocuments200ResponseDocumentsInnerOrigi
250
297
  readonly JsonFeed: "json_feed";
251
298
  readonly HtmlPage: "html_page";
252
299
  readonly Agent: "agent";
300
+ readonly Q4Reports: "q4_reports";
301
+ readonly Q4Event: "q4_event";
302
+ readonly EdgarExhibit: "edgar_exhibit";
303
+ readonly EdgarFiling: "edgar_filing";
304
+ readonly IrListing: "ir_listing";
305
+ readonly PlaybookPattern: "playbook_pattern";
306
+ readonly AgentArchive: "agent_archive";
253
307
  };
254
308
  export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum];
255
309
  /**