@invinite-org/data-api-client 0.1.0 → 0.2.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 (43) 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/AccountApi.md +1 -1
  19. package/docs/AsReportedBalanceSheetApi.md +16 -16
  20. package/docs/AsReportedCashFlowStatementApi.md +16 -16
  21. package/docs/AsReportedIncomeStatementApi.md +16 -16
  22. package/docs/AsReportedSnapshotApi.md +13 -13
  23. package/docs/CompanyApi.md +18 -18
  24. package/docs/EarningsCallsApi.md +210 -189
  25. package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +8 -0
  26. package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
  27. package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +6 -0
  28. package/docs/FinancialMetricsApi.md +17 -17
  29. package/docs/IPOsApi.md +5 -5
  30. package/docs/InsiderTradesApi.md +7 -7
  31. package/docs/InstitutionalOwnershipApi.md +23 -23
  32. package/docs/MarketApi.md +3 -3
  33. package/docs/SECFilingsApi.md +15 -15
  34. package/docs/SegmentedFinancialsApi.md +12 -12
  35. package/docs/StandardizedBalanceSheetApi.md +16 -16
  36. package/docs/StandardizedCashFlowStatementApi.md +16 -16
  37. package/docs/StandardizedIncomeStatementApi.md +16 -16
  38. package/docs/StandardizedSnapshotApi.md +13 -13
  39. package/package.json +4 -4
  40. package/src/apis/EarningsCallsApi.ts +48 -6
  41. package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +75 -7
  42. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +42 -0
  43. package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +42 -0
@@ -13,12 +13,19 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerLinkStatusEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerTrustTierEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerConfidenceEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerEventTypeEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum = void 0;
16
+ exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerLinkStatusEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerTrustTierEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerConfidenceEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerEventTypeEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum = exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum = void 0;
17
17
  exports.instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner = instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner;
18
18
  exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSON = EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSON;
19
19
  exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTyped = EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTyped;
20
20
  exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSON = EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSON;
21
21
  exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONTyped = EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum = {
26
+ Company: 'company',
27
+ Call: 'call'
28
+ };
22
29
  /**
23
30
  * @export
24
31
  */
@@ -57,7 +64,8 @@ exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum = {
57
64
  Infographic: 'infographic',
58
65
  Webcast: 'webcast',
59
66
  Other: 'other',
60
- PreparedRemarks: 'prepared_remarks'
67
+ PreparedRemarks: 'prepared_remarks',
68
+ SecFiling: 'sec_filing'
61
69
  };
62
70
  /**
63
71
  * @export
@@ -71,6 +79,19 @@ exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum = {
71
79
  H2: 'H2',
72
80
  Fy: 'FY'
73
81
  };
82
+ /**
83
+ * @export
84
+ */
85
+ exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum = {
86
+ Earnings: 'earnings',
87
+ Events: 'events',
88
+ Reports: 'reports',
89
+ Presentations: 'presentations',
90
+ Governance: 'governance',
91
+ Esg: 'esg',
92
+ Shareholder: 'shareholder',
93
+ Other: 'other'
94
+ };
74
95
  /**
75
96
  * @export
76
97
  */
@@ -90,7 +111,14 @@ exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum = {
90
111
  NotifiedListing: 'notified_listing',
91
112
  JsonFeed: 'json_feed',
92
113
  HtmlPage: 'html_page',
93
- Agent: 'agent'
114
+ Agent: 'agent',
115
+ Q4Reports: 'q4_reports',
116
+ Q4Event: 'q4_event',
117
+ EdgarExhibit: 'edgar_exhibit',
118
+ EdgarFiling: 'edgar_filing',
119
+ IrListing: 'ir_listing',
120
+ PlaybookPattern: 'playbook_pattern',
121
+ AgentArchive: 'agent_archive'
94
122
  };
