@invinite-org/data-api-client 5.7.0 → 5.9.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.
- package/dist/apis/EventsApi.d.ts +2 -2
- package/dist/apis/EventsApi.js +2 -2
- package/dist/esm/apis/EventsApi.d.ts +2 -2
- package/dist/esm/apis/EventsApi.js +2 -2
- package/dist/esm/models/Event.d.ts +2 -1
- package/dist/esm/models/Event.js +2 -1
- package/dist/esm/models/EventCalendarCall.d.ts +2 -1
- package/dist/esm/models/EventCalendarCall.js +1 -0
- package/dist/models/Event.d.ts +2 -1
- package/dist/models/Event.js +2 -1
- package/dist/models/EventCalendarCall.d.ts +2 -1
- package/dist/models/EventCalendarCall.js +1 -0
- package/docs/EventsApi.md +1 -1
- package/package.json +1 -1
- package/src/apis/EventsApi.ts +2 -2
- package/src/models/Event.ts +3 -2
- package/src/models/EventCalendarCall.ts +2 -1
package/dist/apis/EventsApi.d.ts
CHANGED
|
@@ -138,12 +138,12 @@ export declare class EventsApi extends runtime.BaseAPI {
|
|
|
138
138
|
*/
|
|
139
139
|
listEventsRequestOpts(requestParameters: ListEventsRequest): Promise<runtime.RequestOpts>;
|
|
140
140
|
/**
|
|
141
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
141
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
142
142
|
* List events
|
|
143
143
|
*/
|
|
144
144
|
listEventsRaw(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEvents200Response>>;
|
|
145
145
|
/**
|
|
146
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
146
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
147
147
|
* List events
|
|
148
148
|
*/
|
|
149
149
|
listEvents(requestParameters?: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEvents200Response>;
|
package/dist/apis/EventsApi.js
CHANGED
|
@@ -356,7 +356,7 @@ class EventsApi extends runtime.BaseAPI {
|
|
|
356
356
|
});
|
|
357
357
|
}
|
|
358
358
|
/**
|
|
359
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
359
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
360
360
|
* List events
|
|
361
361
|
*/
|
|
362
362
|
listEventsRaw(requestParameters, initOverrides) {
|
|
@@ -367,7 +367,7 @@ class EventsApi extends runtime.BaseAPI {
|
|
|
367
367
|
});
|
|
368
368
|
}
|
|
369
369
|
/**
|
|
370
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
370
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
371
371
|
* List events
|
|
372
372
|
*/
|
|
373
373
|
listEvents() {
|
|
@@ -138,12 +138,12 @@ export declare class EventsApi extends runtime.BaseAPI {
|
|
|
138
138
|
*/
|
|
139
139
|
listEventsRequestOpts(requestParameters: ListEventsRequest): Promise<runtime.RequestOpts>;
|
|
140
140
|
/**
|
|
141
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
141
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
142
142
|
* List events
|
|
143
143
|
*/
|
|
144
144
|
listEventsRaw(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEvents200Response>>;
|
|
145
145
|
/**
|
|
146
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
146
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
147
147
|
* List events
|
|
148
148
|
*/
|
|
149
149
|
listEvents(requestParameters?: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEvents200Response>;
|
|
@@ -353,7 +353,7 @@ export class EventsApi extends runtime.BaseAPI {
|
|
|
353
353
|
});
|
|
354
354
|
}
|
|
355
355
|
/**
|
|
356
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
356
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
357
357
|
* List events
|
|
358
358
|
*/
|
|
359
359
|
listEventsRaw(requestParameters, initOverrides) {
|
|
@@ -364,7 +364,7 @@ export class EventsApi extends runtime.BaseAPI {
|
|
|
364
364
|
});
|
|
365
365
|
}
|
|
366
366
|
/**
|
|
367
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
367
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
368
368
|
* List events
|
|
369
369
|
*/
|
|
370
370
|
listEvents() {
|
|
@@ -183,7 +183,7 @@ export interface Event {
|
|
|
183
183
|
*/
|
|
184
184
|
has_documents: boolean;
|
|
185
185
|
/**
|
|
186
|
-
* Webcast page of an upcoming dated call; null once published
|
|
186
|
+
* Webcast page of an upcoming dated call; null once published and for a `not_covered` call (`calendar.call.status`)
|
|
187
187
|
* @type {string}
|
|
188
188
|
* @memberof Event
|
|
189
189
|
*/
|
|
@@ -273,6 +273,7 @@ export declare const EventExpiredReasonEnum: {
|
|
|
273
273
|
readonly AgentDifferentDate: "agent_different_date";
|
|
274
274
|
readonly AgentNoWebcast: "agent_no_webcast";
|
|
275
275
|
readonly SupersededByReschedule: "superseded_by_reschedule";
|
|
276
|
+
readonly ResultsWithoutCall: "results_without_call";
|
|
276
277
|
};
|
|
277
278
|
export type EventExpiredReasonEnum = typeof EventExpiredReasonEnum[keyof typeof EventExpiredReasonEnum] | (string & {});
|
|
278
279
|
/**
|
package/dist/esm/models/Event.js
CHANGED
|
@@ -65,7 +65,8 @@ export const EventExpiredReasonEnum = {
|
|
|
65
65
|
SupersededEstimate: 'superseded_estimate',
|
|
66
66
|
AgentDifferentDate: 'agent_different_date',
|
|
67
67
|
AgentNoWebcast: 'agent_no_webcast',
|
|
68
|
-
SupersededByReschedule: 'superseded_by_reschedule'
|
|
68
|
+
SupersededByReschedule: 'superseded_by_reschedule',
|
|
69
|
+
ResultsWithoutCall: 'results_without_call'
|
|
69
70
|
};
|
|
70
71
|
/**
|
|
71
72
|
* Check if a given object implements the Event interface.
|
|
@@ -17,7 +17,7 @@ import type { EventCalendarCallSource } from './EventCalendarCallSource';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface EventCalendarCall {
|
|
19
19
|
/**
|
|
20
|
-
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer)
|
|
20
|
+
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer), not_covered (a reported quarter of a call issuer that our coverage never saw: the call was likely held, we have no record). Clients must accept unknown enum values.
|
|
21
21
|
* @type {EventCalendarCallStatusEnum}
|
|
22
22
|
* @memberof EventCalendarCall
|
|
23
23
|
*/
|
|
@@ -63,6 +63,7 @@ export declare const EventCalendarCallStatusEnum: {
|
|
|
63
63
|
readonly NoCall: "no_call";
|
|
64
64
|
readonly Expired: "expired";
|
|
65
65
|
readonly NotExpected: "not_expected";
|
|
66
|
+
readonly NotCovered: "not_covered";
|
|
66
67
|
readonly Confirmed: "confirmed";
|
|
67
68
|
readonly Announced: "announced";
|
|
68
69
|
readonly Estimated: "estimated";
|
package/dist/models/Event.d.ts
CHANGED
|
@@ -183,7 +183,7 @@ export interface Event {
|
|
|
183
183
|
*/
|
|
184
184
|
has_documents: boolean;
|
|
185
185
|
/**
|
|
186
|
-
* Webcast page of an upcoming dated call; null once published
|
|
186
|
+
* Webcast page of an upcoming dated call; null once published and for a `not_covered` call (`calendar.call.status`)
|
|
187
187
|
* @type {string}
|
|
188
188
|
* @memberof Event
|
|
189
189
|
*/
|
|
@@ -273,6 +273,7 @@ export declare const EventExpiredReasonEnum: {
|
|
|
273
273
|
readonly AgentDifferentDate: "agent_different_date";
|
|
274
274
|
readonly AgentNoWebcast: "agent_no_webcast";
|
|
275
275
|
readonly SupersededByReschedule: "superseded_by_reschedule";
|
|
276
|
+
readonly ResultsWithoutCall: "results_without_call";
|
|
276
277
|
};
|
|
277
278
|
export type EventExpiredReasonEnum = typeof EventExpiredReasonEnum[keyof typeof EventExpiredReasonEnum] | (string & {});
|
|
278
279
|
/**
|
package/dist/models/Event.js
CHANGED
|
@@ -73,7 +73,8 @@ exports.EventExpiredReasonEnum = {
|
|
|
73
73
|
SupersededEstimate: 'superseded_estimate',
|
|
74
74
|
AgentDifferentDate: 'agent_different_date',
|
|
75
75
|
AgentNoWebcast: 'agent_no_webcast',
|
|
76
|
-
SupersededByReschedule: 'superseded_by_reschedule'
|
|
76
|
+
SupersededByReschedule: 'superseded_by_reschedule',
|
|
77
|
+
ResultsWithoutCall: 'results_without_call'
|
|
77
78
|
};
|
|
78
79
|
/**
|
|
79
80
|
* Check if a given object implements the Event interface.
|
|
@@ -17,7 +17,7 @@ import type { EventCalendarCallSource } from './EventCalendarCallSource';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface EventCalendarCall {
|
|
19
19
|
/**
|
|
20
|
-
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer)
|
|
20
|
+
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer), not_covered (a reported quarter of a call issuer that our coverage never saw: the call was likely held, we have no record). Clients must accept unknown enum values.
|
|
21
21
|
* @type {EventCalendarCallStatusEnum}
|
|
22
22
|
* @memberof EventCalendarCall
|
|
23
23
|
*/
|
|
@@ -63,6 +63,7 @@ export declare const EventCalendarCallStatusEnum: {
|
|
|
63
63
|
readonly NoCall: "no_call";
|
|
64
64
|
readonly Expired: "expired";
|
|
65
65
|
readonly NotExpected: "not_expected";
|
|
66
|
+
readonly NotCovered: "not_covered";
|
|
66
67
|
readonly Confirmed: "confirmed";
|
|
67
68
|
readonly Announced: "announced";
|
|
68
69
|
readonly Estimated: "estimated";
|
package/docs/EventsApi.md
CHANGED
|
@@ -432,7 +432,7 @@ example().catch(console.error);
|
|
|
432
432
|
|
|
433
433
|
List events
|
|
434
434
|
|
|
435
|
-
Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
435
|
+
Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
436
436
|
|
|
437
437
|
### Example
|
|
438
438
|
|
package/package.json
CHANGED
package/src/apis/EventsApi.ts
CHANGED
|
@@ -487,7 +487,7 @@ export class EventsApi extends runtime.BaseAPI {
|
|
|
487
487
|
}
|
|
488
488
|
|
|
489
489
|
/**
|
|
490
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
490
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
491
491
|
* List events
|
|
492
492
|
*/
|
|
493
493
|
async listEventsRaw(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEvents200Response>> {
|
|
@@ -498,7 +498,7 @@ export class EventsApi extends runtime.BaseAPI {
|
|
|
498
498
|
}
|
|
499
499
|
|
|
500
500
|
/**
|
|
501
|
-
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
|
|
501
|
+
* Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
|
|
502
502
|
* List events
|
|
503
503
|
*/
|
|
504
504
|
async listEvents(requestParameters: ListEventsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEvents200Response> {
|
package/src/models/Event.ts
CHANGED
|
@@ -218,7 +218,7 @@ export interface Event {
|
|
|
218
218
|
*/
|
|
219
219
|
has_documents: boolean;
|
|
220
220
|
/**
|
|
221
|
-
* Webcast page of an upcoming dated call; null once published
|
|
221
|
+
* Webcast page of an upcoming dated call; null once published and for a `not_covered` call (`calendar.call.status`)
|
|
222
222
|
* @type {string}
|
|
223
223
|
* @memberof Event
|
|
224
224
|
*/
|
|
@@ -313,7 +313,8 @@ export const EventExpiredReasonEnum = {
|
|
|
313
313
|
SupersededEstimate: 'superseded_estimate',
|
|
314
314
|
AgentDifferentDate: 'agent_different_date',
|
|
315
315
|
AgentNoWebcast: 'agent_no_webcast',
|
|
316
|
-
SupersededByReschedule: 'superseded_by_reschedule'
|
|
316
|
+
SupersededByReschedule: 'superseded_by_reschedule',
|
|
317
|
+
ResultsWithoutCall: 'results_without_call'
|
|
317
318
|
} as const;
|
|
318
319
|
export type EventExpiredReasonEnum = typeof EventExpiredReasonEnum[keyof typeof EventExpiredReasonEnum] | (string & {});
|
|
319
320
|
|
|
@@ -28,7 +28,7 @@ import {
|
|
|
28
28
|
*/
|
|
29
29
|
export interface EventCalendarCall {
|
|
30
30
|
/**
|
|
31
|
-
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer)
|
|
31
|
+
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer), not_covered (a reported quarter of a call issuer that our coverage never saw: the call was likely held, we have no record). Clients must accept unknown enum values.
|
|
32
32
|
* @type {EventCalendarCallStatusEnum}
|
|
33
33
|
* @memberof EventCalendarCall
|
|
34
34
|
*/
|
|
@@ -76,6 +76,7 @@ export const EventCalendarCallStatusEnum = {
|
|
|
76
76
|
NoCall: 'no_call',
|
|
77
77
|
Expired: 'expired',
|
|
78
78
|
NotExpected: 'not_expected',
|
|
79
|
+
NotCovered: 'not_covered',
|
|
79
80
|
Confirmed: 'confirmed',
|
|
80
81
|
Announced: 'announced',
|
|
81
82
|
Estimated: 'estimated'
|