@@ -31,12 +31,25 @@ export class News extends APIResource {
3131}
3232
3333export interface NewsSearchResponse {
34+ /**
35+ * Articles matching the search, in the requested order.
36+ */
3437 data : Array < NewsSearchResponse . Data > ;
3538
39+ /**
40+ * True when more results are available beyond this page.
41+ */
3642 has_more : boolean ;
3743
44+ /**
45+ * Summary information about this response.
46+ */
3847 meta : NewsSearchResponse . Meta ;
3948
49+ /**
50+ * Pass as cursor in the next request to fetch the following page. Null when there
51+ * are no more results.
52+ */
4053 next_cursor : string | null ;
4154
4255 /**
@@ -48,54 +61,117 @@ export interface NewsSearchResponse {
4861
4962export namespace NewsSearchResponse {
5063 export interface Data {
64+ /**
65+ * Stable unique identifier for this article. Use it to deduplicate or reference an
66+ * article across requests.
67+ */
5168 id : string ;
5269
70+ /**
71+ * Bylined authors. Empty when no byline is available.
72+ */
5373 authors : Array < string > ;
5474
75+ /**
76+ * Short summary or excerpt of the article, when the publisher provides one.
77+ */
5578 description : string | null ;
5679
80+ /**
81+ * Lead image for the article, when one is available.
82+ */
5783 image_url : string | null ;
5884
85+ /**
86+ * Language the article is written in, as a lowercase ISO 639-1 code such as en.
87+ * Null when unknown.
88+ */
5989 language : string | null ;
6090
91+ /**
92+ * How the article relates to the company you searched for.
93+ */
6194 match : Data . Match ;
6295
96+ /**
97+ * When the article was published, as an ISO 8601 timestamp. Null when the
98+ * publisher does not state a reliable date.
99+ */
63100 published_at : string | null ;
64101
102+ /**
103+ * The publication that published the article.
104+ */
65105 source : Data . Source ;
66106
67107 /**
68- * Groups matching normalized headlines published on the same UTC day.
108+ * Shared by articles covering the same story on the same day. Use it to group or
109+ * collapse syndicated copies of one announcement across outlets.
69110 */
70111 story_id : string ;
71112
113+ /**
114+ * Article headline.
115+ */
72116 title : string ;
73117
118+ /**
119+ * Kind of coverage. Use it to separate independent reporting (editorial) from
120+ * company-issued content (press_release, regulatory_filing, advisory).
121+ */
74122 type : 'editorial' | 'press_release' | 'regulatory_filing' | 'advisory' ;
75123
124+ /**
125+ * Link to the article on the publisher site.
126+ */
76127 url : string ;
77128 }
78129
79130 export namespace Data {
131+ /**
132+ * How the article relates to the company you searched for.
133+ */
80134 export interface Match {
135+ /**
136+ * How confident the match is, from 0 to 1. Null when a score is unavailable.
137+ */
81138 confidence : number | null ;
82139
140+ /**
141+ * primary when the article is mainly about the company, secondary when the company
142+ * is mentioned but is not the main subject.
143+ */
83144 level : 'primary' | 'secondary' ;
84145 }
85146
147+ /**
148+ * The publication that published the article.
149+ */
86150 export interface Source {
87151 /**
88152 * True when Context observed this article in the publisher-owned feed.
89153 */
90154 direct : boolean ;
91155
156+ /**
157+ * Website domain of the publication.
158+ */
92159 domain : string ;
93160
161+ /**
162+ * Name of the publication, such as Reuters.
163+ */
94164 name : string ;
95165 }
96166 }
97167
168+ /**
169+ * Summary information about this response.
170+ */
98171 export interface Meta {
172+ /**
173+ * Number of articles in this page.
174+ */
99175 count : number ;
100176 }
101177
0 commit comments