95
123
  /**
96
124
  * @export
@@ -123,6 +151,8 @@ exports.EarningsCallsCompanyDocuments200ResponseDocumentsInnerLinkStatusEnum = {
123
151
  function instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner(value) {
124
152
  if (!('document_id' in value) || value['document_id'] === undefined)
125
153
  return false;
154
+ if (!('source' in value) || value['source'] === undefined)
155
+ return false;
126
156
  if (!('section' in value) || value['section'] === undefined)
127
157
  return false;
128
158
  if (!('kind' in value) || value['kind'] === undefined)
@@ -131,6 +161,12 @@ function instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner(value)
131
161
  return false;
132
162
  if (!('period' in value) || value['period'] === undefined)
133
163
  return false;
164
+ if (!('group' in value) || value['group'] === undefined)
165
+ return false;
166
+ if (!('group_label' in value) || value['group_label'] === undefined)
167
+ return false;
168
+ if (!('category' in value) || value['category'] === undefined)
169
+ return false;
134
170
  if (!('event_id' in value) || value['event_id'] === undefined)
135
171
  return false;
136
172
  if (!('event_type' in value) || value['event_type'] === undefined)
@@ -182,10 +218,14 @@ function EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTyped(jso
182
218
  }
183
219
  return {
184
220
  'document_id': json['document_id'],
221
+ 'source': json['source'],
185
222
  'section': json['section'],
186
223
  'kind': json['kind'],
187
224
  'year': json['year'],
188
225
  'period': json['period'],
226
+ 'group': json['group'],
227
+ 'group_label': json['group_label'],
228
+ 'category': json['category'],
189
229
  'event_id': json['event_id'],
190
230
  'event_type': json['event_type'],
191
231
  'event_date': (json['event_date'] == null ? null : new Date(json['event_date'])),
@@ -218,10 +258,14 @@ function EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONTyped(value
218
258
  }
219
259
  return {
220
260
  'document_id': value['document_id'],
261
+ 'source': value['source'],
221
262
  'section': value['section'],
222
263
  'kind': value['kind'],
223
264
  'year': value['year'],
224
265
  'period': value['period'],
266
+ 'group': value['group'],
267
+ 'group_label': value['group_label'],
268
+ 'category': value['category'],
225
269
  'event_id': value['event_id'],
226
270
  'event_type': value['event_type'],
227
271
  '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", "Shareholder · Tax"
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
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum = void 0;
16
+ exports.EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = exports.EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum = void 0;
17
17
  exports.instanceOfEarningsCallsDocumentSearch200ResponseHitsInner = instanceOfEarningsCallsDocumentSearch200ResponseHitsInner;
18
18
  exports.EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON = EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON;
19
19
  exports.EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped = EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped;
@@ -26,6 +26,19 @@ exports.EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum = {
26
26
  EventDocuments: 'event_documents',
27
27
  CompanyDocuments: 'company_documents'
28
28
  };
29
+ /**
30
+ * @export
31
+ */
32
+ exports.EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = {
33
+ Earnings: 'earnings',
34
+ Events: 'events',
35
+ Reports: 'reports',
36
+ Presentations: 'presentations',
37
+ Governance: 'governance',
38
+ Esg: 'esg',
39
+ Shareholder: 'shareholder',
40
+ Other: 'other'
41
+ };
29
42
  /**
30
43
  * Check if a given object implements the EarningsCallsDocumentSearch200ResponseHitsInner interface.
31
44
  */
@@ -58,6 +71,12 @@ function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value) {
58
71
  return false;
59
72
  if (!('title' in value) || value['title'] === undefined)
60
73
  return false;
74
+ if (!('group' in value) || value['group'] === undefined)
75
+ return false;
76
+ if (!('group_label' in value) || value['group_label'] === undefined)
77
+ return false;
78
+ if (!('category' in value) || value['category'] === undefined)
79
+ return false;
61
80
  if (!('url' in value) || value['url'] === undefined)
62
81
  return false;
63
82
  if (!('expires_at' in value) || value['expires_at'] === undefined)
@@ -86,6 +105,9 @@ function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(json, igno
86
105
  'heading': json['heading'],
87
106
  'text': json['text'],
88
107
  'title': json['title'],
108
+ 'group': json['group'],
109
+ 'group_label': json['group_label'],
110
+ 'category': json['category'],
89
111
  'url': json['url'],
90
112
  'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
91
113
  };
@@ -112,6 +134,9 @@ function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value, ignor
112
134
  'heading': value['heading'],
113
135
  'text': value['text'],
114
136
  'title': value['title'],
137
+ 'group': value['group'],
138
+ 'group_label': value['group_label'],
139
+ 'category': value['category'],
115
140
  'url': value['url'],
116
141
  'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
117
142
  };
@@ -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", "Shareholder · Tax"
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
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum = exports.EarningsCallsDocuments200ResponseDocumentsInnerOriginEnum = exports.EarningsCallsDocuments200ResponseDocumentsInnerConfidenceEnum = exports.EarningsCallsDocuments200ResponseDocumentsInnerKindEnum = void 0;
16
+ exports.EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum = exports.EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum = exports.EarningsCallsDocuments200ResponseDocumentsInnerOriginEnum = exports.EarningsCallsDocuments200ResponseDocumentsInnerConfidenceEnum = exports.EarningsCallsDocuments200ResponseDocumentsInnerKindEnum = void 0;
17
17
  exports.instanceOfEarningsCallsDocuments200ResponseDocumentsInner = instanceOfEarningsCallsDocuments200ResponseDocumentsInner;
18
18
  exports.EarningsCallsDocuments200ResponseDocumentsInnerFromJSON = EarningsCallsDocuments200ResponseDocumentsInnerFromJSON;
19
19
  exports.EarningsCallsDocuments200ResponseDocumentsInnerFromJSONTyped = EarningsCallsDocuments200ResponseDocumentsInnerFromJSONTyped;
@@ -64,6 +64,19 @@ exports.EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum = {
64
64
  Unconfirmed: 'unconfirmed',
65
65
  Internal: 'internal'
66
66
  };
67
+ /**
68
+ * @export
69
+ */
70
+ exports.EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum = {
71
+ Earnings: 'earnings',
72
+ Events: 'events',
73
+ Reports: 'reports',
74
+ Presentations: 'presentations',
75
+ Governance: 'governance',
76
+ Esg: 'esg',
77
+ Shareholder: 'shareholder',
78
+ Other: 'other'
79
+ };
67
80
  /**
68
81
  * Check if a given object implements the EarningsCallsDocuments200ResponseDocumentsInner interface.
69
82
  */
@@ -98,6 +111,12 @@ function instanceOfEarningsCallsDocuments200ResponseDocumentsInner(value) {
98
111
  return false;
99
112
  if (!('trust_tier' in value) || value['trust_tier'] === undefined)
100
113
  return false;
114
+ if (!('group' in value) || value['group'] === undefined)
115
+ return false;
116
+ if (!('group_label' in value) || value['group_label'] === undefined)
117
+ return false;
118
+ if (!('category' in value) || value['category'] === undefined)
119
+ return false;
101
120
  return true;
102
121
  }
103
122
  function EarningsCallsDocuments200ResponseDocumentsInnerFromJSON(json) {
@@ -123,6 +142,9 @@ function EarningsCallsDocuments200ResponseDocumentsInnerFromJSONTyped(json, igno
123
142
  'bytes': json['bytes'],
124
143
  'pages': json['pages'],
125
144
  'trust_tier': json['trust_tier'],
145
+ 'group': json['group'],
146
+ 'group_label': json['group_label'],
147
+ 'category': json['category'],
126
148
  'body_text': json['body_text'] == null ? undefined : json['body_text'],
127
149
  };
128
150
  }
@@ -149,6 +171,9 @@ function EarningsCallsDocuments200ResponseDocumentsInnerToJSONTyped(value, ignor
149
171
  'bytes': value['bytes'],
150
172
  'pages': value['pages'],
151
173
  'trust_tier': value['trust_tier'],
174
+ 'group': value['group'],
175
+ 'group_label': value['group_label'],
176
+ 'category': value['category'],
152
177
  'body_text': value['body_text'],
153
178
  };
154
179
  }
@@ -35,7 +35,7 @@ async function example() {
35
35
 
36
36
  const body = {
37
37
  // 7 | 30 | 90 | Window in UTC days ending today (inclusive): 7, 30 or 90 (optional)
38
- days: 56,
38
+ days: 30,
39
39
  } satisfies AccountUsageRequest;
40
40
 
41
41
  try {
@@ -37,15 +37,15 @@ async function example() {
37
37
 
38
38
  const body = {
39
39
  // string | Ticker symbol or CIK
40
- identifier: identifier_example,
40
+ identifier: AAPL,
41
41
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
42
- fiscalPeriodType: fiscalPeriodType_example,
42
+ fiscalPeriodType: annual,
43
43
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
44
- sort: sort_example,
44
+ sort: desc,
45
45
  // number | Maximum number of periods per ticker (optional)
46
- limit: 56,
46
+ limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
- offset: 56,
48
+ offset: 0,
49
49
  } satisfies AsReportedBalanceSheetRequest;
50
50
 
51
51
  try {
@@ -124,17 +124,17 @@ async function example() {
124
124
 
125
125
  const body = {
126
126
  // string | Ticker symbol or CIK
127
- identifier: identifier_example,
127
+ identifier: AAPL,
128
128
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
129
- fiscalPeriodType: fiscalPeriodType_example,
129
+ fiscalPeriodType: annual,
130
130
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
131
- sort: sort_example,
131
+ sort: desc,
132
132
  // number | Maximum number of periods per ticker (optional)
133
- limit: 56,
133
+ limit: 5,
134
134
  // number | Number of periods to skip for pagination (optional)
135
- offset: 56,
135
+ offset: 0,
136
136
  // 'true' | 'false' | Include formula in response (optional)
137
- withFormula: withFormula_example,
137
+ withFormula: true,
138
138
  } satisfies AsReportedBalanceSheetDetailedRequest;
139
139
 
140
140
  try {
@@ -214,15 +214,15 @@ async function example() {
214
214
 
215
215
  const body = {
216
216
  // string | Ticker symbol or CIK
217
- identifier: identifier_example,
217
+ identifier: AAPL,
218
218
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
219
- fiscalPeriodType: fiscalPeriodType_example,
219
+ fiscalPeriodType: annual,
220
220
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
221
- sort: sort_example,
221
+ sort: desc,
222
222
  // number | Maximum number of periods per ticker (optional)
223
- limit: 56,
223
+ limit: 5,
224
224
  // number | Number of periods to skip for pagination (optional)
225
- offset: 56,
225
+ offset: 0,
226
226
  } satisfies AsReportedBalanceSheetPresentationRequest;
227
227
 
228
228
  try {
@@ -37,15 +37,15 @@ async function example() {
37
37
 
38
38
  const body = {
39
39
  // string | Ticker symbol or CIK
40
- identifier: identifier_example,
40
+ identifier: AAPL,
41
41
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
42
- fiscalPeriodType: fiscalPeriodType_example,
42
+ fiscalPeriodType: annual,
43
43
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
44
- sort: sort_example,
44
+ sort: desc,
45
45
  // number | Maximum number of periods per ticker (optional)
46
- limit: 56,
46
+ limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
- offset: 56,
48
+ offset: 0,
49
49
  } satisfies AsReportedCashFlowStatementRequest;
50
50
 
51
51
  try {
@@ -124,17 +124,17 @@ async function example() {
124
124
 
125
125
  const body = {
126
126
  // string | Ticker symbol or CIK
127
- identifier: identifier_example,
127
+ identifier: AAPL,
128
128
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
129
- fiscalPeriodType: fiscalPeriodType_example,
129
+ fiscalPeriodType: annual,
130
130
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
131
- sort: sort_example,
131
+ sort: desc,
132
132
  // number | Maximum number of periods per ticker (optional)
133
- limit: 56,
133
+ limit: 5,
134
134
  // number | Number of periods to skip for pagination (optional)
135
- offset: 56,
135
+ offset: 0,
136
136
  // 'true' | 'false' | Include formula in response (optional)
137
- withFormula: withFormula_example,
137
+ withFormula: true,
138
138
  } satisfies AsReportedCashFlowStatementDetailedRequest;
139
139
 
140
140
  try {
@@ -214,15 +214,15 @@ async function example() {
214
214
 
215
215
  const body = {
216
216
  // string | Ticker symbol or CIK
217
- identifier: identifier_example,
217
+ identifier: AAPL,
218
218
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
219
- fiscalPeriodType: fiscalPeriodType_example,
219
+ fiscalPeriodType: annual,
220
220
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
221
- sort: sort_example,
221
+ sort: desc,
222
222
  // number | Maximum number of periods per ticker (optional)
223
- limit: 56,
223
+ limit: 5,
224
224
  // number | Number of periods to skip for pagination (optional)
225
- offset: 56,
225
+ offset: 0,
226
226
  } satisfies AsReportedCashFlowStatementPresentationRequest;
227
227
 
228
228
  try {
@@ -37,15 +37,15 @@ async function example() {
37
37
 
38
38
  const body = {
39
39
  // string | Ticker symbol or CIK
40
- identifier: identifier_example,
40
+ identifier: AAPL,
41
41
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
42
- fiscalPeriodType: fiscalPeriodType_example,
42
+ fiscalPeriodType: annual,
43
43
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
44
- sort: sort_example,
44
+ sort: desc,
45
45
  // number | Maximum number of periods per ticker (optional)
46
- limit: 56,
46
+ limit: 5,
47
47
  // number | Number of periods to skip for pagination (optional)
48
- offset: 56,
48
+ offset: 0,
49
49
  } satisfies AsReportedIncomeStatementRequest;
50
50
 
51
51
  try {
@@ -124,17 +124,17 @@ async function example() {
124
124
 
125
125
  const body = {
126
126
  // string | Ticker symbol or CIK
127
- identifier: identifier_example,
127
+ identifier: AAPL,
128
128
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
129
- fiscalPeriodType: fiscalPeriodType_example,
129
+ fiscalPeriodType: annual,
130
130
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
131
- sort: sort_example,
131
+ sort: desc,
132
132
  // number | Maximum number of periods per ticker (optional)
133
- limit: 56,
133
+ limit: 5,
134
134
  // number | Number of periods to skip for pagination (optional)
135
- offset: 56,
135
+ offset: 0,
136
136
  // 'true' | 'false' | Include formula in response (optional)
137
- withFormula: withFormula_example,
137
+ withFormula: true,
138
138
  } satisfies AsReportedIncomeStatementDetailedRequest;
139
139
 
140
140
  try {
@@ -214,15 +214,15 @@ async function example() {
214
214
 
215
215
  const body = {
216
216
  // string | Ticker symbol or CIK
217
- identifier: identifier_example,
217
+ identifier: AAPL,
218
218
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
219
- fiscalPeriodType: fiscalPeriodType_example,
219
+ fiscalPeriodType: annual,
220
220
  // 'asc' | 'desc' | Sort direction for periods by period_end (optional)
221
- sort: sort_example,
221
+ sort: desc,
222
222
  // number | Maximum number of periods per ticker (optional)
223
- limit: 56,
223
+ limit: 5,
224
224
  // number | Number of periods to skip for pagination (optional)
225
- offset: 56,
225
+ offset: 0,
226
226
  } satisfies AsReportedIncomeStatementPresentationRequest;
227
227
 
228
228
  try {
@@ -37,13 +37,13 @@ async function example() {
37
37
 
38
38
  const body = {
39
39
  // string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
40
- identifiers: identifiers_example,
40
+ identifiers: AAPL,MSFT,
41
41
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
42
- fiscalPeriodType: fiscalPeriodType_example,
42
+ fiscalPeriodType: annual,
43
43
  // number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
44
- calendarYear: 56,
44
+ calendarYear: 2024,
45
45
  // number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
46
- calendarQuarter: 56,
46
+ calendarQuarter: 4,
47
47
  } satisfies AsReportedSnapshotRequest;
48
48
 
49
49
  try {
@@ -121,15 +121,15 @@ async function example() {
121
121
 
122
122
  const body = {
123
123
  // string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
124
- identifiers: identifiers_example,
124
+ identifiers: AAPL,MSFT,
125
125
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
126
- fiscalPeriodType: fiscalPeriodType_example,
126
+ fiscalPeriodType: annual,
127
127
  // number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
128
- calendarYear: 56,
128
+ calendarYear: 2024,
129
129
  // number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
130
- calendarQuarter: 56,
130
+ calendarQuarter: 4,
131
131
  // 'true' | 'false' | Include formula in response (optional)
132
- withFormula: withFormula_example,
132
+ withFormula: true,
133
133
  } satisfies AsReportedSnapshotDetailedRequest;
134
134
 
135
135
  try {
@@ -208,13 +208,13 @@ async function example() {
208
208
 
209
209
  const body = {
210
210
  // string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
211
- identifiers: identifiers_example,
211
+ identifiers: AAPL,MSFT,
212
212
  // 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
213
- fiscalPeriodType: fiscalPeriodType_example,
213
+ fiscalPeriodType: annual,
214
214
  // number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
215
- calendarYear: 56,
215
+ calendarYear: 2024,
216
216
  // number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
217
- calendarQuarter: 56,
217
+ calendarQuarter: 4,
218
218
  } satisfies AsReportedSnapshotPresentationRequest;
219
219
 
220
220
  try {